masqmail

annotate man/masqmail.conf.5 @ 158:91b8b44ba619

find changesets by author, revision, files, or words in the commit message
documented that online_pipe must contain an absolute path
author meillo@marmaro.de
date Thu, 08 Jul 2010 10:35:42 +0200
parents 586f001f5bbd
children 6dd3a289989b
rev   line source
meillo@134 1 .TH masqmail.conf 5 2010-07-06 masqmail-0.2.25 "File Formats"
meillo@34 2
meillo@0 3 .SH NAME
meillo@0 4 masqmail.conf \- masqmail configuration file
meillo@34 5
meillo@34 6
meillo@0 7 .SH DESCRIPTION
meillo@0 8
meillo@34 9 This man page describes the syntax of the main configuration file of masqmail.
meillo@34 10 Its usual location is \fI/etc/masqmail/masqmail.conf\fR
meillo@0 11
meillo@0 12 The configuration consists of lines of the form
meillo@0 13
meillo@34 14 \fBval\fR = \fIexpression\fR
meillo@0 15
meillo@34 16 Where \fBval\fR is a variable name and \fIexpression\fR a string,
meillo@34 17 which can be quoted with double quotes `"'.
meillo@34 18 If the expression is on multiple lines or contains characters other than letters,
meillo@115 19 digits or the characters `.', `-', `_', `/', ';', '@', ':' it must be quoted.
meillo@34 20 You can use quotes inside quotes by escaping them with a backslash.
meillo@0 21
meillo@34 22 Each val has a type, which can be boolean, numeric, string or list.
meillo@34 23 A boolean variable can be set with one of the values `on', `yes', and `true' or `off', `no' and `false'.
meillo@34 24 List items are separated with semicolons `;'.
meillo@34 25 For some values patterns (like `*',`?') can be used.
meillo@34 26 The spaces before and after the equal sign `=' are optional.
meillo@0 27
meillo@34 28 Most lists (exceptions: \fBlocal_hosts\fR, \fBlocal_nets\fR, \fBlisten_addresses\fR,
meillo@139 29 \fBonline_routes\fR, and \fBonline_gets\fR) accept files.
meillo@34 30 These will be recognized by a leading slash `/'.
meillo@34 31 The contents of these files will be included at the position of the file name,
meillo@34 32 there can be items or other files before and after the file entry.
meillo@34 33 The format of the files is different though, within these files each entry is on another line.
meillo@34 34 (And not separated by semicolons).
meillo@34 35 This makes it easy to include large lists which are common in different configuration files,
meillo@34 36 so they do not have to appear in every configuration file.
meillo@0 37
meillo@34 38 Blank lines and lines starting with a hash `#' are ignored.
meillo@34 39
meillo@0 40
meillo@0 41 .SH OPTIONS
meillo@34 42
meillo@0 43 .TP
meillo@34 44 \fBrun_as_user = \fIboolean\fR
meillo@0 45
meillo@34 46 If this is set, masqmail runs with the user id of the user who invoked it and never changes it.
meillo@34 47 This is for debugging purposes only.
meillo@34 48 If the user is not root, masqmail will not be able to listen on a port < 1024
meillo@34 49 and will not be able to deliver local mail to others than the user.
meillo@0 50
meillo@0 51 .TP
meillo@34 52 \fBuse_syslog = \fIboolean\fR
meillo@0 53
meillo@34 54 If this is set, masqmail uses syslogd for logging.
meillo@34 55 It uses facility MAIL.
meillo@34 56 You still have to set \fBlog_dir\fR for debug files.
meillo@0 57
meillo@0 58 .TP
meillo@34 59 \fBdebug_level = \fIn\fR
meillo@0 60
meillo@34 61 Set the debug level.
meillo@34 62 Valid values are 0 to 6, increasing it further makes no difference.
meillo@34 63 Be careful if you set this as high as 5 or higher, the logs may very soon fill your hard drive.
meillo@0 64
meillo@0 65 .TP
meillo@44 66 \fBlog_dir = \fIfile\fR
meillo@44 67
meillo@44 68 The directory where log are stored, if syslog is not used.
meillo@44 69 Debug files are stored in this directory anyways.
meillo@44 70 \fIfile\fR must be an absolute path.
meillo@44 71
meillo@151 72 Default: \fI/var/log/masqmail\fR
meillo@151 73
meillo@44 74 .TP
meillo@34 75 \fBmail_dir = \fIfile\fR
meillo@0 76
meillo@34 77 The directory where local mail is stored, usually \fI/var/spool/mail\fR or \fI/var/mail\fR.
meillo@44 78 \fIfile\fR must be an absolute path.
meillo@0 79
meillo@152 80 Default: \fI/var/mail\fR
meillo@152 81
meillo@0 82 .TP
meillo@34 83 \fBspool_dir = \fIfile\fR
meillo@0 84
meillo@34 85 The directory where masqmail stores its spool files (and later also other stuff).
meillo@34 86 It must have a subdirectory \fIinput\fR.
meillo@34 87 Masqmail needs read and write permissions for this directory.
meillo@44 88 \fIfile\fR must be an absolute path.
meillo@0 89
meillo@151 90 Default: \fI/var/spool/masqmail\fR
meillo@151 91
meillo@0 92 .TP
meillo@133 93 \fBlock_dir = \fIfile\fR
meillo@133 94
meillo@133 95 The directory where masqmail stores its lock files.
meillo@133 96 Masqmail needs read and write permissions for this directory.
meillo@133 97 By default it is a directory ``lock'' inside of \fIspool_dir\fP.
meillo@133 98 \fIfile\fR must be an absolute path.
meillo@133 99
meillo@133 100 .TP
meillo@34 101 \fBhost_name = \fIstring\fR
meillo@0 102
meillo@34 103 This is used in different places: Masqmail identifies itself in the greeting banner
meillo@34 104 on incoming connections and in the HELO/EHLO command for outgoing connections with this name,
meillo@34 105 it is used in the Received: header and to qualify the sender of a locally originating message.
meillo@0 106
meillo@34 107 If the string begins with a slash `/', it it assumed that it is a filename,
meillo@34 108 and the first line of this file will be used.
meillo@34 109 Usually this will be `/etc/mailname' to make masqmail conform to Debian policies.
meillo@0 110
meillo@34 111 It is not used to find whether an address is local. Use \fBlocal_hosts\fR for that.
meillo@0 112
meillo@156 113 Default: none; \fBhost_name\fP MUST be set in the config file
meillo@156 114
meillo@0 115 .TP
meillo@34 116 \fBremote_port = \fIn\fR
meillo@0 117
meillo@0 118 The remote port number to be used. This defaults to port 25.
meillo@0 119
meillo@34 120 This option is deprecated.
meillo@34 121 Use \fBhost_name\fR in the route configuration instead.
meillo@34 122 See \fBmasqmail.route(5)\fR.
meillo@34 123
meillo@0 124 .TP
meillo@34 125 \fBlocal_hosts = \fIlist\fR
meillo@0 126
meillo@34 127 A semicolon `;' separated list of hostnames which are considered local.
meillo@153 128 Normally you should set it to "localhost;foo;foo.bar.com" if your host has the
meillo@34 129 fully qualified domain name `foo.bar.com'.
meillo@0 130
meillo@157 131 Default: localhost ; <value of \fBhost_name\fR cut at the first dot> ; <value of \fBhost_name\fR>
meillo@157 132
meillo@157 133 Example: \fIlocalhost;foo;foo.example.org\fR
meillo@157 134 (if you have set \fBhost_name\fR to \fIfoo.example.org\fR)
meillo@153 135
meillo@0 136 .TP
meillo@34 137 \fBlocal_nets = \fIlist\fR
meillo@0 138
meillo@34 139 A semicolon `;' separated list of hostnames which are on the `local' net.
meillo@34 140 Delivery to these hosts is attempted immediately.
meillo@34 141 You can use patterns with `*', e.g. "*.bar.com".
meillo@0 142
meillo@0 143 .TP
meillo@34 144 \fBlocal_addresses = \fIlist\fR
meillo@0 145
meillo@34 146 A semicolon `;' separated list of fully qualified email-addresses which are
meillo@34 147 considered local although their domain name part is not in the list of \fBlocal_hosts\fR.
meillo@0 148
meillo@34 149 For example: There are two people working at your LAN: person1@yourdomain and person2@yourdomain.
meillo@34 150 But there are other persons @yourdomain which are NOT local.
meillo@34 151 So you can not put yourdomain to the list of local_hosts.
meillo@34 152 If person1 now wants to write to person2@yourdomain and this mail should not leave the LAN then you can put
meillo@0 153
meillo@0 154 local_addresses = "person1@yourdomain;person2@yourdomain"
meillo@0 155
meillo@0 156 to your masqmail.conf.
meillo@34 157
meillo@0 158 .TP
meillo@34 159 \fBnot_local_addresses = \fIlist\fR
meillo@0 160
meillo@34 161 A semicolon `;' separated list of fully qualified email-addresses which are
meillo@34 162 considered not local although their domain name part is in the list of \fBlocal_hosts\fR.
meillo@0 163
meillo@34 164 This is the opposite of the previous case.
meillo@34 165 The majority of addresses of a specific domain are local.
meillo@34 166 But some users are not.
meillo@34 167 With this option you can easily exclude these users.
meillo@0 168
meillo@0 169 Example:
meillo@0 170
meillo@0 171 local_hosts = "localhost;myhost;mydomain.net"
meillo@0 172
meillo@0 173 not_local_addresses = "eric@mydomain.net"
meillo@34 174
meillo@0 175 .TP
meillo@34 176 \fBlisten_addresses = \fIlist\fR
meillo@0 177
meillo@34 178 A semicolon `;' separated list of interfaces on which connections will be accepted.
meillo@34 179 An interface ist defined by a hostname, optionally followed by a colon `:' and a number for the port.
meillo@34 180 If this is left out, port 25 will be used.
meillo@0 181
meillo@34 182 You can set this to "localhost:25;foo:25" if your hostname is `foo'.
meillo@0 183
meillo@34 184 Note that the names are resolved to IP addreses.
meillo@34 185 If your host has different names which resolve to the same IP,
meillo@34 186 use only one of them, otherwise you will get an error message.
meillo@0 187
meillo@0 188 .TP
meillo@34 189 \fBdo_save_envelope_to = \fIboolean\fR
meillo@0 190
meillo@34 191 If this is set to true, a possibly existing Envelope-to: header in an incoming mail
meillo@34 192 which is received via either pop3 or smtp will be saved as an X-Orig-Envelope-to: header.
meillo@0 193
meillo@34 194 This is useful if you retrieve mail from a pop3 server with either masqmail or fetchmail,
meillo@34 195 and the server supports Envelope-to: headers,
meillo@34 196 and you want to make use of those with a mail filtering tool, e.g. procmail.
meillo@34 197 It cannot be preserved because masqmail sets such a header by itself.
meillo@0 198
meillo@0 199 Default is false.
meillo@34 200
meillo@0 201 .TP
meillo@34 202 \fBdo_relay = \fIboolean\fR
meillo@0 203
meillo@34 204 If this is set to false, mail with a return path that is not local and a destination
meillo@34 205 that is also not local will not be accepted via smtp and a 550 reply will be given.
meillo@34 206 Default is true.
meillo@0 207
meillo@34 208 Note that this will not protect you from spammers using open relays,
meillo@34 209 but from users unable to set their address in their mail clients.
meillo@0 210
meillo@0 211 .TP
meillo@34 212 \fBdo_queue = \fIboolean\fR
meillo@0 213
meillo@34 214 If this is set, mail will not be delivered immediately when accepted.
meillo@34 215 Same as calling masqmail with the \fB\-odq\fR option.
meillo@0 216
meillo@0 217 .TP
meillo@34 218 \fBonline_routes.\fIname\fR = \fIlist\fR
meillo@0 219
meillo@34 220 Replace \fIname\fR with a name to identify a connection.
meillo@34 221 Set this to a filename (or a list of filenames) for the special route configuration for that connection.
meillo@34 222 You will use that name to call masqmail with the \fB\-qo\fR option every time a
meillo@34 223 connection to your ISP is set up.
meillo@0 224
meillo@34 225 Example: Your ISP has the name FastNet.
meillo@34 226 Then you write the following line in the main configuration:
meillo@0 227
meillo@139 228 \fBonline_routes.FastNet\fR = \fI"/etc/masqmail/fastnet.route"\fR
meillo@0 229
meillo@34 230 \fI/etc/masqmail/fastnet.route\fR is the route configuration file, see \fBmasqmail.route(5)\fR.
meillo@34 231 As soon as a link to FastNet has been set up, you call masqmail \fB\-qo \fIFastNet\fR.
meillo@34 232 Masqmail will then read the specified file and send the mails.
meillo@0 233
meillo@0 234 .TP
meillo@34 235 \fBconnect_route.\fIname\fR = \fIlist\fR
meillo@0 236
meillo@34 237 Old name for \fBonline_routes\fR.
meillo@0 238
meillo@0 239 .TP
meillo@34 240 \fBlocal_net_route = \fIfile\fR
meillo@0 241
meillo@34 242 This is similar to \fBonline_routes.\fIname\fR but for the local net.
meillo@34 243 Recipient addresses that are in local_nets will be routed using this route configuration.
meillo@34 244 Main purpose is to define a mail server with mail_host in your local network.
meillo@34 245 In simple environments this can be left unset.
meillo@34 246 If unset, a default route configuration will be used.
meillo@0 247
meillo@0 248 .TP
meillo@34 249 \fBalias_file = \fIfile\fR
meillo@0 250
meillo@34 251 Set this to the location of your alias file.
meillo@34 252 If unset, no aliasing will be done.
meillo@0 253
meillo@0 254 .TP
meillo@34 255 \fBalias_local_caseless = \fIboolean\fR
meillo@0 256
meillo@0 257 If this is set, local parts in the alias file will be matched disregarding upper/lower case.
meillo@34 258
meillo@0 259 .TP
meillo@34 260 \fBpipe_fromline = \fIboolean\fR
meillo@0 261
meillo@34 262 If this is set, a from line will be prepended to the output stream whenever
meillo@34 263 a pipe command is called after an alias expansion.
meillo@34 264 Default is false.
meillo@0 265
meillo@0 266 .TP
meillo@34 267 \fBpipe_fromhack = \fIboolean\fR
meillo@0 268
meillo@34 269 If this is set, each line beginning with `From ' is replaced with `>From '
meillo@34 270 whenever a pipe command is called after an alias expansion.
meillo@34 271 You probably want this if you have set \fBpipe_fromline\fR above.
meillo@34 272 Default is false.
meillo@0 273
meillo@0 274 .TP
meillo@34 275 \fBmbox_default = \fIstring\fR
meillo@0 276
meillo@34 277 The default local delivery method.
meillo@34 278 Can be one of mbox, mda or maildir (the latter only if maildir support is enabled at compile time).
meillo@34 279 Default is mbox.
meillo@34 280 You can override this for each user by using the \fBmbox_users\fR, \fBmda_users\fR,
meillo@34 281 or \fBmaildir_users\fR options (see below).
meillo@0 282
meillo@0 283 .TP
meillo@34 284 \fBmbox_users = \fIlist\fR
meillo@0 285
meillo@0 286 A list of users which wish delivery to an mbox style mail folder.
meillo@34 287
meillo@0 288 .TP
meillo@34 289 \fBmda_users = \fIlist\fR
meillo@0 290
meillo@34 291 A list of users which wish local delivery to an mda.
meillo@34 292 You have to set \fBmda\fR (see below) as well.
meillo@0 293
meillo@0 294 .TP
meillo@34 295 \fBmaildir_users = \fIlist\fR
meillo@0 296
meillo@34 297 A list of users which wish delivery to a qmail style maildir.
meillo@34 298 The path to maildir is ~/Maildir/.
meillo@34 299 The maildir will be created if it does not exist.
meillo@0 300
meillo@0 301 .TP
meillo@34 302 \fBmda = \fIexpand string\fR
meillo@0 303
meillo@34 304 If you want local delivery to be transferred to an mda (Mail Delivery Agent),
meillo@34 305 set this to a command.
meillo@34 306 The argument will be expanded on delivery time,
meillo@34 307 you can use variables beginning with a dolloar sign `$', optionally enclosed in curly braces.
meillo@34 308 Variables you can use are:
meillo@0 309
meillo@34 310 uid - the unique message id.
meillo@34 311 This is not necessarily identical with the Message ID as given in the Message ID: header.
meillo@0 312
meillo@0 313 received_host - the host the mail was received from
meillo@0 314
meillo@34 315 ident - the ident, this is either the ident delivered by the ident protocol
meillo@34 316 or the user id of the sender if the message was received locally.
meillo@0 317
meillo@0 318 return_path_local - the local part of the return path (sender).
meillo@0 319
meillo@0 320 return_path_domain - the domain part of the return path (sender).
meillo@0 321
meillo@0 322 return_path - the complete return path (sender).
meillo@0 323
meillo@0 324 rcpt_local - the local part of the recipient.
meillo@0 325
meillo@0 326 rcpt_domain - the domain part of the recipient.
meillo@0 327
meillo@0 328 rcpt - the complete recipient address.
meillo@0 329
meillo@0 330 Example:
meillo@0 331
meillo@16 332 mda="/usr/bin/procmail \-Y \-d ${rcpt_local}"
meillo@0 333
meillo@34 334 For the mda, as for pipe commands, a few environment variables will be set as well.
meillo@34 335 See \fBmasqmail(8)\fR.
meillo@34 336 To use environment variables for the mda, the dollar sign `$' has to be escaped with a backslash,
meillo@34 337 otherwise they will be tried to be expanded with the internal variables.
meillo@34 338
meillo@0 339 .TP
meillo@34 340 \fBmda_fromline = \fIboolean\fR
meillo@0 341
meillo@34 342 If this is set, a from line will be prepended to the output stream whenever
meillo@34 343 a message is delivered to an mda.
meillo@34 344 Default is false.
meillo@0 345
meillo@0 346 .TP
meillo@34 347 \fBmda_fromhack = \fIboolean\fR
meillo@0 348
meillo@34 349 If this is set, each line beginning with `From ' is replaced with `>From '
meillo@34 350 whenever a message is delivered to an mda.
meillo@34 351 You probably want this if you have set \fBmda_fromline\fR above.
meillo@34 352 Default is false.
meillo@0 353
meillo@0 354 .TP
meillo@34 355 \fBonline_detect = \fIstring\fR
meillo@0 356
meillo@34 357 Defines the method masqmail uses to detect whether there is currently an online connection.
meillo@112 358 It can have the values \fIfile\fR, \fIpipe\fR, or \fImserver\fR.
meillo@0 359
meillo@112 360 When it is set to \fIfile\fR, masqmail first checks for the existence of \fBonline_file\fR
meillo@34 361 (see below) and if it exists, it reads it.
meillo@34 362 The content of the file should be the name of the current connection as defined
meillo@34 363 with \fBconnect_route.\fIname\fR (trailing whitespace is removed).
meillo@0 364
meillo@112 365 When it is set to \fIpipe\fR, masqmail calls the executable given by the
meillo@34 366 \fBonline_pipe\fR option (see below) and reads the current online status from its standard output.
meillo@0 367
meillo@112 368 When it is set to \fImserver\fR, masqmail connects to the masqdialer server
meillo@34 369 using the value of \fBmserver_iface\fR and asks it whether a connection exists and for the name,
meillo@34 370 which should be the name of the current connection as defined with \fBconnect_route.\fIname\fR.
meillo@92 371 \fBThe mserver detection method is OBSOLETE.\fR
meillo@92 372 See mserver_iface for a note on how to replace it.
meillo@0 373
meillo@34 374 No matter how masqmail detects the online status,
meillo@34 375 only messages that are accepted at online time will be delivered using the connection.
meillo@34 376 The spool still has to be emptied with masqmail \fB\-qo\fIconnection\fR.
meillo@0 377
meillo@0 378 .TP
meillo@34 379 \fBonline_file = \fIfile\fR
meillo@0 380
meillo@34 381 This is the name of the file checked for when masqmail determines whether it is online.
meillo@34 382 The file should only exist when there is currently a connection.
meillo@34 383 Create it in your ip-up script with e.g.
meillo@0 384
meillo@92 385 echo "connection-name" >/var/run/masqmail/masqmail-route
meillo@0 386
meillo@37 387 chmod 0644 /var/run/masqmail/masqmail-route
meillo@0 388
meillo@0 389 Do not forget to delete it in your ip-down script.
meillo@34 390
meillo@0 391 .TP
meillo@34 392 \fBonline_pipe = \fIfile\fR
meillo@0 393
meillo@34 394 This is the name of the executable which will be called to determine the online status.
meillo@34 395 This executable should just print the name of the current connection to
meillo@34 396 the standard output and return a zero status code.
meillo@34 397 masqmail assumes it is offline if the script returns with a non zero status.
meillo@34 398 Simple example:
meillo@0 399
meillo@0 400 #!/bin/sh
meillo@0 401
meillo@37 402 [ \-e /var/run/masqmail/masqmail-route ] || exit 1
meillo@0 403
meillo@37 404 cat /var/run/masqmail/masqmail-route
meillo@0 405
meillo@0 406 exit 0
meillo@0 407
meillo@129 408 Of course, instead of the example above you could as well use \fIfile\fR as
meillo@34 409 the online detection method, but you can do something more sophisticated.
meillo@34 410
meillo@158 411 \fIfile\fR must contain an absolute path to an executable program.
meillo@158 412 It can contain optional arguments.
meillo@158 413
meillo@158 414 Example: \fI/bin/echo foo\fR
meillo@158 415 (This tells masqmail to be always online with connection `foo'.)
meillo@158 416
meillo@0 417 .TP
meillo@34 418 \fBmserver_iface = \fIinterface\fR
meillo@0 419
meillo@92 420 \fBThis option is OBSOLETE\fP, use
meillo@92 421
meillo@92 422 online_method=pipe
meillo@92 423
meillo@92 424 online_pipe="/usr/bin/mservdetect localhost 222"
meillo@92 425
meillo@92 426 instead.
meillo@92 427
meillo@34 428 The interface the masqdialer server is listening to.
meillo@34 429 Usually this will be "localhost:224" if mserver is running on the same host as masqmail.
meillo@34 430 But using this option, you can also let masqmail run on another host by setting
meillo@34 431 \fBmserver_iface\fR to another hostname, e.g. "foo:224".
meillo@0 432
meillo@0 433 .TP
meillo@34 434 \fBget.\fIname\fR = \fIfile\fR
meillo@0 435
meillo@34 436 Replace \fIname\fR with a name to identify a get configuration.
meillo@34 437 Set this to a filename for the get configuration.
meillo@34 438 These files will be used to retrieve mail when called with the \-g option.
meillo@0 439
meillo@0 440 .TP
meillo@34 441 \fBonline_gets.\fIname\fR = \fIlist\fR
meillo@0 442
meillo@34 443 Replace \fIname\fR with a name to identify an online configuration.
meillo@34 444 Set this to a filename (or a list of filenames) for the get configuration.
meillo@34 445 These files will be used to retrieve mail when called with the \-go option.
meillo@0 446
meillo@0 447 .TP
meillo@34 448 \fBident_trusted_nets = \fIlist\fR
meillo@0 449
meillo@34 450 \fIlist\fR is a list of networks of the form a.b.c.d/e (e.g. 192.168.1.0/24),
meillo@34 451 from which the ident given by the ident protocol will be trusted,
meillo@34 452 so a user can delete his mail from the queue if the ident is identical to his login name.
meillo@0 453
meillo@0 454 .TP
meillo@34 455 \fBerrmsg_file = \fIfile\fR
meillo@0 456
meillo@34 457 Set this to a template which will be used to generate delivery failure reports.
meillo@34 458 Variable parts within the template begin with a dollar sign and are identical
meillo@34 459 to those which can be used as arguments for the mda command, see \fBmda\fR above.
meillo@34 460 Additional information can be included with @failed_rcpts, @msg_headers and @msg_body,
meillo@34 461 these must be at the beginning of a line and will be replaced with the list of the failed recipients,
meillo@34 462 the message headers and the message body of the failed message.
meillo@0 463
meillo@0 464 Default is /usr/share/masqmail/tpl/failmsg.tpl.
meillo@34 465
meillo@0 466 .TP
meillo@34 467 \fBwarnmsg_file = \fIfile\fR
meillo@0 468
meillo@34 469 Set this to a template which will be used to generate delivery warning reports.
meillo@34 470 It uses the same mechanisms for variables as \fBerrmsg_file\fR, see above.
meillo@0 471
meillo@0 472 Default is /usr/share/masqmail/tpl/warnmsg.tpl.
meillo@34 473
meillo@0 474 .TP
meillo@34 475 \fBwarn_intervals\fR = \fIlist\fR
meillo@0 476
meillo@34 477 Set this to a list of time intervals, at which delivery warnings
meillo@34 478 (starting with the receiving time of the message) shall be generated.
meillo@0 479
meillo@34 480 A warning will only be generated just after an attempt to deliver the mail
meillo@34 481 and if that attempt failed temporarily.
meillo@34 482 So a warning may be generated after a longer time, if there was no attempt before.
meillo@0 483
meillo@0 484 Default is "1h;4h;8h;1d;2d;3d"
meillo@34 485
meillo@0 486 .TP
meillo@34 487 \fBmax_defer_time\fR = \fItime\fR
meillo@0 488
meillo@34 489 This is the maximum time, in which a temporarily failed mail will be kept in the spool.
meillo@34 490 When this time is exceeded, it will be handled as a delivery failure,
meillo@34 491 and the message will be bounced.
meillo@0 492
meillo@34 493 The excedence of this time will only be noticed if the message was actually tried to be delivered.
meillo@34 494 If, for example, the message can only be delivered when online,
meillo@34 495 but you have not been online for that time, no bounce will be generated.
meillo@0 496
meillo@0 497 Default is 4d (4 days)
meillo@34 498
meillo@0 499 .TP
meillo@34 500 \fBlog_user = \fIname\fR
meillo@0 501
meillo@34 502 Replace \fIname\fR with a valid local or remote mail address.
meillo@0 503
meillo@44 504 If this option is set, then a copy of every mail,
meillo@44 505 that passes through the masqmail system will also be sent to the given mail address.
meillo@0 506
meillo@34 507 For example you can feed your mails into a program like hypermail
meillo@34 508 for archiving purpose by placing an appropriate pipe command in masqmail.alias
meillo@0 509
meillo@117 510 .TP
meillo@117 511 \fBmax_msg_size\fR = \fIbytes\fR
meillo@117 512
meillo@117 513 This option sets the maximum size in bytes masqmail will accept for delivery.
meillo@117 514 This value is advertised to the SMTP client by the `SIZE' message during SMTP
meillo@117 515 session setup.
meillo@117 516 Clients pretending to send, or actually send,
meillo@117 517 more than \fIbytes\fR will get a 552 error message.
meillo@117 518
meillo@120 519 `0' means no fixed maximum size limit is in force.
meillo@120 520
meillo@120 521 Default is 0 (= unlimited).
meillo@117 522
meillo@134 523 .TP
meillo@134 524 \fBdefer_all\fR = \fIboolean\fR
meillo@134 525
meillo@134 526 If set to true, masqmail replies with ``421 service temporarily unavailable''
meillo@134 527 to any SMTP request and shuts the connection down.
meillo@134 528 Note: This option is for debugging purposes only.
meillo@134 529
meillo@134 530 Default: false
meillo@134 531
meillo@34 532
meillo@0 533 .SH AUTHOR
meillo@0 534
meillo@34 535 Masqmail was written by Oliver Kurth.
meillo@34 536 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
meillo@0 537
meillo@95 538 You will find the newest version of masqmail at \fBhttp://marmaro.de/prog/masqmail/\fR.
meillo@26 539 There is also a mailing list, you will find information about it at masqmail's main site.
meillo@0 540
meillo@34 541
meillo@0 542 .SH BUGS
meillo@0 543
meillo@34 544 Please report bugs to the mailing list.
meillo@34 545
meillo@0 546
meillo@0 547 .SH SEE ALSO
meillo@0 548
meillo@34 549 \fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.get(5)\fR