masqmail
view man/masqmail.conf.5 @ 238:ec28ce798b79
minor improvements in wordings
| author | markus schnalke <meillo@marmaro.de> |
|---|---|
| date | Mon, 25 Oct 2010 14:02:18 -0300 |
| parents | 4b40be6f1cbd |
| children | bc9d9cd9ee8e |
line source
1 .TH masqmail.conf 5 2010-07-23 masqmail-0.3.0 "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 \fBval\fP 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 in front of and after the equal sign `=' are optional.
28 Most lists (exceptions: \fBlocal_hosts\fR, \fBlocal_nets\fR, \fBlisten_addresses\fR,
29 and \fBonline_routes\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 the entries are 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 logs are stored, if syslog is not used.
69 Debug files are always stored in this directory if debugging is enabled.
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 \fBlocal_hosts = \fIlist\fR
118 A semicolon `;' separated list of hostnames which are considered local.
119 Normally you should set it to "localhost;foo;foo.bar.com" if your host has the
120 fully qualified domain name `foo.bar.com'.
122 Default: localhost ; <value of \fBhost_name\fR cut at the first dot> ; <value of \fBhost_name\fR>
124 Example: \fIlocalhost;foo;foo.example.org\fR
125 (if you have set \fBhost_name\fR to \fIfoo.example.org\fR)
127 .TP
128 \fBlocal_addresses = \fIlist\fR
130 A semicolon `;' separated list of fully qualified email-addresses which are
131 considered local although their domain name part is not in the list of \fBlocal_hosts\fR.
132 This list can be seen as an addition to \fBlocal_hosts\fP.
134 For example: There are two people working at your LAN: person1@yourdomain and person2@yourdomain.
135 But there are other persons @yourdomain which are NOT local.
136 So you can not put yourdomain to the list of local_hosts.
137 If person1 now wants to write to person2@yourdomain and this mail should not leave the LAN then you can put
139 local_addresses = "person1@yourdomain;person2@yourdomain"
141 to your masqmail.conf.
143 .TP
144 \fBnot_local_addresses = \fIlist\fR
146 A semicolon `;' separated list of fully qualified email-addresses which are
147 considered not local although their domain name part is in the list of \fBlocal_hosts\fR.
148 This list can be seen as a substraction to \fBlocal_hosts\fP.
150 This is the opposite of the previous case.
151 The majority of addresses of a specific domain are local.
152 But some users are not.
153 With this option you can easily exclude these users.
155 Example:
157 local_hosts = "localhost;myhost;mydomain.net"
159 not_local_addresses = "eric@mydomain.net"
161 .TP
162 \fBlocal_nets = \fIlist\fR
164 A semicolon `;' separated list of hostnames which are on the `local' net.
165 Delivery to these hosts is attempted immediately.
166 You can use patterns with `*', e.g. "*.bar.com".
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 Default: \fI127.0.0.1:25\fR (i.e. only local processes can connect)
183 .TP
184 \fBdo_save_envelope_to = \fIboolean\fR
186 If this is set to true, a possibly existing Envelope-to: header in an incoming mail
187 which is received via either pop3 or smtp will be saved as an X-Orig-Envelope-to: header.
189 This is useful if you retrieve mail from a pop3 server with fetchmail,
190 and the server supports Envelope-to: headers,
191 and you want to make use of those with a mail filtering tool, e.g. procmail.
192 It cannot be preserved because masqmail sets such a header by itself.
194 Default is false.
196 .TP
197 \fBdo_relay = \fIboolean\fR
199 If this is set to false, mail with a return path that is not local and a destination
200 that is also not local will not be accepted via smtp and a 550 reply will be given.
201 Default is true.
203 Note that this will not protect you from spammers using open relays,
204 but from users unable to set their address in their mail clients.
206 .TP
207 \fBdo_queue = \fIboolean\fR
209 If this is set, mail will not be delivered immediately when accepted.
210 Same as calling masqmail with the \fB\-odq\fR option.
212 .TP
213 \fBonline_routes.\fIname\fR = \fIlist\fR
215 Replace \fIname\fR with a name to identify a connection.
216 Set this to a filename (or a list of filenames) for the special route configuration for that connection.
217 You will use that name to call masqmail with the \fB\-qo\fR option every time a
218 connection to your ISP is set up.
220 Example: Your ISP has the name FastNet.
221 Then you write the following line in the main configuration:
223 \fBonline_routes.FastNet\fR = \fI"/etc/masqmail/fastnet.route"\fR
225 \fI/etc/masqmail/fastnet.route\fR is the route configuration file, see \fBmasqmail.route(5)\fR.
226 As soon as a link to FastNet has been set up, you call masqmail \fB\-qo \fIFastNet\fR.
227 Masqmail will then read the specified file and send the mails.
229 .TP
230 \fBconnect_route.\fIname\fR = \fIlist\fR
232 Old name for \fBonline_routes\fR.
234 .TP
235 \fBlocal_net_route = \fIfile\fR
237 This is similar to \fBonline_routes.\fIname\fR but used for delilvery to the local net.
238 Recipient addresses that are in local_nets will be routed using this route configuration.
239 Main purpose is to define a mail server with mail_host in your local network.
240 In simple environments this can be left unset.
241 If unset, a default route configuration (named ``default local_net_route'') will be used.
243 .TP
244 \fBalias_file = \fIfile\fR
246 Set this to the location of your alias file.
247 If not set, no aliasing will be done.
249 Default: <not set> (i.e. no aliasing is 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 Default: false
258 .TP
259 \fBpipe_fromline = \fIboolean\fR
261 If this is set, a from line will be prepended to the output stream whenever
262 a pipe command is called after an alias expansion.
263 Default is false.
265 .TP
266 \fBpipe_fromhack = \fIboolean\fR
268 If this is set, each line beginning with `From ' is replaced with `>From '
269 whenever a pipe command is called after an alias expansion.
270 You probably want this if you have set \fBpipe_fromline\fR above.
271 Default is false.
273 .TP
274 \fBmbox_default = \fIstring\fR
276 The default local delivery method.
277 Can be mbox or mda.
278 You can override this for each user by using the \fBmbox_users\fR or \fBmda_users\fR (see below).
280 Default: mbox.
282 .TP
283 \fBmbox_users = \fIlist\fR
285 A list of users which wish delivery to an mbox style mail folder.
287 .TP
288 \fBmda_users = \fIlist\fR
290 A list of users which wish local delivery to an mda.
291 You have to set \fBmda\fR (see below) as well.
293 .TP
294 \fBmda = \fIexpand string\fR
296 If you want local delivery to be transferred to an mda (Mail Delivery Agent),
297 set this to a command.
298 The argument will be expanded on delivery time,
299 you can use variables beginning with a dolloar sign `$', optionally enclosed in curly braces.
300 Variables you can use are:
302 uid - the unique message id.
303 This is not necessarily identical with the Message ID as given in the Message ID: header.
305 received_host - the host the mail was received from
307 ident - the ident, this is either the ident delivered by the ident protocol
308 or the user id of the sender if the message was received locally.
310 return_path_local - the local part of the return path (sender).
312 return_path_domain - the domain part of the return path (sender).
314 return_path - the complete return path (sender).
316 rcpt_local - the local part of the recipient.
318 rcpt_domain - the domain part of the recipient.
320 rcpt - the complete recipient address.
322 Example:
324 mda="/usr/bin/procmail \-Y \-d ${rcpt_local}"
326 For the mda, as for pipe commands, a few environment variables will be set as well.
327 See \fBmasqmail(8)\fR.
328 To use environment variables for the mda, the dollar sign `$' has to be escaped with a backslash,
329 otherwise they will be tried to be expanded with the internal variables.
331 .TP
332 \fBmda_fromline = \fIboolean\fR
334 If this is set, a from line will be prepended to the output stream whenever
335 a message is delivered to an mda.
336 Default is false.
338 .TP
339 \fBmda_fromhack = \fIboolean\fR
341 If this is set, each line beginning with `From ' is replaced with `>From '
342 whenever a message is delivered to an mda.
343 You probably want this if you have set \fBmda_fromline\fR above.
344 Default is false.
346 .TP
347 \fBonline_detect = \fIstring\fR
349 Defines the method masqmail uses to detect whether there is currently an online connection.
350 It can have the values \fIfile\fR or \fIpipe\fR.
352 When it is set to \fIfile\fR, masqmail first checks for the existence of \fBonline_file\fR
353 (see below) and if it exists, it reads it.
354 The content of the file should be the name of the current connection as defined
355 with \fBconnect_route.\fIname\fR (trailing whitespace is removed).
357 When it is set to \fIpipe\fR, masqmail calls the executable given by the
358 \fBonline_pipe\fR option (see below) and reads the current online status from its standard output.
360 No matter how masqmail detects the online status,
361 only messages that are accepted at online time will be delivered using the connection.
362 The spool still has to be emptied with masqmail \fB\-qo\fIconnection\fR.
364 .TP
365 \fBonline_file = \fIfile\fR
367 This is the name of the file checked for when masqmail determines whether it is online.
368 The file should only exist when there is currently a connection.
369 Create it in your ip-up script with e.g.
371 echo "connection-name" >/var/run/masqmail/masqmail-route
373 chmod 0644 /var/run/masqmail/masqmail-route
375 Do not forget to delete it in your ip-down script.
377 .TP
378 \fBonline_pipe = \fIfile\fR
380 This is the name of the executable which will be called to determine the online status.
381 This executable should just print the name of the current connection to
382 the standard output and return a zero status code.
383 masqmail assumes it is offline if the script returns with a non zero status.
384 Simple example:
386 #!/bin/sh
388 [ \-e /var/run/masqmail/masqmail-route ] || exit 1
390 cat /var/run/masqmail/masqmail-route
392 exit 0
394 Of course, instead of the example above you could as well use \fIfile\fR as
395 the online detection method, but you can do something more sophisticated.
397 \fIfile\fR must contain an absolute path to an executable program.
398 It can contain optional arguments.
400 Example: \fI/bin/echo foo\fR
401 (This tells masqmail to be always online with connection `foo'.)
403 For querying a masqdialer server
404 (= asking it whether a connection exists and what its name is)
405 use:
407 online_method=pipe
409 online_pipe="/usr/bin/mservdetect localhost 224"
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
475 .TP
476 \fBmax_msg_size\fR = \fIbytes\fR
478 This option sets the maximum size in bytes masqmail will accept for delivery.
479 This value is advertised to the SMTP client by the `SIZE' message during SMTP
480 session setup.
481 Clients pretending to send, or actually send,
482 more than \fIbytes\fR will get a 552 error message.
484 `0' means no fixed maximum size limit is in force.
486 Default is 0 (= unlimited).
488 .TP
489 \fBdefer_all\fR = \fIboolean\fR
491 If set to true, masqmail replies with ``421 service temporarily unavailable''
492 to any SMTP request and shuts the connection down.
493 Note: This option is for debugging purposes only.
495 Default: false
498 .SH AUTHOR
500 Masqmail was written by Oliver Kurth.
501 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
503 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
504 There is also a mailing list, you will find information about it at masqmail's main site.
507 .SH BUGS
509 Please report bugs to the mailing list.
512 .SH SEE ALSO
514 \fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR