# Delete messages in the BoxTrapper queue

This function deletes messages in the BoxTrapper queue.

Important:

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

Endpoint: GET /BoxTrapper/delete_messages
Version: 11.136.0.25
Security: BasicAuth

## Query parameters:

  - `email` (string, required)
    The account's email address.

Warning:

If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.
    Example: "user@example.com"

  - `queuefile` (string, required)
    The filename of the email message who's sender to delete.

  Warning:

 To delete multiple email message senders, duplicate the parameter name.
    Example: "example.msg"

  - `all_like` (integer)
    Whether to delete all messages that resemble the queuefile parameter's value.

* 1 - Delete all messages resembling the queuefile parameter.
* 0 - Do not delete all messages resembling the queuefile parameter.
    Enum: 1, 0

## Response 200 fields (application/json):

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

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

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

  - `result` (object)

  - `result.data` (array)
    An array of objects that contain information about the messages that matched the requested pattern.

  - `result.data.email` (string)
    The deleted email message's sender.
    Example: "user@example.com"

  - `result.data.failed` (integer)
    Whether the system failed to delete the messages.

Note:

The function only returns this value if it doesn't delete the message.
    Enum: 1

  - `result.data.matches` (array)
    An array of messages that the system deleted.
    Example: ["example.msg"]

  - `result.data.operator` (string)
    The operation that the system performed.
    Enum: "delete"

  - `result.data.reason` (string)
    A message about the failure or the warning.

Note:

The function only returns this value if it doesn't delete the message or experiences issues when it deletes the message.
    Example: "(XID d9myfd) The system failed to locate the requested message:"

  - `result.data.warning` (integer)
    Whether the system experienced issues when it deleted the message.

Note:

The function only returns this value if it experiences issues when it deletes the message.
    Enum: 1

  - `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.metadata.transformed` (integer)
    Post-processing may have transformed the data.
    Enum: 1

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

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