Mercurial > masqmail

comparison man/masqmail.conf.5 @ 354:08932c629849

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
reworked the route concept; removed the idea of the localnet Renamed to reflect the actual meaning more clearly: s/online_routes/query_routes/g s/local_net_route/permanent_routes/g Removed local_nets, which are now represented by allowed_recipients in a permanent route. (See. examples/localnet.route) There is no more abiguity between `local' and `local net'. Run admin/config-transition on your config to learn how to update it.
author markus schnalke <meillo@marmaro.de>
date Sun, 04 Sep 2011 11:25:38 +0200
parents 1ca9bc4c6552
children 3f923f97563b
comparison
equal deleted inserted replaced
353:48ff59cf0b34 354:08932c629849
23 A boolean variable can be set with one of the values `on', `yes', and `true' or `off', `no' and `false'. 23 A boolean variable can be set with one of the values `on', `yes', and `true' or `off', `no' and `false'.
24 List items are separated with semicolons `;'. 24 List items are separated with semicolons `;'.
25 For some values, patterns (like `*',`?') can be used. 25 For some values, patterns (like `*',`?') can be used.
26 The spaces in front of and after the equal sign `=' are optional. 26 The spaces in front of and after the equal sign `=' are optional.
27 27
28 Most lists (exceptions: \fBlocal_hosts\fR, \fBlocal_nets\fR, \fBlisten_addresses\fR, 28 Most lists (exceptions: \fBlocal_hosts\fR, \fBlisten_addresses\fR,
29 and \fBonline_routes\fR) accept files. 29 \fBquery_routes.\fIname\fR and \fBpermanent_routes\fR) accept files.
30 These will be recognized by a leading slash `/'. 30 These will be recognized by a leading slash `/'.
31 The contents of these files will be included at the position of the file name, 31 The contents of these files will be included at the position of the file name,
32 there can be items or other files before and after the file entry. 32 there can be items or other files before and after the file entry.
33 The format of the files is different though, within these files each entry is on another line 33 The format of the files is different though, within these files each entry is on another line
34 and the entries are not separated by semicolons. 34 and the entries are not separated by semicolons.
162 local_hosts = "localhost;myhost;mydomain.net" 162 local_hosts = "localhost;myhost;mydomain.net"
163 163
164 not_local_addresses = "eric@mydomain.net" 164 not_local_addresses = "eric@mydomain.net"
165 165
166 .TP 166 .TP
167 \fBlocal_nets = \fIlist\fR
168
169 A semicolon `;' separated list of hostnames which are on the `local' net.
170 Delivery to these hosts is attempted immediately.
171 You can use patterns with `*', e.g. "*.bar.com".
172
173 .TP
174 \fBlisten_addresses = \fIlist\fR 167 \fBlisten_addresses = \fIlist\fR
175 168
176 A semicolon `;' separated list of interfaces on which connections will be accepted. 169 A semicolon `;' separated list of interfaces on which connections will be accepted.
177 An interface ist defined by a hostname, optionally followed by a colon `:' and a number for the port. 170 An interface ist defined by a hostname, optionally followed by a colon `:' and a number for the port.
178 If this is left out, port 25 will be used. 171 If this is left out, port 25 will be used.
220 Usually you should leave this option unset. 213 Usually you should leave this option unset.
221 214
222 Default: false 215 Default: false
223 216
224 .TP 217 .TP
225 \fBonline_routes.\fIname\fR = \fIlist\fR 218 \fBpermanent_routes\fR = \fIlist\fR
226 219
227 Replace \fIname\fR with a name to identify a connection. 220 Set this to the filename (or a semicolon-separated list of filenames)
228 Set this to a filename (or a list of filenames) for the special route configuration for that connection. 221 of the route configuration for always available connections.
229 You will use that name to call masqmail with the \fB\-qo\fR option every time a 222 Main purpose is to define a mail server with mail_host in your local network,
230 connection to your ISP is set up. 223 or if masqmail should send mail directly to the target host.
224 If you have only a single host, you can leave it unset.
225
226 A setting `\fBlocal_nets\fR = \fI"*home.net"\fR' in versions <= 0.3.3
227 is in newer versions configured as:
228 `\fBpermanent_routes\fR = \fI"/etc/masqmail/homenet.route"\fR'
229 and the route file `homenet.route' containing:
230 .in +1in
231 .nf
232 allowed_recipients = "*@*home.net"
233 connect_error_fail = true
234 resolve_list = byname
235 .fi
236 .in 0
237 This is just as it had been with \fBlocal_net_route\fP,
238 with the exception that the filtering for appropriate addresses
239 is only in the route file and not with \fBlocal_nets\fR.
240
241 .TP
242 \fBquery_routes.\fIname\fR = \fIlist\fR
243
244 Replace \fIname\fR with a name to identify the connection.
245 Set this to a filename (or a semicolon-separated list of filenames)
246 for the route configuration for that connection.
247
248 Routes of this kind cannot be expected to be online always.
249 Masqmail will query which of the routes are online.
250
251 You can use the name to call masqmail with the \fB\-qo\fR option every time a
252 connection to your ISP is set up, in order to send queued mail through this
253 route.
231 254
232 Example: Your ISP has the name FastNet. 255 Example: Your ISP has the name FastNet.
233 Then you write the following line in the main configuration: 256 Then you write the following line in the main configuration:
234 257
235 \fBonline_routes.FastNet\fR = \fI"/etc/masqmail/fastnet.route"\fR 258 \fBquery_routes.\fBFastNet\fR = \fI"/etc/masqmail/fastnet.route"\fR
236 259
237 \fI/etc/masqmail/fastnet.route\fR is the route configuration file, see \fBmasqmail.route(5)\fR. 260 \fI/etc/masqmail/fastnet.route\fR is the route configuration file,
238 As soon as a link to FastNet has been set up, you call masqmail \fB\-qo \fIFastNet\fR. 261 see \fBmasqmail.route(5)\fR.
262 As soon as a link to FastNet has been set up,
263 you call `masqmail \fB\-qo \fIFastNet\fR'.
239 Masqmail will then read the specified file and send the mails. 264 Masqmail will then read the specified file and send the mails.
240 265
241 .TP 266 See \fBonline_query\fP.
242 \fBconnect_route.\fIname\fR = \fIlist\fR
243
244 Old name for \fBonline_routes\fR.
245
246 .TP
247 \fBlocal_net_route = \fIfile\fR
248
249 This is similar to \fBonline_routes.\fIname\fR but used for delilvery to the local net.
250 Recipient addresses that are in local_nets will be routed using this route configuration.
251 Main purpose is to define a mail server with mail_host in your local network.
252 In simple environments this can be left unset.
253 If unset, a default route configuration (named ``default local_net_route'') will be used.
254 267
255 .TP 268 .TP
256 \fBalias_file = \fIfile\fR 269 \fBalias_file = \fIfile\fR
257 270
258 Set this to the location of your alias file. 271 Set this to the location of your alias file.
364 377
365 Defines the method masqmail uses to detect whether there exists an online connection currently. 378 Defines the method masqmail uses to detect whether there exists an online connection currently.
366 379
367 Masqmail executes the command given and reads from its standard output. 380 Masqmail executes the command given and reads from its standard output.
368 The command should just print a route name, as defined 381 The command should just print a route name, as defined
369 with \fBonline_routes.\fIname\fR, to standard output and return a zero status code. 382 with \fBquery_routes.\fIname\fR, to standard output and return a zero status code.
370 Masqmail assumes it is offline if the script returns with a non-zero status. 383 Masqmail assumes it is offline if the script returns with a non-zero status.
371 Leading and trailing whitespace is removed from the output. 384 Leading and trailing whitespace is removed from the output.
372 385
373 Simple example: 386 Simple example:
374 387