Sun Java System Messaging Server 6.3 Administration Guide

14.4.7 SpamAssassin Options

This section contains the SpamAssassin option table.

Table 14–3 SpamAssassin Options (spamassassin.opt )

Options  

Description  

Default  

debug

Specifies whether to turn on debugging in the libspamass.so. Debugging of spamd itself is controlled by the command line invoking spamd. Set to an integer value. 0 is off, 1 is on, a setting of 2 or greater reports exactly what was received from spamd.

field

Specifies the string prefix for the SpamAssassin result. SpamAssassin results look like this: 

Spam-Test: False ; 0.0 / 5.0 Spam-Test: True ; 27.7 / 5.0

The field option provides the means for changing the Spam-Test: part of the result. Note that the “: “ is removed if an empty field value is specified.

If USE_CHECK is set to 0, the result string will look similar to this:

Spam-test: False ; 0.3 / 4.5 ; HTML_MESSAGE,NO_REAL_NAME 

Spam-test: True ; 8.8 / 4.5 ; NIGERIAN_BODY, NO_REAL_NAME,PLING_PLING,RCVD_IN_SBL,SUBJ_ALL_CAPS 

“Spam-test” 

host

The name of the system where spamd is running.

localhost 

mode

Controls the translation of SpamAssassin filter results to verdict information. That is, it specifies what verdict information is returned after a message is processed. Four modes are available. See 14.4.7.1 The SpamAssassin mode Option for further explanation.

0 - Return a verdict string (specified by the verdict option), if the message is spam. The MTA option spamfilterX_string_action can be used to specify what to do if a verdict string is returned. If the verdict option (defined below) is empty or unspecified, and message is spam, a null verdict is returned. The MTA option spamfilterX_null_action can be used to specify what to do if a null verdict is returned.

Returns a SpamAssassin default result string if it is not spam. (A default verdict always means to take no action and deliver as normal.)

1 - Returns the SpamAssassin result string if the message is found to be spam. Returns a SpamAssassin default result string if it is not spam. (Again, a default verdict always means to take no action and deliver as normal.) A SpamAssassin result string looks something like this: True; 6.5 / 7.3

2 - Same as mode 1 except that the SpamAssassin result string is returned regardless of whether the message is spam or not spam. No default or null verdict is ever returned and the verdict option is never used.

3 - Return the SpamAssassin result string if the message is found to be spam; return the verdict string specified by the verdict option if it is not. You can control the action for the SpamAssassin result string by using the spamfilterX_verdict_n and spamfilterX_action_n matched pair. You can control the action for the verdict string by using spamfilterX_string_action.

port

Specifies the port number where spamd listens for incoming requests.

783 

USE_CHECK

1 - The spamd CHECK command is used to return the SpamAssassin score.

0 - Enables use of the SYMBOLS command which returns a score and a list of the SpamAssassin tests that matched. The system may hang or have other problems with this option in pre-2.55 versions of SpamAssassin. See field above.

 

SOCKS_HOST

String. Specifies the name of an intermediate SOCKS server. If this option is specified the ICAP connection is made through the specified SOCKS server and not directly. 

"" 

SOCKS_PORT

Specifies the port that the intermediate SOCKS server is running on. 

1080 

USERNAME_MAPPING

Specify the name of a mapping to probe with address information as the plugin receives recipient addresses from the MTA. The probe format is: 


current-username|current-recipient-address|current-optin-string

If the mapping sets the $Y flag the output string is taken to be the updated username to pass to spamd.

"" 

verdict

Specifies the verdict string used for MODE 0. 

“” 

14.4.7.1 The SpamAssassin mode Option

After processing a message, SpamAssassin determines whether a message is spam or not. mode allows you to specify the string that is returned to indicate the verdict. The string choices are null, default, SpamAssassin result string, or a verdict string specified with the verdict option. (Note that default is neither null, the SpamAssassin result string, nor the string specified by verdict, but some other non-configurable result string.) The mode operations are outlined in the table below.

Table 14–4 Returned String for the SpamAssassin mode Option

verdict\ Setting

Spam?  

mode=0

mode=1

mode=2

mode=3

verdict="" (not set)

yes 

null 

SpamAssassin result 

SpamAssassin result 

SpamAssassin result 

no 

default 

default 

SpamAssassin result 

default 

verdict=string

yes 

verdict string

SpamAssassin result 

SpamAssassin result 

SpamAssassin result 

no 

default 

default 

SpamAssassin result 

verdict string

The first column indicates whether the verdict option is set or not set. The second column indicates whether the message is spam or not. The mode columns indicate the string returned for the various modes. For example, if verdict is not set and mode is set to 0 and a message is not spam, a default string is returned. If the verdict is set to YO SPAM! and mode is set to 0 and a message is spam, the string YO SPAM! is returned.