1Mail::SpamAssassin::PluUgsienr::CAoWnLt(r3i)buted Perl DMoaciulm:e:nStpaatmiAosnsassin::Plugin::AWL(3)
2
6 Mail::SpamAssassin::Plugin::AWL - Normalize scores via auto-whitelist
7
9 To try this out, add this or uncomment this line in init.pre:
10 loadplugin Mail::SpamAssassin::Plugin::AWL
12 Use the supplied 60_awl.cf file (ie you don't have to do anything) or
14 add these lines to a .cf file:
15 header AWL eval:check_from_in_auto_whitelist()
17 describe AWL From: address is in the auto white-list
18 tflags AWL userconf noautolearn
19 priority AWL 1000
20
22 This plugin module provides support for the auto-whitelist. It keeps
23 track of the average SpamAssassin score for senders. Senders are
24 tracked using a combination of their From: address and their IP
25 address. It then uses that average score to reduce the variability in
26 scoring from message to message and modifies the final score by pushing
27 the result towards the historical average. This improves the accuracy
28 of filtering for most email.
29
31 This plugin module adds the following "tags" that can be used as place‐
32 holders in certain options. See "Mail::SpamAssassin::Conf" for more
33 information on TEMPLATE TAGS.
34 _AWL_ AWL modifier
36 _AWLMEAN_ Mean score on which AWL modification is based
37 _AWLCOUNT_ Number of messages on which AWL modification is based
38 _AWLPRESCORE_ Score before AWL
39
41 The following options can be used in both site-wide ("local.cf") and
42 user-specific ("user_prefs") configuration files to customize how Spa‐
43 mAssassin handles incoming email messages.
44 use_auto_whitelist ( 0 ⎪ 1 ) (default: 1)
46 Whether to use auto-whitelists. Auto-whitelists track the long-
47 term average score for each sender and then shift the score of new
48 messages toward that long-term average. This can increase or
49 decrease the score for messages, depending on the long-term behav‐
50 ior of the particular correspondent.
51 For more information about the auto-whitelist system, please look
53 at the the "Automatic Whitelist System" section of the README file.
54 The auto-whitelist is not intended as a general-purpose replacement
55 for static whitelist entries added to your config files.
56 Note that certain tests are ignored when determining the final mes‐
58 sage score:
59 - rules with tflags set to 'noautolearn'
61 auto_whitelist_factor n (default: 0.5, range [0..1])
63 How much towards the long-term mean for the sender to regress a
64 message. Basically, the algorithm is to track the long-term mean
65 score of messages for the sender ("mean"), and then once we have
66 otherwise fully calculated the score for this message ("score"), we
67 calculate the final score for the message as:
68 "finalscore" = "score" + ("mean" - "score") * "factor"
70 So if "factor" = 0.5, then we'll move to half way between the cal‐
72 culated score and the mean. If "factor" = 0.3, then we'll move
73 about 1/3 of the way from the score toward the mean. "factor" = 1
74 means just use the long-term mean; "factor" = 0 mean just use the
75 calculated score.
76 user_awl_sql_override_username
78 Used by the SQLBasedAddrList storage implementation.
79 If this option is set the SQLBasedAddrList module will override the
81 set username with the value given. This can be useful for imple‐
82 menting global or group based auto-whitelist databases.
83
85 These settings differ from the ones above, in that they are considered
86 'more privileged' -- even more than the ones in the PRIVILEGED SETTINGS
87 section. No matter what "allow_user_rules" is set to, these can never
88 be set from a user's "user_prefs" file.
89 auto_whitelist_factory module (default: Mail::SpamAssassin::DBBasedAd‐
91 drList)
92 Select alternative whitelist factory module.
93 auto_whitelist_path /path/filename (default: ~/.spamassas‐
95 sin/auto-whitelist)
96 This is the automatic-whitelist directory and filename. By
97 default, each user has their own whitelist database in their
98 "~/.spamassassin" directory with mode 0700. For system-wide Spa‐
99 mAssassin use, you may want to share this across all users,
100 although that is not recommended.
101 auto_whitelist_db_modules Module ... (default: see below)
103 What database modules should be used for the auto-whitelist storage
104 database file. The first named module that can be loaded from the
105 perl include path will be used. The format is:
106 PreferredModuleName SecondBest ThirdBest ...
108 ie. a space-separated list of perl module names. The default is:
110 DB_File GDBM_File SDBM_File
112 NDBM_File is no longer supported, since it appears to have bugs
114 that preclude its use for the AWL (see SpamAssassin bug 4353).
115 auto_whitelist_file_mode (default: 0600)
117 The file mode bits used for the automatic-whitelist directory or
118 file.
119 Make sure you specify this using the 'x' mode bits set, as it may
121 also be used to create directories. However, if a file is created,
122 the resulting file will not have any execute bits set (the umask is
123 set to 111).
124 user_awl_dsn DBI:databasetype:databasename:hostname:port
126 Used by the SQLBasedAddrList storage implementation.
127 This will set the DSN used to connect. Example: "DBI:mysql:spamas‐
129 sassin:localhost"
130 user_awl_sql_username username
132 Used by the SQLBasedAddrList storage implementation.
133 The authorized username to connect to the above DSN.
135 user_awl_sql_password password
137 Used by the SQLBasedAddrList storage implementation.
138 The password for the database username, for the above DSN.
140 user_awl_sql_table tablename
142 Used by the SQLBasedAddrList storage implementation.
143 The table user auto-whitelists are stored in, for the above DSN.
145perl v5.8.8 2008-01-05Mail::SpamAssassin::Plugin::AWL(3)