Description

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.

Examples 




$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.

 



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.

 


<cpanel Module="BoxTrapper::cleancfgfilelist( $FORM('account','filetype','cfgfile') )">




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


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

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.