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

Description

This function enables or disables BoxTrapper 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/set_status?email=user@example.com&enabled=1


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.
// Enable BoxTrapper for user@example.com.
$set_status = $cpanel->uapi(
    'BoxTrapper', 'set_status',
    array(
        'email'   => 'user@example.com',
        'enabled' => '1',
    )
);


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.
 
# Enable BoxTrapper for user@example.com.
my $set_status = $cpliveapi->uapi(
    'BoxTrapper', 'set_status',
    {
        'email'   => 'user@example.com',
        'enabled' => '1',
    }
);


Note:

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

 Command Line
uapi --user=username BoxTrapper set_status email=user@example.com enabled=1


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": null,
    "errors": null,
    "messages": null,
    "metadata": {},
    "status": 1
}


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.

Warning

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
enabledBoolean

Required

Whether to enable BoxTrapper for the email address.

  • 1 — Enable BoxTrapper.
  • 0 — Disable BoxTrapper.
1

Returns

This function only returns metadata.