v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
SpamAssassin
Spam Management

Return SpamAssassin™ settings

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

Note:

Additional customizations may appear in the returns. Form more information read the Apache SpamAssassin™ configuration file documentation.

get/SpamAssassin/get_user_preferences

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_user_preferences",
  "module": "SpamAssassin",
  "result": {
    "data": {
      "blacklist_from": [
        "username2@example.com"
      ],
      "required_score": [
        5.1
      ],
      "score": [
        "ACT_NOW_CAPS 1"
      ],
      "whitelist_from": [
        "username@example.com"
      ]
    },
    "status": 1
  }
}