- Info: http://spamassassin.apache.org/
- Docs: http://spamassassin.apache.org/full/4.0.x/doc/
- Latest version: 4.0.1
- Download: http://spamassassin.apache.org/downloads.cgi
SpamAssassin is a mature, widely-deployed open source project that serves as a mail filter to identify Spam. SpamAssassin uses a variety of mechanisms including header and text analysis, Bayesian filtering, DNS blocklists, and collaborative filtering databases. SpamAssassin runs on a server, and filters spam before it reaches your mailbox.
Changelog
- May 26, 2024
- SA upgraded to v. 4.0.1 - Jun 25, 2023
- TheExtractText
notes have been revised and corrected by Gabriel Torres - Dec 27, 2022
- SA upgraded to v. 4.0.0 - Jul 14, 2021
- added DCC setup (next page)
- moved the configuration of Razor, Pyzor and Spamcop to a separate page
Upgrading spamassassin
to version 4.0.x
You have detailed info in a separated page here.
Install
Create the spamd
user and group, prepare config and log dirs:
mkdir -p /etc/mail/spamassassin /home/spamd /var/log/spamassassin groupadd spamd useradd -g spamd -d /home/spamd spamd chown -R spamd:spamd /home/spamd
Finally install spamassassin
via cpan
perl -MCPAN -e shell o conf commit prerequisites_policy ask install Mail::SpamAssassin quit
Installation notes for Slackware users
- REQUIRED module missing: HTML::Parser
- REQUIRED module missing: Net::DNS
- REQUIRED module missing: NetAddr::IP
- REQUIRED module missing: BSD::Resource
- optional module missing: Digest::SHA1
- optional module missing: Mail::SPF
- optional module missing: Razor2
- optional module missing: IO::Socket::INET6
- optional module missing: IO::Socket::SSL
- optional module missing: Mail::DKIM
- optional module missing: LWP::UserAgent
- optional module missing: HTTP::Date
- optional module missing: Encode::Detect
- optional module missing: Geo::IP
- optional module missing: IO::Socket::IP
- optional module missing: Net::Patricia
These modules are missing and must be installed from CPAN. Some of them have dependencies as well...
At the end this is how I have installed everything. Reply yes if dependencies are found, install in this order and force install when needed.
perl -MCPAN -e shell o conf prerequisites_policy ask force notest install Socket6 IO::Socket IO::Socket::INET6 LWP MD5 CPAN::DistnameInfo Mail::DKIM
Installed prerequisites of Net::DNS:
force notest install Test::More MIME::Base64 Digest::MD5 Digest::HMAC_MD5 Net::IP
Continue installing these modules (always from CPAN):
force notest install Net::Ping Net::DNS Time::HiRes Digest::SHA1 Getopt::Long Digest::Nilsimsa URI::Escape HTML::Parser HTTP::Date IO::Zlib Archive::Tar Mail::SPF force notest install Mail::SPF::Query Net::Ident IO::Socket::SSL Mail::DomainKeys Mail::DKIM LWP::UserAgent HTTP::Date Encode::Detect BSD::Resource force notest install Storable DB_File Net::SMTP BerkeleyDB force notest install Geo::IP IO::Socket::IP Net::Patricia force notest install Mail::DMARC::PurePerl DBD::SQLite
Finally, if everything is ok install spamassassin
and Razor
via CPAN
force notest install Mail::SpamAssassin Mail::SpamAssassin::Plugin::Razor2
I had to skip the tests because of many errors... anyway it works.
We have installed the Razor2
perl package that we will see in the next page.
Configuring
You can find the config files into /etc/mail/spamassassin
> cd /etc/mail/spamassassin > ls init.pre local.cf v310.pre v312.pre v320.pre v330.pre v340.pre v341.pre v342.pre v343.pre v400.pre
local.cf
# Add *****SPAM***** to the Subject header of spam e-mails # rewrite_header Subject *****SPAM***** # put here your subnet trusted_networks 10.0.0. # Set the threshold at which a message is considered spam (default: 5.0) required_score 5.0
ExtractText
- Thanks to Gabriel Torres for reviewing and correcting this section
The purpose of the ExtractText
plugin is to, when enabled, convert attachments (including images, byt the use of an OCR)
into plain text in order to SpamAssassin
to apply its rules to this text. So if we receive doc/pdf/images with spammy text in them, SpamAssassin
will now be able to safely mark the email as spam.
In order to do that, we need to have installed some external programs in our server. The configuration lines added to local.cf have to load these programs to scan each message attachment.
Install the required external programs. Debian
users will do;
apt-get install antiword apt-get install docx2txt apt-get install unrtf apt-get install odt2txt apt-get install tesseract-ocr apt-get install poppler-utils
Slackware
users will find all these programs on SlackBuild,
while poppler is already availble in the distro.
Add the following lines to the local.cf file:
ifplugin Mail::SpamAssassin::Plugin::ExtractText extracttext_external pdftotext /usr/bin/pdftotext -nopgbrk -layout -enc UTF-8 {} - extracttext_use pdftotext .pdf application/pdf # http://docx2txt.sourceforge.net extracttext_external docx2txt /usr/bin/docx2txt {} - extracttext_use docx2txt .docx application/docx extracttext_external antiword /usr/bin/antiword -t -w 0 -m UTF-8.txt {} extracttext_use antiword .doc application/(?:vnd\.?)?ms-?word.* extracttext_external unrtf /usr/bin/unrtf --nopict {} extracttext_use unrtf .doc .rtf application/rtf text/rtf extracttext_external odt2txt /usr/bin/odt2txt --encoding=UTF-8 {} extracttext_use odt2txt .odt .ott application/.*?opendocument.*text extracttext_use odt2txt .sdw .stw application/(?:x-)?soffice application/(?:x-)?starwriter extracttext_external tesseract {OMP_THREAD_LIMIT=1} /usr/bin/tesseract -c page_separator= {} - extracttext_use tesseract .jpg .png .bmp .tif .tiff image/(?:jpeg|png|x-ms-bmp|tiff) add_header all ExtractText-Flags _EXTRACTTEXTFLAGS_ #header PDF_NO_TEXT X-ExtractText-Flags =~ /\bNoText\b/ #describe PDF_NO_TEXT PDF without text #score PDF_NO_TEXT 0.2 #header DOC_NO_TEXT X-ExtractText-Flags =~ /\bNoText\b/ #describe DOC_NO_TEXT Document without text #score DOC_NO_TEXT 0.2 #header EXTRACTTEXT exists:X-ExtractText-Flags #describe EXTRACTTEXT Email processed by extracttext plugin #score EXTRACTTEXT 0.001 endif
You can see three rules commented out. You can safely leave them commented out or enable them for debug purposes. The EXTRACTTEXT
rule is just to have proof that the plugin is active. PDF_NO_TEXT
and DOC_NO_TEXT
will be hit in case of an empty document in attach. You will have an header like this when these two rules have been hit:
X-Spam-ExtractText-Flags: NoText
init.pre
# RelayCountry - add metadata for Bayes learning, marking the countries # a message was relayed through # # Note: This requires the IP::Country::Fast Perl module # loadplugin Mail::SpamAssassin::Plugin::RelayCountry # URIDNSBL - look up URLs found in the message against several DNS # blocklists. # loadplugin Mail::SpamAssassin::Plugin::URIDNSBL # SPF - perform SPF verification. # loadplugin Mail::SpamAssassin::Plugin::SPF
v400.pre
Load all new plugin which come with SA v.4
loadplugin Mail::SpamAssassin::Plugin::ExtractText loadplugin Mail::SpamAssassin::Plugin::DecodeShortURLs loadplugin Mail::SpamAssassin::Plugin::DMARC
sa-update
sa-update
updates the rules (it requires gpg 1.4
). Before running spamassassin
for the first time download the rules:
sa-update
Add to your crontab this line to update the rules once a day
# spamassassin update 30 3 * * * /usr/local/bin/sa-update --nogpg -v &
The -v
option will produce an email notification to postmaster.
Testing
Run this debug command. If you get no error you are ready to run the daemon.
sudo -u spamd -H spamassassin -D --lint
Do not quit spamd
with ctrl+C
, because the next test with spamc
will have to connect to it.
Open another terminal and check if the headers are inserted:
echo -e "From: myself@mymailserver.net\nTo:myfriend@domain.net\nSubject: test\n\n" | spamc
Received: from localhost by qmail.mymailserver.net
with SpamAssassin (version 3.3.1);
Tue, 30 Nov 2010 23:18:37 +0100
From: myself@mymailserver.net
To: myfriend@domain.net
Subject: test
X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-04-18) on qmail.mymailserver.net
X-Spam-Flag: YES
X-Spam-Level: *****
X-Spam-Status: Yes, score=5.4 required=5.0 tests=BAYES_99,FREEMAIL_FROM,
MISSING_DATE,MISSING_MID,NO_RECEIVED,NO_RELAYS,TVD_SPACE_RATIO,
T_TO_NO_BRKTS_FREEMAIL autolearn=no version=3.3.1
Running spamassassin
Download the startup script
cd /usr/local/bin wget https://notes.sagredo.eu/files/qmail/spamdctl chmod +x spamdctl
You have to replace the IP of your firewall and check that the path where you daemon has been installed (/usr/local/bin/spamd
or /usr/local/bin/spamd
) matches the one in the run script.
NB: in what follows <external-IP/firewall-IP> is the IP address of your mail server, as seen from the internet.
#!/bin/bash # # Spamd init script # # August, 2th 2003 # Martin Ostlund, nomicon # Modified slightly by Troy Belding for Qmailrocks - February 23, 2004 # # Modified by Roberto Puzzanghera - September 02, 2014 # November 17, 2020: moved log file to /var/log/spamassassin/spamd.log IP=<external-IP/firewall-IP> DAEMON=/usr/local/bin/spamd NAME=spamd SNAME=spamdctl DESC="SpamAssassin Mail Filter Daemon" LOGFILE=/var/log/spamassassin/spamd.log PIDFILE="/var/run/$NAME.pid" PNAME="spamd" DOPTIONS="-x -u spamd -A 127.0.0.1,::1,${IP} -s $LOGFILE -H /home/spamd -d --pidfile=$PIDFILE" KILL="/bin/kill" KILLALL="/bin/killall" # Defaults - don''t touch, edit /etc/mail/spamassassin/local.cf ENABLED=0 OPTIONS="" set -e case "$1" in start) echo -n "Starting $DESC: " $DAEMON $OPTIONS $DOPTIONS echo "$NAME." ;; stop) echo -n "Stopping $DESC: " $KILL -9 `cat $PIDFILE` /bin/rm $PIDFILE echo "$NAME." ;; restart|force-reload) echo -n "Restarting $DESC: " $0 stop $0 start echo "$NAME." ;; *) ME=/usr/local/bin/$SNAME echo "Usage: $ME {start|stop|restart|force-reload}" >&2 exit 1 ;; esac exit 0
Now check that spamd
is running:
> spamdctl start > ps axfu root 1859 0.1 3.4 139360 61044 ? Ss 19:00 0:01 /usr/bin/spamd -x -u spamd -A 127.0.0.1,<external-IP> -H /home/spamd -d --pidfile=/var/run/spamd.pid spamd 1860 0.0 3.2 139360 58984 ? S 19:00 0:00 \_ spamd child spamd 1861 0.0 3.2 139360 58984 ? S 19:00 0:00 \_ spamd child
Type spamd -c
to learn how to use spamd
. See also http://spamassassin.apache.org/full/3.4.x/doc/spamd.html
Starting spamassassin at boot time
To start spamassassin
at boot time put your startup script in your rc.local
:
/usr/local/bin/spamdctl start &
logrotate
Create a file /etc/logrotate.d/spamd
like this (slackware) to rotate daily your spamd
logs:
cat > /etc/logrotate.d/spamd << __EOF__ /var/log/spamassassin/spamd.log /var/log/spamassassin/razor-agent.log { su root apache rotate 5 daily missingok notifempty delaycompress postrotate [ -f '/var/run/spamd.pid' ] && (kill -HUP `cat /var/run/spamd.pid`) || exit 0 endscript } __EOF__
Be aware that we have already setup the logrotate for the log file or Razor
, which we'll see in the next page.
Comments
Reset Spamassassin Score
Kenny Lee September 9, 2024 05:14 CET
Hi Roberto, any way to reset the score of spamassassin and it's AWL score?
Reply | Permalink
Reset Spamassassin Score
Roberto Puzzanghera Kenny Lee September 9, 2024 17:35 CET
Hi Kenny,
are you sure that you mean AWL and not txrep/bayesan? AWL has been replaced by txrep a couple of years ago.
Do you want to purge or completely empty the table? In the first case, just run a query like this (better as a cronjob)
change the number of days. Also purge the userprefs table.
In the second case you can truncate all the tables in the spamassassin database.
Reply | Permalink
Spamassasin at MX level ?
Pablo Murillo December 14, 2023 21:57 CET
Hi
I have SA running on virtual host and I enabled or disabled the SA for any domain from vpopmail.limits table, this works perfect
Now, I'm looking for a way to run SA at MX level, whitout users-prefs, without learning, but I can't find the way to make it work :D
I don't have vpopmail on my mxs, only qmail and spamdyke
How can I make SA works without vpopmail DB (mysql) ?
Can I enable SA from tcp.smtp ?
Thanks
Reply | Permalink
Spamassasin at MX level ?
Roberto Puzzanghera Pablo Murillo December 14, 2023 22:07 CET
Do you mean running SA before qmail-queue? I don't know...
Reply | Permalink
Spamassasin at MX level ?
Pablo Murillo Roberto Puzzanghera December 14, 2023 22:34 CET
Hi Roberto
Sorry !, after I post the question I remember that I'm using SIMSCAN !!!
I recompile simscan with SA support and now it's working :D
Reply | Permalink
Mail::SpamAssassin::Plugin::Hashcash
Mike November 22, 2023 10:32 CET
Hello Roberto,
from ver 4.0 hashcash was REMOVED from SpamAssassin.
pls update.
Txh
Reply | Permalink
Mail::SpamAssassin::Plugin::Hashcash
Roberto Puzzanghera Mike November 22, 2023 14:51 CET
Thank you. Corrected
Reply | Permalink
Details on how to correctly configure the ExtractText plugin
Gabriel Torres June 22, 2023 23:13 CET
Hi Roberto,
The purpose of the ExtractText plugin is to, when enabled, convert attachments (including imagens, byt the use of an OCR) into plain text in order to SpamAssassin to apply its rules to this text. So if we receive doc/pdf/images with spammy text in them, SpamAssassin will now be able to safely mark the email as spam.
In order to do that, we need to have installed some external programs in our server. The configuration lines added to local.cf have to load these programs to scan each message attachment. Also, the rules provided in the example at the SpamAssassin Apache page are just examples. Here are the correct instructions to make the ExtractText plugin to work. I hope you can test them yourself and update this page (and also the "migrating to SpamAssassin 4.0.0" page.
1. Install the required external programs
Here we run Debian, so we need:
2. Add the following lines to the local.cf file. NOTE: your tutorial is missing the required extracttext_external lines:
3. Instructions on how to configure the plugin
The official website suggests the configuration lines above. But this is just an example and there is a small adjustment to be made.
a. Here with me, the string added to X-ExtractText-Flags was only 'NoText' when the attached word/pdf file didn't have any text. So the first two rules wouldn't be triggered. For this reason, I replaced the PDF_NO_TEXT and DOC_NO_TEXT with:
b. Note how I adjusted the score from 0.001 to 0.2. With a score of 0.001, the original rule won't do anything. But, it is up to you to assign a score for emails containing doc/pdf files with no text. I ajusted the rule to a score of 0.2.
Personal note: honestly, both rules PDF_NO_TEXT and DOC_NO_TEXT could be safely removed. They are present in the documentation only so you know they are available.
The final rule, EXTRACTTEXT should be left alone. This rule only exists so we have EXTRACTTEXT in the email header in the list of all rules that the message triggered, so we know that attachments were present in the email and they were converted/scanned by the plugin. It is a great debugging tool.
Cheers,
Gabriel.
Reply | Permalink
Details on how to correctly configure the ExtractText plugin
Roberto Puzzanghera Gabriel Torres June 23, 2023 07:44 CET
Thanks a lot Gabriel. I'll read and test carefully and I'll use it to improve this page
Reply | Permalink
X-Spam-ExtractText-Flags: _EXTRACTTEXTFLAGS_
Gabriel Torres June 20, 2023 23:24 CET
Hi Roberto,
After finally making the move to SA 4.0.0, I noticed that a new header was included, but its value is weird, IMHO:
Isn't this _EXTRACTTEXTFLAGS_ a variable that should be replaced with something else?
Also:
Shouldn't this be:
Please advise!
Cheers!
Reply | Permalink
X-Spam-ExtractText-Flags: _EXTRACTTEXTFLAGS_
Roberto Puzzanghera Gabriel Torres June 21, 2023 09:28 CET
I did a test changing like this with no luck
Reply | Permalink
X-Spam-ExtractText-Flags: _EXTRACTTEXTFLAGS_
Roberto Puzzanghera Gabriel Torres June 21, 2023 08:59 CET
Hi Gabriel,
Actually I would expect it to fill that _EXTRACTTEXTFLAGS_ tag with the notes of the plugin, something like
but I have it as is.
Concerning the other question, I copied the example from the man page here
I hope that someone else can be more specific than me...
Reply | Permalink
X-Spam-ExtractText-Flags: _EXTRACTTEXTFLAGS_
Gabriel Torres Roberto Puzzanghera June 21, 2023 11:54 CET
I'll investigate this further and let you know. Thanks.
Reply | Permalink
Update to spamdctl script
Gabriel Torres August 24, 2021 23:04 CET
Hi Roberto,
After upgrading our OS here to the latest version, spamd stopped working. Upon further inspection, I found this in the log file:
This meant that spamd was listening on 127.0.0.1 but not at ::1 (IPv6 version of 127.0.0.1). Therefore, I replaced IP= with:
and the problem was gone.
Just a small note for you to upgrade the script to support both 127.0.0.1 and ::1.
Cheers.
Reply | Permalink
Update to spamdctl script
Roberto Puzzanghera Gabriel Torres August 25, 2021 09:57 CET
Thank you.
Probably you have to adjust for ipv6 dovecot as well...
Reply | Permalink
GEOIP Perl Module
kittonian June 16, 2020 19:47 CET
For anyone still having issues with GEOIP or GEOIP2, I had to manually patch the file with the help of some freenode people.
Here's the link to the patch: https://github.com/neilgierman/awstats/compare/GeoIP2...Grinnz:patch-1
Reply | Permalink
Create .spamassassin/ dir
Gabriel Torres July 13, 2019 15:03 CET
Here I had to manually create /etc/mail/spamassassin/.spamassassin/ and chown spamd:spamd otherwise I would see error messages in the log files saying that the tx-reputation file couldn't be created.
Reply | Permalink
SA scans only from external emails how to scan local emails?
munku January 12, 2018 01:49 CET
Hi,
Spamassassin is installed correctly and is working fine for years and still is. While spamassassin scans incoming email from external sources, it does not scan emails that is being send locally, (from local to local or local to external domains). Is there a way to make it scan local emails as well? I tried modifying tcp rules to include simscan for local IP addresses but it still does not work.
thanks
Reply | Permalink
How to get SA scan local emails?
Roberto Puzzanghera munku January 12, 2018 18:04 CET
Try to recompile simscan adding
to your configure. This should "turn on spam scanning for authenticated users (default no)."
Reply | Permalink
got error
kwa January 7, 2018 14:40 CET
installed everithing, but got this error (slackware current)
anybody knows where to grab..
Reply | Permalink
got error
Roberto Puzzanghera kwa January 7, 2018 19:03 CET
Let me understand... you upgraded perl and then your installed modules stopped to work?
Reply | Permalink
SSL and AUTH
Nicolas November 3, 2016 09:03 CET
Hello,
Being a long time qmail user I recently wanted to switch to full SSL. Unfortunately I cannot succeed having both SSL and AUTH working at same time.
When using stunnel, it just creates an openrelay : any login/pass is considered as OK (all vars are the same as for normal smtp)
and stunnel_smtpd.conf
When using sslserver, I've no openrelay, but I don't get AUTH on prompt (I've well exported the SMTPAUTH var)
Has anybody succeeded having SSL and AUTH at same time ?
Reply | Permalink
I think I did manage to have
mizzio Nicolas November 11, 2016 11:59 CET
I think I did manage to have SSL on 465 with AUTH. I had to play with the run file of the specific service (on my system, /var/qmail/service/smtpd-465/run). Can you post yours ?
Reply | Permalink
I don't use SSL 465
roberto puzzanghera mizzio November 11, 2016 14:23 CET
I don't use SSL 465
Reply | Permalink
spamdctl DOPTIONS for IPv6
John D Trolinger July 14, 2016 00:12 CET
Spamassassin 3.4.1 was not working. I was getting spamd.log hits
and spamd was not working at all.
I added ::1 in the spamdctl file like so:
Reply | Permalink
I think you have to check
roberto puzzanghera John D Trolinger July 14, 2016 09:26 CET
I think you have to check that spamd is listening on IPv6 as well and eventually add a "-i [::1]:783" option to your spamdctl. Look here for details http://spamassassin.apache.org/full/3.4.x/doc/spamd.html
Reply | Permalink
IPv6
John roberto puzzanghera July 14, 2016 23:06 CET
Roberto,
We have a new email server for 300 people thanks to your guide. Being able to use Roundcube with PGP was the key piece. I had to keep the old qmail / sqmail with the PGP plugin up until today.
IPv6 is working great and spamassassin is doing the job.
I sent you a couple of coffee's and we thank you for keeping the awesome qmail alive.
John D. Trolinger
Reply | Permalink
spamassassin error
rudi durieux February 23, 2016 10:41 CET
Hi,
I have this error on load :
Thanks
Reply | Permalink
spamassassin error
Ivelin Topalov rudi durieux February 8, 2018 15:25 CET
the problem is missing geoip-perl-api - solve like this:
Reply | Permalink
spamassassin error
Roberto Puzzanghera Ivelin Topalov February 8, 2018 16:19 CET
GEO:IP is already mentioned above among the packages that must be installed via CPAN...
Reply | Permalink
I would try to see which
roberto puzzanghera rudi durieux February 23, 2016 13:51 CET
I would try to see which module is missing looking inside that file/line
Reply | Permalink
did you installed GEO:IP?
roberto puzzanghera rudi durieux February 23, 2016 12:01 CET
did you installed GEO:IP?
Reply | Permalink
I have this in cpan
rudi durieux roberto puzzanghera February 23, 2016 12:14 CET
I have this in cpan
install Geo::IP
Geo::IP is up to date (1.45).
Reply | Permalink
Geo::IP
John D Trolinger rudi durieux July 14, 2016 00:27 CET
I had to disable loadplugin Mail::SpamAssassin::Plugin::URILocalBL in v341.pre to get rid of this error in the spamd.log
error: Can't locate loadable object for module Geo::IP in @INC
Reply | Permalink
Geo::IP
J John D Trolinger February 2, 2023 00:48 CET
I had the same issue. It was resolved by installing GeoIP2 and uninstall IP::GeoIP. Spamd may complain about missing Class::XSAccessor, after installing it there was no more error.
Reply | Permalink
Change DB Spamassassin
Arturo May 10, 2015 13:10 CET
For update Spamassassin 3.4.1 is necesary update the db (in my case):
Regards
Reply | Permalink
Disable Spamassassin
Fabiano Heringer April 29, 2014 14:55 CET
How can I disable the use of spamassassin? Just uninstalling it?
Thanks!
Reply | Permalink
no, just edit
roberto puzzanghera Fabiano Heringer April 29, 2014 14:59 CET
no, just edit /var/qmail/control/simcontrol and put spam=no. update the simcontrol after that:
Reply | Permalink
Many thanks
3rensho June 27, 2011 09:07 CET
Wow, just found this post yesterday when I wanted to install Spamassassin on my Slackware64-current box. I can't thank you enough for this superb post. Grazie mille!
Reply | Permalink
Geo::IP plug not working
catalin 3rensho March 30, 2014 23:20 CET
Thank you for a great tutorial.
I was wondering did you manage to make the new Geo::IP plug in working. I have installed from cpan and updated (geoiplookup works) but spamassassin doesn't seems to take that in consideration when I block a country. I have enable it from init.pre. Any ideea what can be?
Thanks
Reply | Permalink
I don't use that plugin
roberto puzzanghera catalin March 31, 2014 13:44 CET
Sorry, I don't use that plugin
Reply | Permalink