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

Versions Compared

Key

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

Description

Warning
titleWarning:

This function will NOT work on modern cPanel & WHM servers.

  • We removed support for email aging in 2006
  • This documentation is provided as a reference to update existing code ONLY.


Excerpt

This function checks an email account's aging setting.

Include Page
LIB:_cPanelAPI1NoEquivalent
LIB:_cPanelAPI1NoEquivalent


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.
$email_aging_setting = $cpanel->api1('Email', 'getaging', 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 $email_aging_setting = $cpliveapi->api1('Email', 'getaging', ['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::getaging( $FORM('email') )">



Expand
titleCommand Line


Code Block
cpapi1 --user=username Email getaging user@example.com

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput (integer)

60



Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

Required

The email address.

A valid email address on the server.

user@example.com

Returns

This function returns the email account's aging setting, as an integer.