Description

This function lists a domain's autoresponders.

Examples 




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



$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',
         )
);

 



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',
    }
);

 



<!-- 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 %]

 



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



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



Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The domain name.

A valid domain on the cPanel account.

example.com
regexstring

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

A valid PCRE.

user

Returns

ReturnTypeDescriptionPossible valuesExample
emailstring

The autoresponder's email address.

An email address on the domain.

user@example.com
subjectstring

The contents of the autoresponder message's Subject: field.

Any string, or a blank value.Autoresponder Subject