CPcpanel
Email
Spam Management

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.

get/Email/get_spam_settings

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

Query parameters

accountstring email
Example:username@example.com

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.

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": "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_score": 8,
      "spam_enabled": 1,
      "spam_status_changeable": 1
    },
    "status": 1
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.