v1

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

Return email account's autoresponder information

This function retrieves autoresponder information.

Important:

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

get/Email/get_auto_responder

Query parameters

emailstring username required
Example:user

The email account name.

temp_charsetstring
Example:utf-8

The autoresponder's character set.

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_auto_responder",
  "module": "Email",
  "result": {
    "data": {
      "body": "This is an autoresponder message.",
      "charset": "UTF-8",
      "from": "User Name",
      "interval": 24,
      "is_html": 1,
      "start": 1410277881,
      "stop": 1410300000,
      "subject": "Autoresponder Subject"
    },
    "status": 1
  }
}