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

Versions Compared

Key

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

Description

Excerpt

This function corrects common BoxTrapper configuration file issues.

 When you run this function, the system removes duplicates and standardizes regular expressions in the BoxTrapper configuration file. Then, the system rewrites a clean configuration file.

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



Expand
titleCommand Line


Code Block
languagebash
cpapi1 --user=username BoxTrapper changestatus user@example.com list black-list.txt

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 configuration file type.

list

Warning
titleImportant:

You must select list for this parameter.


list
cfgfilestring

Required

The configuration file's name.

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

Returns

This function does not return output.