v1

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

Add email address to BoxTrapper blocked senders

This function blacklists email message senders.

Important:

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

get/BoxTrapper/blacklist_messages

Query parameters

emailstring email required
Example:user@example.com

The email address for which to blacklist messages.

Warning:

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

queuefilestring required
Example:example.msg

The filename of the email message to blacklist.

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": "blacklist_messages",
  "module": "BoxTrapper",
  "result": {
    "data": [
      {
        "email": "user@example.com",
        "failed": 1,
        "matches": [
          "example.msg"
        ],
        "operator": "blacklist",
        "reason": "This is a failure message.",
        "warning": 1
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}