Custom Plugins

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 hereto the bottom of this page. Note that only SpamAssassin 3.0.0 or later can use these. To use these, just place the file(s) in /etc/mail/spamassassin your SpamAssassin plugin directory, which may be /usr/share/perl5/Mail/SpamAssassin/Plugin/ (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 You can also keep the plugin's .pm file can be kept in your /etc/mail/spamassassin/ or /etc/spamassassin, too./ directory, but you need to specify the plugin's file name as the second argument to loadplugin. For example, a plugin named Mail::SpamAssassin::Plugin::MyPlugin with a filename of myplugin.pm:
loadplugin Mail::SpamAssassin::Plugin::MyPlugin myplugin.pm

Before running these plugins please do the following:

1. Read any extra info available with the plugins, including the comments in the .cf files, or the POD documentation in the .pm file. 2.
2. Check to make sure that the default scores fit your installation. You might want to modify scores. 3.
3. Make sure to --lint the rules after loading them.
4. 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. These plugins are not generally audited for security, performance or compatibility for any specific SpamAssassin version.

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

Unmaintained Plugins

Plugins without a recent "Maintained as of:" date have been moved to UnmaintainedCustomPlugins. If you own one, or have confirmed that it is currently usable, feel free to move it back here and update that field.

Free Plugins

Mail::SpamAssassin::Plugin::AttachmentDetail

SpamAssassin plugin to check attachment details

Created by: Kent Oyer

License Type: ?

Status: Active

Maintained as of: 2023-05-18

Added: 2023-05-18

Available at: https://github.com/mxguardian/Mail-SpamAssassin-Plugin-AttachmentDetail

Mail::SpamAssassin::Plugin::ASCII

SpamAssassin plugin to convert non-ASCII characters to their ASCII equivalents

Created by: Kent Oyer

License Type: ?

Status: Active

Maintained as of: 2023-05-12

Added: 2023-05-12

Available at: https://github.com/mxguardian/Mail-SpamAssassin-Plugin-ASCII

Mail::SpamAssassin::Plugin::PDFInfo2

Improved PDF Plugin for SpamAssassin

Created by: Kent Oyer

License Type: ?

Status: Active

Maintained as of: 2023-01-26

Added: 2023-01-26

Available at: https://github.com/mxguardian/Mail-SpamAssassin-Plugin-PDFInfo2

Mail::SpamAssassin::Plugin::Esp

SpamAssassin plugin for Invaluement.com Service Provider DNSBLs ("SPBL")

Created by: Giovanni Bechis

License Type: Apache License, Version 2.0

Status: Active

Maintained as of: 2020-08-23

Added: 2020-09-09

Available at: https://github.com/bigio/spamassassin-esp

Mail::SpamAssassin::Plugin::ClamAV

Virus check using Clamav antivirus

Created by: Giovanni Bechis

License Type: Apache License, Version 2.0

Status: Active

Maintained as of: 2020-01-18

Added: 2020-06-04

Available at: https://github.com/bigio/spamassassin-clamav

TesseractOCR

Image scanning with Tesseract OCR engine

Created by: MailCleaner / Fastnet SA

License Type: Apache License, Version 2.0

Status: Active

Maintained as of: 2020-03-02

Added: 2020-03-02

Available at: https://github.com/MailCleaner/TesseractOcr

Mail::SpamAssassin::Plugin::iXhash2

iXhash2 is an unofficial improved version of iXhash plugin for SpamAssassin, adding async DNS lookups for performance and removing unneeded features. It's fully compatible with the iXhash 1.5.5 (https://sourceforge.net/projects/ixhash/) implementation. It computes MD5 checksums of fragments of the body of an e-mail and compares them to those of know spam using DNS queries to a RBL-like name server.

Created by: Henrik Krohns

License Type: Apache License, Version 2.0

Status: Active

Maintained as of: 2021-04-25

Added: 2021-04-25

Available at: https://mailfud.org/iXhash2/

Mail::SpamAssassin::Plugin::RedisAWL

redis support for spamassassin AWL/TxRep

Created by: Markus Benning

Contact: https://markusbenning.de/

WhiteListSubject BR This SpamAssassin plugin module provides eval tests for whitelisting and blacklisting particular strings in the Subject header. The value for whitelist_from or blacklist_from is a pseudo regular expression similar to how whitelist_from, etc works, see the SA configuration documentation for more information. 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:WhiteListSubjectPlugin 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

Status: Active

Maintained as of: 2015-06-08

Added: 2015-06-11

Available at: https://metacpan.org/release/Mail-SpamAssassin-Plugin-RedisAWL

Mail::SpamAssassin::Plugin::RuleTimingRedis

collect SA rule timings in redis

Created by: Markus Benning

Contact: https://markusbenning.de/

License Type: Apache License, Version 2.0

Status: Active

Maintained as of: 2015-06-08

Added: 2015-06-11

Available at: https://metacpan.org/release/Mail-SpamAssassin-Plugin-RuleTimingRedis

Note: The collectd plugin Collectd::Plugins::RedisClient could be used to record counter values.

Botnet

Botnet looks for possible botnet sources of email by checking various DNS values that indicate things such as other ISP's clients or workstations, or misconfigured DNS settings that are more likely to happen with client or workstation addresses than servers. Mirrored for educational purposes with applied patches, as it seems abandonded and nowhere to be found. No other changes are done. As the plugin has some interesting idea's there might be a (partial) rewrite in the future.

Original Author: John Rudd

Maintainer: Thijs Eilander

Contact: via github

License Type: GNU General Public License

Status: Inactive but works fine on 3.4.1

Maintained as of: 2014-11-19

Added: 2015-05-14

Available at: https://github.com/eilandert/Botnet.pm

MTX

A distributed DNS whitelist. (Named after MX records plus the abbreviation "TX" for "transmit".)

Contact: Darxus

License Type: Apache

Status: Active

Maintained as of: 2018-03-02

Added: 2011-08-12

Available at: http://www.chaosreigns.com/mtx/

DSPAM

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.

Created by: Eric Lubow

Contact: eric at lubow dot org

License Type: Same as SpamAssassin

Status: active

Maintained as of: 2011-03-21

Added: 2006-12-08

Available at: http://eric.lubow.org/projects/dspam-spamassassin-plugin/

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.

crm114

Plugin to use CRM114

Created by: MartinSchuette

Contact: info at mschuette.name

License Type: Apache License, Version 2.0

Status: Active

Maintained as of: 2011-03-21

Added: 2007-04-08

Available at: http://mschuette.name/wp/crm114-spamassassin-plugin/ (crm114.pm and crm114.cf)

Bayes OCR Plugin

Bayes OCR Plugin performs a Bayesian content analysis of the OCR extracted text to help Spamassassin catch spam messages with attached images.

Created by: PRA Group, DIEE, University of Cagliari (Italy)

Contact: see Bayes OCR Plugin - Project page

License Type: Apache License, Version 2.0

Status: Active

Maintained as of: 2011-03-21

Added: 2007-06-14

Available at: Bayes OCR Plugin - Project page

Note: (Bayes OCR Plugin is still beta!)

Image Cerberus Plugin

Image Cerberus Plugin performs a content analysis of images attached to e-mails by image processing and pattern recognition techniques.

Created by: PRA Group, DIEE, University of Cagliari (Italy) and Ambient Intelligence Lab, Sardegna DistrICT, Sardegna Ricerche (italy)

Contact: see Plugin - Project page

License Type: Apache License, Version 2.0

Status: Active

Maintained as of: 2011-03-21

Added: 2008-08-11

Available at: Plugin - Project page

Mail::SpamAssassin::Plugin::SaveHits

Stores a copy of a message in a dated directory when specific rules are hit and then creates a dated directory for each rule that is hit and creates a symlink to the message file allowing you to quickly find messages on a given date hitting a specific rule. Useful for developing and testing new rules.

Created by: Steve Freegard

Contact: steve.freegard at fsl.com

License Type: Apache

Status: Active

Maintained as of: 2011-03-21

Added: 2009-08-03

Available at: https://github.com/smfreegard/SaveHits

DNSWL spam reporting

Adds DNSWL to the services which receive a report via the command "spamassassin --report" (or -r).

Contact: Darxus

License Type: Apache

Status: Active

Maintained as of: 2018-03-02

Added: 2011-02-21

!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.kschaosreigns.uiuc.educom/Developmentdnswl/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.sa_plugin/

Mail::SpamAssassin::Plugin::LDAPfilter BR

Mail::SpamAssassin::Plugin::LDAPfilter provides LDAP-based blacklist and whitelist filtering capabilities to SpamAssassin 3.x installs. Specific resources Standard elements from the SMTP session and the RFC822 message are parsed out and searches are submitted to an LDAP server, and scorable responses are returend for any matches. For example, if a message contains a parseable domain name, the domain name will be used as a search key against the LDAP filters, and if a match is found the plugin will return a scorable marker, which could either be positive (blacklist) or negative (whitelist).

, with the resultant attribute values being assigned individual score values.BR Created by: Eric A. HallBR

Contact: ehall@ntrg.com

BR License Type: Same as SpamAssassinBR Status: seemlingly-functional v0.01 releaseBR Available at: http://www.ntrg.com/misc/ldapfilter/ BR Note: see http://www.ntrg.com/misc/ldapfilter/ldapfilter.html firstBR

Status: ongoing maintenance, some development

Maintained as of: 2011-01-01

Added: 2005-05-24

Available at: http://www.eric-a-hall.com/software/spamassassin-ldapfilter/

SAGrey

SAGrey is a two-phased greylist tool for use inside spamassassin. It first looks to see if the score of the current message exceeds the current "spam" threshold value, and if so then it 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 exceeds the spam score and the sender is unknown to spamassassin, SAGrey assumes that this is one-time spam from a throwaway or zombie account, and fires accordingly.

This is badly named, as it does not actually do greylisting.

Created by: Eric A. Hall

Contact: eric.hall@gmail.com

License Type: Same as SpamAssassin

Status: ongoing maintenance, some development

Maintained as of: 2011-01-01

Added: 2005-08-21

Available at: http://www.eric-a-hall.com/software/spamassassin-sagrey/

Commercial Plugins

Spamhaus Data Query Service Plugin for SpamAssassin

This plugin allows to get the most out of a Spamhaus Data Query Service (DQS) subscription.
Subscriptions operates on a "free for most" way, in the sense that if you meet the "Free use" restrictions listed here you are eligible for a free DQS key that you can register at https://www.spamhaustech.com/dqs/

DQS offer an increase of up to 42% in spam catch rate compared to Rsync or our public mirrors, as the Virus Bulletin test we routinely carry will show: https://www.virusbulletin.com/testing/results/latest/vbspam-email-security

Created by: Spamhaus Technology - Spamassassin Team

Contact: https://www.spamhaustech.com/

License Type: Apache License, Version 2.0

Status: Active

Maintained as of: 2019-06-25

Added: 2019-06-25 (date this entry was added)

Available at: https://docs.spamhaustech.com/40-real-world-usage/SpamAssassin/020-SpamAssassin.html

Note: Periodically tested by https://www.virusbulletin.com/testing/vbspam/

Commtouch Plug-in for SpamAssassin

Commtouch offers a SpamAssassin plug-in for its Anti-Spam and Zero-Hour Virus Outbreak Protection technologies. Messages are passed to the Commtouch engine and the results are converted into SpamAssassin scores. Embedding the Commtouch technology allows existing SpamAssassin systems to simultaneously increase accuracy and decrease the amount of resources required for maintenance, with an easy and fast integration effort.

Commtouch SA-Plugin — The Commtouch Plug-In is a quick, easy way to inoculate SpamAssassinprotected mail servers against zero-hour threats, and to beef up detection against zombie or botnet-generated spam.

Created by: Commtouch Software Ltd.

Contact: Gabriel.Mizrahi at Commtouch dot com

License Type: Commercial annual subscription

Status: Active

Maintained as of: 2011-03-23

Added: 2008-09-09

Available at: http://www.commtouch.com/Site/Products/SpamAssassin.asp

PhishPatrol^TM by Wombat Security Technologies, Inc.

PhishPatrol^TM is a dedicated Anti-Phishing email Plug-in that will significantly boost the performance of your SpamAssassin installation, enabling you to catch many of the spear-phishing emails and zero-hour phishing emails that would otherwise go undetected. PhishPatrol^TM is the product of years of research at the world-renowned School of Computer Science at Carnegie Mellon University. It relies on proprietary machine learning techniques and a proprietary set of features to complement your existing anti-spam/anti-virus installation. PhishPatrol^TM is backed by a dedicated team of researchers working relentlessly to ensure that their filter keeps up with the latest threats. As a SpamAssassin plug-in, PhishPatrol^TM integrates seamlessly with your existing installation of SpamAssassin. For additional information, contact info@wombatsecurity.com.

Created by: Wombat Security Technologies, Inc.

Contact: sales at wombatsecurity dot com

License type: Commercial annual subscription

Status: Active

Maintained as of: 2011-04-01

Added: 2008-10-20

Available at: http://wombatsecurity.com

SNF4SA - Message Sniffer Antispam Plugin for SpamAssassin

The Message Sniffer Antispam Plugin for SpamAssassin combines a real-time collaborative IP reputation system, distributed competitive machine learning technologies, and a comprehensive content analysis engine that improves both the accuracy and speed of SpamAssassin without additional tuning.

Created by: ARM Research Labs, LLC

Contact: http://www.armresearch.com/company/contactUs.jsp

License Type: Commercial Subscription

Status: Active

Maintained as of: 2012-02-20

Added: 2009-05-12

Available at: http://www.armresearch.com/products/SNF4SA.jsp

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)

Status: Active / Locked / Defunct (see above)

Maintained as of: YYYY-MM-DD

Added: YYYY-MM-DD (date this entry was added)

BR Status: (status) BR Available at: (url) BR

Mirror: (if applicable)

BR Note: (any extra notes)

BR Sample Results: (mass-check results if available) BRCategorySoftware