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
  • cPanel API 1 Functions - BoxTrapper::showemails
Skip to end of metadata
Go to start of metadata


This function returns BoxTrapper's list of email addresses that send email to an account.


cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:


In cPanel & WHM version 76 and later, when you disable the Receive Mail role, the system disables this function.


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


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 $print_boxtrapper_addresses = $cpliveapi->api1('BoxTrapper', 'showemails', ['user@example.com'] ); # Call the function.


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

 cPanel Tag System (deprecated)


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::showemails( $FORM('account') )">
 Command Line
cpapi1 --user=username BoxTrapper showemails user@example.com


  • 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:


 Output (plaintext)


ParameterTypeDescriptionPossible valuesExample


The account's email address.

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


  • If the function is successful, it returns a comma-separated list of email addresses.
  • If the function is unsuccessful, it does not return output.