1SPAMASSASSIN-RUN(1) User Contributed Perl Documentation SPAMASSASSIN-RUN(1)
2
6 spamassassin - simple front-end filtering script for SpamAssassin
7
9 spamassassin [options] [ < mailmessage | path ... ]
10 spamassassin -d [ < mailmessage | path ... ]
12 spamassassin -r [ < mailmessage | path ... ]
14 spamassassin -k [ < mailmessage | path ... ]
16 spamassassin -W|-R [ < mailmessage | path ... ]
18 Options:
20 -L, --local Local tests only (no online tests)
22 -r, --report Report message as spam
23 -k, --revoke Revoke message as spam
24 -d, --remove-markup Remove spam reports from a message
25 -C path, --configpath=path, --config-file=path
26 Path to standard configuration dir
27 -p prefs, --prefspath=file, --prefs-file=file
28 Set user preferences file
29 --siteconfigpath=path Path for site configs
30 (def: /etc/mail/spamassassin)
31 --cf='config line' Additional line of configuration
32 -x, --nocreate-prefs Don't create user preferences file
33 -e, --exit-code Exit with a non-zero exit code if the
34 tested message was spam
35 --mbox read in messages in mbox format
36 --mbx read in messages in UW mbx format
37 -t, --test-mode Pipe message through and add extra
38 report to the bottom
39 --lint Lint the rule set: report syntax errors
40 -W, --add-to-whitelist Add addresses in mail to persistent address whitelist
41 --add-to-blacklist Add addresses in mail to persistent address blacklist
42 -R, --remove-from-whitelist Remove all addresses found in mail from
43 persistent address list
44 --add-addr-to-whitelist=addr Add addr to persistent address whitelist
45 --add-addr-to-blacklist=addr Add addr to persistent address blacklist
46 --remove-addr-from-whitelist=addr Remove addr from persistent address list
47 -4 --ipv4only, --ipv4-only, --ipv4 Use IPv4, disable use of IPv6 for DNS etc.
48 -6 Use IPv6, disable use of IPv4 where possible
49 --progress Print progress bar
50 -D, --debug [area=n,...] Print debugging messages
51 -V, --version Print version
52 -h, --help Print usage message
53
55 spamassassin is a simple front-end filter for SpamAssassin.
56 Using the SpamAssassin rule base, it uses a wide range of heuristic
58 tests on mail headers and body text to identify "spam", also known as
59 unsolicited bulk email. Once identified, the mail is then tagged as
60 spam for later filtering using the user's own mail user-agent
61 application.
62 The default tagging operations that take place are detailed in
64 "TAGGING" in spamassassin.
65 By default, message(s) are read in from STDIN (< mailmessage), or from
67 specified files and directories (path ...) STDIN and files are assumed
68 to be in file format, with a single message per file. Directories are
69 assumed to be in a format where each file in the directory contains
70 only one message (directories are not recursed and filenames containing
71 whitespace or beginning with "." or "," are skipped). The options
72 --mbox and --mbx can override the assumed format, see the appropriate
73 OPTION information below.
74 Please note that SpamAssassin is not designed to scan large messages.
76 Don't feed messages larger than about 500 KB to SpamAssassin, as this
77 will consume a huge amount of memory.
78
80 -e, --error-code, --exit-code
81 Exit with a non-zero error code, if the message is determined to be
82 spam.
83 -h, --help
85 Print help message and exit.
86 -V, --version
88 Print version and exit.
89 -t, --test-mode
91 Test mode. Pipe message through and add extra report. Note that
92 the report text assumes that the message is spam, since in normal
93 use it is only visible in this case. Pay attention to the score
94 instead.
95 If you run this with -d, the message will first have SpamAssassin
97 markup removed before being tested.
98 -r, --report
100 Report this message as manually-verified spam. This will submit
101 the mail message read from STDIN to various spam-blocker databases.
102 Currently, these are the Distributed Checksum Clearinghouse
103 "http://www.dcc-servers.net/dcc/", Pyzor
104 "http://pyzor.sourceforge.net/", Vipul's Razor
105 "http://razor.sourceforge.net/", and SpamCop
106 "http://www.spamcop.net/".
107 If the message contains SpamAssassin markup, the markup will be
109 stripped out automatically before submission. The support modules
110 for DCC, Pyzor, and Razor must be installed for spam to be reported
111 to each service. SpamCop reports will have greater effect if you
112 register and set the "spamcop_to_address" option.
113 The message will also be submitted to SpamAssassin's learning
115 systems; currently this is the internal Bayesian statistical-
116 filtering system (the BAYES rules). (Note that if you only want to
117 perform statistical learning, and do not want to report mail to
118 third-parties, you should use the "sa-learn" command directly
119 instead.)
120 -k, --revoke
122 Revoke this message. This will revoke the mail message read from
123 STDIN from various spam-blocker databases. Currently, these are
124 Vipul's Razor.
125 Revocation support for the Distributed Checksum Clearinghouse,
127 Pyzor, and SpamCop is not currently available.
128 If the message contains SpamAssassin markup, the markup will be
130 stripped out automatically before submission. The support modules
131 for Razor must be installed for spam to be revoked from the
132 service.
133 The message will also be submitted as 'ham' (non-spam) to
135 SpamAssassin's learning systems; currently this is the internal
136 Bayesian statistical-filtering system (the BAYES rules). (Note
137 that if you only want to perform statistical learning, and do not
138 want to report mail to third-parties, you should use the "sa-learn"
139 command directly instead.)
140 --lint
142 Syntax check (lint) the rule set and configuration files, reporting
143 typos and rules that do not compile correctly. Exits with 0 if
144 there are no errors, or greater than 0 if any errors are found.
145 -W, --add-to-whitelist
147 Add all email addresses, in the headers and body of the mail
148 message read from STDIN, to a persistent address whitelist. Note
149 that you must be running "spamassassin" or "spamd" with a
150 persistent address list plugin enabled for this to work.
151 --add-to-blacklist
153 Add all email addresses, in the headers and body of the mail
154 message read from STDIN, to the persistent address blacklist. Note
155 that you must be running "spamassassin" or "spamd" with a
156 persistent address list plugin enabled for this to work.
157 -R, --remove-from-whitelist
159 Remove all email addresses, in the headers and body of the mail
160 message read from STDIN, from a persistent address list. STDIN must
161 contain a full email message, so to remove a single address you
162 should use --remove-addr-from-whitelist instead.
163 Note that you must be running "spamassassin" or "spamd" with a
165 persistent address list plugin enabled for this to work.
166 --add-addr-to-whitelist
168 Add the named email address to a persistent address whitelist.
169 Note that you must be running "spamassassin" or "spamd" with a
170 persistent address list plugin enabled for this to work.
171 --add-addr-to-blacklist
173 Add the named email address to a persistent address blacklist.
174 Note that you must be running "spamassassin" or "spamd" with a
175 persistent address list plugin enabled for this to work.
176 --remove-addr-from-whitelist
178 Remove the named email address from a persistent address whitelist.
179 Note that you must be running "spamassassin" or "spamd" with a
180 persistent address list plugin enabled for this to work.
181 --ipv4only, --ipv4-only, --ipv4
183 Do not use IPv6 for DNS tests. Normally, SpamAssassin will try to
184 detect if IPv6 is available, using only IPv4 if it is not. Use if
185 the existing tests for IPv6 availability produce incorrect results
186 or crashes.
187 -L, --local
189 Do only the ''local'' tests, ones that do not require an internet
190 connection to operate. Normally, SpamAssassin will try to detect
191 whether you are connected to the net before doing these tests
192 anyway, but for faster checks you may wish to use this.
193 Note that SpamAssassin's network rules are run in parallel. This
195 can cause overhead in terms of the number of file descriptors
196 required if --local is not used; it is recommended that the minimum
197 limit on fds be raised to at least 256 for safety.
198 -d, --remove-markup
200 Remove SpamAssassin markup (the "SpamAssassin results" report,
201 X-Spam-Status headers, etc.) from the mail message. The resulting
202 message, which will be more or less identical to the original, pre-
203 SpamAssassin input, will be output to STDOUT.
204 (Note: the message will not be exactly identical; some headers will
206 be reformatted due to some features of the Mail::Internet package,
207 but the body text will be.)
208 -C path, --configpath=path, --config-file=path
210 Use the specified path for locating the distributed configuration
211 files. Ignore the default directories (usually
212 "/usr/share/spamassassin" or similar).
213 --siteconfigpath=path
215 Use the specified path for locating site-specific configuration
216 files. Ignore the default directories (usually
217 "/etc/mail/spamassassin" or similar).
218 --cf='config line'
220 Add additional lines of configuration directly from the command-
221 line, parsed after the configuration files are read. Multiple
222 --cf arguments can be used, and each will be considered a separate
223 line of configuration. For example:
224 spamassassin -t --cf="body NEWRULE /text/" --cf="score NEWRULE 3.0"
226 -p prefs, --prefspath=prefs, --prefs-file=prefs
228 Read user score preferences from prefs (usually
229 "$HOME/.spamassassin/user_prefs").
230 --progress
232 Prints a progress bar (to STDERR) showing the current progress.
233 This option will only be useful if you are redirecting STDOUT (and
234 not STDERR). In the case where no valid terminal is found this
235 option will behave very much like the --showdots option in other
236 SpamAssassin programs.
237 -D [area,...], --debug [area,...]
239 Produce debugging output. If no areas are listed, all debugging
240 information is printed. Diagnostic output can also be enabled for
241 each area individually; area is the area of the code to instrument.
242 For example, to produce diagnostic output on bayes, learn, and dns,
243 use:
244 spamassassin -D bayes,learn,dns
246 Higher priority informational messages that are suitable for
248 logging in normal circumstances are available with an area of
249 "info".
250 For more information about which areas (also known as channels) are
252 available, please see the documentation at:
253 L<http://wiki.apache.org/spamassassin/DebugChannels>
255 -x, --nocreate-prefs
257 Disable creation of user preferences file.
258 --mbox
260 Specify that the input message(s) are in mbox format. mbox is a
261 standard Unix message folder format.
262 --mbx
264 Specify that the input message(s) are in UW .mbx format. mbx is
265 the mailbox format used within the University of Washington's IMAP
266 implementation; see "http://www.washington.edu/imap/".
267
269 sa-learn(1) spamd(1) spamc(1) Mail::SpamAssassin::Conf(3)
270 Mail::SpamAssassin(3)
271
273 "Mail::SpamAssassin"
274
276 See <http://issues.apache.org/SpamAssassin/>
277
279 The SpamAssassin(tm) Project <http://spamassassin.apache.org/>
280
282 SpamAssassin is distributed under the Apache License, Version 2.0, as
283 described in the file "LICENSE" included with the distribution.
284perl v5.16.3 2014-02-07 SPAMASSASSIN-RUN(1)