Mercurial > masqmail

annotate man/masqmail.conf.5 @ 434:f2a7271746d1 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Removes Freshmeat.net from the docs The site, which was later renamed to freecode.com, is no longer maintained (contains only a static copy).
author markus schnalke <meillo@marmaro.de>
date Sat, 07 Feb 2015 11:45:07 +0100
parents 34c919a8d74e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
431
34c919a8d74e Bumps version number and updates Changelog and NEWS
markus schnalke <meillo@marmaro.de>
parents: 427
diff changeset
1 .TH masqmail.conf 5 2015-02-07 masqmail-0.3.5 "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
421
f37384470855 Changed lockdir to /var/lock/masqmail; Create lockdir and piddir on startup.
markus schnalke <meillo@marmaro.de>
parents: 418
diff changeset
95 (and lock files if \fIrun_as_user\fP).
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
96 Masqmail needs read and write permissions for this directory.
44
5e527abc1fc2 documented log_dir; minor improvements
meillo@marmaro.de
parents: 42
diff changeset
97 \fIfile\fR must be an absolute path.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
98
151
e20fe8c9936a default values for logdir and spooldir
meillo@marmaro.de
parents: 139
diff changeset
99 Default: \fI/var/spool/masqmail\fR
e20fe8c9936a default values for logdir and spooldir
meillo@marmaro.de
parents: 139
diff changeset
100
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
101 .TP
133
06e6b8c23f4d documented, yet undocumented, spool_dir config option
meillo@marmaro.de
parents: 129
diff changeset
102 \fBlock_dir = \fIfile\fR
06e6b8c23f4d documented, yet undocumented, spool_dir config option
meillo@marmaro.de
parents: 129
diff changeset
103
06e6b8c23f4d documented, yet undocumented, spool_dir config option
meillo@marmaro.de
parents: 129
diff changeset
104 The directory where masqmail stores its lock files.
06e6b8c23f4d documented, yet undocumented, spool_dir config option
meillo@marmaro.de
parents: 129
diff changeset
105 Masqmail needs read and write permissions for this directory.
421
f37384470855 Changed lockdir to /var/lock/masqmail; Create lockdir and piddir on startup.
markus schnalke <meillo@marmaro.de>
parents: 418
diff changeset
106 The default is \fI/var/lock/masqmail\fR for normal operation.
133
06e6b8c23f4d documented, yet undocumented, spool_dir config option
meillo@marmaro.de
parents: 129
diff changeset
107 \fIfile\fR must be an absolute path.
421
f37384470855 Changed lockdir to /var/lock/masqmail; Create lockdir and piddir on startup.
markus schnalke <meillo@marmaro.de>
parents: 418
diff changeset
108 The directory is created on startup if yet missing.
f37384470855 Changed lockdir to /var/lock/masqmail; Create lockdir and piddir on startup.
markus schnalke <meillo@marmaro.de>
parents: 418
diff changeset
109
f37384470855 Changed lockdir to /var/lock/masqmail; Create lockdir and piddir on startup.
markus schnalke <meillo@marmaro.de>
parents: 418
diff changeset
110 If \fIrun_as_user\fP then lock files are stored in the \fIspool_dir\fP
f37384470855 Changed lockdir to /var/lock/masqmail; Create lockdir and piddir on startup.
markus schnalke <meillo@marmaro.de>
parents: 418
diff changeset
111 directly and the \fBlock_dir\fP setting is ignored.
133
06e6b8c23f4d documented, yet undocumented, spool_dir config option
meillo@marmaro.de
parents: 129
diff changeset
112
06e6b8c23f4d documented, yet undocumented, spool_dir config option
meillo@marmaro.de
parents: 129
diff changeset
113 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
114 \fBhost_name = \fIstring\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
115
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
116 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
117 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
118 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
119 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
120
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
121 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
122 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
123 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
124 Debian policies.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
125
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
126 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
127 Use \fBlocal_hosts\fR for that.
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
128
156
ee2afbf92428 require host_name to be set in config file
meillo@marmaro.de
parents: 153
diff changeset
129 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
130
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
131 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
132 \fBlocal_hosts = \fIlist\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
133
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
134 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
135 Can contain glob patterns, like
3f923f97563b local_hosts now understands glob patterns like `*example.org'.
markus schnalke <meillo@marmaro.de>
parents: 354
diff changeset
136 `*example.org' or `mail?.*mydomain.net'.
153
51d8eadf3c79 local_hosts defaults to `localhost' now
meillo@marmaro.de
parents: 152
diff changeset
137 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
138 fully qualified domain name `foo.bar.com'.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
139
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
140 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
141 <value of \fBhost_name\fR>
157
586f001f5bbd local_hosts defaults to localhost;foo;foo.example.org now
meillo@marmaro.de
parents: 156
diff changeset
142
586f001f5bbd local_hosts defaults to localhost;foo;foo.example.org now
meillo@marmaro.de
parents: 156
diff changeset
143 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
144 (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
145
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
146 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
147 \fBlocal_addresses = \fIlist\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
148
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
149 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
150 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
151 \fBlocal_hosts\fR.
238
ec28ce798b79 minor improvements in wordings
markus schnalke <meillo@marmaro.de>
parents: 234
diff changeset
152 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
153 .IP
306
382e4260435d clarified local_addresses in man page
meillo@marmaro.de
parents: 291
diff changeset
154 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
155 seeing it as a local user.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
156
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
157 Example:
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
158
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
159 .RS 8
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
160 .nf
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
161 local_hosts = "localhost;myhost"
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
162 local_addresses = "bob@somewhere;alice@foo"
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
163 .fi
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
164 .RE
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
165 .IP
306
382e4260435d clarified local_addresses in man page
meillo@marmaro.de
parents: 291
diff changeset
166 This means mail to person1@yourdomain will effectively go to
382e4260435d clarified local_addresses in man page
meillo@marmaro.de
parents: 291
diff changeset
167 person1@localhost, if not redirected by an alias.
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
168
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
169 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
170 \fBnot_local_addresses = \fIlist\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
171
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
172 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
173 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
174 \fBlocal_hosts\fR.
238
ec28ce798b79 minor improvements in wordings
markus schnalke <meillo@marmaro.de>
parents: 234
diff changeset
175 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
176
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
177 This is the opposite of the previous case.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
178 The majority of addresses of a specific domain are local.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
179 But some users are not.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
180 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
181
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
182 Example:
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
183
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
184 .RS 8
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
185 .nf
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
186 local_hosts = "localhost;myhost;mydomain.net"
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
187 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
188 .fi
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
189 .RE
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
190 .IP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
191
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
192 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
193 \fBlisten_addresses = \fIlist\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
194
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
195 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
196 be accepted.
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
197 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
198 and a number for the port.
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
199 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
200
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
201 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
202
337
fe00f7952a7c Minor fixes in man pages, reported by lintian(1)
markus schnalke <meillo@marmaro.de>
parents: 335
diff changeset
203 Note that the names are resolved to IP addresses.
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
204 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
205 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
206
329
5ce2b1280679 Switched back from 127.0.0.1 to localhost
markus schnalke <meillo@marmaro.de>
parents: 325
diff changeset
207 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
208
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
209 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
210 \fBdo_save_envelope_to = \fIboolean\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
211
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
212 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
213 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
214 as an X-Orig-Envelope-to: header.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
215
192
89f951be358f REMOVED POP3 SUPPORT
meillo@marmaro.de
parents: 178
diff changeset
216 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
217 and the server supports Envelope-to: headers,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
218 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
219 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
220
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
221 Default is false.
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
222
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
223 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
224 \fBdo_relay = \fIboolean\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
225
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
226 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
227 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
228 and a 550 reply will be given.
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
229 Default is true.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
230
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
231 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
232 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
233
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
234 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
235 \fBdo_queue = \fIboolean\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
236
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
237 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
238 immediately when accepted.
346
1ca9bc4c6552 Minor clarifications in man pages (do_queue)
markus schnalke <meillo@marmaro.de>
parents: 337
diff changeset
239 Instead it will always queue it.
427
c96a755b5fc4 Typo fix in man page. Reported via Debian.
markus schnalke <meillo@marmaro.de>
parents: 422
diff changeset
240 (Note: Masqmail will always automatically queue mail if necessary,
346
1ca9bc4c6552 Minor clarifications in man pages (do_queue)
markus schnalke <meillo@marmaro.de>
parents: 337
diff changeset
241 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
242
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
243 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
244 Usually you should leave this option unset.
1ca9bc4c6552 Minor clarifications in man pages (do_queue)
markus schnalke <meillo@marmaro.de>
parents: 337
diff changeset
245
1ca9bc4c6552 Minor clarifications in man pages (do_queue)
markus schnalke <meillo@marmaro.de>
parents: 337
diff changeset
246 Default: false
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
247
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
248 .TP
354
08932c629849 reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents: 346
diff changeset
249 \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
250
08932c629849 reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents: 346
diff changeset
251 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
252 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
253 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
254 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
255 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
256
354
08932c629849 reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents: 346
diff changeset
257 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
258 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
259 `\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
260 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
261
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
262 .RS 8
354
08932c629849 reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents: 346
diff changeset
263 .nf
08932c629849 reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents: 346
diff changeset
264 allowed_recipients = "*@*home.net"
08932c629849 reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents: 346
diff changeset
265 connect_error_fail = true
08932c629849 reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents: 346
diff changeset
266 resolve_list = byname
08932c629849 reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents: 346
diff changeset
267 .fi
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
268 .RE
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
269 .IP
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
270
354
08932c629849 reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents: 346
diff changeset
271 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
272 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
273 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
274
08932c629849 reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents: 346
diff changeset
275 .TP
08932c629849 reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents: 346
diff changeset
276 \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
277
08932c629849 reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents: 346
diff changeset
278 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
279 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
280 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
281
08932c629849 reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents: 346
diff changeset
282 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
283 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
284
08932c629849 reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents: 346
diff changeset
285 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
286 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
287 route.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
288
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
289 Example: Your ISP has the name FastNet.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
290 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
291
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
292 .RS 8
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
293 .nf
354
08932c629849 reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents: 346
diff changeset
294 \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
295 .fi
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
296 .RE
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
297 .IP
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
298
354
08932c629849 reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents: 346
diff changeset
299 \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
300 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
301 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
302 you call `masqmail \fB\-qo \fIFastNet\fR'.
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
303 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
304
354
08932c629849 reworked the route concept; removed the idea of the localnet
markus schnalke <meillo@marmaro.de>
parents: 346
diff changeset
305 See \fBonline_query\fP.
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 .TP
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
308 \fBalias_file = \fIfile\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
309
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
310 Set this to the location of your alias file.
238
ec28ce798b79 minor improvements in wordings
markus schnalke <meillo@marmaro.de>
parents: 234
diff changeset
311 If not set, no aliasing will be done.
ec28ce798b79 minor improvements in wordings
markus schnalke <meillo@marmaro.de>
parents: 234
diff changeset
312
ec28ce798b79 minor improvements in wordings
markus schnalke <meillo@marmaro.de>
parents: 234
diff changeset
313 Default: <not set> (i.e. no aliasing is done)
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
314
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
315 .TP
387
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
316 \fBglobalias_file = \fIfile\fR
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
317
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
318 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
319 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
320 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
321 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
322 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
323 (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
324
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
325 Glob aliasing is done before normal aliasing.
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
326 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
327 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
328
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
329 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
330
a408411ff8df Added a glob-pattern aliasing facility.
markus schnalke <meillo@marmaro.de>
parents: 380
diff changeset
331 .TP
243
e758296de02d renamed `alias_local_caseless' to `caseless_matching'
markus schnalke <meillo@marmaro.de>
parents: 242
diff changeset
332 \fBcaseless_matching = \fIboolean\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
333
242
bc9d9cd9ee8e made addr_isequal() and addr_isequal_parent() more flexible
markus schnalke <meillo@marmaro.de>
parents: 238
diff changeset
334 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
335 \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
336
bc9d9cd9ee8e made addr_isequal() and addr_isequal_parent() more flexible
markus schnalke <meillo@marmaro.de>
parents: 238
diff changeset
337 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
338 correct processing of queued messages is not guaranteed otherwise.
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
339
238
ec28ce798b79 minor improvements in wordings
markus schnalke <meillo@marmaro.de>
parents: 234
diff changeset
340 Default: false
ec28ce798b79 minor improvements in wordings
markus schnalke <meillo@marmaro.de>
parents: 234
diff changeset
341
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
342 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
343 \fBpipe_fromline = \fIboolean\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
344
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
345 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
346 a pipe command is called after an alias expansion.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
347 Default is false.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
348
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
349 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
350 \fBpipe_fromhack = \fIboolean\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
351
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
352 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
353 whenever a pipe command is called after an alias expansion.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
354 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
355 Default is false.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
356
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
357 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
358 \fBmbox_default = \fIstring\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
359
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
360 The default local delivery method.
205
4fd237550525 REMOVED MAILDIR SUPPORT
meillo@marmaro.de
parents: 192
diff changeset
361 Can be mbox or mda.
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
362 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
363 \fBmda_users\fR (see below).
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
364
238
ec28ce798b79 minor improvements in wordings
markus schnalke <meillo@marmaro.de>
parents: 234
diff changeset
365 Default: mbox.
ec28ce798b79 minor improvements in wordings
markus schnalke <meillo@marmaro.de>
parents: 234
diff changeset
366
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
367 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
368 \fBmbox_users = \fIlist\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
369
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
370 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
371
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
372 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
373 \fBmda_users = \fIlist\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
374
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
375 A list of users which wish local delivery to an mda.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
376 You have to set \fBmda\fR (see below) as well.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
377
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
378 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
379 \fBmda = \fIexpand string\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
380
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
381 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
382 set this to a command.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
383 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
384 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
385 optionally enclosed in curly braces.
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
386 Variables you can use are:
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
387
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
388 .RS 8
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
389 .TP
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
390 uid
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
391 the unique message id.
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
392 (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
393 as given in the Message ID: header.)
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
394
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
395 .TP
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
396 received_host
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
397 the host the mail was received from
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
398
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
399 .TP
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
400 ident
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
401 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
402
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
403 .TP
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
404 return_path_local
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
405 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
406
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
407 .TP
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
408 return_path_domain
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
409 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
410
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
411 .TP
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
412 return_path
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
413 the complete return path (sender).
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
414
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
415 .TP
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
416 rcpt_local
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
417 the local part of the recipient.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
418
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
419 .TP
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
420 rcpt_domain
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
421 the domain part of the recipient.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
422
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
423 .TP
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
424 rcpt
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
425 the complete recipient address.
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
426 .RE
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
427 .IP
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
428
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
429 Example:
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
430
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
431 .RS 8
16
163aa299bedb fixed man pages
meillo@marmaro.de
parents: 3
diff changeset
432 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
433 .RE
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
434 .IP
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
435
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
436 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
437 a few environment variables will be set as well.
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
438 See \fBmasqmail(8)\fR.
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
439 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
440 the dollar sign `$' has to be escaped with a backslash,
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
441 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
442
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
443 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
444 \fBmda_fromline = \fIboolean\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
445
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
446 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
447 a message is delivered to an mda.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
448 Default is false.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
449
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
450 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
451 \fBmda_fromhack = \fIboolean\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
452
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
453 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
454 whenever a message is delivered to an mda.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
455 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
456 Default is false.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
457
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
458 .TP
310
f10a56dc7481 reworked online_detect to the simpler online_query
meillo@marmaro.de
parents: 306
diff changeset
459 \fBonline_query = \fIcommand line\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
460
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
461 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
462 an online connection currently.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
463
310
f10a56dc7481 reworked online_detect to the simpler online_query
meillo@marmaro.de
parents: 306
diff changeset
464 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
465 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
466 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
467 a zero status code.
310
f10a56dc7481 reworked online_detect to the simpler online_query
meillo@marmaro.de
parents: 306
diff changeset
468 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
469 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
470
310
f10a56dc7481 reworked online_detect to the simpler online_query
meillo@marmaro.de
parents: 306
diff changeset
471 Simple example:
f10a56dc7481 reworked online_detect to the simpler online_query
meillo@marmaro.de
parents: 306
diff changeset
472
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
473 .RS 8
310
f10a56dc7481 reworked online_detect to the simpler online_query
meillo@marmaro.de
parents: 306
diff changeset
474 .nf
f10a56dc7481 reworked online_detect to the simpler online_query
meillo@marmaro.de
parents: 306
diff changeset
475 #!/bin/sh
418
4cbaf6d6793f Changed the location of the route query file in the docs.
markus schnalke <meillo@marmaro.de>
parents: 398
diff changeset
476 test \-e /var/tmp/masqmail-route || exit 1
4cbaf6d6793f Changed the location of the route query file in the docs.
markus schnalke <meillo@marmaro.de>
parents: 398
diff changeset
477 cat /var/tmp/masqmail-route
310
f10a56dc7481 reworked online_detect to the simpler online_query
meillo@marmaro.de
parents: 306
diff changeset
478 exit 0
f10a56dc7481 reworked online_detect to the simpler online_query
meillo@marmaro.de
parents: 306
diff changeset
479 .fi
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
480 .RE
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
481 .IP
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
482
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
483 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
484 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
485 delivered using the connection.
310
f10a56dc7481 reworked online_detect to the simpler online_query
meillo@marmaro.de
parents: 306
diff changeset
486 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
487 (\fB\-qo\fIconnection\fR).
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 \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
490 It can contain optional arguments.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
491
310
f10a56dc7481 reworked online_detect to the simpler online_query
meillo@marmaro.de
parents: 306
diff changeset
492 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
493
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
494 .RS 8
310
f10a56dc7481 reworked online_detect to the simpler online_query
meillo@marmaro.de
parents: 306
diff changeset
495 \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
496 .RE
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
497 .IP
158
91b8b44ba619 documented that online_pipe must contain an absolute path
meillo@marmaro.de
parents: 157
diff changeset
498
310
f10a56dc7481 reworked online_detect to the simpler online_query
meillo@marmaro.de
parents: 306
diff changeset
499 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
500
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
501 .RS 8
310
f10a56dc7481 reworked online_detect to the simpler online_query
meillo@marmaro.de
parents: 306
diff changeset
502 \fI/bin/echo foo\fP
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
503 .RE
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
504 .IP
92
10d00e3235f2 updated docs (online_file, mserver_iface)
meillo@marmaro.de
parents: 57
diff changeset
505
310
f10a56dc7481 reworked online_detect to the simpler online_query
meillo@marmaro.de
parents: 306
diff changeset
506 To query a masqdialer server
f10a56dc7481 reworked online_detect to the simpler online_query
meillo@marmaro.de
parents: 306
diff changeset
507 (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
508 use:
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
509
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
510 .RS 8
310
f10a56dc7481 reworked online_detect to the simpler online_query
meillo@marmaro.de
parents: 306
diff changeset
511 \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
512 .RE
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
513 .IP
92
10d00e3235f2 updated docs (online_file, mserver_iface)
meillo@marmaro.de
parents: 57
diff changeset
514
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
515 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
516 \fBerrmsg_file = \fIfile\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
517
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
518 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
519 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
520 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
521 see \fBmda\fR above.
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
522 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
523 @msg_headers and @msg_body,
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
524 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
525 with the list of the failed recipients,
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
526 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
527
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
528 Default is /usr/share/masqmail/tpl/failmsg.tpl.
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 .TP
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
531 \fBwarnmsg_file = \fIfile\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
532
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
533 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
534 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
535
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
536 Default is /usr/share/masqmail/tpl/warnmsg.tpl.
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
537
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
538 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
539 \fBwarn_intervals\fR = \fIlist\fR
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 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
542 (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
543
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
544 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
545 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
546 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
547 if there was no attempt before.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
548
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
549 Default is "1h;4h;8h;1d;2d;3d"
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
550
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
551 .TP
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
552 \fBmax_defer_time\fR = \fItime\fR
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
553
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
554 This is the maximum time,
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
555 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
556 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
557 and the message will be bounced.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
558
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
559 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
560 was actually tried to be delivered.
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
561 If, for example, the message can only be delivered when online,
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
562 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
563
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
564 Default is 4d (4 days)
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
565
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
566 .TP
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
567 \fBlog_user = \fIname\fR
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
568
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
569 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
570
44
5e527abc1fc2 documented log_dir; minor improvements
meillo@marmaro.de
parents: 42
diff changeset
571 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
572 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
573 to the given mail address.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
574
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
575 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
576 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
577 in masqmail.alias.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
578
117
5ec5e6637049 added server-side SMTP SIZE support (patch by Paolo)
meillo@marmaro.de
parents: 115
diff changeset
579 .TP
5ec5e6637049 added server-side SMTP SIZE support (patch by Paolo)
meillo@marmaro.de
parents: 115
diff changeset
580 \fBmax_msg_size\fR = \fIbytes\fR
5ec5e6637049 added server-side SMTP SIZE support (patch by Paolo)
meillo@marmaro.de
parents: 115
diff changeset
581
5ec5e6637049 added server-side SMTP SIZE support (patch by Paolo)
meillo@marmaro.de
parents: 115
diff changeset
582 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
583 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
584 session setup.
5ec5e6637049 added server-side SMTP SIZE support (patch by Paolo)
meillo@marmaro.de
parents: 115
diff changeset
585 Clients pretending to send, or actually send,
5ec5e6637049 added server-side SMTP SIZE support (patch by Paolo)
meillo@marmaro.de
parents: 115
diff changeset
586 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
587
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
588 A zero value disables the maximum size limit.
120
cd59a5b4d3dd added support for SMTP SIZE 0 (unlimited)
meillo@marmaro.de
parents: 117
diff changeset
589
cd59a5b4d3dd added support for SMTP SIZE 0 (unlimited)
meillo@marmaro.de
parents: 117
diff changeset
590 Default is 0 (= unlimited).
117
5ec5e6637049 added server-side SMTP SIZE support (patch by Paolo)
meillo@marmaro.de
parents: 115
diff changeset
591
134
43a9447c3583 documented, yet undocumented, defer_all config option
meillo@marmaro.de
parents: 133
diff changeset
592 .TP
43a9447c3583 documented, yet undocumented, defer_all config option
meillo@marmaro.de
parents: 133
diff changeset
593 \fBdefer_all\fR = \fIboolean\fR
43a9447c3583 documented, yet undocumented, defer_all config option
meillo@marmaro.de
parents: 133
diff changeset
594
43a9447c3583 documented, yet undocumented, defer_all config option
meillo@marmaro.de
parents: 133
diff changeset
595 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
596 to any SMTP request and shuts the connection down.
43a9447c3583 documented, yet undocumented, defer_all config option
meillo@marmaro.de
parents: 133
diff changeset
597 Note: This option is for debugging purposes only.
43a9447c3583 documented, yet undocumented, defer_all config option
meillo@marmaro.de
parents: 133
diff changeset
598
43a9447c3583 documented, yet undocumented, defer_all config option
meillo@marmaro.de
parents: 133
diff changeset
599 Default: false
43a9447c3583 documented, yet undocumented, defer_all config option
meillo@marmaro.de
parents: 133
diff changeset
600
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
601
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
602 .SH AUTHOR
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
603
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
604 Masqmail was written by Oliver Kurth.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
605 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
606
398
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
607 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
608 \fBhttp://marmaro.de/prog/masqmail/\fR.
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
609 There is also a mailing list,
b033fd9b96e4 Typographic rework in man page and line-breaking.
markus schnalke <meillo@marmaro.de>
parents: 387
diff changeset
610 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
611
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
612
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
613 .SH BUGS
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
614
34
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
615 Please report bugs to the mailing list.
8ea86ac25658 reformating of man page sources
meillo@marmaro.de
parents: 32
diff changeset
616
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
617
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
618 .SH SEE ALSO
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
619
192
89f951be358f REMOVED POP3 SUPPORT
meillo@marmaro.de
parents: 178
diff changeset
620 \fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR