Description

This function retrieves an autoresponder's information.


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

Examples 




https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=fetchautoresponder&email=bob@example.com



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Retrieve bob@example.com's autoresponder's information.
$get_autoresponder = $cpanel->api2(
    'Email', 'fetchautoresponder', 
    array(
        'email'           => 'bob@example.com', 
    ) 
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Retrieve bob@example.com's autoresponder's information.
my $get_autoresponder = $cpliveapi->api2(
    'Email', 'fetchautoresponder',
    { 
        'email'           => 'bob@example.com', 
    }
);

 




cpapi2 --user=username Email fetchautoresponder email=bob%40example.com


For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.  




{
  "cpanelresult": {
    "apiversion": 2,
    "func": "fetchautoresponder",
    "data": [
      {
        "stop": null,
        "subject": "I am on vacation today.",
        "charset": "utf-8",
        "interval": 3,
        "body": "Try emailing me again tomorrow.\n",
        "from": "malcolm@example.com",
        "is_html": 0,
        "start": null
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}



Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

Required

The autoresponder's email address.

A valid email address on the cPanel account.

bob@example.com

Returns

ReturnTypeDescriptionPossible valuesExample
stopstringThe autoresponder's stop time, if one exists.
  • A date in Unix time format.
  • null — The autoresponder does not have a stop time.
null
subjectstringThe autoresponder's subject.A string value.I am on vacation today.
charsetstringThe autoresponder message's character encoding.The character encoding system. utf-8
intervalintegerThe number of hours that the autoresponder waits between responses to the same email address.A positive integer.3
bodystringThe autoresponder message's body.A string value.Try emailing me again tomorrow.\n
fromstringThe autoresponder message's From: section.

A valid email address.

bob@example.com
is_htmlBooleanWhether the autoresponder message is HTML-formatted.
  • 1 — HTML formatted.
  • 0 — Plaintext formatted.
0
startstringThe autoresponder's start time, if one exists.
  • A date in Unix time format.
  • null — The autoresponder does not have a start time.
null
reasonstring

A reason for failure.

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