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.

Authorizations:
query Parameters
email
required
string <email>

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.

Example: email=user@example.com
enable_auto_whitelist
required
integer

Whether to enable automatic whitelisting for the account.

  • 1 - Enable.
  • 0 - Disable.
Enum: 0 1
Example: enable_auto_whitelist=1
from_addresses
required
string <email-csv>

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

Example: from_addresses=sender1@test.com,sender2@test.com
queue_days
required
integer >= 1

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

Example: queue_days=14
whitelist_by_association
required
integer

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.
Enum: 0 1
Example: whitelist_by_association=1
from_name
string

The name of the person who owns the email account.

Example: from_name=User
spam_score
number

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.

Example: spam_score=2.5

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  BoxTrapper \
  save_configuration \
  email='user@example.com' \
  from_addresses='sender1@test.com,sender2@test.com' \
  queue_days='14' \
  enable_auto_whitelist='1' \
  whitelist_by_association='1'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "save_configuration",
  • "module": "BoxTrapper",
  • "result": {
    • "data": null,
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}