Return email account's autoresponder information

This function retrieves autoresponder information.

Important:

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

Authorizations:
query Parameters
email
required
string <username>

The email account name.

Example: email=user
temp_charset
string
Default: "utf-8"

The autoresponder's character set.

Example: temp_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 --user=username Email get_auto_responder email='user'

Response samples

Content type
application/json
{
  • "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"
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}