Description

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.


Examples 




$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$email_aging_setting = $cpanel->api1('Email', 'getaging', array('user@example.com') ); // Call the function.



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.


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




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


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.