Pigeonhole Sieve: Spamtest Extension

See also

Pigeonhole Sieve: Spamtest and Virustest Extensions

Settings

sieve_spamtest_max_header

• Default: <empty>

• Values: <header-field> [ ":" <regexp> ]

Some spam scanners include the maximum score value in one of their status headers. Using this setting, this maximum can be extracted from the message itself instead of specifying the maximum manually using the setting sieve_spamtest_max_value.

The syntax is identical to the sieve_spamtest_status_header setting.

sieve_spamtest_max_value

• Default: <empty>

• Values: Unsigned integer

This statically specifies the maximum value a numeric spam score can have.

sieve_spamtest_status_header

• Default: <empty>

• Values: <header-field> [ ":" <regexp> ]

This specifies the header field that contains the result information of the spam scanner and it may express the syntax of the content of the header.

If no matching header is found in the message, the spamtest command will match against 0.

This is a structured setting. The first part specifies the header field name. Optionally, a POSIX regular expression follows the header field name, separated by a colon. Any white space directly following the colon is not part of the regular expression. If the regular expression is omitted, any header content is accepted and the full header value is used. When a regular expression is used, it must specify one match value (inside brackets) that yields the desired spam scanner result.

If the header does not match the regular expression or if no value match is found, the spamtest test will match against 0 during Sieve script execution.

sieve_spamtest_status_type

• Default: <empty>

• Values: score, strlen, text

This specifies the type of status result that the spam/virus scanner produces.

This can either be a numeric score (score), a string of identical characters (strlen), e.g. ‘*******’, or a textual description (text), e.g. 'Spam' or 'Not Spam'.

sieve_spamtest_text_valueX

• Default: <empty>

• Values: String

When the sieve_spamtest_status_type setting is set to text, these settings specify that the spamtest test will match against the value X when the specified string is equal to the text (extracted) from the status header.

For spamtest and spamtestplus, values of X between 0 and 10 are recognized, while virustest only uses values between 0 and 5.