Description

This function checks for a BoxTrapper form letter file.

 If the specified file is not present in the account's forms directory, the system copies the default file from the /usr/local/cpanel/etc/boxtrapper/forms/ directory.

Examples




$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$check_form_letter = $cpanel->api1('BoxTrapper', 'editmsg', array('user@example.com', 'blacklist.txt') ); // Call the function.



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $check_form_letter = $cpliveapi->api1('BoxTrapper', 'editmsg', ['user@example.com', 'blacklist.txt'] ); # Call the function.

 


<cpanel Module="BoxTrapper::editmsg( $FORM('account','message') )">




cpapi1 --user=username BoxTrapper editmsg user@example.com blacklist.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
messagestring

Required

The form letter's file name.

  • blacklist.txt
  • returnverify.txt
  • verifyreleased.txt
  • verify.txt
blacklist.txt

Returns

This function does not return output.