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 clas‐
12 sify email using advanced statistical methods. In addition, SpamAssas‐
13 sin has a modular architecture that allows other technologies to be
14 quickly wielded against spam and is designed for easy integration into
15 virtually any email system.
16
18 For ease of access, the SpamAssassin manual has been split up into sev‐
19 eral sections. If you're intending to read these straight through for
20 the first time, the suggested order will tend to reduce the number of
21 forward references.
22 Extensive additional documentation for SpamAssassin is available, pri‐
24 marily 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)
32 CONFIGURATION
34 Mail::SpamAssassin::Conf SpamAssassin configuration files
36 USAGE
38 spamassassin-run "spamassassin" front-end filtering script
40 sa-learn train SpamAssassin's Bayesian classifier
41 spamc client for spamd (faster than spamassassin)
42 spamd spamassassin server (needed by spamc)
43 DEFAULT PLUGINS
45 Mail::SpamAssassin::Plugin::Hashcash
47 Mail::SpamAssassin::Plugin::SPF
48 Mail::SpamAssassin::Plugin::URIDNSBL
49
51 SpamAssassin web site: http://spamassassin.apache.org/
52 Wiki-based documentation: http://wiki.apache.org/spamassassin/
53
55 A users mailing list exists where other experienced users are often
56 able to help and provide tips and advice. Subscription instructions
57 are located on the SpamAssassin web site.
58
60 The SpamAssassin rule base, text templates, and rule description text
61 are loaded from configuration files.
62 Default configuration data is loaded from the first existing directory
64 in:
65 /var/lib/spamassassin/3.002004
67 /usr/share/spamassassin
68 /usr/share/spamassassin
69 /usr/local/share/spamassassin
70 /usr/share/spamassassin
71 Site-specific configuration data is used to override any values which
73 had already been set. This is loaded from the first existing directory
74 in:
75 /etc/mail/spamassassin
77 /usr/etc/mail/spamassassin
78 /usr/etc/spamassassin
79 /usr/local/etc/spamassassin
80 /usr/pkg/etc/spamassassin
81 /usr/etc/spamassassin
82 /etc/mail/spamassassin
83 /etc/spamassassin
84 From those three directories, SpamAssassin will first read files ending
86 in ".pre" in lexical order and then it will read files ending in ".cf"
87 in lexical order (most files begin with two numbers to make the sorting
88 order obvious).
89 In other words, it will read init.pre first, then 10_default_prefs.cf
91 before 50_scores.cf and 20_body_tests.cf before 20_head_tests.cf.
92 Options in later files will override earlier files.
93 Individual user preferences are loaded from the location specified on
95 the "spamassassin", "sa-learn", or "spamd" command line (see respective
96 manual page for details). If the location is not specified, ~/.spamas‐
97 sassin/user_prefs is used if it exists. SpamAssassin will create that
98 file if it does not already exist, using user_prefs.template as a tem‐
99 plate. That file will be looked for in:
100 /etc/mail/spamassassin
102 /usr/etc/mail/spamassassin
103 /usr/share/spamassassin
104 /etc/spamassassin
105 /etc/mail/spamassassin
106 /usr/local/share/spamassassin
107 /usr/share/spamassassin
108
110 The following two sections detail the default tagging and markup that
111 takes place for messages when running "spamassassin" or "spamc" with
112 "spamd" in the default configuration.
113 Note: before header modification and addition, all headers beginning
115 with "X-Spam-" are removed to prevent spammer mischief and also to
116 avoid potential problems caused by prior invocations of SpamAssassin.
117 TAGGING FOR SPAM MAILS
119 By default, all messages with a calculated score of 5.0 or higher are
121 tagged as spam.
122 If an incoming message is tagged as spam, instead of modifying the
124 original message, SpamAssassin will create a new report message and
125 attach the original message as a message/rfc822 MIME part (ensuring the
126 original message is completely preserved and easier to recover).
127 The new report message inherits the following headers (if they are
129 present) from the original spam message:
130 From: header
132 To: header
133 Cc: header
134 Subject: header
135 Date: header
136 Message-ID: header
137 The above headers can be modified if the relevant "rewrite_header"
139 option is given (see "Mail::SpamAssassin::Conf" for more information).
140 By default these message headers are added to spam:
142 X-Spam-Flag: header
144 Set to "YES".
145 The headers that added are fully configurable via the "add_header"
147 option (see "Mail::SpamAssassin::Conf" for more information).
148 spam mail body text
150 The SpamAssassin report is added to top of the mail message body,
151 if the message is marked as spam.
152 DEFAULT TAGGING FOR ALL MAILS
154 These headers are added to all messages, both spam and ham (non-spam).
156 X-Spam-Checker-Version: header
158 The version and subversion of SpamAssassin and the host where Spa‐
159 mAssassin was run.
160 X-Spam-Level: header
162 A series of "*" charactes where each one represents a full score
163 point.
164 X-Spam-Status: header
166 A string, "(Yes⎪No), score=nn required=nn tests=xxx,xxx
167 autolearn=(ham⎪spam⎪no⎪unavailable⎪failed)" is set in this header
168 to reflect the filter status. For the first word, "Yes" means spam
169 and "No" means ham (non-spam).
170 The headers that added are fully configurable via the "add_header"
172 option (see "Mail::SpamAssassin::Conf" for more information).
173
175 The spamassassin command is part of the Mail::SpamAssassin Perl module.
176 Install this as a normal Perl module, using "perl -MCPAN -e shell", or
177 by hand.
178 Note that it is not possible to use the "PERL5LIB" environment variable
180 to affect where SpamAssassin finds its perl modules, due to limitations
181 imposed by perl's "taint" security checks.
182 For further details on how to install, please read the "INSTALL" file
184 from the SpamAssassin distribution.
185
187 Mail::SpamAssassin
188 Spam detector and markup engine
189 Mail::SpamAssassin::ArchiveIterator
191 find and process messages one at a time
192 Mail::SpamAssassin::AutoWhitelist
194 auto-whitelist handler for SpamAssassin
195 Mail::SpamAssassin::Bayes
197 determine spammishness using a Bayesian classifier
198 Mail::SpamAssassin::BayesStore
200 Bayesian Storage Module
201 Mail::SpamAssassin::BayesStore::SQL
203 SQL Bayesian Storage Module Implementation
204 Mail::SpamAssassin::Conf::LDAP
206 load SpamAssassin scores from LDAP database
207 Mail::SpamAssassin::Conf::Parser
209 parse SpamAssassin configuration
210 Mail::SpamAssassin::Conf::SQL
212 load SpamAssassin scores from SQL database
213 Mail::SpamAssassin::Message
215 decode, render, and hold an RFC-2822 message
216 Mail::SpamAssassin::Message::Metadata
218 extract metadata from a message
219 Mail::SpamAssassin::Message::Node
221 decode, render, and make available MIME message parts
222 Mail::SpamAssassin::PerMsgLearner
224 per-message status (spam or not-spam)
225 Mail::SpamAssassin::PerMsgStatus
227 per-message status (spam or not-spam)
228 Mail::SpamAssassin::PersistentAddrList
230 persistent address list base class
231 Mail::SpamAssassin::Plugin
233 SpamAssassin plugin base class
234 Mail::SpamAssassin::Plugin::Hashcash
236 perform hashcash verification tests
237 Mail::SpamAssassin::Plugin::RelayCountry
239 add message metadata indicating the country code of each relay
240 Mail::SpamAssassin::Plugin::SPF
242 perform SPF verification tests
243 Mail::SpamAssassin::Plugin::URIDNSBL
245 look up URLs against DNS blocklists
246 Mail::SpamAssassin::SQLBasedAddrList
248 SpamAssassin SQL Based Auto Whitelist
249
251 See <http://issues.apache.org/SpamAssassin/>
252
254 The SpamAssassin(tm) Project <http://spamassassin.apache.org/>
255
257 SpamAssassin is distributed under the Apache License, Version 2.0, as
258 described in the file "LICENSE" included with the distribution.
259perl v5.8.8 2008-01-29 SPAMASSASSIN(1)