v1

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

Return email account's BoxTrapper queued messages

This function returns a list of messages in the account's BoxTrapper queue.

Important:

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

get/BoxTrapper/list_queued_messages

Query parameters

emailstring email required
Example:user@example.com

The email account for which to retrieve queued messages.

Important:

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

dateinteger
Example:1556812881

The date for which to return queued messages.

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": "list_queued_messages",
  "module": "BoxTrapper",
  "result": {
    "data": [
      {
        "from": "user@example.com",
        "queuefile": "example.msg",
        "subject": "Email Message Subject",
        "time": 1556812881
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}