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

Description

This function checks whether BoxTrapper is enabled for an email account.

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/get_status?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.
// Check BoxTrapper status for user@example.com.
$set_status = $cpanel->uapi(
    'BoxTrapper', 'get_status',
    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.
 
# Check BoxTrapper status for user@example.com.
my $get_status = $cpliveapi->uapi(
    'BoxTrapper', 'get_status',
    {
        'email'  => 'user@example.com',
    }
);


Note:

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

 cPanel Template Toolkit
<!-- Check BoxTrapper status for user@example.com. -->
[% result = execute( 'BoxTrapper', 'get_status',
    {
        'email'=> 'user@example.com'
    }); %]
[% IF result.status == 1 %]
     [% IF result.data == 1 %]
     BoxTrapper is enabled for 'user@example.com'
     [% ELSE %]
     BoxTrapper is disabled for 'user@example.com'
	 [% END % ]
[% ELSE %]
    Failed to get the current BoxTrapper stats for
    'user@example' due to an error:
    <ul>
    [% FOR error IN result.errors %]
        <li>[% error %]</li>
    [% END %]
    </ul>
[% END %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username BoxTrapper get_status 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)
{
   "data": 0,
   "errors": null,
   "messages": null,
   "metadata": {},
   "status": 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.

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

Returns

ReturnTypeDescriptionPossible valuesExample
data

Boolean

Whether BoxTrapper is enabled for the email account.

  • 1 — Enabled.
  • 0 — Disabled.
0