v1

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

Return domain's autoresponders

This function lists a domain's autoresponders.

Important:

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

get/Email/list_auto_responders

Query parameters

domainstring domain required
Example:example.com

The domain name.

regexstring
Example:user

A Perl Compatible Regular Expression (PCRE) that filters the results.

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": "list_auto_responders",
  "module": "Email",
  "result": {
    "data": [
      {
        "email": "user@example.com",
        "subject": "Autoresponder Subject"
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}