1SPAMASSASSIN(1) User Contributed Perl Documentation SPAMASSASSIN(1)
2
6 spamassassin - extensible email filter used to identify spam
7
9 SpamAssassin is an intelligent email filter which uses a diverse range
10 of tests to identify unsolicited bulk email, more commonly known as
11 "spam". These tests are applied to email headers and content to
12 classify email using advanced statistical methods. In addition,
13 SpamAssassin has a modular architecture that allows other technologies
14 to be quickly wielded against spam and is designed for easy integration
15 into virtually any email system.
16
18 For ease of access, the SpamAssassin manual has been split up into
19 several sections. If you're intending to read these straight through
20 for the first time, the suggested order will tend to reduce the number
21 of forward references.
22 Extensive additional documentation for SpamAssassin is available,
24 primarily on the SpamAssassin web site and wiki.
25 You should be able to view SpamAssassin's documentation with your
27 man(1) program or perldoc(1).
28 OVERVIEW
30 spamassassin SpamAssassin overview (this section)
31 CONFIGURATION
33 Mail::SpamAssassin::Conf SpamAssassin configuration files
34 USAGE
36 spamassassin-run "spamassassin" front-end filtering script
37 sa-learn train SpamAssassin's Bayesian classifier
38 spamc client for spamd (faster than spamassassin)
39 spamd spamassassin server (needed by spamc)
40 DEFAULT PLUGINS
42 Mail::SpamAssassin::Plugin::AskDNS
43 Mail::SpamAssassin::Plugin::AutoLearnThreshold
44 Mail::SpamAssassin::Plugin::Bayes
45 Mail::SpamAssassin::Plugin::BodyEval
46 Mail::SpamAssassin::Plugin::Check
47 Mail::SpamAssassin::Plugin::DKIM
48 Mail::SpamAssassin::Plugin::DMARC
49 Mail::SpamAssassin::Plugin::DNSEval
50 Mail::SpamAssassin::Plugin::FreeMail
51 Mail::SpamAssassin::Plugin::HTMLEval
52 Mail::SpamAssassin::Plugin::HTTPSMismatch
53 Mail::SpamAssassin::Plugin::HashBL
54 Mail::SpamAssassin::Plugin::HeaderEval
55 Mail::SpamAssassin::Plugin::ImageInfo
56 Mail::SpamAssassin::Plugin::MIMEEval
57 Mail::SpamAssassin::Plugin::MIMEHeader
58 Mail::SpamAssassin::Plugin::Pyzor
59 Mail::SpamAssassin::Plugin::Razor2
60 Mail::SpamAssassin::Plugin::RelayEval
61 Mail::SpamAssassin::Plugin::ReplaceTags
62 Mail::SpamAssassin::Plugin::SPF
63 Mail::SpamAssassin::Plugin::SpamCop
64 Mail::SpamAssassin::Plugin::URIDNSBL
65 Mail::SpamAssassin::Plugin::URIDetail
66 Mail::SpamAssassin::Plugin::URIEval
67 Mail::SpamAssassin::Plugin::VBounce
68 Mail::SpamAssassin::Plugin::WLBLEval
69 Mail::SpamAssassin::Plugin::WelcomeListSubject
70
72 SpamAssassin web site: https://spamassassin.apache.org/
73 Wiki-based documentation: https://wiki.apache.org/spamassassin/
74
76 A users mailing list exists where other experienced users are often
77 able to help and provide tips and advice. Subscription instructions
78 are located on the SpamAssassin web site.
79
81 The SpamAssassin rule base, text templates, and rule description text
82 are loaded from configuration files.
83 Default configuration data is loaded from the first existing directory
85 in:
86 /var/lib/spamassassin/4.000000
88 /usr/share/spamassassin
89 /usr/share/spamassassin
90 /usr/local/share/spamassassin
91 /usr/share/spamassassin
92 Site-specific configuration data is used to override any values which
94 had already been set. This is loaded from the first existing directory
95 in:
96 /etc/mail/spamassassin
98 /usr/etc/mail/spamassassin
99 /usr/etc/spamassassin
100 /usr/local/etc/spamassassin
101 /usr/pkg/etc/spamassassin
102 /usr/etc/spamassassin
103 /etc/mail/spamassassin
104 /etc/spamassassin
105 From those directories, SpamAssassin will first read files ending in
107 ".pre" in lexical order and then it will read files ending in ".cf" in
108 lexical order (most files begin with two numbers to make the sorting
109 order obvious).
110 In other words, it will read init.pre first, then 10_default_prefs.cf
112 before 50_scores.cf and 20_body_tests.cf before 20_head_tests.cf.
113 Options in later files will override earlier files.
114 Individual user preferences are loaded from the location specified on
116 the "spamassassin", "sa-learn", or "spamd" command line (see respective
117 manual page for details). If the location is not specified,
118 ~/.spamassassin/user_prefs is used if it exists. SpamAssassin will
119 create that file if it does not already exist, using
120 user_prefs.template as a template. That file will be looked for in:
121 /etc/mail/spamassassin
123 /usr/etc/mail/spamassassin
124 /usr/share/spamassassin
125 /etc/spamassassin
126 /etc/mail/spamassassin
127 /usr/local/share/spamassassin
128 /usr/share/spamassassin
129
131 The following two sections detail the default tagging and markup that
132 takes place for messages when running "spamassassin" or "spamc" with
133 "spamd" in the default configuration.
134 Note: before header modification and addition, all headers beginning
136 with "X-Spam-" are removed to prevent spammer mischief and also to
137 avoid potential problems caused by prior invocations of SpamAssassin.
138 TAGGING FOR SPAM MAILS
140 By default, all messages with a calculated score of 5.0 or higher are
141 tagged as spam.
142 If an incoming message is tagged as spam, instead of modifying the
144 original message, SpamAssassin will create a new report message and
145 attach the original message as a message/rfc822 MIME part (ensuring the
146 original message is completely preserved and easier to recover).
147 The new report message inherits the following headers (if they are
149 present) from the original spam message:
150 From: header
152 To: header
153 Cc: header
154 Subject: header
155 Date: header
156 Message-ID: header
157 The above headers can be modified if the relevant "rewrite_header"
159 option is given (see "Mail::SpamAssassin::Conf" for more information).
160 By default these message headers are added to spam:
162 X-Spam-Flag: header
164 Set to "YES".
165 The headers that added are fully configurable via the "add_header"
167 option (see "Mail::SpamAssassin::Conf" for more information).
168 spam mail body text
170 The SpamAssassin report is added to top of the mail message body,
171 if the message is marked as spam.
172 DEFAULT TAGGING FOR ALL MAILS
174 These headers are added to all messages, both spam and ham (non-spam).
175 X-Spam-Checker-Version: header
177 The version and subversion of SpamAssassin and the host where
178 SpamAssassin was run.
179 X-Spam-Level: header
181 A series of "*" characters where each one represents a full score
182 point.
183 X-Spam-Status: header
185 A string, "(Yes|No), score=nn required=nn tests=xxx,xxx
186 autolearn=(ham|spam|no|unavailable|failed)" is set in this header
187 to reflect the filter status. For the first word, "Yes" means spam
188 and "No" means ham (non-spam).
189 The headers that added are fully configurable via the "add_header"
191 option (see "Mail::SpamAssassin::Conf" for more information).
192
194 The spamassassin command is part of the Mail::SpamAssassin Perl module.
195 Install this as a normal Perl module, using "perl -MCPAN -e shell", or
196 by hand.
197 Note that it is not possible to use the "PERL5LIB" environment variable
199 to affect where SpamAssassin finds its perl modules, due to limitations
200 imposed by perl's "taint" security checks.
201 For further details on how to install, please read the "INSTALL" file
203 from the SpamAssassin distribution.
204
206 Mail::SpamAssassin
207 Spam detector and markup engine
208 Mail::SpamAssassin::ArchiveIterator
210 find and process messages one at a time
211 Mail::SpamAssassin::AutoWelcomelist
213 auto-welcomelist handler for SpamAssassin
214 Mail::SpamAssassin::Bayes
216 determine spammishness using a Bayesian classifier
217 Mail::SpamAssassin::BayesStore
219 Bayesian Storage Module
220 Mail::SpamAssassin::BayesStore::SQL
222 SQL Bayesian Storage Module Implementation
223 Mail::SpamAssassin::Conf::LDAP
225 load SpamAssassin scores from LDAP database
226 Mail::SpamAssassin::Conf::Parser
228 parse SpamAssassin configuration
229 Mail::SpamAssassin::Conf::SQL
231 load SpamAssassin scores from SQL database
232 Mail::SpamAssassin::Message
234 decode, render, and hold an RFC-2822 message
235 Mail::SpamAssassin::Message::Metadata
237 extract metadata from a message
238 Mail::SpamAssassin::Message::Node
240 decode, render, and make available MIME message parts
241 Mail::SpamAssassin::PerMsgLearner
243 per-message status (spam or not-spam)
244 Mail::SpamAssassin::PerMsgStatus
246 per-message status (spam or not-spam)
247 Mail::SpamAssassin::PersistentAddrList
249 persistent address list base class
250 Mail::SpamAssassin::Plugin
252 SpamAssassin plugin base class
253 Mail::SpamAssassin::Plugin::RelayCountry
255 add message metadata indicating the country code of each relay
256 Mail::SpamAssassin::Plugin::SPF
258 perform SPF verification tests
259 Mail::SpamAssassin::Plugin::URIDNSBL
261 look up URLs against DNS blocklists
262 Mail::SpamAssassin::SQLBasedAddrList
264 SpamAssassin SQL Based Auto Welcomelist
265
267 See <https://issues.apache.org/SpamAssassin/>
268
270 The SpamAssassin(tm) Project <https://spamassassin.apache.org/>
271
273 SpamAssassin is distributed under the Apache License, Version 2.0, as
274 described in the file "LICENSE" included with the distribution.
275 Copyright (C) 2015 The Apache Software Foundation
277perl v5.38.0 2023-07-22 SPAMASSASSIN(1)