1SPAMASSASSIN(1)       User Contributed Perl Documentation      SPAMASSASSIN(1)
2
3
4

NAME

6       spamassassin - extensible email filter used to identify spam
7

DESCRIPTION

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

SYNOPSIS

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
23       Extensive additional documentation for SpamAssassin is available,
24       primarily on the SpamAssassin web site and wiki.
25
26       You should be able to view SpamAssassin's documentation with your
27       man(1) program or perldoc(1).
28
29   OVERVIEW
30           spamassassin              SpamAssassin overview (this section)
31
32   CONFIGURATION
33           Mail::SpamAssassin::Conf  SpamAssassin configuration files
34
35   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
41   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::DNSEval
49           Mail::SpamAssassin::Plugin::FreeMail
50           Mail::SpamAssassin::Plugin::HTMLEval
51           Mail::SpamAssassin::Plugin::HTTPSMismatch
52           Mail::SpamAssassin::Plugin::HeaderEval
53           Mail::SpamAssassin::Plugin::ImageInfo
54           Mail::SpamAssassin::Plugin::MIMEEval
55           Mail::SpamAssassin::Plugin::MIMEHeader
56           Mail::SpamAssassin::Plugin::Pyzor
57           Mail::SpamAssassin::Plugin::Razor2
58           Mail::SpamAssassin::Plugin::RelayEval
59           Mail::SpamAssassin::Plugin::ReplaceTags
60           Mail::SpamAssassin::Plugin::SPF
61           Mail::SpamAssassin::Plugin::SpamCop
62           Mail::SpamAssassin::Plugin::URIDNSBL
63           Mail::SpamAssassin::Plugin::URIDetail
64           Mail::SpamAssassin::Plugin::URIEval
65           Mail::SpamAssassin::Plugin::VBounce
66           Mail::SpamAssassin::Plugin::WLBLEval
67           Mail::SpamAssassin::Plugin::WhiteListSubject
68

WEB SITES

70           SpamAssassin web site:     http://spamassassin.apache.org/
71           Wiki-based documentation:  http://wiki.apache.org/spamassassin/
72

USER MAILING LIST

74       A users mailing list exists where other experienced users are often
75       able to help and provide tips and advice.  Subscription instructions
76       are located on the SpamAssassin web site.
77

CONFIGURATION FILES

79       The SpamAssassin rule base, text templates, and rule description text
80       are loaded from configuration files.
81
82       Default configuration data is loaded from the first existing directory
83       in:
84
85       /var/lib/spamassassin/3.004006
86       /usr/share/spamassassin
87       /usr/share/spamassassin
88       /usr/local/share/spamassassin
89       /usr/share/spamassassin
90
91       Site-specific configuration data is used to override any values which
92       had already been set.  This is loaded from the first existing directory
93       in:
94
95       /etc/mail/spamassassin
96       /usr/etc/mail/spamassassin
97       /usr/etc/spamassassin
98       /usr/local/etc/spamassassin
99       /usr/pkg/etc/spamassassin
100       /usr/etc/spamassassin
101       /etc/mail/spamassassin
102       /etc/spamassassin
103
104       From those directories, SpamAssassin will first read files ending in
105       ".pre" in lexical order and then it will read files ending in ".cf" in
106       lexical order (most files begin with two numbers to make the sorting
107       order obvious).
108
109       In other words, it will read init.pre first, then 10_default_prefs.cf
110       before 50_scores.cf and 20_body_tests.cf before 20_head_tests.cf.
111       Options in later files will override earlier files.
112
113       Individual user preferences are loaded from the location specified on
114       the "spamassassin", "sa-learn", or "spamd" command line (see respective
115       manual page for details).  If the location is not specified,
116       ~/.spamassassin/user_prefs is used if it exists.  SpamAssassin will
117       create that file if it does not already exist, using
118       user_prefs.template as a template.  That file will be looked for in:
119
120       /etc/mail/spamassassin
121       /usr/etc/mail/spamassassin
122       /usr/share/spamassassin
123       /etc/spamassassin
124       /etc/mail/spamassassin
125       /usr/local/share/spamassassin
126       /usr/share/spamassassin
127

TAGGING

