Plugin Settings

Plugins Supported

Name Description
AntiVirus Simple antivirus tests to check if an email contains an executable attachment.
ASN Add metadata to the Bayesian filtering process, allowing the Bayesian filters to learn information based on the ASN of the connecting IP address.
AWL Track scores from messages previously received and adjusts the message score by boosting or penalizing messages from senders who send ham or spam.
DCC DCC is a system of servers counting checksums of millions of mail messages to determine of a message is bulk email or not. (not installed by default)
DecodeShortURLs Decode shortened URLs in messages then add the URLs to a list of URIs which can then be scored and accessed by other plug-ins. (experimental)
DKIM Perform DKIM lookups as well as historical DomainKeys lookups.
FreeMail Check the headers for indication that a senders domain is that of a site offering free email services.
FromNameSpoof Perform various tests to detect spoof attempts using the From: header name section. (Spamassassin 3.4.2 or newer)
HashBL Search email addresses in the msbl.org blacklists. (Spamassassin 3.4.2 or newer)
OLEVBMacro Use several methods to search attached documents for evidence of an OLE Macro.
PDFInfo Use several methods to detect a PDF files ham and spam traits.
Phishing Check URIs against Openphish and PhishTank phishing feeds. (Spamassassin 3.4.2 or newer)
Pyzor A collaborative, networked system to detect and block spam using identifying digests of messages.
Razor2 A distributed, collaborative, spam detection and filtering network based on user submissions of spam.
RelayCountry Add metadata to the Bayesian filtering process, allowing the Bayesian filters to learn information based on countries.
ResourceLimits Limit the memory / CPU usage of child spamd processes. (Spamassassin 3.4.2 or newer)
Rule2XSBody Compile SpamAssassin ruleset into native code. (not installed by default)
SH The Data Query Service is a set of DNSBLs with real time updates operated by by Spamhaus Technology.
SPF Check SPF records published by the domain owners in DNS to fight email address forgery and make it easier to identify spams.
TesseractOcr Use optical character recognition to parse text from images within the body of an email.
TextCat Try to guess the language used in the message body text.
TxRep Normalize scores with sender reputation records. (Spamassassin 3.4.1 or newer)
URIDNSBL Look up URLs in a message against DNS blocklists.
URILocalBL Blacklist URIs using local country and CIDR information. (Spamassassin 3.4.1 or newer)
VBounce Aid in rescuing genuine bounces.
Warden Manages the logging of spam and virus information for use by Plesk and Warden.
WhiteListSubject Whitelist or blacklist by Subject: header.

Perl Modules Installation

The GeoIP and GeoIP2 perl modules require additional configuration depending on the version of Spamassassin you are using.
For Spamassassin 3.4.2 or newer use GeoIP2::Database::Reader Perl Module Installation
For Spamassassin 3.4.1 or older use GeoIP Perl Module Installation

You can install the Perl modules required by the Spamassassin plugins using the following commands:

RHEL / Centos:

yum install perl-DBD-MySQL perl-Net-Patricia perl-Mail-SPF perl-Mail-DKIM perl-IO-Socket-IP perl-IO-Socket-SSL \
perl-IO-Socket-INET6 perl-Razor-Agent perl-Error perl-Geo-IP perl-Digest-SHA1 perl-Net-DNS perl-BSD-Resource \
perl-Encode perl-Encode-Detect perl-DBD-SQLite perl-libwww-perl perl-Archive-Zip perl-IO-String

Debian / Ubuntu:

sudo apt-get install libdbd-mysql-perl libnet-patricia-perl libmail-spf-perl libmail-dkim-perl libio-socket-ip-perl \
libio-socket-ssl-perl libio-socket-inet6-perl libnet-dns-perl liberror-perl libgeo-ip-perl libdigest-sha-perl \
libbsd-resource-perl libencode-perl libencode-detect-perl libdbd-sqlite3-perl libwww-perl libarchive-zip-perl libio-string-perl

To view any missing perl modules run the command:

spamassassin -D --lint 2>&1 | grep -i failed

GeoIP2::Database::Reader Perl Module Installation

