1July 25, 2001() July 25, 2001()
2
3
4
6 spamass-milter - sendmail milter for passing emails through SpamAssas‐
7 sin
8
10 spamass-milter -p socket [-b|-B spamaddress] [-d debugflags] [-D host]
11 [-e defaultdomain] [-f] [-g group] [-i networks] [-I] [-m] [-M] [-P
12 pidfile] [-r nn] [-u defaultuser] [-x] [-- spamc flags ...]
13
15 The spamass-milter utility is a sendmail milter that checks and modi‐
16 fies incoming email messages with SpamAssassin.
17
18 The following options are available:
19
20 -p socket
21 Specifies the pathname of a socket to create for communication
22 with sendmail. If it is removed, sendmail will not be able to
23 access the milter. This may cause messages to bounce, queue, or
24 be passed through unmiltered, depending on the parameters in
25 sendmail's .cf file.
26
27 -b spamaddress
28 Redirects tagged spam to the specified email address. All enve‐
29 lope recipients are removed, and inserted into the message as
30 `X-Spam-Orig-To:' headers.
31
32 -B spamaddress
33 Same as -b, except the original recipients are retained. Only
34 one of -b and -B may be used.
35
36 -d debugflags
37 Enables logging. debugflags is a comma-separated list of
38 tokens:
39
40 func Entry and exit of internal functions.
41
42 misc Other non-verbose logging.
43
44 net Lookups of the ignored netblocks list.
45
46 poll Low-level I/O to the child spamc process.
47
48 rcpt Recipient processing.
49
50 spamc High-level I/O to the child spamc process.
51
52 str Calls to field lookup and string comparison functions.
53
54 uori Calls to the update_or_insert function.
55
56 1 (historical) Same as func,misc.
57
58 2 (historical) Same as func,misc,poll.
59
60 3 (historical) Same as func,misc,poll,str,uori.
61
62 -D host
63 Connects to a remote spamd server on host, instead of using one
64 on localhost. This option is deprecated; use -- -d host
65 instead.
66
67 -e defaultdomain
68 Pass the full user@domain address to spamc. The default is to
69 pass only the username part on the assumption that all users are
70 local. This flag is useful if you are using an SQL (or other
71 username) backend with spamassassin and have listed the full
72 address there. If the recipient name has no domain part (if the
73 recipient is on the local machine for example), defaultdomain is
74 added. Requires the -u flag.
75
76 -f Causes spamass-milter to fork into the background.
77
78 -g group
79 Makes the socket for communication with the MTA group-writable
80 (mode 0750) and sets the socket's group to group. This option
81 is intended for use with MTA's like Postfix that do not run as
82 root, and is incompatible with Sendmail usage.
83
84 -i networks
85 Ignores messages if the originating IP is in the network(s)
86 listed. The message will be passed through without calling Spa‐
87 mAssassin at all. networks is a comma-separated list, where
88 each element can be either an IP address (nnn.nnn.nnn.nnn), a
89 CIDR network (nnn.nnn.nnn.nnn/nn), or a network/netmask pair
90 (nnn.nnn.nnn.nnn/nnn.nnn.nnn.nnn). Multiple -i flags will
91 append to the list. For example, if you list all your internal
92 networks, no outgoing emails will be filtered.
93
94 -I Ignores messages if the sender has authenticated via SMTP AUTH.
95
96 -m Disables modification of the `Subject:' and `Content-Type:'
97 headers and message body. This is useful when SpamAssassin is
98 configured with `"defang_mime' 0" and `"report_header' 1" , or
99 when SA is simply used to add headers for postprocessing later.
100 Updating the body through the milter interface can be slow for
101 large messages.
102
103 -M Like -m, but also disables creation of any SpamAssassin `X-
104 Spam-*' headers as well. Both tagged and untagged mail gets
105 passed through unchanged. To be useful, this option should be
106 used with the -r, -b, or -B flags. If -b is used, the `X-Spam-
107 Orig-To:' headers will still be added.
108
109 -P pidfile
110 Create the file pidfile, containing the processid of the milter.
111
112 -r nn Reject scanned email if it greater than or equal to nn. If -1,
113 reject scanned email if SpamAssassin tags it as spam (useful if
114 you are also using the -u flag, and users have changed their
115 required_hits value).
116
117 For example, if you usually use procmail to redirect tagged
118 email into a separate folder just in case of false positives,
119 you can use -r 15 and reject flagrant spam outright while still
120 receiving low-scoring messages.
121
122 -u defaultuser
123 Pass the username part of the first recipient to spamc with the
124 -u flag. This allows user preferences files to be used. If the
125 message is addressed to multiple recipients, the username
126 defaultuser is passed instead.
127
128 Note that spamass-milter does not know whether an email is
129 incoming or outgoing, so a message from <user1@localdomain.com>
130 to <user2@yahoo.com> will make spamass-milter pass -u user2 to
131 spamc.
132
133 -x Pass the recipient address through sendmail -bv, which will per‐
134 form virtusertable and alias expansion. The resulting username
135 is then passed to spamc. Requires the -u flag.
136
137 -- spamc flags ...
138 Pass all remaining options to spamc. This allows you to connect
139 to a remote spamd with -d or -p.
140
142 /usr/bin/spamc
143 client interface to SpamAssassin
144
146 spamassassin(1), spamd(1)
147
149 "Georg C. F. Greve" <greve@gnu.org>
150
151 "Dan Nelson" <dnelson@allantgroup.com>
152
153
154
155 July 25, 2001()