---
title: "Return email account's autoresponder information"
method: GET
path: "/Email/get_auto_responder"
tags: ["Email", "Email Accounts"]
---

# Return email account's autoresponder information

`GET /Email/get_auto_responder`

This function retrieves autoresponder information.

**Important:**

When you disable the [Receive Mail role](https://go.cpanel.net/serverroles), the system **disables** this function.

## Query parameters

- `email` string, username, required
- `temp_charset` string

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object
      - `body` string — The contents of the autoresponder message's `Body` section.
      - `charset` string — The autoresponder's [character set](https://en.wikipedia.org/wiki/Character_encoding).
      - `from` string — The contents of the autoresponder message's `From` field.
      - `interval` integer — The amount of time, in hours, that the server waits between autoresponder messages to the same address. **Note:** A value of `0` indicates that the system sends a message for each email received.
      - `is_html` 0 | 1 — Whether the body of the autoresponder message begins with an [HTML content type declaration](https://en.wikipedia.org/wiki/Character_encodings_in_HTML#Specifying_the_document.27s_character_encoding). - `1` - Includes an HTML content type declaration. - `0` - Does **not** include an HTML content type declaration.
      - `start` integer — When the autoresponder becomes enabled in Unix time.
      - `stop` integer — When the autoresponder becomes disabled in Unix time.
      - `subject` string — The contents of the autoresponder message's `Subject` field.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
    - `status` 0 | 1 — * `1` - Success. * `0` - Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/revisions/632e2f8e6d04/schema)
