cPanel API 2 Functions - Email::listautoresponders

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function lists the cPanel account's autoresponders.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

Email::list_auto_responders — This function lists a domain's autoresponders.

Important:

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

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=listautoresponders&domain="example.com"&regex="vacation"

Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

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

// List example.com's autoresponders that include "vacation".
$list_autoresponders = $cpanel->api2(
    'Email', 'listautoresponders',
    array(
        'domain'          => 'example.com',
        'regex'           => 'vacation',
    )
);

Note:

For more information, read our Guide to the LiveAPI System.

LiveAPI Perl Module

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

# List example.com's autoresponders that include "vacation".
my $list_autoresponders = $cpliveapi->api2(
    'Email', 'listautoresponders',
    {
        'domain'          => 'example.com',
        'regex'           => 'vacation',
    }
);

Note:

For more information, read our Guide to the LiveAPI System.

cPanel Tag System (deprecated)

Warnings:

cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI 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 .
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 documentation.

Command Line

cpapi2 --user=username Email listautoresponders domain=example.com regex=vacation

Notes:

You must URI-encode values.
username represents your account-level username.
You must run the --user=username command.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

{
    "cpanelresult": {
        "apiversion": 2,
        "func": "listautoresponders",
        "data": [{
                "email": "bob@example.com",
                "subject": "I am on vacation today."
            },
            {
                "email": "malcolm@example.com",
                "subject": "Out on vacation until Monday."
            }
        ],
        "event": {
            "result": 1
        },
        "module": "Email"
    }
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter Type Description Possible values Example

Parameter	Type	Description	Possible values	Example
`domain`	string	The domain to query. If you do not use this parameter, the function lists all of the account's autoresponders.	A valid domain on the cPanel account.	`example.com`
`regex`	string	A Perl Compatible Regular Expression (PCRE) that filters the results. If you do not use this parameter, the function lists all of the account or domain's autoresponders.	A valid PCRE.	`vacation`

domain

string

The domain to query.

If you do not use this parameter, the function lists all of the account's autoresponders.

A valid domain on the cPanel account.

example.com

regex

string

A Perl Compatible Regular Expression (PCRE) that filters the results.

If you do not use this parameter, the function lists all of the account or domain's autoresponders.

A valid PCRE.

vacation

Returns

Return	Type	Description	Possible values	Example
`email`	string	The autoresponder's email address.	A valid email address on the cPanel account.	`bob@example.com`
`subject`	string	The autoresponder's subject.	A string value.	`I am on vacation today.`
`reason`	string	A reason for failure. Note: This function only returns a `reason` value if it failed.	A string that describes the error.	`This is an error message.`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`