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.

SecurityBasicAuth

Request

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

200

HTTP Request was successful.

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

get/Email/list_filters

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Email \
  list_filters

Response samples

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
}
}