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

Versions Compared

Key

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

Description

Excerpt

This function saves a string to a BoxTrapper configuration file or form letter.


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_add_string = $cpanel->api1('BoxTrapper', 'savecfgfile', array('user@example.com', 'list', 'blacklist.txt', 'Example text.') ); // 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_add_string = $cpliveapi->api1('BoxTrapper', 'savecfgfile', ['user@example.com', 'list', 'blacklist.txt', 'Example text.'] ); # 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::savecfgfile( $FORM('account','filetype','cfgfile','page') )">



Expand
titleCommand Line


Code Block
languagebash
cpapi1 --user=username BoxTrapper savecfg user@example.com list blacklist.txt "Example text."

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput (none)

This function does not return output.



Parameters

ParameterTypeDescriptionPossible valuesExample
accountstring

Required

The account's email address.

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

Required

The file type.

  • msg — Use a configuration file.
  • list — Use a form letter file.
list
cfgfilestring

Required

The filename.


Warning
titleImportant:

You must select the correct filetype value.

Configuration files:

  • black-list.txt
  • ignore-list.txt
  • white-list.txt

Form letter files:

  • blacklist.txt
  • returnverify.txt
  • verifyreleased.txt
  • verify.txt
blacklist.txt
pagestring

Required

The string to add.

Any string.Example text.

Returns

This function does not return output.