Description

This function modifies an account's BoxTrapper configuration.


Examples 




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



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.



<cpanel Module="BoxTrapper::saveconf( $FORM('account','froms','queuetime','autowhitelist','fromname') )">




cpapi1 --user=username BoxTrapper saveconf user@example.com sender1@test.com,sender2@test.com 14 1 "User Name"


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.