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::get_forwarders
Skip to end of metadata
Go to start of metadata

Description

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

Important:

When you disable the Receive Mail role, the system disables this function.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/get_forwarders?email=user@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.
// Return email forwarders for user@example.com.
$get_forwarders = $cpanel->uapi(
    'BoxTrapper', 'get_forwarders',
    array(
        'email'  => 'user@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.
 
# Return email forwarders for user@example.com.
my $get_forwarders = $cpliveapi->uapi(
    'BoxTrapper', 'get_forwarders',
    {
        'email'  => 'user@example.com',
    }
);


Note:

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

 Command Line
uapi --user=username BoxTrapper get_forwarders email=user@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)
{ 
   "errors":null,
   "status":1,
   "messages":null,
   "data":[ 
      "user1@example.com",
      "user2@example.com",
      "user3@example.com"
   ],
   "metadata":{ 
      "transformed":1
   },
   "warnings":null
}


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.

Important:

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

Returns

ReturnTypeDescriptionPossible valuesExample
data

array of strings

The email addresses to which BoxTrapper forwards email.

An array of email addresses.

user1@example.com,
user2@example.com,
user3@example.com