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

Versions Compared

Key

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

 

Description

Excerpt

This function enables or disables BoxTrapper for an email account.

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_status = $cpanel->api1('BoxTrapper', 'changestatus', array('user@example.com', 'enable') ); // 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_status = $cpliveapi->api1('BoxTrapper', 'changestatus', ['user@example.com', 'enable'] ); # 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::changestatus( $FORM('account','action') )">



Expand
titleCommand Line


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

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput (plaintext)


Code Block
languagetext
enabled




Parameters

ParameterTypeDescriptionPossible valuesExample
accountstring

Required

The account's email address.

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

Required

The desired action.

  • enable — Enables BoxTrapper.
  • disable — Disables BoxTrapper.
Note
titleNote:

All other values disable BoxTrapper. 


enable

Returns

  • disabled — BoxTrapper is now disabled for the account.
  • enabled — BoxTrapper is now enabled for the account.