cPanel API 2 Functions - Email::listautoresponders

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 


 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=

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

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

 cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 

 Command Line

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

 

Notes:

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

 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 (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

 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 areason 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

 

  • 1 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....