# 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.

Endpoint: GET /BoxTrapper/get_log
Version: 11.136.0.31
Security: BasicAuth

## Query parameters:

  - `email` (string, required)
    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: "user@example.com"

  - `date` (integer)
    The date for which to return the log file and its contents.

Note:

This parameter defaults to the current date.
    Example: 1556812881

## Response 200 fields (application/json):

  - `apiversion` (integer)
    The version of the API.
    Example: 3

  - `func` (string)
    The name of the method called.
    Example: "get_log"

  - `module` (string)
    The name of the module called.
    Example: "BoxTrapper"

  - `result` (object)

  - `result.data` (object)

  - `result.data.date` (integer)
    The date for which the system returned the log.
    Example: 1556812881

  - `result.data.lines` (array)
    An array of lines from the log file. If the log file doesn't exist or if no log lines exist in the file, the function returns an empty array.
    Example: ["Processing email with trusted transport method."]

  - `result.data.path` (string)
    The log file's filepath. If the log file doesn't exist, the function returns an empty string.
    Example: "/home/user/etc/example.com/user/boxtrapper/log/05-02-2019.log"

  - `result.errors` (array,null)
    List of errors if the API failed.

  - `result.messages` (array,null)
    List of messages generated by the API.

  - `result.metadata` (object)

  - `result.status` (integer)
    * 1 — Success.
* 0 — Failed. Check the errors field for more details.
    Enum: 0, 1

  - `result.warnings` (array,null)
    List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.