v1

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

Update account BoxTrapper allowlist

This function sets the BoxTrapper allowlist configuration rules. BoxTrapper will deliver emails that match these rules.

Important:

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

get/BoxTrapper/set_allowlist

Query parameters

emailstring email required
Example:user@example.com

A valid email address on the cPanel account.

Warning:

If you call this function in Webmail, the system overrides this parameter. This parameter defaults to the current email address.

rulesstring[] required

An array of allowlist rules.

Note:

You can set multiple allowlist rules, duplicate or increment the parameter name. For example, rules-1, rules-2, and rules-3.

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": "set_allowlist",
  "module": "BoxTrapper",
  "result": {
    "status": 1
  }
}