v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

BoxTrapper

Spam Prevention (BoxTrapper)

Enable or disable BoxTrapper for email account

This function enables or disables BoxTrapper for an email account.

Important:

When you disable the Receive Mail role, the system disables this function.

get/BoxTrapper/set_status

string email required

string username required

Example:user@example.com

The account's name. This can be an email address or the cPanel user’s username.

Warning:

If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.

enabled0 | 1 required

Example:1

Whether to enable or disable BoxTrapper for the email account.

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

{
  "apiversion": 3,
  "func": "set_status",
  "module": "BoxTrapper",
  "result": {
    "status": 1
  }
}