Description

This function returns the path to an account's BoxTrapper configuration directory.

Examples 




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



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

 


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




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



/home/user/etc/example.com/emailuser/.boxtrapper




Parameters

ParameterTypeDescriptionPossible valuesExample
accountstring

Required

The account's email address.

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

Returns

This function returns the path to the account's BoxTrapper configuration directory.