masqmail: man/masqmail.conf.5 annotate

annotate man/masqmail.conf.5 @ 413:7c5e51c53f72

Finally found the newline that was to much in spool_read_header().

author	markus schnalke <meillo@marmaro.de>
date	Wed, 29 Feb 2012 14:22:44 +0100
parents	b033fd9b96e4
children	4cbaf6d6793f

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

Mercurial > masqmail

annotate man/masqmail.conf.5 @ 413:7c5e51c53f72