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.

Authorizations:
query Parameters
body
required
string

The contents of the autoresponder message's Body section.

Example: body=This is an autoresponder message.
domain
required
string <domain>

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

Example: domain=example.com
email
required
string

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

Example: email=user
from
required
string

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

Example: from=User Name
interval
required
integer >= 0

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.

Example: interval=24
is_html
required
integer

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.
Enum: 0 1
Example: is_html=1
start
required
integer <unix_timestamp>

When to enable the autoresponder.

Example: start=1410277881
stop
required
integer <unix_timestamp>

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

Example: stop=1410300000
subject
required
string

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

Example: subject=Autoresponder Subject
charset
string
Default: "utf-8"
Example: charset=UTF-8

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  Email \
  add_auto_responder \
  email='user' \
  from='User Name' \
  subject='Autoresponder Subject' \
  body='This is an autoresponder message.' \
  domain='example.com' \
  is_html='1' \
  interval='24' \
  start='1410277881' \
  stop='1410300000'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "add_auto_responder",
  • "module": "Email",
  • "result": {
    • "data": null,
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}