Child pages
  • cPanel API 1 Functions - BoxTrapper::showfromname

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

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

Include Page
LIB:_cPanelAPI1NoEquivalent
LIB:_cPanelAPI1NoEquivalent

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledReceiveMailRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleLiveAPI PHP Class


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

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

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



Expand
titleCommand Line


Code Block
languagebash
cpapi1 --user=username BoxTrapper showfromname user@example.com

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput (plaintext)


Code Block
languagetext
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.