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.
Examples
Note:
Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.
Parameters
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 |
Returns
Return |
Type |
Description |
Possible values |
Example |
|
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 areason value if it failed. |
A string that describes the error. |
This is an error message. |
result |
Boolean |
Whether the function succeeded. |
|
1 |