|
<< Click to Display Table of Contents >> Navigation: »No topics above this level« Components and Plugins |
The following executable components are included in "SpamAssassin in a Box". You will find a complete list of available start parameters for the corresponding executable when using the "-h" or "--help" parameter on the command line. The official documentation can also be found in the "doc" folder or on the Apache SpamAssassin Website.
Component |
Description |
spamassassin.exe |
Checks a given mail for spam signs and assigns a spam score. Additional information can be found here. |
spamd.exe |
Daemonized version of spamassassin (spamd). Started once to run as a background process that is listening for incoming mails (similar to a Windows service). In contrast to "spamassassin.exe", which is started and stopped for each mail, the daemon works much more efficient. The daemon will require a lot less time to scan a mail. Additional information can be found here. |
spamc.exe |
Client for spamd. Passes the given mail to the spamassassin daemon and returns the result. Additional information can be found here. |
sa-update.exe |
Downloads the latest SpamAssassin rule set. You should run this tool on a regular basis to ensure that the spam filter uses the most recent anti-spam rules. Additional information can be found here. |
sa-learn.exe |
Trains the SpamAssassin Bayes filter with spam/ham messages. Additional information can be found here. |
The following plugins have been tested on Windows and should work properly. Any other SpamAssassin or third party plugin may be used as well, but will not be covered by the support of JAM Software.
Plugin |
Description |
Documentation |
|
AskDNS |
form a DNS query using tag values, and look up the DNSxL lists |
||
AutoLearnThreshold |
threshold-based discriminator for Bayes auto-learning |
||
AWL |
normalize scores via auto-welcomelist (deprecated, superseded by TxRep) |
||
Bayes |
determines likelihood of a mail being spam using a Bayesian classifier |
||
Check |
provides main check functionality |
||
DKIM |
performs DomainKeys Identified Mail (DKIM) checks to validate mail |
||
DMARC |
check the DMARC policy of the sender domain |
||
FreeMail |
check message headers and body for freemail domains |
||
HashBL |
query hashed (and unhashed) DNS blocklists |
||
HTTPSMismatch |
find URI mismatches between href and anchor text |
N/A |
|
ImageInfo |
rules to match metadata of image attachments |
N/A |
|
MIMEHeader |
apply regexp rules against MIME headers in the message |
||
PDFInfo |
use information about attached PDF files in rules |
||
Pyzor |
perform Pyzor checks; no external client is needed - set "pyzor_perl 1" and "pyzor_fork 0" to use the bundled Perl client |
||
Razor2 |
distributed, collaborative, spam detection and filtering network |
||
RelayCountry |
add message metadata indicating the country code of each relay |
||
Shortcircuit |
short-circuit evaluation for certain rules |
||
SPF |
checks a message against Sender Policy Framework (SPF) records to fight email address forgery |
||
SpamCop |
perform SpamCop message reporting |
||
TextCat |
guess the language used in the message body text |
||
TxRep |
normalize scores with sender reputation records |
||
URIDetail |
test URIs using detailed URI information |
||
URIDNSBL |
look up URLs found in the message against several DNS blocklists |
||
VBounce |
avoid backscatter spam |
||
WelcomeListSubject |
welcomelist/blocklist certain subject regular expressions |
SpamAssassin in a Box supports the dynamic loading of additional plugins. To add a plugin, please copy the plugin script file (file extensions *.pm) to the configuration directory (C:\ProgramData\JAM Software\spamdService\sa-config\) of SpamAssassin in a Box. Most plugins also ship with a configuration file (file extensions *.cf) which should be copied to the same folder as well.
As an example, you can register the "RelayedByDialup" plugin by opening the "relayed_by_dialup.cf" and changing the "loadplugin" line into the following:
loadplugin RelayedByDialup relayed_by_dialup.pm
When using the SpamAssassin daemon (spamd.exe), you will have to stop and start the application to make the daemon consider the new configuration.