1 .\" $Id: spamass-milter.1.in,v 1.19 2004/03/18 18:37:08 dnelson Exp $
7 .Nd sendmail milter for passing emails through SpamAssassin
11 .Op Fl b Ns | Ns Fl B Ar spamaddress
12 .Op Fl d Ar debugflags
14 .Op Fl e Ar defaultdomain
21 .Op Fl u Ar defaultuser
23 .Op Fl - Ar spamc flags ...
27 utility is a sendmail milter that checks and modifies incoming email
28 messages with SpamAssassin.
30 The following options are available:
31 .Bl -tag -width "indent"
33 Specifies the pathname of a socket to create for communication with
37 will not be able to access the milter.
38 This may cause messages to bounce, queue, or be passed through
39 unmiltered, depending on the parameters in
40 .Nm sendmail Ns 's .cf file.
41 .It Fl b Ar spamaddress
42 Redirects tagged spam to the specified email address.
43 All envelope recipients are removed, and inserted into the message as
46 .It Fl B Ar spamaddress
49 except the original recipients are retained.
55 .It Fl d Ar debugflags
58 is a comma-separated list of tokens:
59 .Bl -tag -width "indent"
61 Entry and exit of internal functions.
63 Other non-verbose logging.
65 Lookups of the ignored netblocks list.
67 Low-level I/O to the child spamc process.
71 High-level I/O to the child spamc process.
73 Calls to field lookup and string comparison functions.
75 Calls to the update_or_insert function.
84 .Ar func,misc,poll,str,uori .
87 Connects to a remote spamd server on
89 instead of using one on localhost.
90 This option is deprecated; use
93 .It Fl e Ar defaultdomain
94 Pass the full user@domain address to spamc.
95 The default is to pass only the username part on the assumption that
97 This flag is useful if you are using an SQL (or other username) backend
98 with spamassassin and have listed the full address there.
99 If the recipient name has no domain part (if the recipient is on the
100 local machine for example),
109 to fork into the background.
111 Ignores messages if the originating IP is in the network(s) listed.
112 The message will be passed through without calling SpamAssassin at all.
114 is a comma-separated list, where each element can be either an IP address
115 (nnn.nnn.nnn.nnn), a CIDR network (nnn.nnn.nnn.nnn/nn), or a network/netmask
116 pair (nnn.nnn.nnn.nnn/nnn.nnn.nnn.nnn).
119 flags will append to the list.
120 For example, if you list all your internal networks, no outgoing emails
123 Disables modification of the
129 This is useful when SpamAssassin is configured with
132 .Ql "report_header 1" ,
133 or when SA is simply used to add headers for postprocessing later.
134 Updating the body through the milter interface can be slow for large
139 but also disables creation of any SpamAssassin
142 Both tagged and untagged mail gets passed through unchanged.
143 To be useful, this option should be used with the
153 headers will still be added.
157 containing the processid of the milter.
159 Reject scanned email if it greater than or equal to
163 reject scanned email if SpamAssassin tags it as spam (useful if you
166 flag, and users have changed their required_hits value).
168 For example, if you usually use procmail to redirect tagged email into
169 a separate folder just in case of false positives, you can use
171 and reject flagrant spam outright while still receiving low-scoring
173 .It Fl u Ar defaultuser
174 Pass the username part of the first recipient to spamc with the
177 This allows user preferences files to be used.
178 If the message is addressed to multiple recipients, the username
184 does not know whether an email is incoming or outgoing, so a message
186 .Aq user1@localdomain.com
195 Pass the recipient address through
197 which will perform virtusertable and alias expansion.
198 The resulting username is then passed to spamc.
202 .It Fl - Ar spamc flags ...
203 Pass all remaining options to spamc.
204 This allows you to connect to a remote spamd with
210 .Bl -tag -width "indent"
211 .It Pa /usr/bin/spamc
212 client interface to SpamAssassin
218 .An "Georg C. F. Greve" Aq greve@gnu.org
219 .An "Dan Nelson" Aq dnelson@allantgroup.com