v1

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

Return BoxTrapper log file and contents

This function returns the account's BoxTrapper log file and its contents.

Important:

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

get/BoxTrapper/get_log

Query parameters

emailstring email required
Example:user@example.com

The account's email address.

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 the log file and its contents.

Note:

This parameter defaults to the current date.

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_log",
  "module": "BoxTrapper",
  "result": {
    "data": {
      "date": 1556812881,
      "lines": [
        "Processing email with trusted transport method."
      ],
      "path": "/home/user/etc/example.com/user/boxtrapper/log/05-02-2019.log"
    },
    "status": 1
  }
}