v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Email
Email Filtering

Return email filter's information

This function retrieves an email filter's information.

Important:

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

get/Email/get_filter

Query parameters

accountstring email required
Example:user@example.com

The email address that owns the filter.

filternamestring required
Example:coffee

The filter's name.

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_filter",
  "module": "Email",
  "result": {
    "data": {
      "actions": [
        {
          "dest": "/dev/null",
          "number": 1
        }
      ],
      "filtername": "coffee",
      "metadata": {
        "transformed": 1
      },
      "rules": [
        {
          "match": "contains",
          "number": 1,
          "opt": "or",
          "part": "$message_body",
          "val": "coconut"
        }
      ]
    },
    "status": 1
  }
}