Return email account Apache SpamAssassin settings

This function retrieves the Apache SpamAssassin™ settings for the account.

Important:

When you disable the SpamFilter role, the system disables this function.

Authorizations:
query Parameters
account
string <email>

Retrieve a specific user account's SpamAssassin settings.

Note:

If you do not specify this parameter, the function returns the settings for the default email account.

Example: account=username@example.com

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 \
  Email \
  get_spam_settings

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "get_spam_settings",
  • "module": "Email",
  • "result": {
    • "data": {
      • "cpuser_spam_auto_delete": 1,
      • "cpuser_spam_auto_delete_score": 8,
      • "rewrites_subjects": 1,
      • "spam_as_acl": 1,
      • "spam_auto_delete": 0,
      • "spam_auto_delete_score": 8,
      • "spam_box_enabled": 0,
      • "spam_enabled": 1,
      • "spam_status_changeable": 1
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}