v1

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

Return email account's BoxTrapper configuration

This function retrieves an account's BoxTrapper configuration.

Important:

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

get/BoxTrapper/get_configuration

Query parameters

emailstring email required
Example:user@example.com

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.

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_configuration",
  "module": "BoxTrapper",
  "result": {
    "data": {
      "enable_auto_whitelist": 1,
      "from_addresses": "user@example.com,user2@example.com",
      "from_name": "User",
      "queue_days": 14,
      "spam_score": 2.5,
      "whitelist_by_association": 1
    },
    "status": 1
  }
}