---
title: "Delete messages in the BoxTrapper queue"
method: GET
path: "/BoxTrapper/delete_messages"
tags: ["BoxTrapper", "Spam Prevention (BoxTrapper)"]
---

# Delete messages in the BoxTrapper queue

`GET /BoxTrapper/delete_messages`

This function deletes messages in the BoxTrapper queue.

**Important:**

When you disable the [Receive Mail](https://go.cpanel.net/serverroles) role, the system disables this function.

## Query parameters

- `email` string, email, required
- `queuefile` string, required
- `all_like` 1 | 0

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object[] — An array of objects that contain information about the messages that matched the requested pattern.
      - `email` string, email — The deleted email message's sender.
      - `failed` 1 — Whether the system failed to delete the messages. **Note:** The function only returns this value if it doesn't delete the message.
      - `matches` string[] — An array of messages that the system deleted.
      - `operator` 'delete' — The operation that the system performed.
      - `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.
      - `warning` 1 — 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.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
      - `transformed` 1 — Post-processing may have transformed the data.
    - `status` 1 | 0 — * `1` - Success. * `0` - Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/revisions/632e2f8e6d04/schema)