Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function modifies the minimum Apache SpamAssassin™ spam score.

Note:

For more information, read our Apache SpamAssassin documentation. 

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$set_spam_score = $cpanel->api1('Email', 'addspamfilter', array('8.0') ); // 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 $set_spam_score = $cpliveapi->api1('Email', 'addspamfilter', ['8.0'] ); # 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="Email::addspamfilter( $FORM('required_score') )">
 Command Line
cpapi1 --user=username Email addspamfilter 8.0

Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 

 Output (none)

This function does not return output.

 

Parameters

ParameterTypeDescriptionPossible valuesExample
required_scorestring

The new spam score.

If you do not specify a value, the function resets the spam score to the default value (5.0).

A positive integer.

Note:

The default value, 5.0, is an aggressive spam score.

The lower the spam score, the more likely it is that Apache SpamAssassin will label messages as spam.

Some systems may wish to use a more lenient spam score (for example, 8.0 or 10.0). 

8.0

Returns

This function does not return output.