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

# Send messages in the BoxTrapper queue

`GET /BoxTrapper/deliver_messages`

This function delivers messages in the BoxTrapper queue.

**Important:**

When you disable the
[*Receive Mail* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles),
the system **disables** this function.

## Query parameters

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

## 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[] — The delivered email message information.
      - `email` string, email — The delivered email message's sender.
      - `failed` 1 — Whether the system could not deliver the message. **Note:** * The function only returns this value if it doesn't deliver the message. * `1` is the only possible value.
      - `matches` string[] — A list of delivered email messages.
      - `operator` 'deliver' | 'deliverall' — The action that the function performed. * `deliver` * `deliverall`
      - `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 delivered the message. **Note:** * The function only returns this value if it experiences issues when it delivers the message. * `1` is the only possible value.
    - `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` 0 | 1 — * `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)