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

Description

This function retrieves the BoxTrapper status for email accounts.


Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

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


 WHM API (JSON)
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=BoxTrapper&cpanel_jsonapi_func=accountmanagelist&regex=user


Note:

 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List email accounts' BoxTrapper status.
$display_BoxTrapper_status = $cpanel->api2(
    'BoxTrapper', 'accountmanagelist',
		array(        
			'regex'      => 'User'
    ) 
 );


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.
 
# List email accounts' BoxTrapper status.
my $display_BoxTrapper_status = $cpliveapi->api2(
    'BoxTrapper', 'accountmanagelist',
    { 
        'regex'      => 'User'

	}
 );


Note:

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

 

 cPanel Tag System (deprecated)


Warnings:

  • In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

 Command Line
cpapi2 --user=username BoxTrapper accountmanagelist regex=user


Notes:

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

    /usr/local/cpanel/bin/cpapi2

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "accountmanagelist",
    "data": [
      {
        "account": "user",
        "status": "enabled",
        "accounturi": "user",
        "enabled": 1,
        "bg": "even"
      },
      {
        "account": "user@example.com",
        "status": "enabled",
        "accounturi": "user%40example.com",
        "enabled": 1,
        "bg": "odd"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "BoxTrapper"
  }
}


Note:

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

Parameters

InputTypeDescriptionPossible valuesExample
regexstring

A Perl Compatible Regular Expression (PCRE) that filters the results by email address.

Note:

This filter applies to both the username and the domain.

A valid PCRE.user

Returns

ReturnTypeDescriptionPossible valuesExample

account

string

The email account.

 

Any valid email address.user@example.com

status

string

Whether BoxTrapper is enabled or disabled for an email address.

  • enabled —  Enabled.
  • disabled — Disabled.
Enabled

accounturi

string

The email account's Uniform Resource Identifier (URI).

A valid domain on the account.
example.com

enabled

Boolean

Whether BoxTrapper is enabled or disabled for an account.

  • 1 —  Enabled.
  • 0 —  Disabled.
1

bg

string

The order of the account as the system displays it.

  • odd
  • even
odd

reason

string

A reason for failure.

Note:

This function only returns a reason value if there was an error.

A string that describes the error. This is an error message.

result

Boolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1