v1

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

Return account BoxTrapper blocklist rules

This function retrieves a list of BoxTrapper blocklist configuration rules. BoxTrapper will delete messages that match these rules and send a notification to the sender.

Important:

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

get/BoxTrapper/get_blocklist

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.

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_blocklist",
  "module": "BoxTrapper",
  "result": {
    "data": [
      "from blocklisted-email\\@domain\\.com"
    ],
    "status": 1
  }
}