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