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.

Examples 


$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$get_autoresponder_interval = $cpanel->api1('Email', 'getarsinterval', array('user@example.com') ); // Call the function.

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 Module="Email::getarsinterval( $FORM('email') )">
cpapi1 --user=username Email getarsinterval email=user@example.com

0

Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

Required

The email address.

A valid email address on the server.

user@example.com

Returns

This function returns an integer value that indicates the autoresponder's interval setting.

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