Mail::SpamAssassin::Plugin::AWL(3pm) | User Contributed Perl Documentation | Mail::SpamAssassin::Plugin::AWL(3pm) |
Mail::SpamAssassin::Plugin::AWL - Normalize scores via auto-whitelist
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
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.
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
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.
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'
"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.
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.
If this option is set the SQLBasedAddrList module will keep separate database entries for DKIM-validated e-mail addresses and for non-validated ones. A pre-requisite when setting this option is that a field awl.signedby exists in a SQL table, otherwise SQL operations will fail (which is why we need this option at all - for compatibility with pre-3.3.0 database schema). A plugin DKIM should also be enabled, as otherwise there is no benefit from turning on this option.
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.
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).
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 0111).
This will set the DSN used to connect. Example: "DBI:mysql:spamassassin:localhost"
The authorized username to connect to the above DSN.
The password for the database username, for the above DSN.
The table user auto-whitelists are stored in, for the above DSN.
2021-03-26 | perl v5.28.1 |