Return account-level email filters

This function lists account-level mail filters. For more information about Exim filters, read Exim’s documentation.

Important:

When you disable the Mail Receive role, the system disables this function.

Authorizations:
query Parameters
string or string

The email address or cPanel account username for which to return a list of filters. If you do not specify this value, the function lists all of the cPanel account’s account-level filters.

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 \
  list_filters

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "list_filters",
  • "module": "Email",
  • "result": {
    • "data": [
      • {
        • "actions": [
          • {
            • "action": "string",
            • "dest": "/dev/null"
            }
          ],
        • "enabled": 0,
        • "filtername": "coffee",
        • "rules": [
          • {
            • "match": "contains",
            • "opt": "or",
            • "part": "$message_body",
            • "val": "coconut"
            }
          ],
        • "unescaped": true
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}