Sign in

v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
BoxTrapper
Spam Prevention (BoxTrapper)

Update email account's BoxTrapper configuration

This function modifies an account's BoxTrapper configuration.

Important:

When you disable the Receive Mail role, the system disables this function.

get/BoxTrapper/save_configuration

Query parameters

emailstring email required
Example:user@example.com

The account's email address.

Warning:

If you call this function in Webmail, the system ignores this parameter and defaults to the currently-authenticated email address.

enable_auto_whitelist0 | 1 required
Example:1

Whether to enable automatic whitelisting for the account.

  • 1 - Enable.
  • 0 - Disable.
from_addressesstring email-csv required
Example:sender1@test.com,sender2@test.com

A comma-separated list of email addresses that the system uses when it sends messages back to the original message senders.

queue_daysinteger required
Example:14

The number of days to retain log files and queued messages.

whitelist_by_association0 | 1 required
Example:1

Whether to whitelist the email addresses in a message's To and From sections, including carbon-copied (CC) recipients.

  • 1 - Whitelist.
  • 0 - Do not whitelist.
from_namestring
Example:User

The name of the person who owns the email account.

spam_scorenumber
Example:2.5

The account's Apache SpamAssassin™ threshold score. For more information about Apache SpamAssassin threshold scores, read our Spam Filters documentation.

Note:

This parameter defaults to the account's current configuration.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "save_configuration",
  "module": "BoxTrapper",
  "result": {
    "status": 1
  }
}