Description

This function performs an action on a message in the BoxTrapper queue.

Examples 




$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$boxtrapper_message_action = $cpanel->api1('BoxTrapper', 'messageaction', array('user@example.com', '', 'example.msg', 'deliverall,whitelist') ); // Call the function.



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $boxtrapper_message_action = $cpliveapi->api1('BoxTrapper', 'messageaction', ['user@example.com', '', 'example.msg', 'deliverall,whitelist'] ); # Call the function.

 


<cpanel Module="BoxTrapper::messageaction( $FORM('account','logdate','queuefile','action') )">




cpapi1 --user=username BoxTrapper messageaction user@example.com '' example.msg deliverall,whitelist


This function does not return output.



Parameters

ParameterTypeDescriptionPossible valuesExample
accountstring

Required

The account's email address.

A valid email address on the server.user@example.com
logdatestring

Required

The system does not use this parameter, and will ignore the value.

Any placeholder value.''
queuefilestring

Required

The email message's filename.

A valid filename.example.msg
actionstring

Required

The desired action.

This parameter accepts multiple actions as a comma-separated list.

  • blacklist — Blacklist the sender.
  • delete — Delete the message.
  • deleteall — Delete all messages from the sender.
  • deliver — Deliver the message.
  • deliverall — Deliver all messages from the sender.
  • ignorelist — Add the sender to the ignore list.
  • whitelist — Whitelist the sender.
deliverall,whitelist

Returns

This function does not return output.