Child pages
  • cPanel API 1 Functions - Email::getarsinterval

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

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
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

  • UAPI (recommended)Email::get_auto_responder
    Excerpt Include
    UAPI Functions - Email::get_auto_responder
    UAPI Functions - Email::get_auto_responder
    nopaneltrue
  • cPanel API 2Email::fetchautoresponder
    Excerpt Include
    cPanel API 2 Functions - Email::fetchautoresponder
    cPanel API 2 Functions - Email::fetchautoresponder
    nopaneltrue
Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$get_autoresponder_interval = $cpanel->api1('Email', 'getarsinterval', array('user@example.com') ); // Call the function.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
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.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="Email::getarsinterval( $FORM('email') )">
Expand
titleCommand Line
Code Block
cpapi1 --user=username Email getarsinterval email=user@example.com

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote

Expand
titleOutput (integer)
Code Block
languagetext
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.

Note
titleNote:

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