Description

This function checks the number of days to retain messages in the BoxTrapper queue.


Examples 




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



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $boxtrapper_days = $cpliveapi->api1('BoxTrapper', 'showqueuetime', ['user@example.com'] ); # Call the function.


<cpanel Module="BoxTrapper::showqueuetime( $FORM('account') )">




cpapi1 --user=username BoxTrapper showqueuetime user@example.com



9




Parameters

ParameterTypeDescriptionPossible valuesExample
accountstring

Required

The account's email address.

A valid email address on the server.user@example.com

Returns

This function returns an integer that represents the number of days to retain messages in the BoxTrapper queue.