Disclaimer
Custom or third-party plugins described here are not part of the official SpamAssassin distribution. They may have a different license and are not from the Apache Software Foundation.
Custom Plugins
Please add links to third-party SA plugins here. Note that only SpamAssassin 3.0.0 or later can use these. To use these, just place the file(s) in /etc/mail/spamassassin (if you use spamd, be sure to restart); SpamAssassin will need at least 1 rule file (ending in .cf) to load the plugin, and that will typically use a loadplugin line to load a .pm file containing the plugin's perl code.
FYI: The .pm file can be kept in /etc/mail/spamassassin, too.
Before running these plugins please do the following:
- Read any extra info available with the plugins, including the comments in the .cf files, or the POD documentation in the .pm file. 2. Check to make sure that the default scores fit your installation. You might want to modify scores. 3. Make sure to --lint the rules after loading them. 4. Test the new plugin. Keep an eye on hits from the new rules to determine if the scoring is right for you.
Use at your own risk.
Status Information
Active: Plugin is actively updated and maintained BR Locked: Plugin is not actively updated, but is fine to run and considered "stable" BR Defunct: Plugin is no longer maintained, may be out of date or have problems BR BR Please respect the wishes of the authors and/or the site hosts.
The Plugins
DumpText BR A demo plugin that simply dumps the rendered text to stderr. BR Created by: Justin Mason BR Contact: jm at jmason dot org BR License Type: public domain (it's tiny!) BR Status: active BR Available at: DumpTextPlugin BR
ClamAV [BR] This plugin submits the entire email to a locally running [http://www.clamav.net/ Clam AntiVirus] server for virus detection. [BR] Created by: Troels Walsted Hansen [BR] Contact: troels at thule dot no [BR] License Type: Public Domain [BR] Status: Active [BR] Available at: Self:ClamAVPlugin [BR] Note: Requires the [http://search.cpan.org/~cfaber/File-Scan-ClamAV/lib/File/Scan/ClamAV.pm File::Scan::ClamAV] perl module. [BR]
WrongMX BR A plugin that determines if an email was sent to a lower preference MX when a higher preference MX was probably available. BR Created by: Daryl C. W. O'Shea BR Contact: spamassassin at dostech dot ca BR License Type: public domain BR Status: active BR Available at: Self:WrongMXPlugin BR
AuthzUser BR A example plugin using the services_allowed_for_username hook (available in 3.1 dev tree) that determines if a username is authorized to use a particular service. BR Created by: Michael Parker BR Contact: parkerm at pobox dot com BR License Type: public domain BR Status: active BR Available at: Self:AuthzUserPlugin BR
ReplaceTags BR A plugin to create character classes, which can be used in your rules to increases the chance of matching. BR Created by: Felix Bauer BR Contact: dev - at - doph dot com BR License Type: Public Domain BR Status: active BR Available at: Self:ReplaceTags BR Note: Please read the POD
PublicCheckTo BR A plugin that tests for email sent to public addresses, (such as mailing lists) it can optionally allow "If the email is to this address, its probably spam UNLESS it is a reply." It does this by checking the In-Reply-To header against known message IDs.BR Created by: Jamie HoglundBR Contact: http://www.geniegate.com/contact.php BR License Type: Free BR Status: beta BR Available at: http://geniegate.com/other/spamref/index.php BR Note: For the In-Reply-To to work, it needs a storage implementation. (Included are SQL and flat file)
CustomLearner BR This plugin implements a different bayes learning algorithm: every message marked as spam is learned as spam and every other message is learned as ham.BR Please read the source and http://bugzilla.spamassassin.org/show_bug.cgi?id=2094 for details.BR Created by: Nikolaus RathBR Contact: Nikolaus@rath.org BR License Type: Same as SpamAssassin itself BR Status: Quick hack BR Available at: http://bugzilla.spamassassin.org/show_bug.cgi?id=2094 BR Note: This plugin should really use the new plugin interface. I intend to implement it as soon as SA 3.1.0 is ready.BR
!UIUC BR Mail::SpamAssassin::UIUC is a project to connecting the CITES Spam Control (CSC) project, which runs on all mails sent to @uiuc.edu addreses (plus internal CITES mail servers like express.cites.uiuc.edu), and SpamAssassin, which is used at many smaller sites for all incoming mail. The goals were to a) make sure that the work from CITES' servers is not removed by SpamAssassin and b) hopefully use the information received from those servers as well.BR Created by: Tim Skirvin BR Contact: tskirvin@ks.uiuc.edu BR License Type: Same as SpamAssassin BR Status: It works, and will probably be maintained to match the campus setup. BR Available at: http://www.ks.uiuc.edu/Development/MDTools/spamassassin-uiuc/ BR Note: This distribution is actually released as a full patch to SpamAssassin, for ease of use by the UIUC community. More information on modified files is available at the main website.
Mail::SpamAssassin::Plugin::LDAPfilter BR Mail::SpamAssassin::Plugin::LDAPfilter provides LDAP-based blacklist and whitelist filtering capabilities to SpamAssassin 3.x installs. Specific resources from the SMTP session and the RFC822 message are parsed out and searches are submitted to an LDAP server, with the resultant attribute values being assigned individual score values.BR Created by: Eric A. HallBR Contact: ehall@ntrg.comBR License Type: Same as SpamAssassinBR Status: currently stable and also undergoing ongoing development BR Available at: http://www.ntrg.com/misc/ldapfilter/ BR Note: see http://www.ntrg.com/misc/ldapfilter/ldapfilter.html firstBR
Mail::SpamAssassin::Plugin::iXhash BR Mail::SpamAssassin::Plugin::iXhash is based on the procmail-based project 'NiXSpam', created and maintained by Bert Ungerer, editor with the German IT-magazin 'iX' (http://www.heise.de/ix/). Basically redundant information is removed from the body of a mail, then a MD5 hash is computed from the rest and compared to a given database of known spam. The actual comparison is realised via DNS. See code for more info. Read up at http://www.heise.de/ix/nixspam/ for even more. .BR Created by: Dirk BonengelBR Contact: dirk.bonengel@login-solutions.deBR License Type: Same as SpamAssassinBR Status: works-for-me-but-needs-more-perl-know-how releaseBR Available at: Self:iXhash BR Note: Please read the POD too BR
URICountry BR This plugin provides meta data for scoring URIs based on the country in which they are hosted enabling easy creation of rules for any countryBR Created by: Derek HardingBR Contact: derek_sa at atuin dot net BR License Type: Same as SpamAssassinBR Status: active BR Available at: Self:URICountryPlugin BR
SAGreyBR SAGrey is two-phased, in that it first looks to see if the current score of the current message exceeds the user-defined threshold value (as set in one of the cf files), and then looks to see if the message sender's email and IP address tuple are already known to the auto-whitelist (AWL) repository. If the message is spam and the sender is unknown, SAGrey assumes that this is one-time spam from a throwaway or zombie account, and fires accordingly.BR Created by: Eric A. HallBR License Type: Same as SpamAssassinBR Status: seemingly-functional initial release; ongoing developmentBR Available at: http://www.ntrg.com/misc/sagrey/ BR
POPAuth BR Utilizes an access.db style hash file to extend the SpamAssassin trusted_networks to 'POPAuth' or 'POP-before-SMTP' hosts by dynamically adding and removing the hosts or networks found in the specified database to SpamAssassin's trusted_networks configuration. BR Created by: Daryl C. W. O'Shea BR Contact: spamassassin at dostech dot ca BR License Type: Apache License, Version 2.0 BR Status: active BR Available at: Self:POPAuthPlugin BR
CustomDeleteTag BR This SpamAssassin plugin module allows users to specify a value that will be added to the message header, for all messages, specifying what value/score it is safe to delete the message. Obviously, you need some other process that looks at this header and performs the action, since SpamAssassin only filters and does not delete. BR Created by: Michael Parker BR Contact: parkerm at pobox dot com BR License Type: Apache License, Version 2.0 BR Status: active BR Available at: Self:CustomDeleteTag BR
Persistent Database Plugin BR This plugin module provides persistent database connections. It uses the DBI interface in much the same way that Apache::DBI does, in fact a large portion of the inspiration comes from that module.
To use, all you need to do is load the plugin module, via loadplugin, and it will automatically step in and handle your database connections.
Requires SpamAssassin 3.1+ BR Created by: Michael Parker BR Contact: parkerm at pobox dot com BR License Type: Artistic License BR Status: active BR Available at: Self:DBIPlugin BR
WebRedirect BR Fetches web pages linked to in messages and provides their contents in a pseudo-header that can be used in custom header rules.
Two eval tests are also provided to report links that return an HTTP status of either 403 (Forbidden) or 404 (Not Found).
Limited decoding of data contained in pages is also attempted. The decoded data is provided in an additional pseudo-header that is made available to custom header rules. BR Created by: Daryl C. W. O'Shea BR Contact: spamassassin at dostech dot ca BR License Type: Apache License, Version 2.0 BR Status: active BR Available at: Self:WebRedirectPlugin BR
Stats Plugin BR Keeps real-time statistics inside of a MySQL database. Statistics are rotated on a daily basis and contain user totals for that day; including total ham, spam, and messages processed. A "$TOTALS" field provides the complete summary of messages processed by the system for the day. BR Created by: James Keating BR Contact: jamesk at okeating dot net BR License Type: Apache License, Version 2.0 BR Status: active BR Available at: Self:StatsPlugin BR
OCR Plugin BR Checks for specific keywords in image/gif attachments, using gocr. This can be used to detect spam that puts all the real contect in an attached image, accompanied with random text and html (no URL's, etc). BR Created by: Maarten de Boer BR Contact: mdeboer at iua dot upf dot edu BR License Type: Same as SpamAssassin BR Status: active BR Available at: Self:OcrPlugin BR Note: this is my first SA plugin, so any feedback is welcome. Please test and send reports. BR
OCR scanner and image validator SA-plugin BR Checks for specific keywords in gif/jpg/png attachments, using gocr. This can be used to detect spam that puts all the real contect in an attached image, accompanied with random text and html (no URL's, etc). There are also various rules to validate attached images and detect forged content types or broken images. This plugin needs SpamAssassin 3.1.1 or later. The version 2.0 is able to defeat recent gif animations which use gif tricks to avoid OCR.BR Created by: Martin Blapp BR Contact: mb at imp dot ch BR License Type: BSD BR Status: active BR Available at: http://antispam.imp.ch/patches/ocrtext-3.2.tgz BR Note: Feedback and new sample images are welcome. Please test and send reports. BR
Fuzzy OCR Plugin BR Derived from OcrPlugin (see above), but has many feature enhancements, including an approximate matching algorithm to compensate recognition errors and obfuscation, support for broken gifs, jpeg and png, dynamic scoring, automatic content-type independant format detection and many more.BR Created by: Christian Holler BR Contact: decoder_at_own-hero_dot_net BR License Type: Same as SpamAssassin BR Status: active BR Available at: Self:FuzzyOcrPlugin BR Note: Feedback and new sample images are welcome. Please test and send reports. BR
DSPAM BR When using dspam in conjuction with SpamAssassin and amavisd-new, amavisd-new automatically has dspam calculate the probabability of a message being HAM/SPAM and then insert headers. If you have SA installed, the dspam information goes to waste. That is unless you take advantage of this plugin.BR Created by: Eric Lubow BR Contact: eric at lubow dot org BR License Type: Same as SpamAssassin BR Status: active BR Available at: http://eric.lubow.org/projects/index.cgi?project=dspam BR Note: Using dspam's results, this module adds a tag/token to the message that SA picks up and based on the score you assign it in the ruleset configuration file, it adds/subtracts that score. Read the homepage link for more information.BR
Relayed By Dialup BR This plugin tries to find out if the delivering host has its IP coded in the DNS-record. it doesn't lookup the IPs itself, but takes the data from the Received-Headers.BR Created by: Lars Uffmann, converted to a Module: Cord Beermann BR Contact: lu at cachescrubber.org, cord@Wunder-Nett.org BR License Type: same as Spamassassin BR Status: active BR Available at: RelayedByDialup BR Sample Results: on my setup hits of this test are 97% spam, the rest is ham BR
Addressbook BR This provides a way to automatically give a negative score to all addresses in an addressbook, which may be updated dynamically. It's not the same as whitelisting all addresses because spammers may know about some of them, so we don't want to whitelist, only give a small negative score. It's not the same as autowhitelist (AWL), which is an unlabeled learner, i.e. it just smooths scores per sender over time, but doesn't help senders who have consistently high scores.BR Created by: Karl Chen BR Contact: <quarl@nospam.quarl.org> BR License Type: Public domain BR Status: activeBR Available at: http://svn.cubewano.org/repos/spamassassin-addons/trunk/plugins/addressbook.pm BR
Mail::SpamAssassin::Plugin::OpenPGP [BR] Validates OpenPGP-signed emails; requires Mail::GPG[BR] Created by: Dave Brondsema [BR] Contact: konfidi-devel at lists.sourceforge.net[BR] License Type: Apache License, Version 2.0 [BR] Status: Active [BR] Available at: [http://search.cpan.org/perldoc?Mail::SpamAssassin::Plugin::OpenPGP] [BR] SVN: http://konfidi.org/wiki/SVN/
(in clients/spamassassin-openpgp/trunk) [BR]
crm114 [BR] Plugin to use [http://crm114.sourceforge.net/ CRM114][BR] Created by: [MartinSchuette] [BR] Contact: info at mschuette.name [BR] License Type: Apache License, Version 2.0 [BR] Status: Active [BR] Available at: [http://mschuette.name/files/crm114.pm] and [http://mschuette.name/files/crm114.cf] [BR]
Bayes OCR Plugin [BR] Bayes OCR Plugin performs a Bayesian content analysis of the OCR extracted text to help Spamassassin catch spam messages with attached images. [BR] Created by: PRA Group, DIEE, University of Cagliari (Italy) [BR] Contact: see [http://prag.diee.unica.it/n3ws1t0/?q=node/108 Bayes OCR Plugin - Project page] [BR] License Type: Apache License, Version 2.0 [BR] Status: Active (beta test) [BR] Available at: [http://prag.diee.unica.it/n3ws1t0/?q=node/108 Bayes OCR Plugin - Project page] [BR] Note: (Please remind Bayes OCR Plugin is still beta!)[BR]
Format for new entries
Suggested format (a la CustomRulesets format):
name-of-plugin BR (brief description goes here)BR Created by: (name) BR Contact: (contact addr) BR License Type: (license) BR Status: (status) BR Available at: (url) BR Mirror: (if applicable) BR Note: (any extra notes)BR Sample Results: (mass-check results if available) BR