cPanel API 1 Functions - BoxTrapper::changestatus - Knowledgebase

Knowledgebase

Description

This function enables or disables BoxTrapper for an email account.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$boxtrapper_status = $cpanel->api1('BoxTrapper', 'changestatus', array('user@example.com', 'enable') ); // Call the function.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $boxtrapper_status = $cpliveapi->api1('BoxTrapper', 'changestatus', ['user@example.com', 'enable'] ); # Call the function.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="BoxTrapper::changestatus( $FORM('account','action') )">

Output (plaintext)

enabled

disabled

Parameters

Parameter	Type	Description	Possible values	Example
account	string	Required The account's email address.	A valid email address on the server.	user@example.com
action	string	Required The desired action.	enable — Enables BoxTrapper. disable — Disables BoxTrapper. Note: All other values disable BoxTrapper.	enable

Parameter

Type

Description

Possible values

Example

account

string

Required

The account's email address.

A valid email address on the server.

user@example.com

action

string

Required

The desired action.

enable — Enables BoxTrapper.
disable — Disables BoxTrapper.

Note:

All other values disable BoxTrapper.

enable

Returns

disabled — BoxTrapper is now disabled for the account.
enabled — BoxTrapper is now enabled for the account.

Knowledgebase

Categories

Categories