Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
cPanel API 1 Functions - Email::getaging - Developer Documentation - cPanel Documentation
Child pages
  • cPanel API 1 Functions - Email::getaging
Skip to end of metadata
Go to start of metadata

Description

Warning:

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.

This function checks an email account's aging setting.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.


Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$email_aging_setting = $cpanel->api1('Email', 'getaging', 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 $email_aging_setting = $cpliveapi->api1('Email', 'getaging', ['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::getaging( $FORM('email') )">
 Command Line
cpapi1 --user=username Email getaging 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)

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.