Child pages
  • cPanel API 1 Functions - BoxTrapper::showfromname
Skip to end of metadata
Go to start of metadata

 

Description

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

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.
$boxtrapper_from = $cpanel->api1('BoxTrapper', 'showfromname', 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 $boxtrapper_from = $cpliveapi->api1('BoxTrapper', 'showfromname', ['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="BoxTrapper::showfromname( $FORM('account') )">
 Command Line
cpapi1 --user=username BoxTrapper showfromname 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. 

 Output (plaintext)
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.