---
title: "Run test for main domain email filters"
method: GET
path: "/Email/trace_filter"
tags: ["Email", "Email Filtering"]
---

# Run test for main domain email filters

`GET /Email/trace_filter`

This function tests mail filters. The function **only** tests filters for the cPanel account's main domain, and only tests against the message's body. For more information about Exim filters, read [Exim's documentation](http://www.exim.org/exim-html-3.30/doc/html/filter.html).

**Note:**

If the domain or account does not contain a filter file, this function will fail.

**Important:**

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

## Query parameters

- `msg` string, required
- `account` 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
      - `trace` string — A series of messages that describe the trace results. **Note:** This output may contain HTML.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
    - `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.dev/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.dev/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/revisions/632e2f8e6d04/schema)