Description
This function returns an autoresponder message's HTML body.
Examples
LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$get_autoresponder_html = $cpanel->api1('Email', 'getarshtml', array('user@example.com') ); // Call the function.
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $get_autoresponder_html = $cpliveapi->api1('Email', 'getarshtml', ['user@example.com'] ); # Call the function.
cPanel Tag System (deprecated)
Warning:
In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.
We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.
<cpanel Module="Email::getarshtml( $FORM('email') )">
Output (HTML)
This is an autoresponder message.<br />
<br />
Parameters
|
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
|
email
|
string
|
Required
The email address.
|
A valid email address on the server.
|
user@example.com
|
Returns
This function returns the contents of the autoresponder message's HTML body.
