spamass-milter.1.in

   1 .\" $Id: spamass-milter.1.in,v 1.19 2004/03/18 18:37:08 dnelson Exp $
   2 .Dd July 25, 2001
   3 .Os
   4 .Dt SPAMASS_MILTER 8
   5 .Sh NAME
   6 .Nm spamass-milter
   7 .Nd sendmail milter for passing emails through SpamAssassin
   8 .Sh SYNOPSIS
   9 .Nm
  10 .Fl p Ar socket
  11 .Op Fl b Ns | Ns Fl B Ar spamaddress
  12 .Op Fl d Ar debugflags
  13 .Op Fl D Ar host
  14 .Op Fl e Ar defaultdomain
  15 .Op Fl f
  16 .Op Fl i Ar networks
  17 .Op Fl m
  18 .Op Fl M
  19 .Op Fl P Ar pidfile
  20 .Op Fl r Ar nn
  21 .Op Fl u Ar defaultuser
  22 .Op Fl x
  23 .Op Fl - Ar spamc flags ...
  24 .Sh DESCRIPTION
  25 The
  26 .Nm
  27 utility is a sendmail milter that checks and modifies incoming email
  28 messages with SpamAssassin.
  29 .Pp
  30 The following options are available:
  31 .Bl -tag -width "indent"
  32 .It Fl p Ar socket
  33 Specifies the pathname of a socket to create for communication with
  34 .Nm sendmail .
  35 If it is removed,
  36 .Nm sendmail
  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
  44 .Ql X-Spam-Orig-To:
  45 headers.
  46 .It Fl B Ar spamaddress
  47 Same as
  48 .Fl b ,
  49 except the original recipients are retained.
  50 Only one of
  51 .Fl b
  52 and
  53 .Fl B
  54 may be used.
  55 .It Fl d Ar debugflags
  56 Enables logging.
  57 .Ar debugflags
  58 is a comma-separated list of tokens:
  59 .Bl -tag -width "indent"
  60 .It func
  61 Entry and exit of internal functions.
  62 .It misc
  63 Other non-verbose logging.
  64 .It net
  65 Lookups of the ignored netblocks list.
  66 .It poll
  67 Low-level I/O to the child spamc process.
  68 .It rcpt
  69 Recipient processing.
  70 .It spamc
  71 High-level I/O to the child spamc process.
  72 .It str
  73 Calls to field lookup and string comparison functions.
  74 .It uori
  75 Calls to the update_or_insert function.
  76 .It 1
  77 (historical) Same as
  78 .Ar func,misc .
  79 .It 2
  80 (historical) Same as
  81 .Ar func,misc,poll .
  82 .It 3
  83 (historical) Same as
  84 .Ar func,misc,poll,str,uori .
  85 .El
  86 .It Fl D Ar host
  87 Connects to a remote spamd server on
  88 .Ar host ,
  89 instead of using one on localhost.
  90 This option is deprecated; use
  91 .Fl - Fl d Ar host
  92 instead.
  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
  96 all users are local.
  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),
 101 .Ar defaultdomain
 102 is added.
 103 Requires the
 104 .Fl u
 105 flag.
 106 .It Fl f
 107 Causes
 108 .Nm
 109 to fork into the background.
 110 .It Fl i Ar networks
 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.
 113 .Ar networks
 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).
 117 Multiple
 118 .Fl i
 119 flags will append to the list.
 120 For example, if you list all your internal networks, no outgoing emails
 121 will be filtered.
 122 .It Fl m
 123 Disables modification of the
 124 .Ql Subject:
 125 and
 126 .Ql Content-Type:
 127 headers and
 128 message body.
 129 This is useful when SpamAssassin is configured with
 130 .Ql "defang_mime 0"
 131 and
 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
 135 messages.
 136 .It Fl M
 137 Like
 138 .Fl m ,
 139 but also disables creation of any SpamAssassin
 140 .Ql X-Spam-*
 141 headers as well.
 142 Both tagged and untagged mail gets passed through unchanged.
 143 To be useful, this option should be used with the
 144 .Fl r ,
 145 .Fl b ,
 146 or
 147 .Fl B
 148 flags.
 149 If
 150 .Fl b
 151 is used, the
 152 .Ql X-Spam-Orig-To:
 153 headers will still be added.
 154 .It Fl P Ar pidfile
 155 Create the file
 156 .Ar pidfile ,
 157 containing the processid of the milter.
 158 .It Fl r Ar nn
 159 Reject scanned email if it greater than or equal to
 160 .Ar nn .
 161 If
 162 .Ar -1 ,
 163 reject scanned email if SpamAssassin tags it as spam (useful if you
 164 are also using the
 165 .Fl u
 166 flag, and users have changed their required_hits value).
 167 .Pp
 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
 170 .Fl r Ar 15
 171 and reject flagrant spam outright while still receiving low-scoring
 172 messages.
 173 .It Fl u Ar defaultuser
 174 Pass the username part of the first recipient to spamc with the
 175 .Fl u
 176 flag.
 177 This allows user preferences files to be used.
 178 If the message is addressed to multiple recipients, the username
 179 .Ar defaultuser
 180 is passed instead.
 181 .Pp
 182 Note that
 183 .Nm
 184 does not know whether an email is incoming or outgoing, so a message
 185 from
 186 .Aq user1@localdomain.com
 187 to
 188 .Aq user2@yahoo.com
 189 will make
 190 .Nm
 191 pass
 192 .Fl u Ar user2
 193 to spamc.
 194 .It Fl x
 195 Pass the recipient address through
 196 .Nm sendmail Fl bv ,
 197 which will perform virtusertable and alias expansion.
 198 The resulting username is then passed to spamc.
 199 Requires the
 200 .Fl u
 201 flag.
 202 .It Fl - Ar spamc flags ...
 203 Pass all remaining options to spamc.
 204 This allows you to connect to a remote spamd with
 205 .Fl d
 206 or
 207 .Fl p .
 208 .El
 209 .Sh FILES
 210 .Bl -tag -width "indent"
 211 .It Pa @SPAMC@
 212 client interface to SpamAssassin
 213 .El
 214 .Sh SEE ALSO
 215 .Xr spamassassin 1 ,
 216 .Xr spamd 1
 217 .Sh AUTHORS
 218 .An "Georg C. F. Greve" Aq greve@gnu.org
 219 .An "Dan Nelson" Aq dnelson@allantgroup.com