1.1 --- a/man/masqmail.route.5	Mon Apr 25 15:15:34 2011 +0200
     1.2 +++ b/man/masqmail.route.5	Mon Apr 25 15:17:30 2011 +0200
     1.3 @@ -12,10 +12,85 @@
     1.4  Mail will be sent with the SMTP protocol to its destination, unless
     1.5  `pipe' is given.
     1.6  In this case the message will be piped to the given program.
     1.7 -See option `pipe' below.
     1.8  
     1.9  
    1.10 -.SH OPTIONS
    1.11 +.SH ROUTE CONDITIONS
    1.12 +
    1.13 +.TP
    1.14 +\fBallowed_mail_locals\fR = \fIlist\fR
    1.15 +
    1.16 +This is a semicolon `;' separated list of local parts of envelope
    1.17 +senders (= mail from = return path) which will be allowed
    1.18 +to send mail through this connection.
    1.19 +If unset and \fBnot_allowed_mail_locals\fR is also unset, all users are allowed.
    1.20 +
    1.21 +.TP
    1.22 +\fBnot_allowed_mail_locals\fR = \fIlist\fR
    1.23 +
    1.24 +This is a semicolon `;' separated list of local parts of envelope
    1.25 +senders (= mail from = return path) which will be not allowed
    1.26 +to send mail through this connection.
    1.27 +Local parts in this list will not be allowed to use this route even if they
    1.28 +are part of \fBallowed_mail_locals\fR (see above).
    1.29 +
    1.30 +.TP
    1.31 +\fBallowed_return_paths\fR = \fIlist\fR
    1.32 +
    1.33 +This is a semicolon `;' separated list of addresses.
    1.34 +Messages which have one of these addresses as the return path (=
    1.35 +envelope sender = mail from) will be used using this route
    1.36 +(if not also in \fBnot_allowed_return_paths\fR or an item in \fBnot_allowed_mail_locals\fR matches).
    1.37 +
    1.38 +Patterns containing `?' and `*' can be used.
    1.39 +The special item "<>" matches the null sender address (eg. failure notices or delivery notifications).
    1.40 +
    1.41 +.TP
    1.42 +\fBnot_allowed_return_paths\fR = \fIlist\fR
    1.43 +
    1.44 +This is a semicolon `;' separated list of addresses.
    1.45 +Messages which have one of these addresses as the return path (=
    1.46 +envelope sender = mail from) will not
    1.47 +be used using this route (even if also in \fBallowed_return_paths\fR
    1.48 +or an item in \fBallowed_mail_locals\fR matches).
    1.49 +
    1.50 +Patterns containing `?' and `*' can be used.
    1.51 +The special item "<>" matches the null sender address (eg. failure notices or delivery notifications).
    1.52 +
    1.53 +.TP
    1.54 +\fBallowed_rcpt_domains\fR = \fIlist\fR
    1.55 +
    1.56 +A list of recipient domains (of envelope recipients) where mail will be sent to.
    1.57 +This is for example useful if you use this route configuration when connected to another LAN via ppp.
    1.58 +Patterns containing `?' and `*' can be used.
    1.59 +
    1.60 +.TP
    1.61 +\fBnot_allowed_rcpt_domains\fR = \fIlist\fR
    1.62 +
    1.63 +A list of recipient domains (of envelope recipients) where mail will not be sent to.
    1.64 +This is for example useful if you send mail directly (\fBmail_host\fR is not set)
    1.65 +and you know of hosts that will not accept mail from you because they use a dialup list
    1.66 +(eg. \fBhttp://maps.vix.com/dul/\fR).
    1.67 +If any domain matches both \fBallowed_rcpt_domains\fR and \fBnot_allowed_rcpt_domains\fR,
    1.68 +mail will not be sent to this domain.
    1.69 +Patterns containing `?' and `*' can be used.
    1.70 +
    1.71 +.TP
    1.72 +\fBlast_route\fR = \fIboolean\fR
    1.73 +
    1.74 +If this is set, a mail which would have been delivered using this route,
    1.75 +but has failed temporarily, will not be tried to be delivered using the next route.
    1.76 +
    1.77 +If you have set up a special route with filters using the lists `allowed_rcpt_domains',
    1.78 +`allowed_return_paths', and `allowed_mail_locals' or their complements (not_),
    1.79 +and the mail passing these rules should be delivered using this route only,
    1.80 +you should set this to `true'.
    1.81 +Otherwise the mail would be passed to the next route (if any),
    1.82 +unless that route has rules which prevent that.
    1.83 +
    1.84 +Default is false.
    1.85 +
    1.86 +
    1.87 +.SH SMTP CONFIGURATION
    1.88  
    1.89  .TP
    1.90  \fBmail_host\fR = \fIstring\fR
    1.91 @@ -87,7 +162,6 @@
    1.92  
    1.93  Default: false
    1.94  
    1.95 -
    1.96  .TP
    1.97  \fBdo_pipelining\fR = \fIboolean\fR
    1.98  
    1.99 @@ -99,59 +173,84 @@
   1.100  remote server side is really broken.
   1.101  Keywords: wingate.
   1.102  
   1.103 -.TP
   1.104 -\fBallowed_mail_locals\fR = \fIlist\fR
   1.105 -
   1.106 -This is a semicolon `;' separated list of local parts which will be allowed
   1.107 -to send mail through this connection.
   1.108 -If unset and \fBnot_allowed_mail_locals\fR is also unset, all users are allowed.
   1.109  
   1.110  .TP
   1.111 -\fBnot_allowed_mail_locals\fR = \fIlist\fR
   1.112 +\fBauth_name\fR = \fIstring\fR
   1.113  
   1.114 -This is a semicolon `;' separated list of local parts which will be not allowed
   1.115 -to send mail through this connection.
   1.116 -Local parts in this list will not be allowed to use this route even if they
   1.117 -are part of \fBallowed_mail_locals\fR (see above).
   1.118 +Set the authentication type for ESMTP AUTH authentication.
   1.119 +Currently only `cram-md5' and `login' are supported.
   1.120  
   1.121  .TP
   1.122 -\fBallowed_return_paths\fR = \fIlist\fR
   1.123 +\fBauth_login\fR = \fIstring\fR
   1.124  
   1.125 -This is a semicolon `;' separated list of addresses.
   1.126 -Messages which have one of these addresses as the return path will be used using this route
   1.127 -(if not also in \fBnot_allowed_return_paths\fR or an item in \fBnot_allowed_mail_locals\fR matches).
   1.128 -
   1.129 -Patterns containing `?' and `*' can be used.
   1.130 -The special item "<>" matches the null sender address (eg. failure notices or delivery notifications).
   1.131 +Your account name for ESMTP AUTH authentication.
   1.132  
   1.133  .TP
   1.134 -\fBnot_allowed_return_paths\fR = \fIlist\fR
   1.135 +\fBauth_secret\fR = \fIstring\fR
   1.136  
   1.137 -This is a semicolon `;' separated list of addresses.
   1.138 -Messages which have one of these addresses as the return path will not
   1.139 -be used using this route (even if also in \fBallowed_return_paths\fR
   1.140 -or an item in \fBallowed_mail_locals\fR matches).
   1.141 -
   1.142 -Patterns containing `?' and `*' can be used.
   1.143 -The special item "<>" matches the null sender address (eg. failure notices or delivery notifications).
   1.144 +Your secret for ESMTP AUTH authentication.
   1.145  
   1.146  .TP
   1.147 -\fBallowed_rcpt_domains\fR = \fIlist\fR
   1.148 +\fBwrapper\fR = \fIcommand\fR
   1.149  
   1.150 -A list of recipient domains where mail will be sent to.
   1.151 -This is for example useful if you use this route configuration when connected to another LAN via ppp.
   1.152 -Patterns containing `?' and `*' can be used.
   1.153 +If set, instead of opening a connection to a remote server,
   1.154 +\fIcommand\fR will be called and all traffic will be piped to its stdin and from its stdout.
   1.155 +Purpose is to tunnel ip traffic, eg. for ssl.
   1.156 +
   1.157 +Example for SMTP over SSL tunneling:
   1.158 +.nf
   1.159 +wrapper="/usr/bin/openssl s_client \-quiet \-connect mail.gmx.net:465 2>/dev/null"
   1.160 +.fi
   1.161 +
   1.162 +SMTP over SSL is supported since masqmail-0.1.8.
   1.163 +It is marked obsolete by the IETF but is still in use.
   1.164 +
   1.165 +
   1.166 +Example for encryption with STARTTLS (RFC-3207):
   1.167 +.nf
   1.168 +# don't forget the instant_helo, otherwise it won't work
   1.169 +instant_helo=true
   1.170 +wrapper="/usr/bin/openssl s_client \-quiet \-starttls smtp \-connect mail.gmx.net:25 2>/dev/null"
   1.171 +.fi
   1.172 +
   1.173 +This is supported since masqmail-0.2.28.
   1.174 +STARTTLS supersedes SMTP over SSL.
   1.175 +
   1.176 +Note for openssl:
   1.177 +Ensure that stderr is redirected.
   1.178 +Do *not* use \-crlf in the wrapper command, because masqmail does already insert CRLF.
   1.179 +However, you might want to specify \-crlf if you want to test your wrapper command
   1.180 +interactively on the command line.
   1.181 +
   1.182 +
   1.183 +.SH PIPE CONFIGURATION
   1.184  
   1.185  .TP
   1.186 -\fBnot_allowed_rcpt_domains\fR = \fIlist\fR
   1.187 +\fBpipe\fR = \fIcommand\fR
   1.188  
   1.189 -A list of recipient domains where mail will not be sent to.
   1.190 -This is for example useful if you send mail directly (\fBmail_host\fR is not set)
   1.191 -and you know of hosts that will not accept mail from you because they use a dialup list
   1.192 -(eg. \fBhttp://maps.vix.com/dul/\fR).
   1.193 -If any domain matches both \fBallowed_rcpt_domains\fR and \fBnot_allowed_rcpt_domains\fR,
   1.194 -mail will not be sent to this domain.
   1.195 -Patterns containing `?' and `*' can be used.
   1.196 +\fIcommand\fR will be called and the message will be piped to its stdin.
   1.197 +Purpose is to use gateways to uucp, fax, sms or whatever else.
   1.198 +
   1.199 +You can use variables to give as arguments to the command,
   1.200 +these are the same as for the mda in the main configuration, see \fBmasqmail.conf(5)\fR.
   1.201 +
   1.202 +.TP
   1.203 +\fBpipe_fromline = \fIboolean\fR
   1.204 +
   1.205 +Only if `pipe' is used.
   1.206 +A from line will be prepended to the output stream whenever a pipe command is called.
   1.207 +Default is false.
   1.208 +
   1.209 +.TP
   1.210 +\fBpipe_fromhack = \fIboolean\fR
   1.211 +
   1.212 +Only if `pipe' is used.
   1.213 +Each line beginning with `From ' is replaced with `>From ' whenever a pipe command is called.
   1.214 +You probably want this if you have set \fBpipe_fromline\fR above.
   1.215 +Default is false.
   1.216 +
   1.217 +
   1.218 +.SH ADDRESS REWRITE RULES
   1.219  
   1.220  .TP
   1.221  \fBset_h_from_domain\fR = \fIstring\fR
   1.222 @@ -237,93 +336,6 @@
   1.223  Like \fBexpand_h_sender_address\fR, but sets the domain only.
   1.224  Deprecated, will be removed in a later version.
   1.225  
   1.226 -.TP
   1.227 -\fBlast_route\fR = \fIboolean\fR
   1.228 -
   1.229 -If this is set, a mail which would have been delivered using this route,
   1.230 -but has failed temporarily, will not be tried to be delivered using the next route.
   1.231 -
   1.232 -If you have set up a special route with filters using the lists `allowed_rcpt_domains',
   1.233 -`allowed_return_paths', and `allowed_mail_locals' or their complements (not_),
   1.234 -and the mail passing these rules should be delivered using this route only,
   1.235 -you should set this to `true'.
   1.236 -Otherwise the mail would be passed to the next route (if any),
   1.237 -unless that route has rules which prevent that.
   1.238 -
   1.239 -Default is false.
   1.240 -
   1.241 -.TP
   1.242 -\fBauth_name\fR = \fIstring\fR
   1.243 -
   1.244 -Set the authentication type for ESMTP AUTH authentication.
   1.245 -Currently only `cram-md5' and `login' are supported.
   1.246 -
   1.247 -.TP
   1.248 -\fBauth_login\fR = \fIstring\fR
   1.249 -
   1.250 -Your account name for ESMTP AUTH authentication.
   1.251 -
   1.252 -.TP
   1.253 -\fBauth_secret\fR = \fIstring\fR
   1.254 -
   1.255 -Your secret for ESMTP AUTH authentication.
   1.256 -
   1.257 -.TP
   1.258 -\fBwrapper\fR = \fIcommand\fR
   1.259 -
   1.260 -If set, instead of opening a connection to a remote server,
   1.261 -\fIcommand\fR will be called and all traffic will be piped to its stdin and from its stdout.
   1.262 -Purpose is to tunnel ip traffic, eg. for ssl.
   1.263 -
   1.264 -Example for SMTP over SSL tunneling:
   1.265 -.nf
   1.266 -wrapper="/usr/bin/openssl s_client \-quiet \-connect mail.gmx.net:465 2>/dev/null"
   1.267 -.fi
   1.268 -
   1.269 -SMTP over SSL is supported since masqmail-0.1.8.
   1.270 -It is marked obsolete by the IETF but is still in use.
   1.271 -
   1.272 -
   1.273 -Example for encryption with STARTTLS (RFC-3207):
   1.274 -.nf
   1.275 -# don't forget the instant_helo, otherwise it won't work
   1.276 -instant_helo=true
   1.277 -wrapper="/usr/bin/openssl s_client \-quiet \-starttls smtp \-connect mail.gmx.net:25 2>/dev/null"
   1.278 -.fi
   1.279 -
   1.280 -This is supported since masqmail-0.2.28.
   1.281 -STARTTLS supersedes SMTP over SSL.
   1.282 -
   1.283 -Note for openssl:
   1.284 -Ensure that stderr is redirected.
   1.285 -Do *not* use \-crlf in the wrapper command, because masqmail does already insert CRLF.
   1.286 -However, you might want to specify \-crlf if you want to test your wrapper command
   1.287 -interactively on the command line.
   1.288 -
   1.289 -.TP
   1.290 -\fBpipe\fR = \fIcommand\fR
   1.291 -
   1.292 -\fIcommand\fR will be called and the message will be piped to its stdin.
   1.293 -Purpose is to use gateways to uucp, fax, sms or whatever else.
   1.294 -
   1.295 -You can use variables to give as arguments to the command,
   1.296 -these are the same as for the mda in the main configuration, see \fBmasqmail.conf(5)\fR.
   1.297 -
   1.298 -.TP
   1.299 -\fBpipe_fromline = \fIboolean\fR
   1.300 -
   1.301 -Only if `pipe' is used.
   1.302 -A from line will be prepended to the output stream whenever a pipe command is called.
   1.303 -Default is false.
   1.304 -
   1.305 -.TP
   1.306 -\fBpipe_fromhack = \fIboolean\fR
   1.307 -
   1.308 -Only if `pipe' is used.
   1.309 -Each line beginning with `From ' is replaced with `>From ' whenever a pipe command is called.
   1.310 -You probably want this if you have set \fBpipe_fromline\fR above.
   1.311 -Default is false.
   1.312 -
   1.313  
   1.314  .SH AUTHOR
   1.315