cPanel API 1 Functions - Email::getarsinterval - Knowledgebase

Description

This function retrieves an autoresponder's interval setting. The interval setting determines the amount of time, in hours, that the server waits between autoresponder messages to the same address.

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::get_auto_responder — This function retrieves autoresponder information.
cPanel API 2 — Email::fetchautoresponder — This function retrieves an autoresponder's information.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$get_autoresponder_interval = $cpanel->api1('Email', 'getarsinterval', 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_interval = $cpliveapi->api1('Email', 'getarsinterval', ['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::getarsinterval( $FORM('email') )">

Output (integer)

Parameters

Parameter	Type	Description	Possible values	Example
email	string	Required The email address.	A valid email address on the server.	user@example.com

Parameter

Type

Description

Possible values

Example

string

Required

The email address.

A valid email address on the server.

user@example.com

Returns

This function returns the autoresponder's interval setting, as an integer.

Note:

A value of 0 indicates that the system sends an autoresponder message for each email received.

Knowledgebase

Categories

Categories