masqmail
view man/masqmail.conf.5 @ 156:ee2afbf92428
require host_name to be set in config file
exit otherwise
there is no portable way to determine the hostname
(actually the hostname that masqmail should use)
thus it must be set by the administrator
| author | meillo@marmaro.de |
|---|---|
| date | Thu, 08 Jul 2010 09:49:05 +0200 |
| parents | 51d8eadf3c79 |
| children | 586f001f5bbd |
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 Default: none; \fBhost_name\fP MUST be set in the config file
115 .TP
116 \fBremote_port = \fIn\fR
118 The remote port number to be used. This defaults to port 25.
120 This option is deprecated.
121 Use \fBhost_name\fR in the route configuration instead.
122 See \fBmasqmail.route(5)\fR.
124 .TP
125 \fBlocal_hosts = \fIlist\fR
127 A semicolon `;' separated list of hostnames which are considered local.
128 Normally you should set it to "localhost;foo;foo.bar.com" if your host has the
129 fully qualified domain name `foo.bar.com'.
131 Default: \fIlocalhost\fR
133 .TP
134 \fBlocal_nets = \fIlist\fR
136 A semicolon `;' separated list of hostnames which are on the `local' net.
137 Delivery to these hosts is attempted immediately.
138 You can use patterns with `*', e.g. "*.bar.com".
140 .TP
141 \fBlocal_addresses = \fIlist\fR
143 A semicolon `;' separated list of fully qualified email-addresses which are
144 considered local although their domain name part is not in the list of \fBlocal_hosts\fR.
146 For example: There are two people working at your LAN: person1@yourdomain and person2@yourdomain.
147 But there are other persons @yourdomain which are NOT local.
148 So you can not put yourdomain to the list of local_hosts.
149 If person1 now wants to write to person2@yourdomain and this mail should not leave the LAN then you can put
151 local_addresses = "person1@yourdomain;person2@yourdomain"
153 to your masqmail.conf.
155 .TP
156 \fBnot_local_addresses = \fIlist\fR
158 A semicolon `;' separated list of fully qualified email-addresses which are
159 considered not local although their domain name part is in the list of \fBlocal_hosts\fR.
161 This is the opposite of the previous case.
162 The majority of addresses of a specific domain are local.
163 But some users are not.
164 With this option you can easily exclude these users.
166 Example:
168 local_hosts = "localhost;myhost;mydomain.net"
170 not_local_addresses = "eric@mydomain.net"
172 .TP
173 \fBlisten_addresses = \fIlist\fR
175 A semicolon `;' separated list of interfaces on which connections will be accepted.
176 An interface ist defined by a hostname, optionally followed by a colon `:' and a number for the port.
177 If this is left out, port 25 will be used.
179 You can set this to "localhost:25;foo:25" if your hostname is `foo'.
181 Note that the names are resolved to IP addreses.
182 If your host has different names which resolve to the same IP,
183 use only one of them, otherwise you will get an error message.
185 .TP
186 \fBdo_save_envelope_to = \fIboolean\fR
188 If this is set to true, a possibly existing Envelope-to: header in an incoming mail
189 which is received via either pop3 or smtp will be saved as an X-Orig-Envelope-to: header.
191 This is useful if you retrieve mail from a pop3 server with either masqmail or fetchmail,
192 and the server supports Envelope-to: headers,
193 and you want to make use of those with a mail filtering tool, e.g. procmail.
194 It cannot be preserved because masqmail sets such a header by itself.
196 Default is false.
198 .TP
199 \fBdo_relay = \fIboolean\fR
201 If this is set to false, mail with a return path that is not local and a destination
202 that is also not local will not be accepted via smtp and a 550 reply will be given.
203 Default is true.
205 Note that this will not protect you from spammers using open relays,
206 but from users unable to set their address in their mail clients.
208 .TP
209 \fBdo_queue = \fIboolean\fR
211 If this is set, mail will not be delivered immediately when accepted.
212 Same as calling masqmail with the \fB\-odq\fR option.
214 .TP
215 \fBonline_routes.\fIname\fR = \fIlist\fR
217 Replace \fIname\fR with a name to identify a connection.
218 Set this to a filename (or a list of filenames) for the special route configuration for that connection.
219 You will use that name to call masqmail with the \fB\-qo\fR option every time a
220 connection to your ISP is set up.
222 Example: Your ISP has the name FastNet.
223 Then you write the following line in the main configuration:
225 \fBonline_routes.FastNet\fR = \fI"/etc/masqmail/fastnet.route"\fR
227 \fI/etc/masqmail/fastnet.route\fR is the route configuration file, see \fBmasqmail.route(5)\fR.
228 As soon as a link to FastNet has been set up, you call masqmail \fB\-qo \fIFastNet\fR.
229 Masqmail will then read the specified file and send the mails.
231 .TP
232 \fBconnect_route.\fIname\fR = \fIlist\fR
234 Old name for \fBonline_routes\fR.
236 .TP
237 \fBlocal_net_route = \fIfile\fR
239 This is similar to \fBonline_routes.\fIname\fR but for the local net.
240 Recipient addresses that are in local_nets will be routed using this route configuration.
241 Main purpose is to define a mail server with mail_host in your local network.
242 In simple environments this can be left unset.
243 If unset, a default route configuration will be used.
245 .TP
246 \fBalias_file = \fIfile\fR
248 Set this to the location of your alias file.
249 If unset, no aliasing will be done.
251 .TP
252 \fBalias_local_caseless = \fIboolean\fR
254 If this is set, local parts in the alias file will be matched disregarding upper/lower case.
256 .TP
257 \fBpipe_fromline = \fIboolean\fR
259 If this is set, a from line will be prepended to the output stream whenever
260 a pipe command is called after an alias expansion.
261 Default is false.
263 .TP
264 \fBpipe_fromhack = \fIboolean\fR
266 If this is set, each line beginning with `From ' is replaced with `>From '
267 whenever a pipe command is called after an alias expansion.
268 You probably want this if you have set \fBpipe_fromline\fR above.
269 Default is false.
271 .TP
272 \fBmbox_default = \fIstring\fR
274 The default local delivery method.
275 Can be one of mbox, mda or maildir (the latter only if maildir support is enabled at compile time).
276 Default is mbox.
277 You can override this for each user by using the \fBmbox_users\fR, \fBmda_users\fR,
278 or \fBmaildir_users\fR options (see below).
280 .TP
281 \fBmbox_users = \fIlist\fR
283 A list of users which wish delivery to an mbox style mail folder.
285 .TP
286 \fBmda_users = \fIlist\fR
288 A list of users which wish local delivery to an mda.
289 You have to set \fBmda\fR (see below) as well.
291 .TP
292 \fBmaildir_users = \fIlist\fR
294 A list of users which wish delivery to a qmail style maildir.
295 The path to maildir is ~/Maildir/.
296 The maildir will be created if it does not exist.
298 .TP
299 \fBmda = \fIexpand string\fR
301 If you want local delivery to be transferred to an mda (Mail Delivery Agent),
302 set this to a command.
303 The argument will be expanded on delivery time,
304 you can use variables beginning with a dolloar sign `$', optionally enclosed in curly braces.
305 Variables you can use are:
307 uid - the unique message id.
308 This is not necessarily identical with the Message ID as given in the Message ID: header.
310 received_host - the host the mail was received from
312 ident - the ident, this is either the ident delivered by the ident protocol
313 or the user id of the sender if the message was received locally.
315 return_path_local - the local part of the return path (sender).
317 return_path_domain - the domain part of the return path (sender).
319 return_path - the complete return path (sender).
321 rcpt_local - the local part of the recipient.
323 rcpt_domain - the domain part of the recipient.
325 rcpt - the complete recipient address.
327 Example:
329 mda="/usr/bin/procmail \-Y \-d ${rcpt_local}"
331 For the mda, as for pipe commands, a few environment variables will be set as well.
332 See \fBmasqmail(8)\fR.
333 To use environment variables for the mda, the dollar sign `$' has to be escaped with a backslash,
334 otherwise they will be tried to be expanded with the internal variables.
336 .TP
337 \fBmda_fromline = \fIboolean\fR
339 If this is set, a from line will be prepended to the output stream whenever
340 a message is delivered to an mda.
341 Default is false.
343 .TP
344 \fBmda_fromhack = \fIboolean\fR
346 If this is set, each line beginning with `From ' is replaced with `>From '
347 whenever a message is delivered to an mda.
348 You probably want this if you have set \fBmda_fromline\fR above.
349 Default is false.
351 .TP
352 \fBonline_detect = \fIstring\fR
354 Defines the method masqmail uses to detect whether there is currently an online connection.
355 It can have the values \fIfile\fR, \fIpipe\fR, or \fImserver\fR.
357 When it is set to \fIfile\fR, masqmail first checks for the existence of \fBonline_file\fR
358 (see below) and if it exists, it reads it.
359 The content of the file should be the name of the current connection as defined
360 with \fBconnect_route.\fIname\fR (trailing whitespace is removed).
362 When it is set to \fIpipe\fR, masqmail calls the executable given by the
363 \fBonline_pipe\fR option (see below) and reads the current online status from its standard output.
365 When it is set to \fImserver\fR, masqmail connects to the masqdialer server
366 using the value of \fBmserver_iface\fR and asks it whether a connection exists and for the name,
367 which should be the name of the current connection as defined with \fBconnect_route.\fIname\fR.
368 \fBThe mserver detection method is OBSOLETE.\fR
369 See mserver_iface for a note on how to replace it.
371 No matter how masqmail detects the online status,
372 only messages that are accepted at online time will be delivered using the connection.
373 The spool still has to be emptied with masqmail \fB\-qo\fIconnection\fR.
375 .TP
376 \fBonline_file = \fIfile\fR
378 This is the name of the file checked for when masqmail determines whether it is online.
379 The file should only exist when there is currently a connection.
380 Create it in your ip-up script with e.g.
382 echo "connection-name" >/var/run/masqmail/masqmail-route
384 chmod 0644 /var/run/masqmail/masqmail-route
386 Do not forget to delete it in your ip-down script.
388 .TP
389 \fBonline_pipe = \fIfile\fR
391 This is the name of the executable which will be called to determine the online status.
392 This executable should just print the name of the current connection to
393 the standard output and return a zero status code.
394 masqmail assumes it is offline if the script returns with a non zero status.
395 Simple example:
397 #!/bin/sh
399 [ \-e /var/run/masqmail/masqmail-route ] || exit 1
401 cat /var/run/masqmail/masqmail-route
403 exit 0
405 Of course, instead of the example above you could as well use \fIfile\fR as
406 the online detection method, but you can do something more sophisticated.
408 .TP
409 \fBmserver_iface = \fIinterface\fR
411 \fBThis option is OBSOLETE\fP, use
413 online_method=pipe
415 online_pipe="/usr/bin/mservdetect localhost 222"
417 instead.
419 The interface the masqdialer server is listening to.
420 Usually this will be "localhost:224" if mserver is running on the same host as masqmail.
421 But using this option, you can also let masqmail run on another host by setting
422 \fBmserver_iface\fR to another hostname, e.g. "foo:224".
424 .TP
425 \fBget.\fIname\fR = \fIfile\fR
427 Replace \fIname\fR with a name to identify a get configuration.
428 Set this to a filename for the get configuration.
429 These files will be used to retrieve mail when called with the \-g option.
431 .TP
432 \fBonline_gets.\fIname\fR = \fIlist\fR
434 Replace \fIname\fR with a name to identify an online configuration.
435 Set this to a filename (or a list of filenames) for the get configuration.
436 These files will be used to retrieve mail when called with the \-go option.
438 .TP
439 \fBident_trusted_nets = \fIlist\fR
441 \fIlist\fR is a list of networks of the form a.b.c.d/e (e.g. 192.168.1.0/24),
442 from which the ident given by the ident protocol will be trusted,
443 so a user can delete his mail from the queue if the ident is identical to his login name.
445 .TP
446 \fBerrmsg_file = \fIfile\fR
448 Set this to a template which will be used to generate delivery failure reports.
449 Variable parts within the template begin with a dollar sign and are identical
450 to those which can be used as arguments for the mda command, see \fBmda\fR above.
451 Additional information can be included with @failed_rcpts, @msg_headers and @msg_body,
452 these must be at the beginning of a line and will be replaced with the list of the failed recipients,
453 the message headers and the message body of the failed message.
455 Default is /usr/share/masqmail/tpl/failmsg.tpl.
457 .TP
458 \fBwarnmsg_file = \fIfile\fR
460 Set this to a template which will be used to generate delivery warning reports.
461 It uses the same mechanisms for variables as \fBerrmsg_file\fR, see above.
463 Default is /usr/share/masqmail/tpl/warnmsg.tpl.
465 .TP
466 \fBwarn_intervals\fR = \fIlist\fR
468 Set this to a list of time intervals, at which delivery warnings
469 (starting with the receiving time of the message) shall be generated.
471 A warning will only be generated just after an attempt to deliver the mail
472 and if that attempt failed temporarily.
473 So a warning may be generated after a longer time, if there was no attempt before.
475 Default is "1h;4h;8h;1d;2d;3d"
477 .TP
478 \fBmax_defer_time\fR = \fItime\fR
480 This is the maximum time, in which a temporarily failed mail will be kept in the spool.
481 When this time is exceeded, it will be handled as a delivery failure,
482 and the message will be bounced.
484 The excedence of this time will only be noticed if the message was actually tried to be delivered.
485 If, for example, the message can only be delivered when online,
486 but you have not been online for that time, no bounce will be generated.
488 Default is 4d (4 days)
490 .TP
491 \fBlog_user = \fIname\fR
493 Replace \fIname\fR with a valid local or remote mail address.
495 If this option is set, then a copy of every mail,
496 that passes through the masqmail system will also be sent to the given mail address.
498 For example you can feed your mails into a program like hypermail
499 for archiving purpose by placing an appropriate pipe command in masqmail.alias
501 .TP
502 \fBmax_msg_size\fR = \fIbytes\fR
504 This option sets the maximum size in bytes masqmail will accept for delivery.
505 This value is advertised to the SMTP client by the `SIZE' message during SMTP
506 session setup.
507 Clients pretending to send, or actually send,
508 more than \fIbytes\fR will get a 552 error message.
510 `0' means no fixed maximum size limit is in force.
512 Default is 0 (= unlimited).
514 .TP
515 \fBdefer_all\fR = \fIboolean\fR
517 If set to true, masqmail replies with ``421 service temporarily unavailable''
518 to any SMTP request and shuts the connection down.
519 Note: This option is for debugging purposes only.
521 Default: false
524 .SH AUTHOR
526 Masqmail was written by Oliver Kurth.
527 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
529 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
530 There is also a mailing list, you will find information about it at masqmail's main site.
533 .SH BUGS
535 Please report bugs to the mailing list.
538 .SH SEE ALSO
540 \fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.get(5)\fR