cPanel API 2 Functions - BoxTrapper::accountmanagelist - Knowledgebase

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.

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

 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'
    )
 );

 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'
 
    }
 );

cPanel Tag System (deprecated)

Warning:

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.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Input	Type	Description	Possible values	Example
regex	string	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

Input

Type

Description

Possible values

Example

regex

string

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

Return	Type	Description	Possible values	Example
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	string	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 reasonvalue 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

Knowledgebase

Categories

Categories