Child pages
  • cPanel API 1 Functions - BoxTrapper::savecfgfile
Skip to end of metadata
Go to start of metadata

Description

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


Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.

Important:

In cPanel & WHM version 76 and later, when you disable the MailReceive role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 LiveAPI PHP Class
$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.


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
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.


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="BoxTrapper::savecfgfile( $FORM('account','filetype','cfgfile','page') )">
 Command Line
cpapi1 --user=username BoxTrapper savecfg user@example.com list blacklist.txt "Example text."


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi1 command:

    /usr/local/cpanel/bin/cpapi1

 Output (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.

Important:

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.