Child pages
  • cPanel API 1 Functions - BoxTrapper::multimessageaction
Skip to end of metadata
Go to start of metadata

Description

This function performs an action on multiple messages in the BoxTrapper queue.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.

Important:

In cPanel & WHM version 76 and later, when you disable the MailReceive role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$boxtrapper_multi_action = $cpanel->api1('BoxTrapper', 'multimessageaction', array('user@example.com', 'example1.msg', 'deleteall') ); // Call the function.


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $boxtrapper_multi_action = $cpliveapi->api1('BoxTrapper', 'multimessageaction', ['user@example.com', 'example1.msg', 'deleteall'] ); # Call the function.


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="BoxTrapper::multimessageaction( $FORM('account','msgid1','multimsg') )">
 Command Line
cpapi1 --user=username BoxTrapper multimessageaction user@example.com example.msg deleteall


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi1 command:

    /usr/local/cpanel/bin/cpapi1

 Output (plaintext)
Deleted example1.msg from user@example.com 

Parameters

ParameterTypeDescriptionPossible valuesExample
accountstring

Required

The account's email address.

A valid email address on the server.user@example.com
msgid*string

Required

The messages' filenames. Include a msgid parameter for each message.

For example, to include three messages, specify values for the msgid1, msgid2, and msgid3 parameters.

A valid filename.example1.msg
actionstring

Required

The desired action.

  • deleteall — Delete the messages.
  • whitelistall — Whitelist the messages' senders.
deleteall

Returns

This function returns a confirmation message that lists the action taken, the message filenames, and the sender.