We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Child pages
  • UAPI Functions - BoxTrapper::set_forwarders
Skip to end of metadata
Go to start of metadata

Description

This function adds a list of email addresses to which BoxTrapper forwards email messages. 

Important:

When you disable the MailReceive role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/set_forwarders?email=user@example.com&forwarder=user1@example.com&forwarder=user2@example.com&forwarder=user3@example.com


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
// Add email address to forward mail for user@example.com.
$set_forwarders = $cpanel->uapi(
    'BoxTrapper', 'set_forwarders',
    array(
        'email'       => 'user@example.com',
        'forwarder-1' => 'user1@example.com,'
		'forwarder-2' => 'user2@example.com'
		'forwarder-3' => 'user3@example.com'
    )
);


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.
 
# Add email address to forward mail for user@example.com.
my $set_forwarders = $cpliveapi->uapi(
    'BoxTrapper', 'set_status',
    {
        'email'      => 'user@example.com',
        'forwarder-1' => 'user1@example.com,'
		'forwarder-2' => 'user2@example.com'
		'forwarder-3' => 'user3@example.com'
    }
);


Note:

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

 Command Line
uapi --user=username BoxTrapper set_forwarders email=user@example.com forwarder-1=user1@example.com forwarder-2=user2@example.com forwarder-3=user3@example.com


Notes:

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

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
    "data": null,
    "errors": null,
    "messages": null,
    "metadata": {},
    "status": 1
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
email

string

Required

The account's email address.

Warning

If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.

A valid email address on the cPanel account.user@example.com 
forwarderstring

Required

The email address to which to forward email messages.

Note:

To add multiple forwarders, increment this parameter. For example, forwarder-1forwarder-2forwarder-3.

A valid email address.
user1@example.com 

Returns

This function only returns metadata.