This is the new GeoIP Perl module used by Spamassassin 3.4.2 or newer. This is the recommended module to use as it supports both IPv4 and IPv6 addresses. Cpanm will install the GeoIP2::Database::Reader and its dependencies to the directory /usr/local/share/perl5/ on RHEL/Centos or /usr/local/share/perl/<perl_version>/ on Debian/Ubuntu. This directory is different than any Perl RPM / Deb packages. This module is required by the RelayCountry and URILocalBL plugins.

RHEL/Centos/CoundLinux 7

// install the Perl dependencies required for the GeoIP2::Database::Reader module
yum install curl gcc perl perl-core perl-devel perl-App-cpanminus perl-CPAN-Meta perl-CPAN-Meta-YAML \
perl-Clone-PP perl-Data-Dumper perl-Data-Dumper-Concise perl-DateTime perl-DateTime-Locale perl-DateTime-TimeZone \
perl-Dist-CheckConflicts perl-Exporter perl-ExtUtils-MakeMaker perl-File-HomeDir perl-File-ShareDir \
perl-File-ShareDir-Install perl-File-Which perl-Getopt-Long perl-HTTP-Message perl-IO-Compress perl-JSON-MaybeXS \
perl-JSON-PP perl-LWP-Protocol-https perl-Module-Implementation perl-Module-Metadata perl-Module-Runtime \
perl-Module-Runtime perl-Package-Stash perl-Package-Stash-XS perl-Params-Validate perl-Path-Class \
perl-PathTools perl-Role-Tiny perl-Scalar-List-Utils perl-Sort-Naturally perl-Test-Deep perl-Test-Fatal \
perl-Test-Number-Delta perl-Test-Requires perl-Test-Simple perl-Test-Tester perl-Test-Warnings perl-Throwable \
perl-Try-Tiny perl-URI perl-libwww-perl perl-namespace-autoclean perl-namespace-clean

// install the MaxMind GeoIP2::Database::Reader
cpanm GeoIP2::Database::Reader

// Sit back and relax while cpamn builds and installs all the requred perl modules.
// After this completes the GeoIP2::Database::Reader and its dependencies should be installed.

RHEL/Centos/CoundLinux 8

// install the Perl dependencies required for the GeoIP2::Database::Reader module
yum install curl gcc perl perl-core perl-devel perl-App-cpanminus perl-CPAN-Meta perl-CPAN-Meta-YAML \
perl-Clone-PP perl-Data-Dumper perl-Exporter perl-ExtUtils-MakeMaker perl-File-HomeDir perl-File-ShareDir \
perl-File-ShareDir-Install perl-File-Which perl-Getopt-Long perl-HTTP-Message perl-IO-Compress \
perl-JSON-MaybeXS perl-JSON-PP perl-LWP-Protocol-https perl-Module-Metadata perl-Module-Runtime \
perl-Path-Class perl-PathTools perl-Scalar-List-Utils perl-Test-Number-Delta perl-Test-Simple \
perl-Try-Tiny perl-URI perl-libwww-perl

// install the MaxMind GeoIP2::Database::Reader
cpanm GeoIP2::Database::Reader

// Sit back and relax while cpamn builds and installs all the requred perl modules.
// After this completes the GeoIP2::Database::Reader and its dependencies should be installed.

Debian / Ubuntu

// install the Perl dependencies required for the GeoIP2::Database::Reader module
sudo apt-get install perl build-essential libssl-dev cpanminus libfile-which-perl libdata-printer-perl

// install the MaxMind GeoIP2::Database::Reader
sudo cpanm GeoIP2::Database::Reader

// Sit back and relax while cpamn builds and installs all the requred perl modules.
// After this completes the GeoIP2::Database::Reader and its dependencies should be installed.

GeoIP Perl Module Installation

This is the legacy GeoIP Perl module used by Spamassassin 3.4.1 or older. Maxmind discontinued the GeoLite Legacy databases as of January 2, 2019. We recomend that users upgrade to Spamassassin 3.4.2 which supports the new Maxmind GeoIP2 databases. This module is required by the RelayCountry and URILocalBL plugins.

RHEL / Centos 7:

yum install GeoIP perl-Geo-IP

RHEL / Centos 6:

yum install GeoIP
wget https://www.danami.com/clients/downloads/perl-Geo-IP-1.38-6.el6.x86_64.rpm
rpm -Uvh perl-Geo-IP-1.38-6.el6.x86_64.rpm

Debian / Ubuntu:

apt-get install geoip-database libgeo-ip-perl