masqmail
view man/masqmail.conf.5 @ 140:867bb186a829
added a script that checks the documentation coverage of config options
| author | meillo@marmaro.de |
|---|---|
| date | Tue, 06 Jul 2010 17:43:31 +0200 |
| parents | 43a9447c3583 |
| children | e20fe8c9936a dbe3dadd1afe |
line source
1 .TH masqmail.conf 5 2010-07-06 masqmail-0.2.25 "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 \fBlock_dir = \fIfile\fR
91 The directory where masqmail stores its lock files.
92 Masqmail needs read and write permissions for this directory.
93 By default it is a directory ``lock'' inside of \fIspool_dir\fP.
94 \fIfile\fR must be an absolute path.
96 .TP
97 \fBhost_name = \fIstring\fR
99 This is used in different places: Masqmail identifies itself in the greeting banner
100 on incoming connections and in the HELO/EHLO command for outgoing connections with this name,
101 it is used in the Received: header and to qualify the sender of a locally originating message.
103 If the string begins with a slash `/', it it assumed that it is a filename,
104 and the first line of this file will be used.
105 Usually this will be `/etc/mailname' to make masqmail conform to Debian policies.
107 It is not used to find whether an address is local. Use \fBlocal_hosts\fR for that.
109 .TP
110 \fBremote_port = \fIn\fR
112 The remote port number to be used. This defaults to port 25.
114 This option is deprecated.
115 Use \fBhost_name\fR in the route configuration instead.
116 See \fBmasqmail.route(5)\fR.
118 .TP
119 \fBlocal_hosts = \fIlist\fR
121 A semicolon `;' separated list of hostnames which are considered local.
122 Normally you set it to "localhost;foo;foo.bar.com" if your host has the
123 fully qualified domain name `foo.bar.com'.
125 .TP
126 \fBlocal_nets = \fIlist\fR
128 A semicolon `;' separated list of hostnames which are on the `local' net.
129 Delivery to these hosts is attempted immediately.
130 You can use patterns with `*', e.g. "*.bar.com".
132 .TP
133 \fBlocal_addresses = \fIlist\fR
135 A semicolon `;' separated list of fully qualified email-addresses which are
136 considered local although their domain name part is not in the list of \fBlocal_hosts\fR.
138 For example: There are two people working at your LAN: person1@yourdomain and person2@yourdomain.
139 But there are other persons @yourdomain which are NOT local.
140 So you can not put yourdomain to the list of local_hosts.
141 If person1 now wants to write to person2@yourdomain and this mail should not leave the LAN then you can put
143 local_addresses = "person1@yourdomain;person2@yourdomain"
145 to your masqmail.conf.
147 .TP
148 \fBnot_local_addresses = \fIlist\fR
150 A semicolon `;' separated list of fully qualified email-addresses which are
151 considered not local although their domain name part is in the list of \fBlocal_hosts\fR.
153 This is the opposite of the previous case.
154 The majority of addresses of a specific domain are local.
155 But some users are not.
156 With this option you can easily exclude these users.
158 Example:
160 local_hosts = "localhost;myhost;mydomain.net"
162 not_local_addresses = "eric@mydomain.net"
164 .TP
165 \fBlisten_addresses = \fIlist\fR
167 A semicolon `;' separated list of interfaces on which connections will be accepted.
168 An interface ist defined by a hostname, optionally followed by a colon `:' and a number for the port.
169 If this is left out, port 25 will be used.
171 You can set this to "localhost:25;foo:25" if your hostname is `foo'.
173 Note that the names are resolved to IP addreses.
174 If your host has different names which resolve to the same IP,
175 use only one of them, otherwise you will get an error message.
177 .TP
178 \fBdo_save_envelope_to = \fIboolean\fR
180 If this is set to true, a possibly existing Envelope-to: header in an incoming mail
181 which is received via either pop3 or smtp will be saved as an X-Orig-Envelope-to: header.
183 This is useful if you retrieve mail from a pop3 server with either masqmail or fetchmail,
184 and the server supports Envelope-to: headers,
185 and you want to make use of those with a mail filtering tool, e.g. procmail.
186 It cannot be preserved because masqmail sets such a header by itself.
188 Default is false.
190 .TP
191 \fBdo_relay = \fIboolean\fR
193 If this is set to false, mail with a return path that is not local and a destination
194 that is also not local will not be accepted via smtp and a 550 reply will be given.
195 Default is true.
197 Note that this will not protect you from spammers using open relays,
198 but from users unable to set their address in their mail clients.
200 .TP
201 \fBdo_queue = \fIboolean\fR
203 If this is set, mail will not be delivered immediately when accepted.
204 Same as calling masqmail with the \fB\-odq\fR option.
206 .TP
207 \fBonline_routes.\fIname\fR = \fIlist\fR
209 Replace \fIname\fR with a name to identify a connection.
210 Set this to a filename (or a list of filenames) for the special route configuration for that connection.
211 You will use that name to call masqmail with the \fB\-qo\fR option every time a
212 connection to your ISP is set up.
214 Example: Your ISP has the name FastNet.
215 Then you write the following line in the main configuration:
217 \fBonline_routes.FastNet\fR = \fI"/etc/masqmail/fastnet.route"\fR
219 \fI/etc/masqmail/fastnet.route\fR is the route configuration file, see \fBmasqmail.route(5)\fR.
220 As soon as a link to FastNet has been set up, you call masqmail \fB\-qo \fIFastNet\fR.
221 Masqmail will then read the specified file and send the mails.
223 .TP
224 \fBconnect_route.\fIname\fR = \fIlist\fR
226 Old name for \fBonline_routes\fR.
228 .TP
229 \fBlocal_net_route = \fIfile\fR
231 This is similar to \fBonline_routes.\fIname\fR but for the local net.
232 Recipient addresses that are in local_nets will be routed using this route configuration.
233 Main purpose is to define a mail server with mail_host in your local network.
234 In simple environments this can be left unset.
235 If unset, a default route configuration will be used.
237 .TP
238 \fBalias_file = \fIfile\fR
240 Set this to the location of your alias file.
241 If unset, no aliasing will be done.
243 .TP
244 \fBalias_local_caseless = \fIboolean\fR
246 If this is set, local parts in the alias file will be matched disregarding upper/lower case.
248 .TP
249 \fBpipe_fromline = \fIboolean\fR
251 If this is set, a from line will be prepended to the output stream whenever
252 a pipe command is called after an alias expansion.
253 Default is false.
255 .TP
256 \fBpipe_fromhack = \fIboolean\fR
258 If this is set, each line beginning with `From ' is replaced with `>From '
259 whenever a pipe command is called after an alias expansion.
260 You probably want this if you have set \fBpipe_fromline\fR above.
261 Default is false.
263 .TP
264 \fBmbox_default = \fIstring\fR
266 The default local delivery method.
267 Can be one of mbox, mda or maildir (the latter only if maildir support is enabled at compile time).
268 Default is mbox.
269 You can override this for each user by using the \fBmbox_users\fR, \fBmda_users\fR,
270 or \fBmaildir_users\fR options (see below).
272 .TP
273 \fBmbox_users = \fIlist\fR
275 A list of users which wish delivery to an mbox style mail folder.
277 .TP
278 \fBmda_users = \fIlist\fR
280 A list of users which wish local delivery to an mda.
281 You have to set \fBmda\fR (see below) as well.
283 .TP
284 \fBmaildir_users = \fIlist\fR
286 A list of users which wish delivery to a qmail style maildir.
287 The path to maildir is ~/Maildir/.
288 The maildir will be created if it does not exist.
290 .TP
291 \fBmda = \fIexpand string\fR
293 If you want local delivery to be transferred to an mda (Mail Delivery Agent),
294 set this to a command.
295 The argument will be expanded on delivery time,
296 you can use variables beginning with a dolloar sign `$', optionally enclosed in curly braces.
297 Variables you can use are:
299 uid - the unique message id.
300 This is not necessarily identical with the Message ID as given in the Message ID: header.
302 received_host - the host the mail was received from
304 ident - the ident, this is either the ident delivered by the ident protocol
305 or the user id of the sender if the message was received locally.
307 return_path_local - the local part of the return path (sender).
309 return_path_domain - the domain part of the return path (sender).
311 return_path - the complete return path (sender).
313 rcpt_local - the local part of the recipient.
315 rcpt_domain - the domain part of the recipient.
317 rcpt - the complete recipient address.
319 Example:
321 mda="/usr/bin/procmail \-Y \-d ${rcpt_local}"
323 For the mda, as for pipe commands, a few environment variables will be set as well.
324 See \fBmasqmail(8)\fR.
325 To use environment variables for the mda, the dollar sign `$' has to be escaped with a backslash,
326 otherwise they will be tried to be expanded with the internal variables.
328 .TP
329 \fBmda_fromline = \fIboolean\fR
331 If this is set, a from line will be prepended to the output stream whenever
332 a message is delivered to an mda.
333 Default is false.
335 .TP
336 \fBmda_fromhack = \fIboolean\fR
338 If this is set, each line beginning with `From ' is replaced with `>From '
339 whenever a message is delivered to an mda.
340 You probably want this if you have set \fBmda_fromline\fR above.
341 Default is false.
343 .TP
344 \fBonline_detect = \fIstring\fR
346 Defines the method masqmail uses to detect whether there is currently an online connection.
347 It can have the values \fIfile\fR, \fIpipe\fR, or \fImserver\fR.
349 When it is set to \fIfile\fR, masqmail first checks for the existence of \fBonline_file\fR
350 (see below) and if it exists, it reads it.
351 The content of the file should be the name of the current connection as defined
352 with \fBconnect_route.\fIname\fR (trailing whitespace is removed).
354 When it is set to \fIpipe\fR, masqmail calls the executable given by the
355 \fBonline_pipe\fR option (see below) and reads the current online status from its standard output.
357 When it is set to \fImserver\fR, masqmail connects to the masqdialer server
358 using the value of \fBmserver_iface\fR and asks it whether a connection exists and for the name,
359 which should be the name of the current connection as defined with \fBconnect_route.\fIname\fR.
360 \fBThe mserver detection method is OBSOLETE.\fR
361 See mserver_iface for a note on how to replace it.
363 No matter how masqmail detects the online status,
364 only messages that are accepted at online time will be delivered using the connection.
365 The spool still has to be emptied with masqmail \fB\-qo\fIconnection\fR.
367 .TP
368 \fBonline_file = \fIfile\fR
370 This is the name of the file checked for when masqmail determines whether it is online.
371 The file should only exist when there is currently a connection.
372 Create it in your ip-up script with e.g.
374 echo "connection-name" >/var/run/masqmail/masqmail-route
376 chmod 0644 /var/run/masqmail/masqmail-route
378 Do not forget to delete it in your ip-down script.
380 .TP
381 \fBonline_pipe = \fIfile\fR
383 This is the name of the executable which will be called to determine the online status.
384 This executable should just print the name of the current connection to
385 the standard output and return a zero status code.
386 masqmail assumes it is offline if the script returns with a non zero status.
387 Simple example:
389 #!/bin/sh
391 [ \-e /var/run/masqmail/masqmail-route ] || exit 1
393 cat /var/run/masqmail/masqmail-route
395 exit 0
397 Of course, instead of the example above you could as well use \fIfile\fR as
398 the online detection method, but you can do something more sophisticated.
400 .TP
401 \fBmserver_iface = \fIinterface\fR
403 \fBThis option is OBSOLETE\fP, use
405 online_method=pipe
407 online_pipe="/usr/bin/mservdetect localhost 222"
409 instead.
411 The interface the masqdialer server is listening to.
412 Usually this will be "localhost:224" if mserver is running on the same host as masqmail.
413 But using this option, you can also let masqmail run on another host by setting
414 \fBmserver_iface\fR to another hostname, e.g. "foo:224".
416 .TP
417 \fBget.\fIname\fR = \fIfile\fR
419 Replace \fIname\fR with a name to identify a get configuration.
420 Set this to a filename for the get configuration.
421 These files will be used to retrieve mail when called with the \-g option.
423 .TP
424 \fBonline_gets.\fIname\fR = \fIlist\fR
426 Replace \fIname\fR with a name to identify an online configuration.
427 Set this to a filename (or a list of filenames) for the get configuration.
428 These files will be used to retrieve mail when called with the \-go option.
430 .TP
431 \fBident_trusted_nets = \fIlist\fR
433 \fIlist\fR is a list of networks of the form a.b.c.d/e (e.g. 192.168.1.0/24),
434 from which the ident given by the ident protocol will be trusted,
435 so a user can delete his mail from the queue if the ident is identical to his login name.
437 .TP
438 \fBerrmsg_file = \fIfile\fR
440 Set this to a template which will be used to generate delivery failure reports.
441 Variable parts within the template begin with a dollar sign and are identical
442 to those which can be used as arguments for the mda command, see \fBmda\fR above.
443 Additional information can be included with @failed_rcpts, @msg_headers and @msg_body,
444 these must be at the beginning of a line and will be replaced with the list of the failed recipients,
445 the message headers and the message body of the failed message.
447 Default is /usr/share/masqmail/tpl/failmsg.tpl.
449 .TP
450 \fBwarnmsg_file = \fIfile\fR
452 Set this to a template which will be used to generate delivery warning reports.
453 It uses the same mechanisms for variables as \fBerrmsg_file\fR, see above.
455 Default is /usr/share/masqmail/tpl/warnmsg.tpl.
457 .TP
458 \fBwarn_intervals\fR = \fIlist\fR
460 Set this to a list of time intervals, at which delivery warnings
461 (starting with the receiving time of the message) shall be generated.
463 A warning will only be generated just after an attempt to deliver the mail
464 and if that attempt failed temporarily.
465 So a warning may be generated after a longer time, if there was no attempt before.
467 Default is "1h;4h;8h;1d;2d;3d"
469 .TP
470 \fBmax_defer_time\fR = \fItime\fR
472 This is the maximum time, in which a temporarily failed mail will be kept in the spool.
473 When this time is exceeded, it will be handled as a delivery failure,
474 and the message will be bounced.
476 The excedence of this time will only be noticed if the message was actually tried to be delivered.
477 If, for example, the message can only be delivered when online,
478 but you have not been online for that time, no bounce will be generated.
480 Default is 4d (4 days)
482 .TP
483 \fBlog_user = \fIname\fR
485 Replace \fIname\fR with a valid local or remote mail address.
487 If this option is set, then a copy of every mail,
488 that passes through the masqmail system will also be sent to the given mail address.
490 For example you can feed your mails into a program like hypermail
491 for archiving purpose by placing an appropriate pipe command in masqmail.alias
493 .TP
494 \fBmax_msg_size\fR = \fIbytes\fR
496 This option sets the maximum size in bytes masqmail will accept for delivery.
497 This value is advertised to the SMTP client by the `SIZE' message during SMTP
498 session setup.
499 Clients pretending to send, or actually send,
500 more than \fIbytes\fR will get a 552 error message.
502 `0' means no fixed maximum size limit is in force.
504 Default is 0 (= unlimited).
506 .TP
507 \fBdefer_all\fR = \fIboolean\fR
509 If set to true, masqmail replies with ``421 service temporarily unavailable''
510 to any SMTP request and shuts the connection down.
511 Note: This option is for debugging purposes only.
513 Default: false
516 .SH AUTHOR
518 Masqmail was written by Oliver Kurth.
519 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
521 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
522 There is also a mailing list, you will find information about it at masqmail's main site.
525 .SH BUGS
527 Please report bugs to the mailing list.
530 .SH SEE ALSO
532 \fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.get(5)\fR