---
title: "Return email account's BoxTrapper configuration"
method: GET
path: "/BoxTrapper/get_configuration"
tags: ["BoxTrapper", "Spam Prevention (BoxTrapper)"]
---

# Return email account's BoxTrapper configuration

`GET /BoxTrapper/get_configuration`

This function retrieves an account's BoxTrapper configuration.

**Important:**

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

## Query parameters

- `email` string, email, 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
      - `enable_auto_whitelist` 0 | 1 — Whether whitelisting is enabled. * 1 - Enabled. * 0 - Disabled.
      - `from_addresses` string — The email addresses that send emails from the account. A comma-separated list of email addresses.
      - `from_name` string — The name of the person who owns the email account.
      - `queue_days` integer — The number of days that the system retains log files and queued messages.
      - `spam_score` number — The account's [Apache SpamAssassin](https://go.cpanel.net/cpaneldocsSpamFilters) threshold score.
      - `whitelist_by_association` 0 | 1 — Whether the system whitelisted the email addresses in a message's `To` and `From` sections, including carbon-copied (CC) recipients.
    - `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.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)