CPcpanel
Email
Email Filtering

Return cPanel account's email filters total

This function returns the number of email filters for every email address on a cPanel account.

Important:

When you disable the Receive Mail role or the IP Blocker feature, the system disables this function. For more information, read our How to Use Server Profiles documentation.

get/Email/count_filters

Request

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

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": "count_filters",
  "module": "Email",
  "result": {
    "data": 1,
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}

Changes

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