---
title: "Run a specific BoxTrapper action for a message"
method: GET
path: "/BoxTrapper/process_messages"
tags: ["BoxTrapper", "Spam Prevention (BoxTrapper)"]
---

# Run a specific BoxTrapper action for a message

`GET /BoxTrapper/process_messages`

This function performs a specified action on messages in the BoxTrapper queue.

**Important:**

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

## Query parameters

- `action` 'deliver' | 'deliverall' | 'delete' | 'deleteall' | 'blacklist' | 'whitelist' | 'ignore', required
- `queuefile` string, required
- `email` string, email

## 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 containing processed email message information.
      - `email` string, email, nullable — The email address for which the system processed an email message.
      - `failed` 1 — Whether the system failed to process the message. * `1` - The function failed to process the message. This is the only possible value. **Note:** The function only returns this value if it fails to process the message.
      - `matches` string[] — An array of email messages that the system processed.
      - `operator` 'deliver' | 'deliverall' | 'delete' | 'deleteall' | 'blacklist' | 'whitelist' | 'ignore' — The operation that the system performed. * `deliver` - Delivered a specific message. * `deliverall` - Delivered all messages from a sender. * `delete` - Deleted a message. * `deleteall` - Deleted all messages from a sender. * `blacklist` - Blacklisted the sender of an email message. * `whitelist` - Whitelisted the sender of an email message. * `ignore` - Ignored email messages from a sender. **Note:** The function only returns this value if it successfully processes the message.
      - `reason` string — A message about the failure or the warning. **Note:** The function only returns this value if it fails to processes the message or experiences issues when it processes 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` 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)