Content-type: text/html
Man page of Mail::SpamAssassin::Plugin::AWL
Mail::SpamAssassin::Plugin::AWL
Section: User Contributed Perl Documentation (3pm)
Updated: 2008-06-10
Index
Return to Main Contents
NAME
Mail::SpamAssassin::Plugin::AWL - Normalize scores via auto-whitelist
SYNOPSIS
To try this out, add this or uncomment this line in init.pre:
loadplugin Mail::SpamAssassin::Plugin::AWL
Use the supplied 60_awl.cf file (ie you don't have to do anything) or
add these lines to a .cf file:
header AWL eval:check_from_in_auto_whitelist()
describe AWL From: address is in the auto white-list
tflags AWL userconf noautolearn
priority AWL 1000
DESCRIPTION
This plugin module provides support for the auto-whitelist. It keeps
track of the average SpamAssassin score for senders. Senders are
tracked using a combination of their From: address and their IP address.
It then uses that average score to reduce the variability in scoring
from message to message and modifies the final score by pushing the
result towards the historical average. This improves the accuracy of
filtering for most email.
TEMPLATE TAGS
This plugin module adds the following "tags" that can be used as
placeholders in certain options. See "Mail::SpamAssassin::Conf"
for more information on TEMPLATE TAGS.
_AWL_ AWL modifier
_AWLMEAN_ Mean score on which AWL modification is based
_AWLCOUNT_ Number of messages on which AWL modification is based
_AWLPRESCORE_ Score before AWL
USER PREFERENCES
The following options can be used in both site-wide ("local.cf") and
user-specific ("user_prefs") configuration files to customize how
SpamAssassin handles incoming email messages.
- use_auto_whitelist ( 0 | 1 ) (default: 1)
-
Whether to use auto-whitelists. Auto-whitelists track the long-term
average score for each sender and then shift the score of new messages
toward that long-term average. This can increase or decrease the score
for messages, depending on the long-term behavior of the particular
correspondent.
For more information about the auto-whitelist system, please look
at the the "Automatic Whitelist System" section of the README file.
The auto-whitelist is not intended as a general-purpose replacement
for static whitelist entries added to your config files.
Note that certain tests are ignored when determining the final
message score:
- rules with tflags set to 'noautolearn'
- auto_whitelist_factor n (default: 0.5, range [0..1])
-
How much towards the long-term mean for the sender to regress a message.
Basically, the algorithm is to track the long-term mean score of messages for
the sender ("mean"), and then once we have otherwise fully calculated the
score for this message ("score"), we calculate the final score for the
message as:
"finalscore" = "score" + ("mean" - "score") * "factor"
So if "factor" = 0.5, then we'll move to half way between the calculated
score and the mean. If "factor" = 0.3, then we'll move about 1/3 of the way
from the score toward the mean. "factor" = 1 means just use the long-term
mean; "factor" = 0 mean just use the calculated score.
- user_awl_sql_override_username
-
Used by the SQLBasedAddrList storage implementation.
If this option is set the SQLBasedAddrList module will override the set
username with the value given. This can be useful for implementing global
or group based auto-whitelist databases.
ADMINISTRATOR SETTINGS
These settings differ from the ones above, in that they are considered 'more
privileged' --- even more than the ones in the PRIVILEGED SETTINGS section.
No matter what "allow_user_rules" is set to, these can never be set from a
user's "user_prefs" file.
- auto_whitelist_factory module (default: Mail::SpamAssassin::DBBasedAddrList)
-
Select alternative whitelist factory module.
- auto_whitelist_path /path/filename (default: ~/.spamassassin/auto-whitelist)
-
This is the automatic-whitelist directory and filename. By default, each user
has their own whitelist database in their "~/.spamassassin" directory with
mode 0700. For system-wide SpamAssassin use, you may want to share this
across all users, although that is not recommended.
- auto_whitelist_db_modules Module ... (default: see below)
-
What database modules should be used for the auto-whitelist storage database
file. The first named module that can be loaded from the perl include path
will be used. The format is:
PreferredModuleName SecondBest ThirdBest ...
ie. a space-separated list of perl module names. The default is:
DB_File GDBM_File SDBM_File
NDBM_File is no longer supported, since it appears to have bugs that
preclude its use for the AWL (see SpamAssassin bug 4353).
- auto_whitelist_file_mode (default: 0600)
-
The file mode bits used for the automatic-whitelist directory or file.
Make sure you specify this using the 'x' mode bits set, as it may also be used
to create directories. However, if a file is created, the resulting file will
not have any execute bits set (the umask is set to 111).
- user_awl_dsn DBI:databasetype:databasename:hostname:port
-
Used by the SQLBasedAddrList storage implementation.
This will set the DSN used to connect. Example:
"DBI:mysql:spamassassin:localhost"
- user_awl_sql_username username
-
Used by the SQLBasedAddrList storage implementation.
The authorized username to connect to the above DSN.
- user_awl_sql_password password
-
Used by the SQLBasedAddrList storage implementation.
The password for the database username, for the above DSN.
- user_awl_sql_table tablename
-
Used by the SQLBasedAddrList storage implementation.
The table user auto-whitelists are stored in, for the above DSN.
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- TEMPLATE TAGS
-
- USER PREFERENCES
-
- ADMINISTRATOR SETTINGS
-
This document was created by
man2html,
using the manual pages.
Time: 04:14:16 GMT, September 24, 2010