masqmail-0.2
view man/masqmail.conf.5 @ 60:e119cee8d493
tiny improvement in usage message
| author | meillo@marmaro.de |
|---|---|
| date | Sat, 29 May 2010 22:57:17 +0200 |
| parents | 5e527abc1fc2 |
| children | 10d00e3235f2 |
line source
1 .TH masqmail.conf 5 2010-05-07 masqmail-0.2.22 "File Formats"
3 .SH NAME
4 masqmail.conf \- masqmail configuration file
7 .SH DESCRIPTION
9 This man page describes the syntax of the main configuration file of masqmail.
10 Its usual location is \fI/etc/masqmail/masqmail.conf\fR
12 The configuration consists of lines of the form
14 \fBval\fR = \fIexpression\fR
16 Where \fBval\fR is a variable name and \fIexpression\fR a string,
17 which can be quoted with double quotes `"'.
18 If the expression is on multiple lines or contains characters other than letters,
19 digits or the characters `.', `-', `_', `/', it must be quoted.
20 You can use quotes inside quotes by escaping them with a backslash.
22 Each val has a type, which can be boolean, numeric, string or list.
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 `;'.
25 For some values patterns (like `*',`?') can be used.
26 The spaces before and after the equal sign `=' are optional.
28 Most lists (exceptions: \fBlocal_hosts\fR, \fBlocal_nets\fR, \fBlisten_addresses\fR,
29 \fBonline_routes\fR, and \fBonline_gets\fR) accept files.
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,
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.
34 (And not separated by semicolons).
35 This makes it easy to include large lists which are common in different configuration files,
36 so they do not have to appear in every configuration file.
38 Blank lines and lines starting with a hash `#' are ignored.
41 .SH OPTIONS
43 .TP
44 \fBrun_as_user = \fIboolean\fR
46 If this is set, masqmail runs with the user id of the user who invoked it and never changes it.
47 This is for debugging purposes only.
48 If the user is not root, masqmail will not be able to listen on a port < 1024
49 and will not be able to deliver local mail to others than the user.
51 .TP
52 \fBuse_syslog = \fIboolean\fR
54 If this is set, masqmail uses syslogd for logging.
55 It uses facility MAIL.
56 You still have to set \fBlog_dir\fR for debug files.
58 .TP
59 \fBdebug_level = \fIn\fR
61 Set the debug level.
62 Valid values are 0 to 6, increasing it further makes no difference.
63 Be careful if you set this as high as 5 or higher, the logs may very soon fill your hard drive.
65 .TP
66 \fBlog_dir = \fIfile\fR
68 The directory where log are stored, if syslog is not used.
69 Debug files are stored in this directory anyways.
70 \fI/var/log/masqmail\fR is a common value.
71 \fIfile\fR must be an absolute path.
73 .TP
74 \fBmail_dir = \fIfile\fR
76 The directory where local mail is stored, usually \fI/var/spool/mail\fR or \fI/var/mail\fR.
77 \fIfile\fR must be an absolute path.
79 .TP
80 \fBspool_dir = \fIfile\fR
82 The directory where masqmail stores its spool files (and later also other stuff).
83 It must have a subdirectory \fIinput\fR.
84 Masqmail needs read and write permissions for this directory.
85 I suggest to use \fI/var/spool/masqmail\fR.
86 \fIfile\fR must be an absolute path.
88 .TP
89 \fBhost_name = \fIstring\fR
91 This is used in different places: Masqmail identifies itself in the greeting banner
92 on incoming connections and in the HELO/EHLO command for outgoing connections with this name,
93 it is used in the Received: header and to qualify the sender of a locally originating message.
95 If the string begins with a slash `/', it it assumed that it is a filename,
96 and the first line of this file will be used.
97 Usually this will be `/etc/mailname' to make masqmail conform to Debian policies.
99 It is not used to find whether an address is local. Use \fBlocal_hosts\fR for that.
101 .TP
102 \fBremote_port = \fIn\fR
104 The remote port number to be used. This defaults to port 25.
106 This option is deprecated.
107 Use \fBhost_name\fR in the route configuration instead.
108 See \fBmasqmail.route(5)\fR.
110 .TP
111 \fBlocal_hosts = \fIlist\fR
113 A semicolon `;' separated list of hostnames which are considered local.
114 Normally you set it to "localhost;foo;foo.bar.com" if your host has the
115 fully qualified domain name `foo.bar.com'.
117 .TP
118 \fBlocal_nets = \fIlist\fR
120 A semicolon `;' separated list of hostnames which are on the `local' net.
121 Delivery to these hosts is attempted immediately.
122 You can use patterns with `*', e.g. "*.bar.com".
124 .TP
125 \fBlocal_addresses = \fIlist\fR
127 A semicolon `;' separated list of fully qualified email-addresses which are
128 considered local although their domain name part is not in the list of \fBlocal_hosts\fR.
130 For example: There are two people working at your LAN: person1@yourdomain and person2@yourdomain.
131 But there are other persons @yourdomain which are NOT local.
132 So you can not put yourdomain to the list of local_hosts.
133 If person1 now wants to write to person2@yourdomain and this mail should not leave the LAN then you can put
135 local_addresses = "person1@yourdomain;person2@yourdomain"
137 to your masqmail.conf.
139 .TP
140 \fBnot_local_addresses = \fIlist\fR
142 A semicolon `;' separated list of fully qualified email-addresses which are
143 considered not local although their domain name part is in the list of \fBlocal_hosts\fR.
145 This is the opposite of the previous case.
146 The majority of addresses of a specific domain are local.
147 But some users are not.
148 With this option you can easily exclude these users.
150 Example:
152 local_hosts = "localhost;myhost;mydomain.net"
154 not_local_addresses = "eric@mydomain.net"
156 .TP
157 \fBlisten_addresses = \fIlist\fR
159 A semicolon `;' separated list of interfaces on which connections will be accepted.
160 An interface ist defined by a hostname, optionally followed by a colon `:' and a number for the port.
161 If this is left out, port 25 will be used.
163 You can set this to "localhost:25;foo:25" if your hostname is `foo'.
165 Note that the names are resolved to IP addreses.
166 If your host has different names which resolve to the same IP,
167 use only one of them, otherwise you will get an error message.
169 .TP
170 \fBdo_save_envelope_to = \fIboolean\fR
172 If this is set to true, a possibly existing Envelope-to: header in an incoming mail
173 which is received via either pop3 or smtp will be saved as an X-Orig-Envelope-to: header.
175 This is useful if you retrieve mail from a pop3 server with either masqmail or fetchmail,
176 and the server supports Envelope-to: headers,
177 and you want to make use of those with a mail filtering tool, e.g. procmail.
178 It cannot be preserved because masqmail sets such a header by itself.
180 Default is false.
182 .TP
183 \fBdo_relay = \fIboolean\fR
185 If this is set to false, mail with a return path that is not local and a destination
186 that is also not local will not be accepted via smtp and a 550 reply will be given.
187 Default is true.
189 Note that this will not protect you from spammers using open relays,
190 but from users unable to set their address in their mail clients.
192 .TP
193 \fBdo_queue = \fIboolean\fR
195 If this is set, mail will not be delivered immediately when accepted.
196 Same as calling masqmail with the \fB\-odq\fR option.
198 .TP
199 \fBonline_routes.\fIname\fR = \fIlist\fR
201 Replace \fIname\fR with a name to identify a connection.
202 Set this to a filename (or a list of filenames) for the special route configuration for that connection.
203 You will use that name to call masqmail with the \fB\-qo\fR option every time a
204 connection to your ISP is set up.
206 Example: Your ISP has the name FastNet.
207 Then you write the following line in the main configuration:
209 \fBonline_routes.FastNet\fR = \fI"/etc/masqmail/fastnet.route"\fR
211 \fI/etc/masqmail/fastnet.route\fR is the route configuration file, see \fBmasqmail.route(5)\fR.
212 As soon as a link to FastNet has been set up, you call masqmail \fB\-qo \fIFastNet\fR.
213 Masqmail will then read the specified file and send the mails.
215 .TP
216 \fBconnect_route.\fIname\fR = \fIlist\fR
218 Old name for \fBonline_routes\fR.
220 .TP
221 \fBlocal_net_route = \fIfile\fR
223 This is similar to \fBonline_routes.\fIname\fR but for the local net.
224 Recipient addresses that are in local_nets will be routed using this route configuration.
225 Main purpose is to define a mail server with mail_host in your local network.
226 In simple environments this can be left unset.
227 If unset, a default route configuration will be used.
229 .TP
230 \fBalias_file = \fIfile\fR
232 Set this to the location of your alias file.
233 If unset, no aliasing will be done.
235 .TP
236 \fBalias_local_caseless = \fIboolean\fR
238 If this is set, local parts in the alias file will be matched disregarding upper/lower case.
240 .TP
241 \fBpipe_fromline = \fIboolean\fR
243 If this is set, a from line will be prepended to the output stream whenever
244 a pipe command is called after an alias expansion.
245 Default is false.
247 .TP
248 \fBpipe_fromhack = \fIboolean\fR
250 If this is set, each line beginning with `From ' is replaced with `>From '
251 whenever a pipe command is called after an alias expansion.
252 You probably want this if you have set \fBpipe_fromline\fR above.
253 Default is false.
255 .TP
256 \fBmbox_default = \fIstring\fR
258 The default local delivery method.
259 Can be one of mbox, mda or maildir (the latter only if maildir support is enabled at compile time).
260 Default is mbox.
261 You can override this for each user by using the \fBmbox_users\fR, \fBmda_users\fR,
262 or \fBmaildir_users\fR options (see below).
264 .TP
265 \fBmbox_users = \fIlist\fR
267 A list of users which wish delivery to an mbox style mail folder.
269 .TP
270 \fBmda_users = \fIlist\fR
272 A list of users which wish local delivery to an mda.
273 You have to set \fBmda\fR (see below) as well.
275 .TP
276 \fBmaildir_users = \fIlist\fR
278 A list of users which wish delivery to a qmail style maildir.
279 The path to maildir is ~/Maildir/.
280 The maildir will be created if it does not exist.
282 .TP
283 \fBmda = \fIexpand string\fR
285 If you want local delivery to be transferred to an mda (Mail Delivery Agent),
286 set this to a command.
287 The argument will be expanded on delivery time,
288 you can use variables beginning with a dolloar sign `$', optionally enclosed in curly braces.
289 Variables you can use are:
291 uid - the unique message id.
292 This is not necessarily identical with the Message ID as given in the Message ID: header.
294 received_host - the host the mail was received from
296 ident - the ident, this is either the ident delivered by the ident protocol
297 or the user id of the sender if the message was received locally.
299 return_path_local - the local part of the return path (sender).
301 return_path_domain - the domain part of the return path (sender).
303 return_path - the complete return path (sender).
305 rcpt_local - the local part of the recipient.
307 rcpt_domain - the domain part of the recipient.
309 rcpt - the complete recipient address.
311 Example:
313 mda="/usr/bin/procmail \-Y \-d ${rcpt_local}"
315 For the mda, as for pipe commands, a few environment variables will be set as well.
316 See \fBmasqmail(8)\fR.
317 To use environment variables for the mda, the dollar sign `$' has to be escaped with a backslash,
318 otherwise they will be tried to be expanded with the internal variables.
320 .TP
321 \fBmda_fromline = \fIboolean\fR
323 If this is set, a from line will be prepended to the output stream whenever
324 a message is delivered to an mda.
325 Default is false.
327 .TP
328 \fBmda_fromhack = \fIboolean\fR
330 If this is set, each line beginning with `From ' is replaced with `>From '
331 whenever a message is delivered to an mda.
332 You probably want this if you have set \fBmda_fromline\fR above.
333 Default is false.
335 .TP
336 \fBonline_detect = \fIstring\fR
338 Defines the method masqmail uses to detect whether there is currently an online connection.
339 It can have the values \fBfile\fR, \fBpipe\fR, or \fBmserver\fR.
341 When it is set to \fBfile\fR, masqmail first checks for the existence of \fBonline_file\fR
342 (see below) and if it exists, it reads it.
343 The content of the file should be the name of the current connection as defined
344 with \fBconnect_route.\fIname\fR (trailing whitespace is removed).
346 When it is set to \fBpipe\fR, masqmail calls the executable given by the
347 \fBonline_pipe\fR option (see below) and reads the current online status from its standard output.
349 When it is set to \fBmserver\fR, masqmail connects to the masqdialer server
350 using the value of \fBmserver_iface\fR and asks it whether a connection exists and for the name,
351 which should be the name of the current connection as defined with \fBconnect_route.\fIname\fR.
353 No matter how masqmail detects the online status,
354 only messages that are accepted at online time will be delivered using the connection.
355 The spool still has to be emptied with masqmail \fB\-qo\fIconnection\fR.
357 .TP
358 \fBonline_file = \fIfile\fR
360 This is the name of the file checked for when masqmail determines whether it is online.
361 The file should only exist when there is currently a connection.
362 Create it in your ip-up script with e.g.
364 echo \-n <name> > /var/run/masqmail/masqmail-route
366 chmod 0644 /var/run/masqmail/masqmail-route
368 Do not forget to delete it in your ip-down script.
370 .TP
371 \fBonline_pipe = \fIfile\fR
373 This is the name of the executable which will be called to determine the online status.
374 This executable should just print the name of the current connection to
375 the standard output and return a zero status code.
376 masqmail assumes it is offline if the script returns with a non zero status.
377 Simple example:
379 #!/bin/sh
381 [ \-e /var/run/masqmail/masqmail-route ] || exit 1
383 cat /var/run/masqmail/masqmail-route
385 exit 0
387 Of course, instead of the example above you could as well use \fBfile\fR as
388 the online detection method, but you can do something more sophisticated.
390 .TP
391 \fBmserver_iface = \fIinterface\fR
393 The interface the masqdialer server is listening to.
394 Usually this will be "localhost:224" if mserver is running on the same host as masqmail.
395 But using this option, you can also let masqmail run on another host by setting
396 \fBmserver_iface\fR to another hostname, e.g. "foo:224".
398 .TP
399 \fBget.\fIname\fR = \fIfile\fR
401 Replace \fIname\fR with a name to identify a get configuration.
402 Set this to a filename for the get configuration.
403 These files will be used to retrieve mail when called with the \-g option.
405 .TP
406 \fBonline_gets.\fIname\fR = \fIlist\fR
408 Replace \fIname\fR with a name to identify an online configuration.
409 Set this to a filename (or a list of filenames) for the get configuration.
410 These files will be used to retrieve mail when called with the \-go option.
412 .TP
413 \fBident_trusted_nets = \fIlist\fR
415 \fIlist\fR is a list of networks of the form a.b.c.d/e (e.g. 192.168.1.0/24),
416 from which the ident given by the ident protocol will be trusted,
417 so a user can delete his mail from the queue if the ident is identical to his login name.
419 .TP
420 \fBerrmsg_file = \fIfile\fR
422 Set this to a template which will be used to generate delivery failure reports.
423 Variable parts within the template begin with a dollar sign and are identical
424 to those which can be used as arguments for the mda command, see \fBmda\fR above.
425 Additional information can be included with @failed_rcpts, @msg_headers and @msg_body,
426 these must be at the beginning of a line and will be replaced with the list of the failed recipients,
427 the message headers and the message body of the failed message.
429 Default is /usr/share/masqmail/tpl/failmsg.tpl.
431 .TP
432 \fBwarnmsg_file = \fIfile\fR
434 Set this to a template which will be used to generate delivery warning reports.
435 It uses the same mechanisms for variables as \fBerrmsg_file\fR, see above.
437 Default is /usr/share/masqmail/tpl/warnmsg.tpl.
439 .TP
440 \fBwarn_intervals\fR = \fIlist\fR
442 Set this to a list of time intervals, at which delivery warnings
443 (starting with the receiving time of the message) shall be generated.
445 A warning will only be generated just after an attempt to deliver the mail
446 and if that attempt failed temporarily.
447 So a warning may be generated after a longer time, if there was no attempt before.
449 Default is "1h;4h;8h;1d;2d;3d"
451 .TP
452 \fBmax_defer_time\fR = \fItime\fR
454 This is the maximum time, in which a temporarily failed mail will be kept in the spool.
455 When this time is exceeded, it will be handled as a delivery failure,
456 and the message will be bounced.
458 The excedence of this time will only be noticed if the message was actually tried to be delivered.
459 If, for example, the message can only be delivered when online,
460 but you have not been online for that time, no bounce will be generated.
462 Default is 4d (4 days)
464 .TP
465 \fBlog_user = \fIname\fR
467 Replace \fIname\fR with a valid local or remote mail address.
469 If this option is set, then a copy of every mail,
470 that passes through the masqmail system will also be sent to the given mail address.
472 For example you can feed your mails into a program like hypermail
473 for archiving purpose by placing an appropriate pipe command in masqmail.alias
476 .SH AUTHOR
478 Masqmail was written by Oliver Kurth.
479 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
481 You will find the newest version of masqmail at \fBhttp://prog.marmaro.de/masqmail/\fR.
482 There is also a mailing list, you will find information about it at masqmail's main site.
485 .SH BUGS
487 Please report bugs to the mailing list.
490 .SH SEE ALSO
492 \fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.get(5)\fR