cPanel API 1 Functions - Email::addspamfilter - Knowledgebase

Description

This function modifies the minimum Apache SpamAssassin™ spam score.

Warning:

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

UAPI (recommended) — Email::change_mx — This function modifies a Mail Exchanger (MX) record.
cPanel API 2 — Email::changemx — This function changes an MX entry's configuration.

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.

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.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

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 required_score=8.0

Notes:

You must URI-encode values.
username represents your account-level username.

Output (none)

This function does not return output.

Parameters

Parameter	Type	Description	Possible values	Example
required_score	string	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

Parameter

Type

Description

Possible values

Example

required_score

string

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.

Knowledgebase

Categories

Categories