v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
BoxTrapper
Spam Prevention (BoxTrapper)

Return whether email account uses BoxTrapper

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

Important:

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

get/BoxTrapper/get_status

Query parameters

emailstring email required
Example:user@example.com

The account's email address.

Important:

If you call this function in Webmail, the system ignores this parameter.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

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