1 .\" $Id: spamass-milter.1.in,v 1.21 2014/08/15 02:25:31 kovert Exp $
7 .Nd sendmail milter for passing emails through SpamAssassin
11 .Op Fl b Ns | Ns Fl B Ar spamaddress
13 .Op Fl d Ar debugflags
15 .Op Fl e Ar defaultdomain
23 .Op Fl u Ar defaultuser
25 .Op Fl S /path/to/sendmail
26 .Op Fl - Ar spamc flags ...
30 utility is a sendmail milter that checks and modifies incoming email
31 messages with SpamAssassin.
33 The following options are available:
34 .Bl -tag -width "indent"
36 Specifies the pathname of a socket to create for communication with
40 will not be able to access the milter.
41 This may cause messages to bounce, queue, or be passed through
42 unmiltered, depending on the parameters in
43 .Nm sendmail Ns 's .cf file.
44 .It Fl b Ar spamaddress
45 Redirects tagged spam to the specified email address.
46 All envelope recipients are removed, and inserted into the message as
49 .It Fl B Ar spamaddress
52 except the original recipients are retained.
58 .It Fl C Ar rejectcode
59 Mail that is rejected is rejected by default with a 5.7.1 code. This option
60 allows that to be overridden. See also, -R
63 .It Fl d Ar debugflags
66 is a comma-separated list of tokens:
67 .Bl -tag -width "indent"
69 Entry and exit of internal functions.
71 Other non-verbose logging.
73 Lookups of the ignored netblocks list.
75 Low-level I/O to the child spamc process.
79 High-level I/O to the child spamc process.
81 Calls to field lookup and string comparison functions.
83 Calls to the update_or_insert function.
92 .Ar func,misc,poll,str,uori .
95 Connects to a remote spamd server on
97 instead of using one on localhost.
98 This option is deprecated; use
101 .It Fl e Ar defaultdomain
102 Pass the full user@domain address to spamc.
103 The default is to pass only the username part on the assumption that
105 This flag is useful if you are using an SQL (or other username) backend
106 with spamassassin and have listed the full address there.
107 If the recipient name has no domain part (if the recipient is on the
108 local machine for example),
117 to fork into the background.
119 Ignores messages if the originating IP is in the network(s) listed.
120 The message will be passed through without calling SpamAssassin at all.
122 is a comma-separated list, where each element can be either an IP address
123 (nnn.nnn.nnn.nnn), a CIDR network (nnn.nnn.nnn.nnn/nn), or a network/netmask
124 pair (nnn.nnn.nnn.nnn/nnn.nnn.nnn.nnn).
127 flags will append to the list.
128 For example, if you list all your internal networks, no outgoing emails
131 Disables modification of the
137 This is useful when SpamAssassin is configured with
140 .Ql "report_header 1" ,
141 or when SA is simply used to add headers for postprocessing later.
142 Updating the body through the milter interface can be slow for large
147 but also disables creation of any SpamAssassin
150 Both tagged and untagged mail gets passed through unchanged.
151 To be useful, this option should be used with the
161 headers will still be added.
165 containing the processid of the milter.
167 Reject scanned email if it greater than or equal to
171 reject scanned email if SpamAssassin tags it as spam (useful if you
174 flag, and users have changed their required_hits value).
176 For example, if you usually use procmail to redirect tagged email into
177 a separate folder just in case of false positives, you can use
179 and reject flagrant spam outright while still receiving low-scoring
181 .It Fl R Ar rejecttext
182 Mail that is rejected is rejected with the message "Blocked by SpamAssassin".
183 This option allows the user to call with a different message, instead. See
187 .It Fl S Ar /path/to/sendmail
188 This option is used in conjunction with the -x option to specify a path
189 to sendmail if the default compiled in choice is not satisfactory.
190 .It Fl u Ar defaultuser
191 Pass the username part of the first recipient to spamc with the
194 This allows user preferences files to be used.
195 If the message is addressed to multiple recipients, the username
201 does not know whether an email is incoming or outgoing, so a message
203 .Aq user1@localdomain.com
212 Pass the recipient address through
214 which will perform virtusertable and alias expansion.
215 The resulting username is then passed to spamc.
218 flag. The spamass-milter configuration process does its
219 best to find sendmail, but it is possible to override this compiled-in
221 .It Fl - Ar spamc flags ...
222 Pass all remaining options to spamc.
223 This allows you to connect to a remote spamd with
229 .Bl -tag -width "indent"
231 client interface to SpamAssassin
237 .An "Georg C. F. Greve" Aq greve@gnu.org
238 .An "Dan Nelson" Aq dnelson@allantgroup.com
239 .An "Todd Kover" Aq kovert@omniscient.com