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
22 .Op Fl u Ar defaultuser
24 .Op Fl - Ar spamc flags ...
28 utility is a sendmail milter that checks and modifies incoming email
29 messages with SpamAssassin.
31 The following options are available:
32 .Bl -tag -width "indent"
34 Specifies the pathname of a socket to create for communication with
38 will not be able to access the milter.
39 This may cause messages to bounce, queue, or be passed through
40 unmiltered, depending on the parameters in
41 .Nm sendmail Ns 's .cf file.
42 .It Fl b Ar spamaddress
43 Redirects tagged spam to the specified email address.
44 All envelope recipients are removed, and inserted into the message as
47 .It Fl B Ar spamaddress
50 except the original recipients are retained.
56 .It Fl d Ar debugflags
59 is a comma-separated list of tokens:
60 .Bl -tag -width "indent"
62 Entry and exit of internal functions.
64 Other non-verbose logging.
66 Lookups of the ignored netblocks list.
68 Low-level I/O to the child spamc process.
72 High-level I/O to the child spamc process.
74 Calls to field lookup and string comparison functions.
76 Calls to the update_or_insert function.
85 .Ar func,misc,poll,str,uori .
88 Connects to a remote spamd server on
90 instead of using one on localhost.
91 This option is deprecated; use
94 .It Fl e Ar defaultdomain
95 Pass the full user@domain address to spamc.
96 The default is to pass only the username part on the assumption that
98 This flag is useful if you are using an SQL (or other username) backend
99 with spamassassin and have listed the full address there.
100 If the recipient name has no domain part (if the recipient is on the
101 local machine for example),
110 to fork into the background.
112 Ignores messages if the originating IP is in the network(s) listed.
113 The message will be passed through without calling SpamAssassin at all.
115 is a comma-separated list, where each element can be either an IP address
116 (nnn.nnn.nnn.nnn), a CIDR network (nnn.nnn.nnn.nnn/nn), or a network/netmask
117 pair (nnn.nnn.nnn.nnn/nnn.nnn.nnn.nnn).
120 flags will append to the list.
121 For example, if you list all your internal networks, no outgoing emails
124 Ignores messages if the sender has authenticated via SMTP AUTH.
126 Disables modification of the
132 This is useful when SpamAssassin is configured with
135 .Ql "report_header 1" ,
136 or when SA is simply used to add headers for postprocessing later.
137 Updating the body through the milter interface can be slow for large
142 but also disables creation of any SpamAssassin
145 Both tagged and untagged mail gets passed through unchanged.
146 To be useful, this option should be used with the
156 headers will still be added.
160 containing the processid of the milter.
162 Reject scanned email if it greater than or equal to
166 reject scanned email if SpamAssassin tags it as spam (useful if you
169 flag, and users have changed their required_hits value).
171 For example, if you usually use procmail to redirect tagged email into
172 a separate folder just in case of false positives, you can use
174 and reject flagrant spam outright while still receiving low-scoring
176 .It Fl u Ar defaultuser
177 Pass the username part of the first recipient to spamc with the
180 This allows user preferences files to be used.
181 If the message is addressed to multiple recipients, the username
187 does not know whether an email is incoming or outgoing, so a message
189 .Aq user1@localdomain.com
198 Pass the recipient address through
200 which will perform virtusertable and alias expansion.
201 The resulting username is then passed to spamc.
205 .It Fl - Ar spamc flags ...
206 Pass all remaining options to spamc.
207 This allows you to connect to a remote spamd with
213 .Bl -tag -width "indent"
215 client interface to SpamAssassin
221 .An "Georg C. F. Greve" Aq greve@gnu.org
222 .An "Dan Nelson" Aq dnelson@allantgroup.com