cPanel API 1 Functions - Email::getarsinterval


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.


cPanel API 1 is deprecatedDo 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.


 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$get_autoresponder_interval = $cpanel->api1('Email', 'getarsinterval', array('') ); // 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', [''] ); # Call the function.

 cPanel Tag System (deprecated)


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)






Possible values





 The email address. 

 A valid email address on the server. 



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


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

  • 12 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....