cPanel API 1 Functions - Email::addautoresponder - Knowledgebase

Description

This function creates an autoresponder for an email account.

Note:

This function is not available in demo mode.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

UAPI (recommended) — Email::add_auto_responder — This function creates an autoresponder for an email account.
cPanel API 2 — None.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

$add_autoresponder = $cpanel->api1('Email', 'addautoresponder', array('user', 'User Name', 'Autoresponder Subject', 'This is an autoresponder message.', 'example.com', '1', 'UTF-8', '24', '1410277881', '1410300000') ); // Call the function.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

my $add_autoresponder = $cpliveapi->api1('Email', 'addautoresponder', ['user', 'User Name', 'Autoresponder Subject', 'This is an autoresponder message.', 'example.com', '1', 'UTF-8', '24', '1410277881', '1410300000'] ); # Call the function.

cPanel Tag System (deprecated)

<cpanel Module="Email::addautoresponder( $FORM('email','from','subject','body','domain','html','charset','interval','start','stop') )">

Output (none)

This function does not return output.

Parameters

Parameter	Type	Description	Possible values	Example
email	string	Required The email account name. For example, user if the email address isuser@example.com .	A valid email account name on the server.	user
from	string	Required The contents of the autoresponder message's From: field.	Any string, or a blank value.	User Name
subject	string	Required The contents of the autoresponder message's Subject: field.	Any string, or a blank value.	Autoresponder Subject
body	string	Required The contents of the autoresponder message's Body section.	Any string, or a blank value.	This is an autoresponder message.
domain	string	Required The email account's domain. For example, example.com if the email address is user@example.com .	The email account's domain.	example.com
html	boolean	Required Whether the body of the autoresponder message begins with an HTML content type declaration.	1 — Include an HTML content type declaration. 0 — Do not include an HTML content type declaration.	1
charset	string	The character set to use. This parameter defaults to us-ascii.	Any standard character encoding set.	UTF-8
interval	integer	Required The amount of time, in hours, that the server waits between autoresponder messages to the same address.	Any positive integer. Note: If you specify 0, the system sends a message for each email received.	24
start	integer	Required The Unix time at which to enable the autoresponder.	A time, in Unix time format.	1410277881
stop	integer	Required The Unix time at which to disable the autoresponder.	A time that is after the starttime, in Unix time format.	1410300000

Returns

This function does not return output.

Knowledgebase

Categories

Categories