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