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

 

Description

This function modifies an account's BoxTrapper configuration.

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.

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$edit_boxtrapper_config = $cpanel->api1('BoxTrapper', 'saveconf', array('user@example.com', 'sender1@test.com,sender2@test.com', '14', '1', 'User Name') ); // 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 $edit_boxtrapper_config = $cpliveapi->api1('BoxTrapper', 'saveconf', ['user@example.com', 'sender1@test.com,sender2@test.com', '14', '1', 'User Name'] ); # 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::saveconf( $FORM('account','froms','queuetime','autowhitelist','fromname') )">
 Command Line
cpapi1 --user=username BoxTrapper saveconf user@example.com sender1@test.com,sender2@test.com 14 1 "User Name"


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. 
  • We introduced this functionality in cPanel & WHM version 56.

 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
fromsstring

Required

The email addresses that send mail to the account.

A comma-separated list of email addresses.

sender1@test.com,sender2@test.com
queuetimeinteger

Required

The number of days to retain log files and queued messages.

A positive integer.

14
autowhitelistBoolean

Required

Whether to enable automatic whitelisting.

  • 1 — Enable.
  • 0 — Disable.
1
fromnamestring

Required

The From: name that BoxTrapper form emails use.

Any valid string.User Name

Returns

This function does not return output.