Child pages
  • cPanel API 2 Functions - Email::listautoresponders

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function lists the cPanel account's autoresponders.

Warning
titleWarning:

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

  • Email::list_auto_responders

    Excerpt Include
    UAPI Functions - Email::list_auto_responders
    UAPI Functions - Email::list_auto_responders
    nopaneltrue

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleWHM API (JSON)
Code Block
languagetext
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"

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$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', 
    ) 
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
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', 
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning

Expand
titleCommand Line
Code Block
languagebash
cpapi2 --user=username Email listautoresponders domain=example.com regex=vacation

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "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"
  }
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

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
regexstring

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

ReturnTypeDescriptionPossible valuesExample
emailstringThe autoresponder's email address.A valid email address on the cPanel account.bob@example.com
subjectstringThe autoresponder's subject.A string value.I am on vacation today.
reasonstring

A reason for failure.

Note
titleNote:

This function only returns a reason value if it failed. 

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1