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

Versions Compared

Key

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

Description

Excerpt

This function generates HTML for a button that enables or disables BoxTrapper.

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_button = $cpanel->api1('BoxTrapper', 'statusbutton'); // 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_button = $cpliveapi->api1('BoxTrapper', 'statusbutton'); # 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::statusbutton()">



Expand
titleCommand Line


Code Block
languagebash
cpapi1 --user=username BoxTrapper statusbutton

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput (HTML)


Code Block
languagexml
linenumberstrue
<input type="hidden" name="action" value="Disable">
<input type="submit" class="input-button" name="submitaction" value="Disable">




Parameters

This function does not accept parameters.

Returns

This function returns HTML to generate a button that changes the status of BoxTrapper for the account.

  • If BoxTrapper is currently enabled for the account, the function generates a button that disables BoxTrapper.
  • If BoxTrapper is currently disabled for the account, the function generates a button that enables BoxTrapper.
Note
titleNote:

This function does not generate all of the necessary form elements to allow the button to function. It only generates the HTML for the button itself.