This function modifies an account's BoxTrapper configuration.
Important:
When you disable the Receive Mail role, the system disables this function.
| email required | string 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: |
| enable required | integer Whether to enable automatic whitelisting for the account.
Example: |
| from required | string A comma-separated list of email addresses that the system uses when it sends messages back to the original message senders. Example: |
| queue required | integer The number of days to retain log files and queued messages. Example: |
| whitelist required | integer Whether to whitelist the email addresses in a message's To and From sections, including carbon-copied (CC) recipients.
Example: |
| from | string The name of the person who owns the email account. Example: |
| spam | 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: |
HTTP Request was successful.
| apiversion | integer The version of the API. |
| func | string The name of the method called. |
| module | string The name of the module called. |
object |
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'
{- "apiversion": 3,
- "func": "save_configuration",
- "module": "BoxTrapper",
- "result": {
- "data": null,
- "errors": null,
- "messages": null,
- "metadata": { },
- "status": 1,
- "warnings": null
}
}