UAPI Functions - Email::list_auto_responders - Knowledgebase

Description

This function lists a domain's autoresponders.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Email/list_auto_responders?domain=example.com

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// List example.com's autoresponders.
$list_auto_responders = $cpanel->uapi(
    'Email', 'list_auto_responders',
    array(
        'domain'         => 'example.com',
         )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# List example.com's autoresponders.
my $list_auto_responders = $cpliveapi->uapi(
    'Email', 'list_auto_responders',
    {
        'domain'         => 'example.com',
    }
);

 cPanel Template Toolkit

<!-- Get a hash of autoresponders, then display the email addresses. -->
[% data = execute( 'Email', 'list_auto_responders', { 'domain' => 'example.com' } ); %]
[% FOREACH q = data.email %]
     <p>
         [% q %]
     </p>
[% END %]
  
<!-- Get only the email addresses. -->
[% execute( 'Email', 'list_auto_responders', { 'domain' => 'example.com' } ).data.email %]

Command Line

uapi --user=username Email list_auto_responders domain=example.com

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": [
    {
      "email": "user@example.com",
      "subject": "Autoresponder Subject"
    }
  ],
  "metadata": {
    "transformed": 1
  }
}

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	Required The domain name.	A valid domain on the cPanel account.	example.com
regex	string	A Perl Compatible Regular Expression (PCRE) that filters the results.	A valid PCRE.	user

Parameter

Type

Description

Possible values

Example

domain

string

Required

The domain name.

A valid domain on the cPanel account.

example.com

regex

string

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

A valid PCRE.

user

Returns

Return	Type	Description	Possible values	Example
email	string	The autoresponder's email address.	An email address on the domain.	user@example.com
subject	string	The contents of the autoresponder message's Subject:field.	Any string, or a blank value.	Autoresponder Subject

Knowledgebase

Categories

Categories