v1

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

Add email account to Exim ignore list

This function marks email message senders for Exim to ignore.

Important:

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

get/BoxTrapper/ignore_messages

Query parameters

emailstring email required
Example:user@example.com

The cPanel email account from which to ignore messages.

Warning:

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

queuefilestring required

The filename of the email message to ignore.

Note:

To ignore multiple email messages, duplicate 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": "ignore_messages",
  "module": "BoxTrapper",
  "result": {
    "data": [
      {
        "email": "user@example.com",
        "matches": [
          "example.msg"
        ],
        "operator": "ignore"
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}