masqmail
view man/masqmail.conf.5 @ 152:dfb6143e7832
mail_dir defaults to /var/mail now
hence one usually does not need to specify it in masqmail.conf
| author | meillo@marmaro.de |
|---|---|
| date | Wed, 07 Jul 2010 13:34:19 +0200 |
| parents | e20fe8c9936a |
| children | 51d8eadf3c79 |
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 \fIfile\fR must be an absolute path.
72 Default: \fI/var/log/masqmail\fR
74 .TP
75 \fBmail_dir = \fIfile\fR
77 The directory where local mail is stored, usually \fI/var/spool/mail\fR or \fI/var/mail\fR.
78 \fIfile\fR must be an absolute path.
80 Default: \fI/var/mail\fR
82 .TP
83 \fBspool_dir = \fIfile\fR
85 The directory where masqmail stores its spool files (and later also other stuff).
86 It must have a subdirectory \fIinput\fR.
87 Masqmail needs read and write permissions for this directory.
88 \fIfile\fR must be an absolute path.
90 Default: \fI/var/spool/masqmail\fR
92 .TP
93 \fBlock_dir = \fIfile\fR
95 The directory where masqmail stores its lock files.
96 Masqmail needs read and write permissions for this directory.
97 By default it is a directory ``lock'' inside of \fIspool_dir\fP.
98 \fIfile\fR must be an absolute path.
100 .TP
101 \fBhost_name = \fIstring\fR
103 This is used in different places: Masqmail identifies itself in the greeting banner
104 on incoming connections and in the HELO/EHLO command for outgoing connections with this name,
105 it is used in the Received: header and to qualify the sender of a locally originating message.
107 If the string begins with a slash `/', it it assumed that it is a filename,
108 and the first line of this file will be used.
109 Usually this will be `/etc/mailname' to make masqmail conform to Debian policies.
111 It is not used to find whether an address is local. Use \fBlocal_hosts\fR for that.
113 .TP
114 \fBremote_port = \fIn\fR
116 The remote port number to be used. This defaults to port 25.
118 This option is deprecated.
119 Use \fBhost_name\fR in the route configuration instead.
120 See \fBmasqmail.route(5)\fR.
122 .TP
123 \fBlocal_hosts = \fIlist\fR
125 A semicolon `;' separated list of hostnames which are considered local.
126 Normally you set it to "localhost;foo;foo.bar.com" if your host has the
127 fully qualified domain name `foo.bar.com'.
129 .TP
130 \fBlocal_nets = \fIlist\fR
132 A semicolon `;' separated list of hostnames which are on the `local' net.
133 Delivery to these hosts is attempted immediately.
134 You can use patterns with `*', e.g. "*.bar.com".
136 .TP
137 \fBlocal_addresses = \fIlist\fR
139 A semicolon `;' separated list of fully qualified email-addresses which are
140 considered local although their domain name part is not in the list of \fBlocal_hosts\fR.
142 For example: There are two people working at your LAN: person1@yourdomain and person2@yourdomain.
143 But there are other persons @yourdomain which are NOT local.
144 So you can not put yourdomain to the list of local_hosts.
145 If person1 now wants to write to person2@yourdomain and this mail should not leave the LAN then you can put
147 local_addresses = "person1@yourdomain;person2@yourdomain"
149 to your masqmail.conf.
151 .TP
152 \fBnot_local_addresses = \fIlist\fR
154 A semicolon `;' separated list of fully qualified email-addresses which are
155 considered not local although their domain name part is in the list of \fBlocal_hosts\fR.
157 This is the opposite of the previous case.
158 The majority of addresses of a specific domain are local.
159 But some users are not.
160 With this option you can easily exclude these users.
162 Example:
164 local_hosts = "localhost;myhost;mydomain.net"
166 not_local_addresses = "eric@mydomain.net"
168 .TP
169 \fBlisten_addresses = \fIlist\fR
171 A semicolon `;' separated list of interfaces on which connections will be accepted.
172 An interface ist defined by a hostname, optionally followed by a colon `:' and a number for the port.
173 If this is left out, port 25 will be used.
175 You can set this to "localhost:25;foo:25" if your hostname is `foo'.
177 Note that the names are resolved to IP addreses.
178 If your host has different names which resolve to the same IP,
179 use only one of them, otherwise you will get an error message.
181 .TP
182 \fBdo_save_envelope_to = \fIboolean\fR
184 If this is set to true, a possibly existing Envelope-to: header in an incoming mail
185 which is received via either pop3 or smtp will be saved as an X-Orig-Envelope-to: header.
187 This is useful if you retrieve mail from a pop3 server with either masqmail or fetchmail,
188 and the server supports Envelope-to: headers,
189 and you want to make use of those with a mail filtering tool, e.g. procmail.
190 It cannot be preserved because masqmail sets such a header by itself.
192 Default is false.
194 .TP
195 \fBdo_relay = \fIboolean\fR
197 If this is set to false, mail with a return path that is not local and a destination
198 that is also not local will not be accepted via smtp and a 550 reply will be given.
199 Default is true.
201 Note that this will not protect you from spammers using open relays,
202 but from users unable to set their address in their mail clients.
204 .TP
205 \fBdo_queue = \fIboolean\fR
207 If this is set, mail will not be delivered immediately when accepted.
208 Same as calling masqmail with the \fB\-odq\fR option.
210 .TP
211 \fBonline_routes.\fIname\fR = \fIlist\fR
213 Replace \fIname\fR with a name to identify a connection.
214 Set this to a filename (or a list of filenames) for the special route configuration for that connection.
215 You will use that name to call masqmail with the \fB\-qo\fR option every time a
216 connection to your ISP is set up.
218 Example: Your ISP has the name FastNet.
219 Then you write the following line in the main configuration:
221 \fBonline_routes.FastNet\fR = \fI"/etc/masqmail/fastnet.route"\fR
223 \fI/etc/masqmail/fastnet.route\fR is the route configuration file, see \fBmasqmail.route(5)\fR.
224 As soon as a link to FastNet has been set up, you call masqmail \fB\-qo \fIFastNet\fR.
225 Masqmail will then read the specified file and send the mails.
227 .TP
228 \fBconnect_route.\fIname\fR = \fIlist\fR
230 Old name for \fBonline_routes\fR.
232 .TP
233 \fBlocal_net_route = \fIfile\fR
235 This is similar to \fBonline_routes.\fIname\fR but for the local net.
236 Recipient addresses that are in local_nets will be routed using this route configuration.
237 Main purpose is to define a mail server with mail_host in your local network.
238 In simple environments this can be left unset.
239 If unset, a default route configuration will be used.
241 .TP
242 \fBalias_file = \fIfile\fR
244 Set this to the location of your alias file.
245 If unset, no aliasing will be done.
247 .TP
248 \fBalias_local_caseless = \fIboolean\fR
250 If this is set, local parts in the alias file will be matched disregarding upper/lower case.
252 .TP
253 \fBpipe_fromline = \fIboolean\fR
255 If this is set, a from line will be prepended to the output stream whenever
256 a pipe command is called after an alias expansion.
257 Default is false.
259 .TP
260 \fBpipe_fromhack = \fIboolean\fR
262 If this is set, each line beginning with `From ' is replaced with `>From '
263 whenever a pipe command is called after an alias expansion.
264 You probably want this if you have set \fBpipe_fromline\fR above.
265 Default is false.
267 .TP
268 \fBmbox_default = \fIstring\fR
270 The default local delivery method.
271 Can be one of mbox, mda or maildir (the latter only if maildir support is enabled at compile time).
272 Default is mbox.
273 You can override this for each user by using the \fBmbox_users\fR, \fBmda_users\fR,
274 or \fBmaildir_users\fR options (see below).
276 .TP
277 \fBmbox_users = \fIlist\fR
279 A list of users which wish delivery to an mbox style mail folder.
281 .TP
282 \fBmda_users = \fIlist\fR
284 A list of users which wish local delivery to an mda.
285 You have to set \fBmda\fR (see below) as well.
287 .TP
288 \fBmaildir_users = \fIlist\fR
290 A list of users which wish delivery to a qmail style maildir.
291 The path to maildir is ~/Maildir/.
292 The maildir will be created if it does not exist.
294 .TP
295 \fBmda = \fIexpand string\fR
297 If you want local delivery to be transferred to an mda (Mail Delivery Agent),
298 set this to a command.
299 The argument will be expanded on delivery time,
300 you can use variables beginning with a dolloar sign `$', optionally enclosed in curly braces.
301 Variables you can use are:
303 uid - the unique message id.
304 This is not necessarily identical with the Message ID as given in the Message ID: header.
306 received_host - the host the mail was received from
308 ident - the ident, this is either the ident delivered by the ident protocol
309 or the user id of the sender if the message was received locally.
311 return_path_local - the local part of the return path (sender).
313 return_path_domain - the domain part of the return path (sender).
315 return_path - the complete return path (sender).
317 rcpt_local - the local part of the recipient.
319 rcpt_domain - the domain part of the recipient.
321 rcpt - the complete recipient address.
323 Example:
325 mda="/usr/bin/procmail \-Y \-d ${rcpt_local}"
327 For the mda, as for pipe commands, a few environment variables will be set as well.
328 See \fBmasqmail(8)\fR.
329 To use environment variables for the mda, the dollar sign `$' has to be escaped with a backslash,
330 otherwise they will be tried to be expanded with the internal variables.
332 .TP
333 \fBmda_fromline = \fIboolean\fR
335 If this is set, a from line will be prepended to the output stream whenever
336 a message is delivered to an mda.
337 Default is false.
339 .TP
340 \fBmda_fromhack = \fIboolean\fR
342 If this is set, each line beginning with `From ' is replaced with `>From '
343 whenever a message is delivered to an mda.
344 You probably want this if you have set \fBmda_fromline\fR above.
345 Default is false.
347 .TP
348 \fBonline_detect = \fIstring\fR
350 Defines the method masqmail uses to detect whether there is currently an online connection.
351 It can have the values \fIfile\fR, \fIpipe\fR, or \fImserver\fR.
353 When it is set to \fIfile\fR, masqmail first checks for the existence of \fBonline_file\fR
354 (see below) and if it exists, it reads it.
355 The content of the file should be the name of the current connection as defined
356 with \fBconnect_route.\fIname\fR (trailing whitespace is removed).
358 When it is set to \fIpipe\fR, masqmail calls the executable given by the
359 \fBonline_pipe\fR option (see below) and reads the current online status from its standard output.
361 When it is set to \fImserver\fR, masqmail connects to the masqdialer server
362 using the value of \fBmserver_iface\fR and asks it whether a connection exists and for the name,
363 which should be the name of the current connection as defined with \fBconnect_route.\fIname\fR.
364 \fBThe mserver detection method is OBSOLETE.\fR
365 See mserver_iface for a note on how to replace it.
367 No matter how masqmail detects the online status,
368 only messages that are accepted at online time will be delivered using the connection.
369 The spool still has to be emptied with masqmail \fB\-qo\fIconnection\fR.
371 .TP
372 \fBonline_file = \fIfile\fR
374 This is the name of the file checked for when masqmail determines whether it is online.
375 The file should only exist when there is currently a connection.
376 Create it in your ip-up script with e.g.
378 echo "connection-name" >/var/run/masqmail/masqmail-route
380 chmod 0644 /var/run/masqmail/masqmail-route
382 Do not forget to delete it in your ip-down script.
384 .TP
385 \fBonline_pipe = \fIfile\fR
387 This is the name of the executable which will be called to determine the online status.
388 This executable should just print the name of the current connection to
389 the standard output and return a zero status code.
390 masqmail assumes it is offline if the script returns with a non zero status.
391 Simple example:
393 #!/bin/sh
395 [ \-e /var/run/masqmail/masqmail-route ] || exit 1
397 cat /var/run/masqmail/masqmail-route
399 exit 0
401 Of course, instead of the example above you could as well use \fIfile\fR as
402 the online detection method, but you can do something more sophisticated.
404 .TP
405 \fBmserver_iface = \fIinterface\fR
407 \fBThis option is OBSOLETE\fP, use
409 online_method=pipe
411 online_pipe="/usr/bin/mservdetect localhost 222"
413 instead.
415 The interface the masqdialer server is listening to.
416 Usually this will be "localhost:224" if mserver is running on the same host as masqmail.
417 But using this option, you can also let masqmail run on another host by setting
418 \fBmserver_iface\fR to another hostname, e.g. "foo:224".
420 .TP
421 \fBget.\fIname\fR = \fIfile\fR
423 Replace \fIname\fR with a name to identify a get configuration.
424 Set this to a filename for the get configuration.
425 These files will be used to retrieve mail when called with the \-g option.
427 .TP
428 \fBonline_gets.\fIname\fR = \fIlist\fR
430 Replace \fIname\fR with a name to identify an online configuration.
431 Set this to a filename (or a list of filenames) for the get configuration.
432 These files will be used to retrieve mail when called with the \-go option.
434 .TP
435 \fBident_trusted_nets = \fIlist\fR
437 \fIlist\fR is a list of networks of the form a.b.c.d/e (e.g. 192.168.1.0/24),
438 from which the ident given by the ident protocol will be trusted,
439 so a user can delete his mail from the queue if the ident is identical to his login name.
441 .TP
442 \fBerrmsg_file = \fIfile\fR
444 Set this to a template which will be used to generate delivery failure reports.
445 Variable parts within the template begin with a dollar sign and are identical
446 to those which can be used as arguments for the mda command, see \fBmda\fR above.
447 Additional information can be included with @failed_rcpts, @msg_headers and @msg_body,
448 these must be at the beginning of a line and will be replaced with the list of the failed recipients,
449 the message headers and the message body of the failed message.
451 Default is /usr/share/masqmail/tpl/failmsg.tpl.
453 .TP
454 \fBwarnmsg_file = \fIfile\fR
456 Set this to a template which will be used to generate delivery warning reports.
457 It uses the same mechanisms for variables as \fBerrmsg_file\fR, see above.
459 Default is /usr/share/masqmail/tpl/warnmsg.tpl.
461 .TP
462 \fBwarn_intervals\fR = \fIlist\fR
464 Set this to a list of time intervals, at which delivery warnings
465 (starting with the receiving time of the message) shall be generated.
467 A warning will only be generated just after an attempt to deliver the mail
468 and if that attempt failed temporarily.
469 So a warning may be generated after a longer time, if there was no attempt before.
471 Default is "1h;4h;8h;1d;2d;3d"
473 .TP
474 \fBmax_defer_time\fR = \fItime\fR
476 This is the maximum time, in which a temporarily failed mail will be kept in the spool.
477 When this time is exceeded, it will be handled as a delivery failure,
478 and the message will be bounced.
480 The excedence of this time will only be noticed if the message was actually tried to be delivered.
481 If, for example, the message can only be delivered when online,
482 but you have not been online for that time, no bounce will be generated.
484 Default is 4d (4 days)
486 .TP
487 \fBlog_user = \fIname\fR
489 Replace \fIname\fR with a valid local or remote mail address.
491 If this option is set, then a copy of every mail,
492 that passes through the masqmail system will also be sent to the given mail address.
494 For example you can feed your mails into a program like hypermail
495 for archiving purpose by placing an appropriate pipe command in masqmail.alias
497 .TP
498 \fBmax_msg_size\fR = \fIbytes\fR
500 This option sets the maximum size in bytes masqmail will accept for delivery.
501 This value is advertised to the SMTP client by the `SIZE' message during SMTP
502 session setup.
503 Clients pretending to send, or actually send,
504 more than \fIbytes\fR will get a 552 error message.
506 `0' means no fixed maximum size limit is in force.
508 Default is 0 (= unlimited).
510 .TP
511 \fBdefer_all\fR = \fIboolean\fR
513 If set to true, masqmail replies with ``421 service temporarily unavailable''
514 to any SMTP request and shuts the connection down.
515 Note: This option is for debugging purposes only.
517 Default: false
520 .SH AUTHOR
522 Masqmail was written by Oliver Kurth.
523 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
525 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
526 There is also a mailing list, you will find information about it at masqmail's main site.
529 .SH BUGS
531 Please report bugs to the mailing list.
534 .SH SEE ALSO
536 \fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.get(5)\fR