masqmail

annotate man/masqmail.conf.5 @ 414:309935f59820

find changesets by author, revision, files, or words in the commit message
Minor refactoring and added a newline to the debug output.
author markus schnalke <meillo@marmaro.de>
date Wed, 29 Feb 2012 14:23:16 +0100
parents a408411ff8df
children 4cbaf6d6793f
rev   line source
meillo@380 1 .TH masqmail.conf 5 2012-01-18 masqmail-0.3.4 "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@398 14 .RS 8
meillo@34 15 \fBval\fR = \fIexpression\fR
meillo@398 16 .RE
meillo@0 17
meillo@34 18 Where \fBval\fR is a variable name and \fIexpression\fR a string,
meillo@34 19 which can be quoted with double quotes `"'.
meillo@398 20 If the expression is on multiple lines or contains characters other
meillo@398 21 than letters,
meillo@398 22 digits or the characters `.', `\-', `_', `/', ';', '@', ':', it must be quoted.
meillo@34 23 You can use quotes inside quotes by escaping them with a backslash.
meillo@0 24
meillo@174 25 Each \fBval\fP has a type, which can be boolean, numeric, string or list.
meillo@398 26 A boolean variable can be set with one of the values `on', `yes', and `true'
meillo@398 27 or `off', `no' and `false'.
meillo@34 28 List items are separated with semicolons `;'.
meillo@398 29 The spaces around the equal sign `=' are optional.
meillo@0 30
meillo@398 31 All lists, except
meillo@398 32 \fBquery_routes.\fIname\fR and \fBpermanent_routes\fR, accept absolute
meillo@398 33 pathnames (leading slash `/') as entries, too.
meillo@398 34 They can be intermixed with normal entries.
meillo@398 35 The contents of these files will be included at this position in the list.
meillo@398 36 This makes including large lists more convenient.
meillo@398 37 Within these files, each line is one entry; the semicolon is no separator.
meillo@0 38
meillo@34 39 Blank lines and lines starting with a hash `#' are ignored.
meillo@34 40
meillo@0 41
meillo@0 42 .SH OPTIONS
meillo@34 43
meillo@0 44 .TP
meillo@34 45 \fBrun_as_user = \fIboolean\fR
meillo@0 46
meillo@398 47 If this is set, masqmail runs with the user id of the user who
meillo@398 48 invoked it and never changes it.
meillo@34 49 This is for debugging purposes only.
meillo@34 50 If the user is not root, masqmail will not be able to listen on a port < 1024
meillo@34 51 and will not be able to deliver local mail to others than the user.
meillo@0 52
meillo@0 53 .TP
meillo@34 54 \fBuse_syslog = \fIboolean\fR
meillo@0 55
meillo@34 56 If this is set, masqmail uses syslogd for logging.
meillo@34 57 It uses facility MAIL.
meillo@34 58 You still have to set \fBlog_dir\fR for debug files.
meillo@0 59
meillo@0 60 .TP
meillo@34 61 \fBdebug_level = \fIn\fR
meillo@0 62
meillo@34 63 Set the debug level.
meillo@333 64 Valid values are 0 to 6 and 9.
meillo@333 65 Be careful if you set this as high as 5 or higher,
meillo@333 66 the logs may very soon fill your hard drive.
meillo@333 67 Level 9 enables printing of debug messages to stderr during reading of
meillo@333 68 the config file.
meillo@333 69 The debug file comes available for the first time after this step.
meillo@333 70 Thus nothing but stderr is available.
meillo@333 71 Level 9 is almost never interesting.
meillo@0 72
meillo@0 73 .TP
meillo@44 74 \fBlog_dir = \fIfile\fR
meillo@44 75
meillo@174 76 The directory where logs are stored, if syslog is not used.
meillo@174 77 Debug files are always stored in this directory if debugging is enabled.
meillo@44 78 \fIfile\fR must be an absolute path.
meillo@44 79
meillo@151 80 Default: \fI/var/log/masqmail\fR
meillo@151 81
meillo@44 82 .TP
meillo@34 83 \fBmail_dir = \fIfile\fR
meillo@0 84
meillo@398 85 The directory where local mail is stored,
meillo@398 86 usually \fI/var/spool/mail\fR or \fI/var/mail\fR.
meillo@44 87 \fIfile\fR must be an absolute path.
meillo@0 88
meillo@152 89 Default: \fI/var/mail\fR
meillo@152 90
meillo@0 91 .TP
meillo@34 92 \fBspool_dir = \fIfile\fR
meillo@0 93
meillo@398 94 The directory where masqmail stores its spool files
meillo@398 95 (and later also other stuff).
meillo@34 96 It must have a subdirectory \fIinput\fR.
meillo@34 97 Masqmail needs read and write permissions for this directory.
meillo@44 98 \fIfile\fR must be an absolute path.
meillo@0 99
meillo@151 100 Default: \fI/var/spool/masqmail\fR
meillo@151 101
meillo@0 102 .TP
meillo@133 103 \fBlock_dir = \fIfile\fR
meillo@133 104
meillo@133 105 The directory where masqmail stores its lock files.
meillo@133 106 Masqmail needs read and write permissions for this directory.
meillo@133 107 By default it is a directory ``lock'' inside of \fIspool_dir\fP.
meillo@133 108 \fIfile\fR must be an absolute path.
meillo@133 109
meillo@133 110 .TP
meillo@34 111 \fBhost_name = \fIstring\fR
meillo@0 112
meillo@398 113 This is used in different places: Masqmail identifies itself in
meillo@398 114 the greeting banner on incoming connections and in the HELO/EHLO command
meillo@398 115 for outgoing connections with this name, it is used in the Received: header
meillo@398 116 and to qualify the sender of a locally originating message.
meillo@0 117
meillo@34 118 If the string begins with a slash `/', it it assumed that it is a filename,
meillo@34 119 and the first line of this file will be used.
meillo@398 120 Usually this will be `/etc/mailname' to make masqmail conform to
meillo@398 121 Debian policies.
meillo@0 122
meillo@398 123 It is not used to find whether an address is local.
meillo@398 124 Use \fBlocal_hosts\fR for that.
meillo@0 125
meillo@156 126 Default: none; \fBhost_name\fP MUST be set in the config file
meillo@156 127
meillo@0 128 .TP
meillo@34 129 \fBlocal_hosts = \fIlist\fR
meillo@0 130
meillo@34 131 A semicolon `;' separated list of hostnames which are considered local.
meillo@375 132 Can contain glob patterns, like
meillo@375 133 `*example.org' or `mail?.*mydomain.net'.
meillo@153 134 Normally you should set it to "localhost;foo;foo.bar.com" if your host has the
meillo@34 135 fully qualified domain name `foo.bar.com'.
meillo@0 136
meillo@398 137 Default: localhost ; <value of \fBhost_name\fR cut at the first dot> ;
meillo@398 138 <value of \fBhost_name\fR>
meillo@157 139
meillo@157 140 Example: \fIlocalhost;foo;foo.example.org\fR
meillo@157 141 (if you have set \fBhost_name\fR to \fIfoo.example.org\fR)
meillo@153 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@398 147 considered local although their domain name part is not in the list of
meillo@398 148 \fBlocal_hosts\fR.
meillo@238 149 This list can be seen as an addition to \fBlocal_hosts\fP.
meillo@398 150 .IP
meillo@306 151 Further more only the local part of the addresses will be regarded,
meillo@306 152 seeing it as a local user.
meillo@0 153
meillo@398 154 Example:
meillo@0 155
meillo@398 156 .RS 8
meillo@398 157 .nf
meillo@398 158 local_hosts = "localhost;myhost"
meillo@398 159 local_addresses = "bob@somewhere;alice@foo"
meillo@398 160 .fi
meillo@398 161 .RE
meillo@398 162 .IP
meillo@306 163 This means mail to person1@yourdomain will effectively go to
meillo@306 164 person1@localhost, if not redirected by an alias.
meillo@34 165
meillo@0 166 .TP
meillo@34 167 \fBnot_local_addresses = \fIlist\fR
meillo@0 168
meillo@34 169 A semicolon `;' separated list of fully qualified email-addresses which are
meillo@398 170 considered not local although their domain name part is in the list of
meillo@398 171 \fBlocal_hosts\fR.
meillo@238 172 This list can be seen as a substraction to \fBlocal_hosts\fP.
meillo@0 173
meillo@34 174 This is the opposite of the previous case.
meillo@34 175 The majority of addresses of a specific domain are local.
meillo@34 176 But some users are not.
meillo@34 177 With this option you can easily exclude these users.
meillo@0 178
meillo@0 179 Example:
meillo@0 180
meillo@398 181 .RS 8
meillo@398 182 .nf
meillo@0 183 local_hosts = "localhost;myhost;mydomain.net"
meillo@0 184 not_local_addresses = "eric@mydomain.net"
meillo@398 185 .fi
meillo@398 186 .RE
meillo@398 187 .IP
meillo@34 188
meillo@0 189 .TP
meillo@34 190 \fBlisten_addresses = \fIlist\fR
meillo@0 191
meillo@398 192 A semicolon `;' separated list of interfaces on which connections will
meillo@398 193 be accepted.
meillo@398 194 An interface ist defined by a hostname, optionally followed by a colon `:'
meillo@398 195 and a number for the port.
meillo@34 196 If this is left out, port 25 will be used.
meillo@0 197
meillo@34 198 You can set this to "localhost:25;foo:25" if your hostname is `foo'.
meillo@0 199
meillo@337 200 Note that the names are resolved to IP addresses.
meillo@34 201 If your host has different names which resolve to the same IP,
meillo@34 202 use only one of them, otherwise you will get an error message.
meillo@0 203
meillo@329 204 Default: \fIlocalhost:25\fR (i.e. only local processes can connect)
meillo@161 205
meillo@0 206 .TP
meillo@34 207 \fBdo_save_envelope_to = \fIboolean\fR
meillo@0 208
meillo@398 209 If this is set to true, a possibly existing Envelope-to: header in
meillo@398 210 an incoming mail which is received via either pop3 or smtp will be saved
meillo@398 211 as an X-Orig-Envelope-to: header.
meillo@0 212
meillo@192 213 This is useful if you retrieve mail from a pop3 server with fetchmail,
meillo@34 214 and the server supports Envelope-to: headers,
meillo@34 215 and you want to make use of those with a mail filtering tool, e.g. procmail.
meillo@34 216 It cannot be preserved because masqmail sets such a header by itself.
meillo@0 217
meillo@0 218 Default is false.
meillo@34 219
meillo@0 220 .TP
meillo@34 221 \fBdo_relay = \fIboolean\fR
meillo@0 222
meillo@398 223 If this is set to false, mail with a return path that is not local
meillo@398 224 and a destination that is also not local will not be accepted via smtp
meillo@398 225 and a 550 reply will be given.
meillo@34 226 Default is true.
meillo@0 227
meillo@34 228 Note that this will not protect you from spammers using open relays,
meillo@34 229 but from users unable to set their address in their mail clients.
meillo@0 230
meillo@0 231 .TP
meillo@34 232 \fBdo_queue = \fIboolean\fR
meillo@0 233
meillo@398 234 If this is set, masqmail will not try to deliver mail
meillo@398 235 immediately when accepted.
meillo@346 236 Instead it will always queue it.
meillo@346 237 (Note: Masqmail will always automatically queue mail if neccesary,
meillo@346 238 i.e. if it cannot deliver because no suitable route was available for example.)
meillo@346 239
meillo@34 240 Same as calling masqmail with the \fB\-odq\fR option.
meillo@346 241 Usually you should leave this option unset.
meillo@346 242
meillo@346 243 Default: false
meillo@0 244
meillo@0 245 .TP
meillo@354 246 \fBpermanent_routes\fR = \fIlist\fR
meillo@0 247
meillo@354 248 Set this to the filename (or a semicolon-separated list of filenames)
meillo@354 249 of the route configuration for always available connections.
meillo@354 250 Main purpose is to define a mail server with mail_host in your local network,
meillo@354 251 or if masqmail should send mail directly to the target host.
meillo@354 252 If you have only a single host, you can leave it unset.
meillo@354 253
meillo@354 254 A setting `\fBlocal_nets\fR = \fI"*home.net"\fR' in versions <= 0.3.3
meillo@354 255 is in newer versions configured as:
meillo@354 256 `\fBpermanent_routes\fR = \fI"/etc/masqmail/homenet.route"\fR'
meillo@354 257 and the route file `homenet.route' containing:
meillo@398 258
meillo@398 259 .RS 8
meillo@354 260 .nf
meillo@354 261 allowed_recipients = "*@*home.net"
meillo@354 262 connect_error_fail = true
meillo@354 263 resolve_list = byname
meillo@354 264 .fi
meillo@398 265 .RE
meillo@398 266 .IP
meillo@398 267
meillo@354 268 This is just as it had been with \fBlocal_net_route\fP,
meillo@354 269 with the exception that the filtering for appropriate addresses
meillo@354 270 is only in the route file and not with \fBlocal_nets\fR.
meillo@354 271
meillo@354 272 .TP
meillo@354 273 \fBquery_routes.\fIname\fR = \fIlist\fR
meillo@354 274
meillo@354 275 Replace \fIname\fR with a name to identify the connection.
meillo@354 276 Set this to a filename (or a semicolon-separated list of filenames)
meillo@354 277 for the route configuration for that connection.
meillo@354 278
meillo@354 279 Routes of this kind cannot be expected to be online always.
meillo@354 280 Masqmail will query which of the routes are online.
meillo@354 281
meillo@354 282 You can use the name to call masqmail with the \fB\-qo\fR option every time a
meillo@354 283 connection to your ISP is set up, in order to send queued mail through this
meillo@354 284 route.
meillo@0 285
meillo@34 286 Example: Your ISP has the name FastNet.
meillo@34 287 Then you write the following line in the main configuration:
meillo@0 288
meillo@398 289 .RS 8
meillo@398 290 .nf
meillo@354 291 \fBquery_routes.\fBFastNet\fR = \fI"/etc/masqmail/fastnet.route"\fR
meillo@398 292 .fi
meillo@398 293 .RE
meillo@398 294 .IP
meillo@0 295
meillo@354 296 \fI/etc/masqmail/fastnet.route\fR is the route configuration file,
meillo@354 297 see \fBmasqmail.route(5)\fR.
meillo@354 298 As soon as a link to FastNet has been set up,
meillo@354 299 you call `masqmail \fB\-qo \fIFastNet\fR'.
meillo@34 300 Masqmail will then read the specified file and send the mails.
meillo@0 301
meillo@354 302 See \fBonline_query\fP.
meillo@0 303
meillo@0 304 .TP
meillo@34 305 \fBalias_file = \fIfile\fR
meillo@0 306
meillo@34 307 Set this to the location of your alias file.
meillo@238 308 If not set, no aliasing will be done.
meillo@238 309
meillo@238 310 Default: <not set> (i.e. no aliasing is done)
meillo@0 311
meillo@0 312 .TP
meillo@387 313 \fBglobalias_file = \fIfile\fR
meillo@387 314
meillo@387 315 Set this to the location of a glob-pattern alias file.
meillo@387 316 This kind of aliasing matches glob patterns against full email addresses,
meillo@387 317 not strings against local parts like in normal aliasing.
meillo@387 318 You can use this to handle catch-all maildrops (``*@example.org'')
meillo@387 319 and to split between virtual hosts on a single machine
meillo@387 320 (e.g. ``info@foo.ex.org'' and ``info@bar.ex.org'').
meillo@387 321
meillo@387 322 Glob aliasing is done before normal aliasing.
meillo@387 323 If you have both kinds, glob and normal aliasing, then the results of the
meillo@387 324 glob aliasing may be expanded further by the normal aliasing mechanism.
meillo@387 325
meillo@387 326 Default: <not set> (i.e. no glob aliasing is done)
meillo@387 327
meillo@387 328 .TP
meillo@243 329 \fBcaseless_matching = \fIboolean\fR
meillo@0 330
meillo@242 331 If this is set, aliasing and the matching for \fBlocal_addresses\fP and
meillo@242 332 \fBnot_local_addresses\fP will be done caseless.
meillo@242 333
meillo@242 334 Note: Be sure to change this option only if the queue is empty as
meillo@242 335 correct processing of queued messages is not guaranteed otherwise.
meillo@34 336
meillo@238 337 Default: false
meillo@238 338
meillo@0 339 .TP
meillo@34 340 \fBpipe_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 pipe command is called after an alias expansion.
meillo@34 344 Default is false.
meillo@0 345
meillo@0 346 .TP
meillo@34 347 \fBpipe_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 pipe command is called after an alias expansion.
meillo@34 351 You probably want this if you have set \fBpipe_fromline\fR above.
meillo@34 352 Default is false.
meillo@0 353
meillo@0 354 .TP
meillo@34 355 \fBmbox_default = \fIstring\fR
meillo@0 356
meillo@34 357 The default local delivery method.
meillo@205 358 Can be mbox or mda.
meillo@398 359 You can override this for each user by using the \fBmbox_users\fR or
meillo@398 360 \fBmda_users\fR (see below).
meillo@0 361
meillo@238 362 Default: mbox.
meillo@238 363
meillo@0 364 .TP
meillo@34 365 \fBmbox_users = \fIlist\fR
meillo@0 366
meillo@0 367 A list of users which wish delivery to an mbox style mail folder.
meillo@34 368
meillo@0 369 .TP
meillo@34 370 \fBmda_users = \fIlist\fR
meillo@0 371
meillo@34 372 A list of users which wish local delivery to an mda.
meillo@34 373 You have to set \fBmda\fR (see below) as well.
meillo@0 374
meillo@0 375 .TP
meillo@34 376 \fBmda = \fIexpand string\fR
meillo@0 377
meillo@34 378 If you want local delivery to be transferred to an mda (Mail Delivery Agent),
meillo@34 379 set this to a command.
meillo@34 380 The argument will be expanded on delivery time,
meillo@398 381 you can use variables beginning with a dolloar sign `$',
meillo@398 382 optionally enclosed in curly braces.
meillo@34 383 Variables you can use are:
meillo@0 384
meillo@398 385 .RS 8
meillo@398 386 .TP
meillo@398 387 uid
meillo@398 388 the unique message id.
meillo@398 389 (This is not necessarily identical with the Message ID
meillo@398 390 as given in the Message ID: header.)
meillo@0 391
meillo@398 392 .TP
meillo@398 393 received_host
meillo@398 394 the host the mail was received from
meillo@0 395
meillo@398 396 .TP
meillo@398 397 ident
meillo@398 398 the user id of the sender if the message was received locally.
meillo@0 399
meillo@398 400 .TP
meillo@398 401 return_path_local
meillo@398 402 the local part of the return path (sender).
meillo@0 403
meillo@398 404 .TP
meillo@398 405 return_path_domain
meillo@398 406 the domain part of the return path (sender).
meillo@0 407
meillo@398 408 .TP
meillo@398 409 return_path
meillo@398 410 the complete return path (sender).
meillo@0 411
meillo@398 412 .TP
meillo@398 413 rcpt_local
meillo@398 414 the local part of the recipient.
meillo@0 415
meillo@398 416 .TP
meillo@398 417 rcpt_domain
meillo@398 418 the domain part of the recipient.
meillo@0 419
meillo@398 420 .TP
meillo@398 421 rcpt
meillo@398 422 the complete recipient address.
meillo@398 423 .RE
meillo@398 424 .IP
meillo@0 425
meillo@0 426 Example:
meillo@0 427
meillo@398 428 .RS 8
meillo@16 429 mda="/usr/bin/procmail \-Y \-d ${rcpt_local}"
meillo@398 430 .RE
meillo@398 431 .IP
meillo@0 432
meillo@398 433 For the mda, as for pipe commands,
meillo@398 434 a few environment variables will be set as well.
meillo@34 435 See \fBmasqmail(8)\fR.
meillo@398 436 To use environment variables for the mda,
meillo@398 437 the dollar sign `$' has to be escaped with a backslash,
meillo@34 438 otherwise they will be tried to be expanded with the internal variables.
meillo@34 439
meillo@0 440 .TP
meillo@34 441 \fBmda_fromline = \fIboolean\fR
meillo@0 442
meillo@34 443 If this is set, a from line will be prepended to the output stream whenever
meillo@34 444 a message is delivered to an mda.
meillo@34 445 Default is false.
meillo@0 446
meillo@0 447 .TP
meillo@34 448 \fBmda_fromhack = \fIboolean\fR
meillo@0 449
meillo@34 450 If this is set, each line beginning with `From ' is replaced with `>From '
meillo@34 451 whenever a message is delivered to an mda.
meillo@34 452 You probably want this if you have set \fBmda_fromline\fR above.
meillo@34 453 Default is false.
meillo@0 454
meillo@0 455 .TP
meillo@310 456 \fBonline_query = \fIcommand line\fR
meillo@0 457
meillo@398 458 Defines the method masqmail uses to detect whether there exists
meillo@398 459 an online connection currently.
meillo@0 460
meillo@310 461 Masqmail executes the command given and reads from its standard output.
meillo@310 462 The command should just print a route name, as defined
meillo@398 463 with \fBquery_routes.\fIname\fR, to standard output and return
meillo@398 464 a zero status code.
meillo@310 465 Masqmail assumes it is offline if the script returns with a non-zero status.
meillo@310 466 Leading and trailing whitespace is removed from the output.
meillo@0 467
meillo@310 468 Simple example:
meillo@310 469
meillo@398 470 .RS 8
meillo@310 471 .nf
meillo@310 472 #!/bin/sh
meillo@310 473 test \-e /var/run/masqmail/masqmail-route || exit 1
meillo@310 474 cat /var/run/masqmail/masqmail-route
meillo@310 475 exit 0
meillo@310 476 .fi
meillo@398 477 .RE
meillo@398 478 .IP
meillo@0 479
meillo@34 480 No matter how masqmail detects the online status,
meillo@398 481 only messages that are accepted at online time will be
meillo@398 482 delivered using the connection.
meillo@310 483 The mail spool still needs to be emptied manually
meillo@310 484 (\fB\-qo\fIconnection\fR).
meillo@0 485
meillo@310 486 \fIcommand line\fR must start with an absolute path to an executable program.
meillo@158 487 It can contain optional arguments.
meillo@0 488
meillo@310 489 To simulate the old online_method=file, use:
meillo@398 490
meillo@398 491 .RS 8
meillo@310 492 \fI/bin/cat /path/to/file\fP
meillo@398 493 .RE
meillo@398 494 .IP
meillo@158 495
meillo@310 496 To be always online with connection `foo', use:
meillo@398 497
meillo@398 498 .RS 8
meillo@310 499 \fI/bin/echo foo\fP
meillo@398 500 .RE
meillo@398 501 .IP
meillo@310 502
meillo@310 503 To query a masqdialer server
meillo@310 504 (i.e. asking it whether a connection exists and what its name is)
meillo@164 505 use:
meillo@398 506
meillo@398 507 .RS 8
meillo@310 508 \fI/usr/bin/mservdetect localhost 224\fP
meillo@398 509 .RE
meillo@398 510 .IP
meillo@92 511
meillo@0 512 .TP
meillo@34 513 \fBerrmsg_file = \fIfile\fR
meillo@0 514
meillo@34 515 Set this to a template which will be used to generate delivery failure reports.
meillo@34 516 Variable parts within the template begin with a dollar sign and are identical
meillo@398 517 to those which can be used as arguments for the mda command,
meillo@398 518 see \fBmda\fR above.
meillo@398 519 Additional information can be included with @failed_rcpts,
meillo@398 520 @msg_headers and @msg_body,
meillo@398 521 these must be at the beginning of a line and will be replaced
meillo@398 522 with the list of the failed recipients,
meillo@34 523 the message headers and the message body of the failed message.
meillo@0 524
meillo@0 525 Default is /usr/share/masqmail/tpl/failmsg.tpl.
meillo@34 526
meillo@0 527 .TP
meillo@34 528 \fBwarnmsg_file = \fIfile\fR
meillo@0 529
meillo@34 530 Set this to a template which will be used to generate delivery warning reports.
meillo@34 531 It uses the same mechanisms for variables as \fBerrmsg_file\fR, see above.
meillo@0 532
meillo@0 533 Default is /usr/share/masqmail/tpl/warnmsg.tpl.
meillo@34 534
meillo@0 535 .TP
meillo@34 536 \fBwarn_intervals\fR = \fIlist\fR
meillo@0 537
meillo@34 538 Set this to a list of time intervals, at which delivery warnings
meillo@34 539 (starting with the receiving time of the message) shall be generated.
meillo@0 540
meillo@34 541 A warning will only be generated just after an attempt to deliver the mail
meillo@34 542 and if that attempt failed temporarily.
meillo@398 543 So a warning may be generated after a longer time,
meillo@398 544 if there was no attempt before.
meillo@0 545
meillo@0 546 Default is "1h;4h;8h;1d;2d;3d"
meillo@34 547
meillo@0 548 .TP
meillo@34 549 \fBmax_defer_time\fR = \fItime\fR
meillo@0 550
meillo@398 551 This is the maximum time,
meillo@398 552 in which a temporarily failed mail will be kept in the spool.
meillo@34 553 When this time is exceeded, it will be handled as a delivery failure,
meillo@34 554 and the message will be bounced.
meillo@0 555
meillo@398 556 The excedence of this time will only be noticed if the message
meillo@398 557 was actually tried to be delivered.
meillo@34 558 If, for example, the message can only be delivered when online,
meillo@34 559 but you have not been online for that time, no bounce will be generated.
meillo@0 560
meillo@0 561 Default is 4d (4 days)
meillo@34 562
meillo@0 563 .TP
meillo@34 564 \fBlog_user = \fIname\fR
meillo@0 565
meillo@34 566 Replace \fIname\fR with a valid local or remote mail address.
meillo@0 567
meillo@44 568 If this option is set, then a copy of every mail,
meillo@398 569 that passes through the masqmail system will also be sent
meillo@398 570 to the given mail address.
meillo@0 571
meillo@34 572 For example you can feed your mails into a program like hypermail
meillo@398 573 for archiving purpose by placing an appropriate pipe command
meillo@398 574 in masqmail.alias.
meillo@0 575
meillo@117 576 .TP
meillo@117 577 \fBmax_msg_size\fR = \fIbytes\fR
meillo@117 578
meillo@117 579 This option sets the maximum size in bytes masqmail will accept for delivery.
meillo@117 580 This value is advertised to the SMTP client by the `SIZE' message during SMTP
meillo@117 581 session setup.
meillo@117 582 Clients pretending to send, or actually send,
meillo@117 583 more than \fIbytes\fR will get a 552 error message.
meillo@117 584
meillo@398 585 A zero value disables the maximum size limit.
meillo@120 586
meillo@120 587 Default is 0 (= unlimited).
meillo@117 588
meillo@134 589 .TP
meillo@134 590 \fBdefer_all\fR = \fIboolean\fR
meillo@134 591
meillo@134 592 If set to true, masqmail replies with ``421 service temporarily unavailable''
meillo@134 593 to any SMTP request and shuts the connection down.
meillo@134 594 Note: This option is for debugging purposes only.
meillo@134 595
meillo@134 596 Default: false
meillo@134 597
meillo@34 598
meillo@0 599 .SH AUTHOR
meillo@0 600
meillo@34 601 Masqmail was written by Oliver Kurth.
meillo@34 602 It is now maintained by Markus Schnalke <meillo@marmaro.de>.
meillo@0 603
meillo@398 604 You will find the newest version of masqmail at
meillo@398 605 \fBhttp://marmaro.de/prog/masqmail/\fR.
meillo@398 606 There is also a mailing list,
meillo@398 607 you will find information about it at masqmail's main site.
meillo@0 608
meillo@34 609
meillo@0 610 .SH BUGS
meillo@0 611
meillo@34 612 Please report bugs to the mailing list.
meillo@34 613
meillo@0 614
meillo@0 615 .SH SEE ALSO
meillo@0 616
meillo@192 617 \fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR