---
title: "Add email account to Exim ignore list"
method: GET
path: "/BoxTrapper/ignore_messages"
tags: ["BoxTrapper", "Spam Prevention (BoxTrapper)"]
---

# Add email account to Exim ignore list

`GET /BoxTrapper/ignore_messages`

This function marks email message senders for Exim to ignore.

**Important:**

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

## Query parameters

- `email` string, email, required
- `queuefile` string, required

## 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 ignored email message information.
      - `email` string, email — The ignored email message's sender.
      - `failed` 1 — Whether the system failed to ignore the messages. * `1` - Failed to ignore the message. * `1` - Failed to ignore the message. * `1` - Failed to ignore the message. * `1` - Failed to ignore the message. * `1` - Failed to ignore the message. **Note:** The function only returns this value if it experiences issues when it ignores the message.
      - `matches` string[] — An array containing ignored message files.
      - `operator` 'ignore' — The operation that the system performed. * `ignore` — The system ignored this email message.
      - `reason` string — A message that describes the failure or the warning. **Note:** The function only returns this value if it doesn't ignore the message or experiences issues when it ignores the message.
      - `warning` 1 — Whether the system experienced issues when it ignored the message. * `1` — The system encountered a problem. **Note:** The function only returns this value if it experiences issues when it ignores 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)