129       The following two sections detail the default tagging and markup that
130       takes place for messages when running "spamassassin" or "spamc" with
131       "spamd" in the default configuration.
132
133       Note: before header modification and addition, all headers beginning
134       with "X-Spam-" are removed to prevent spammer mischief and also to
135       avoid potential problems caused by prior invocations of SpamAssassin.
136
137   TAGGING FOR SPAM MAILS
138       By default, all messages with a calculated score of 5.0 or higher are
139       tagged as spam.
140
141       If an incoming message is tagged as spam, instead of modifying the
142       original message, SpamAssassin will create a new report message and
143       attach the original message as a message/rfc822 MIME part (ensuring the
144       original message is completely preserved and easier to recover).
145
146       The new report message inherits the following headers (if they are
147       present) from the original spam message:
148
149       From: header
150       To: header
151       Cc: header
152       Subject: header
153       Date: header
154       Message-ID: header
155
156       The above headers can be modified if the relevant "rewrite_header"
157       option is given (see "Mail::SpamAssassin::Conf" for more information).
158
159       By default these message headers are added to spam:
160
161       X-Spam-Flag: header
162           Set to "YES".
163
164       The headers that added are fully configurable via the "add_header"
165       option (see "Mail::SpamAssassin::Conf" for more information).
166
167       spam mail body text
168           The SpamAssassin report is added to top of the mail message body,
169           if the message is marked as spam.
170
171   DEFAULT TAGGING FOR ALL MAILS
172       These headers are added to all messages, both spam and ham (non-spam).
173
174       X-Spam-Checker-Version: header
175           The version and subversion of SpamAssassin and the host where
176           SpamAssassin was run.
177
178       X-Spam-Level: header
179           A series of "*" characters where each one represents a full score
180           point.
181
182       X-Spam-Status: header
183           A string, "(Yes|No), score=nn required=nn tests=xxx,xxx
184           autolearn=(ham|spam|no|unavailable|failed)" is set in this header
185           to reflect the filter status.  For the first word, "Yes" means spam
186           and "No" means ham (non-spam).
187
188       The headers that added are fully configurable via the "add_header"
189       option (see "Mail::SpamAssassin::Conf" for more information).
190

INSTALLATION

192       The spamassassin command is part of the Mail::SpamAssassin Perl module.
193       Install this as a normal Perl module, using "perl -MCPAN -e shell", or
194       by hand.
195
196       Note that it is not possible to use the "PERL5LIB" environment variable
197       to affect where SpamAssassin finds its perl modules, due to limitations
198       imposed by perl's "taint" security checks.
199
200       For further details on how to install, please read the "INSTALL" file
201       from the SpamAssassin distribution.
202

DEVELOPER DOCUMENTATION

204           Mail::SpamAssassin
205               Spam detector and markup engine
206
207           Mail::SpamAssassin::ArchiveIterator
208               find and process messages one at a time
209
210           Mail::SpamAssassin::AutoWhitelist
211               auto-whitelist handler for SpamAssassin
212
213           Mail::SpamAssassin::Bayes
214               determine spammishness using a Bayesian classifier
215
216           Mail::SpamAssassin::BayesStore
217               Bayesian Storage Module
218
219           Mail::SpamAssassin::BayesStore::SQL
220               SQL Bayesian Storage Module Implementation
221
222           Mail::SpamAssassin::Conf::LDAP
223               load SpamAssassin scores from LDAP database
224
225           Mail::SpamAssassin::Conf::Parser
226               parse SpamAssassin configuration
227
228           Mail::SpamAssassin::Conf::SQL
229               load SpamAssassin scores from SQL database
230
231           Mail::SpamAssassin::Message
232               decode, render, and hold an RFC-2822 message
233
234           Mail::SpamAssassin::Message::Metadata
235               extract metadata from a message
236
237           Mail::SpamAssassin::Message::Node
238               decode, render, and make available MIME message parts
239
240           Mail::SpamAssassin::PerMsgLearner
241               per-message status (spam or not-spam)
242
243           Mail::SpamAssassin::PerMsgStatus
244               per-message status (spam or not-spam)
245
246           Mail::SpamAssassin::PersistentAddrList
247               persistent address list base class
248
249           Mail::SpamAssassin::Plugin
250               SpamAssassin plugin base class
251
252           Mail::SpamAssassin::Plugin::Hashcash
253               perform hashcash verification tests
254
255           Mail::SpamAssassin::Plugin::RelayCountry
256               add message metadata indicating the country code of each relay
257
258           Mail::SpamAssassin::Plugin::SPF
259               perform SPF verification tests
260
261           Mail::SpamAssassin::Plugin::URIDNSBL
262               look up URLs against DNS blocklists
263
264           Mail::SpamAssassin::SQLBasedAddrList
265               SpamAssassin SQL Based Auto Whitelist
266

BUGS

268       See <http://issues.apache.org/SpamAssassin/>
269

AUTHORS

271       The SpamAssassin(tm) Project <http://spamassassin.apache.org/>
272
274       SpamAssassin is distributed under the Apache License, Version 2.0, as
275       described in the file "LICENSE" included with the distribution.
276
277       Copyright (C) 2015 The Apache Software Foundation
278
279
280
281perl v5.32.1                      2021-04-14                   SPAMASSASSIN(1)
Impressum