Description

This function returns the From: name that the account's BoxTrapper form letters use.

Examples 




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



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

 


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




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



John Doe




Parameters

ParameterTypeDescriptionPossible valuesExample
accountstring

Required

The account's email address.

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

Returns

  • If the function is successful, it returns the name that appears in the From: field of form letter messages.
  • If the boxtrapper.conf file does not contain a From: name, it does not return output.