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.

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.

Note:

For more information, read our Guide to the LiveAPI System.

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.

Note:

For more information, read our Guide to the LiveAPI System.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Email::getarsinterval( $FORM('email') )">

Command Line

cpapi1 --user=username Email getarsinterval email=user@example.com

Notes:

You must URI-encode these values.
username represents your account-level username.
For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command.
If you run CloudLinux™, you must use the full path of the cpapi1 command:
```
/usr/local/cpanel/bin/cpapi1
```

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

Returns

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

Note:

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

Function information

Module:

Email

API Version:

cPanel API 1

Available in:

cPanel 11+

Methods:

GET, POST

Required Parameters:

email

Return Formats:

integer

About this module

The Email module modifies cPanel email account settings.

About cPanel API 1

cPanel API 1 accesses information about cPanel accounts.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you use cPanel API 2 or UAPI instead.

Notes:

These functions may require a feature list. To view the available feature lists on a cPanel server, view WHM's Feature Manager interface.
Unless you call this API via the WHM API, you must use the appropriate cPanel ports ( 2082 or 2083 ). You can also call some functions via cPanel's Webmail ports ( 2095 or 2096 ).

Find a function

Related functions

Page:

cPanel API 1 Functions - Email::addautoresponder — This function creates an autoresponder for an email account.
Page:

cPanel API 1 Functions - Email::adddforward — This function adds a domain-level email forwarder.
Page:

cPanel API 1 Functions - Email::addlist — This function adds a Mailman mailing list.
Page:

cPanel API 1 Functions - Email::addspam — This function enables Apache SpamAssassin™ for a cPanel account.
Page:

cPanel API 1 Functions - Email::addspamfilter — This function modifies the minimum Apache SpamAssassin™ spam score.

Child pages

cPanel API 1 Functions - Email::getarsinterval

Description

Examples

Parameters

Returns

Function information

About this module

About cPanel API 1

Find a function

Search

Related functions