# cPanel API 2 Functions - Email::fetchautoresponder

Warning:

The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This function retrieves an autoresponder's information.

Warning:

We **strongly** recommend that you use the following [UAPI](/cpanel/introduction/) function instead of this function:

- ` Email::get_auto_responder ` — This function retrieves autoresponder information.


div
Important:
br
When you disable the [*Receive Mail* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.

br
## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=fetchautoresponder&email=bob@example.com
```

div
Note:
br
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

br
LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Retrieve bob@example.com's autoresponder's information.
$get_autoresponder = $cpanel->api2(
    'Email', 'fetchautoresponder',
    array(
        'email'           => 'bob@example.com',
    )
);
```

div
Note:
br
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

br
LiveAPI Perl Module


```undefined syntaxhighlighter-pre
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Retrieve bob@example.com's autoresponder's information.
my $get_autoresponder = $cpliveapi->api2(
    'Email', 'fetchautoresponder',
    {
        'email'           => 'bob@example.com',
    }
);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

div
Warnings:
br
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) system to call the cPanel APIs. Examples are **only** present in order to help developers move from the old cPanel tag system to our [LiveAPI](/guides/guide-to-the-liveapi-system).
- cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
- For more information, read our [Deprecated cPanel Tag Usage](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


br
Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username Email fetchautoresponder email=bob%40example.com
```

div
Note:
br
For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.

br
Output (JSON)


```undefined syntaxhighlighter-pre
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "fetchautoresponder",
    "data": [
      {
        "stop": null,
        "subject": "I am on vacation today.",
        "charset": "utf-8",
        "interval": 3,
        "body": "Try emailing me again tomorrow.\n",
        "from": "malcolm@example.com",
        "is_html": 0,
        "start": null
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}
```

div
Note:
br
Use cPanel's *[API Shell](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

br
## Parameters

table
colgroup
col
col
col
col
col
thead
tr
th
strong
Parameter
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
email
td
em
string
td
p
strong
Required
p
The autoresponder's email address.
td
p
A valid email address on the cPanel account.
td
code
bob@example.com
## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
stop
td
em
string
td
The autoresponder's stop time, if one exists.
td
ul
li
A date in 
a
Unix time
 format.
li
code
null
 — The autoresponder does not have a stop time.
td
code
null
tr
td
code
subject
td
em
string
td
The autoresponder's subject.
td
A string value.
td
code
I am on vacation today.
tr
td
code
charset
td
em
string
td
The autoresponder message's character encoding.
td
The 
a
character encoding
 system.
td
code
utf-8
tr
td
code
interval
td
em
integer
td
The number of hours that the autoresponder waits between responses to the same email address.
td
A positive integer.
td
code
3
tr
td
code
body
td
em
string
td
The autoresponder message's body.
td
A string value.
td
code
Try emailing me again tomorrow.\n
tr
td
code
from
td
em
string
td
The autoresponder message's 
code
From:
 section.
td
p
A valid email address.
td
code
bob@example.com
tr
td
code
is_html
td
em
Boolean
td
Whether the autoresponder message is HTML-formatted.
td
ul
li
code
1
 — HTML formatted.
li
code
0
 — Plaintext formatted.
td
code
0
tr
td
code
start
td
em
string
td
The autoresponder's start time, if one exists.
td
ul
li
A date in 
a
Unix time
 format.
li
code
null
 — The autoresponder does not have a start time.
td
code
null
tr
td
code
reason
td
em
string
td
p
A reason for failure.
p
div
Note:
br
p
This function only returns a 
code
reason
 value if it failed. 
br
p
td
p
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1