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.

Authorizations:
query Parameters
email
required
string <email>

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.

Example: email=user@example.com
date
integer <unix_timestamp>

The date for which to return the log file and its contents.

Note:

This parameter defaults to the current date.

Example: date=1556812881

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  BoxTrapper \
  get_log \
  email='user@example.com'

Response samples

Content type
application/json
{
  • "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"
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}