CPcpanel
Email
Email Accounts

Create email account's autoresponder

This function creates an autoresponder for an email account.

Important:

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

get/Email/add_auto_responder

Request

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

Query parameters

bodystring required
Example:This is an autoresponder message.

The contents of the autoresponder message's Body section.

domainstring domain required
Example:example.com

The email account's domain. For example, example.com if the email address is user@example.com.

emailstring required
Example:user

The email account name. For example, user if the email address is user@example.com.

fromstring required
Example:User Name

The contents of the autoresponder message's From: field.

intervalinteger required
Example:24

The amount of time, in hours, that the server waits between autoresponder messages to the same address.

Note:

If you specify 0, the system sends a message for each received email.

is_html0 | 1 required
Example:1

Whether the body of the autoresponder message begins with an HTML Content-Type declaration.

  • 1 — Include an HTML content type declaration.
  • 0 — Do not include an HTML content type declaration.
startinteger required
Example:1410277881

When to enable the autoresponder.

stopinteger required
Example:1410300000

When to disable the autoresponder. A time that is after the start time.

subjectstring required
Example:Autoresponder Subject

The contents of the autoresponder message's Subject: field.

charsetstring
Example:UTF-8

The 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": "add_auto_responder",
  "module": "Email",
  "result": {
    "status": 1
  }
}

Changes

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