Mercurial > masqmail
annotate man/masqmail.conf.5 @ 175:25b769efafe6
merge
| author | meillo@marmaro.de |
|---|---|
| date | Wed, 14 Jul 2010 12:15:45 +0200 |
| parents | 5b621742b2e7 dbe3dadd1afe |
| children | 91f8ee6514f5 |
| rev | line source |
|---|---|
|
134
43a9447c3583
documented, yet undocumented, defer_all config option
meillo@marmaro.de
parents:
133
diff
changeset
|
1 .TH masqmail.conf 5 2010-07-06 masqmail-0.2.25 "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, |
| 139 | 29 \fBonline_routes\fR, and \fBonline_gets\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 \fBremote_port = \fIn\fR |
| 0 | 117 |
| 118 The remote port number to be used. This defaults to port 25. | |
| 119 | |
| 34 | 120 This option is deprecated. |
| 121 Use \fBhost_name\fR in the route configuration instead. | |
| 122 See \fBmasqmail.route(5)\fR. | |
| 123 | |
| 0 | 124 .TP |
| 34 | 125 \fBlocal_hosts = \fIlist\fR |
| 0 | 126 |
| 34 | 127 A semicolon `;' separated list of hostnames which are considered local. |
| 153 | 128 Normally you should set it to "localhost;foo;foo.bar.com" if your host has the |
| 34 | 129 fully qualified domain name `foo.bar.com'. |
| 0 | 130 |
|
157
586f001f5bbd
local_hosts defaults to localhost;foo;foo.example.org now
meillo@marmaro.de
parents:
156
diff
changeset
|
131 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
|
132 |
|
586f001f5bbd
local_hosts defaults to localhost;foo;foo.example.org now
meillo@marmaro.de
parents:
156
diff
changeset
|
133 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
|
134 (if you have set \fBhost_name\fR to \fIfoo.example.org\fR) |
| 153 | 135 |
| 0 | 136 .TP |
| 34 | 137 \fBlocal_nets = \fIlist\fR |
| 0 | 138 |
| 34 | 139 A semicolon `;' separated list of hostnames which are on the `local' net. |
| 140 Delivery to these hosts is attempted immediately. | |
| 141 You can use patterns with `*', e.g. "*.bar.com". | |
| 0 | 142 |
| 143 .TP | |
| 34 | 144 \fBlocal_addresses = \fIlist\fR |
| 0 | 145 |
| 34 | 146 A semicolon `;' separated list of fully qualified email-addresses which are |
| 147 considered local although their domain name part is not in the list of \fBlocal_hosts\fR. | |
| 0 | 148 |
| 34 | 149 For example: There are two people working at your LAN: person1@yourdomain and person2@yourdomain. |
| 150 But there are other persons @yourdomain which are NOT local. | |
| 151 So you can not put yourdomain to the list of local_hosts. | |
| 152 If person1 now wants to write to person2@yourdomain and this mail should not leave the LAN then you can put | |
| 0 | 153 |
| 154 local_addresses = "person1@yourdomain;person2@yourdomain" | |
| 155 | |
| 156 to your masqmail.conf. | |
| 34 | 157 |
| 0 | 158 .TP |
| 34 | 159 \fBnot_local_addresses = \fIlist\fR |
| 0 | 160 |
| 34 | 161 A semicolon `;' separated list of fully qualified email-addresses which are |
| 162 considered not local although their domain name part is in the list of \fBlocal_hosts\fR. | |
| 0 | 163 |
| 34 | 164 This is the opposite of the previous case. |
| 165 The majority of addresses of a specific domain are local. | |
| 166 But some users are not. | |
| 167 With this option you can easily exclude these users. | |
| 0 | 168 |
| 169 Example: | |
| 170 | |
| 171 local_hosts = "localhost;myhost;mydomain.net" | |
| 172 | |
| 173 not_local_addresses = "eric@mydomain.net" | |
| 34 | 174 |
| 0 | 175 .TP |
| 34 | 176 \fBlisten_addresses = \fIlist\fR |
| 0 | 177 |
| 34 | 178 A semicolon `;' separated list of interfaces on which connections will be accepted. |
| 179 An interface ist defined by a hostname, optionally followed by a colon `:' and a number for the port. | |
| 180 If this is left out, port 25 will be used. | |
| 0 | 181 |
| 34 | 182 You can set this to "localhost:25;foo:25" if your hostname is `foo'. |
| 0 | 183 |
| 34 | 184 Note that the names are resolved to IP addreses. |
| 185 If your host has different names which resolve to the same IP, | |
| 186 use only one of them, otherwise you will get an error message. | |
| 187 | |
| 161 | 188 Default: \fIlocalhost:25\fR (i.e. only local processes can connect) |
| 189 | |
| 0 | 190 .TP |
| 34 | 191 \fBdo_save_envelope_to = \fIboolean\fR |
| 0 | 192 |
| 34 | 193 If this is set to true, a possibly existing Envelope-to: header in an incoming mail |
| 194 which is received via either pop3 or smtp will be saved as an X-Orig-Envelope-to: header. | |
| 0 | 195 |
| 34 | 196 This is useful if you retrieve mail from a pop3 server with either masqmail or fetchmail, |
| 197 and the server supports Envelope-to: headers, | |
| 198 and you want to make use of those with a mail filtering tool, e.g. procmail. | |
| 199 It cannot be preserved because masqmail sets such a header by itself. | |
| 0 | 200 |
| 201 Default is false. | |
| 34 | 202 |
| 0 | 203 .TP |
| 34 | 204 \fBdo_relay = \fIboolean\fR |
| 0 | 205 |
| 34 | 206 If this is set to false, mail with a return path that is not local and a destination |
| 207 that is also not local will not be accepted via smtp and a 550 reply will be given. | |
| 208 Default is true. | |
| 0 | 209 |
| 34 | 210 Note that this will not protect you from spammers using open relays, |
| 211 but from users unable to set their address in their mail clients. | |
| 212 | |
| 0 | 213 .TP |
| 34 | 214 \fBdo_queue = \fIboolean\fR |
| 0 | 215 |
| 34 | 216 If this is set, mail will not be delivered immediately when accepted. |
| 217 Same as calling masqmail with the \fB\-odq\fR option. | |
| 0 | 218 |
| 219 .TP | |
| 34 | 220 \fBonline_routes.\fIname\fR = \fIlist\fR |
| 0 | 221 |
| 34 | 222 Replace \fIname\fR with a name to identify a connection. |
| 223 Set this to a filename (or a list of filenames) for the special route configuration for that connection. | |
| 224 You will use that name to call masqmail with the \fB\-qo\fR option every time a | |
| 225 connection to your ISP is set up. | |
| 0 | 226 |
| 34 | 227 Example: Your ISP has the name FastNet. |
| 228 Then you write the following line in the main configuration: | |
| 0 | 229 |
| 139 | 230 \fBonline_routes.FastNet\fR = \fI"/etc/masqmail/fastnet.route"\fR |
| 0 | 231 |
| 34 | 232 \fI/etc/masqmail/fastnet.route\fR is the route configuration file, see \fBmasqmail.route(5)\fR. |
| 233 As soon as a link to FastNet has been set up, you call masqmail \fB\-qo \fIFastNet\fR. | |
| 234 Masqmail will then read the specified file and send the mails. | |
| 0 | 235 |
| 34 | 236 .TP |
| 237 \fBconnect_route.\fIname\fR = \fIlist\fR | |
| 0 | 238 |
| 34 | 239 Old name for \fBonline_routes\fR. |
| 240 | |
| 0 | 241 .TP |
| 34 | 242 \fBlocal_net_route = \fIfile\fR |
| 0 | 243 |
| 34 | 244 This is similar to \fBonline_routes.\fIname\fR but for the local net. |
| 245 Recipient addresses that are in local_nets will be routed using this route configuration. | |
| 246 Main purpose is to define a mail server with mail_host in your local network. | |
| 247 In simple environments this can be left unset. | |
| 248 If unset, a default route configuration will be used. | |
| 0 | 249 |
| 34 | 250 .TP |
| 251 \fBalias_file = \fIfile\fR | |
| 0 | 252 |
| 34 | 253 Set this to the location of your alias file. |
| 254 If unset, no aliasing will be done. | |
| 255 | |
| 0 | 256 .TP |
| 34 | 257 \fBalias_local_caseless = \fIboolean\fR |
| 0 | 258 |
| 259 If this is set, local parts in the alias file will be matched disregarding upper/lower case. | |
| 34 | 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. |
| 280 Can be one of mbox, mda or maildir (the latter only if maildir support is enabled at compile time). | |
| 281 Default is mbox. | |
| 282 You can override this for each user by using the \fBmbox_users\fR, \fBmda_users\fR, | |
| 283 or \fBmaildir_users\fR options (see below). | |
| 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 \fBmaildir_users = \fIlist\fR |
| 0 | 298 |
| 34 | 299 A list of users which wish delivery to a qmail style maildir. |
| 300 The path to maildir is ~/Maildir/. | |
| 301 The maildir will be created if it does not exist. | |
| 302 | |
| 0 | 303 .TP |
| 34 | 304 \fBmda = \fIexpand string\fR |
| 0 | 305 |
| 34 | 306 If you want local delivery to be transferred to an mda (Mail Delivery Agent), |
| 307 set this to a command. | |
| 308 The argument will be expanded on delivery time, | |
| 309 you can use variables beginning with a dolloar sign `$', optionally enclosed in curly braces. | |
| 310 Variables you can use are: | |
| 0 | 311 |
| 34 | 312 uid - the unique message id. |
| 313 This is not necessarily identical with the Message ID as given in the Message ID: header. | |
| 0 | 314 |
| 315 received_host - the host the mail was received from | |
| 316 | |
| 34 | 317 ident - the ident, this is either the ident delivered by the ident protocol |
| 318 or the user id of the sender if the message was received locally. | |
| 0 | 319 |
| 320 return_path_local - the local part of the return path (sender). | |
| 321 | |
| 322 return_path_domain - the domain part of the return path (sender). | |
| 323 | |
| 324 return_path - the complete return path (sender). | |
| 325 | |
| 326 rcpt_local - the local part of the recipient. | |
| 327 | |
| 328 rcpt_domain - the domain part of the recipient. | |
| 329 | |
| 330 rcpt - the complete recipient address. | |
| 331 | |
| 332 Example: | |
| 333 | |
| 16 | 334 mda="/usr/bin/procmail \-Y \-d ${rcpt_local}" |
| 0 | 335 |
| 34 | 336 For the mda, as for pipe commands, a few environment variables will be set as well. |
| 337 See \fBmasqmail(8)\fR. | |
| 338 To use environment variables for the mda, the dollar sign `$' has to be escaped with a backslash, | |
| 339 otherwise they will be tried to be expanded with the internal variables. | |
| 0 | 340 |
| 341 .TP | |
| 34 | 342 \fBmda_fromline = \fIboolean\fR |
| 0 | 343 |
| 34 | 344 If this is set, a from line will be prepended to the output stream whenever |
| 345 a message is delivered to an mda. | |
| 346 Default is false. | |
| 0 | 347 |
| 348 .TP | |
| 34 | 349 \fBmda_fromhack = \fIboolean\fR |
| 0 | 350 |
| 34 | 351 If this is set, each line beginning with `From ' is replaced with `>From ' |
| 352 whenever a message is delivered to an mda. | |
| 353 You probably want this if you have set \fBmda_fromline\fR above. | |
| 354 Default is false. | |
| 355 | |
| 356 .TP | |
| 357 \fBonline_detect = \fIstring\fR | |
| 0 | 358 |
| 34 | 359 Defines the method masqmail uses to detect whether there is currently an online connection. |
| 164 | 360 It can have the values \fIfile\fR or \fIpipe\fR. |
| 0 | 361 |
|
112
c2f1ba43ae0c
typographic fixes for masqmail.conf.5 (thanks to Paolo)
meillo@marmaro.de
parents:
95
diff
changeset
|
362 When it is set to \fIfile\fR, masqmail first checks for the existence of \fBonline_file\fR |
| 34 | 363 (see below) and if it exists, it reads it. |
| 364 The content of the file should be the name of the current connection as defined | |
| 365 with \fBconnect_route.\fIname\fR (trailing whitespace is removed). | |
| 0 | 366 |
|
112
c2f1ba43ae0c
typographic fixes for masqmail.conf.5 (thanks to Paolo)
meillo@marmaro.de
parents:
95
diff
changeset
|
367 When it is set to \fIpipe\fR, masqmail calls the executable given by the |
| 34 | 368 \fBonline_pipe\fR option (see below) and reads the current online status from its standard output. |
| 0 | 369 |
| 34 | 370 No matter how masqmail detects the online status, |
| 371 only messages that are accepted at online time will be delivered using the connection. | |
| 372 The spool still has to be emptied with masqmail \fB\-qo\fIconnection\fR. | |
| 373 | |
| 0 | 374 .TP |
| 34 | 375 \fBonline_file = \fIfile\fR |
| 0 | 376 |
| 34 | 377 This is the name of the file checked for when masqmail determines whether it is online. |
| 378 The file should only exist when there is currently a connection. | |
| 379 Create it in your ip-up script with e.g. | |
| 0 | 380 |
| 92 | 381 echo "connection-name" >/var/run/masqmail/masqmail-route |
| 0 | 382 |
|
37
4fee89792559
updated config example and man page to new default online file
meillo@marmaro.de
parents:
34
diff
changeset
|
383 chmod 0644 /var/run/masqmail/masqmail-route |
| 0 | 384 |
| 385 Do not forget to delete it in your ip-down script. | |
| 34 | 386 |
| 0 | 387 .TP |
| 34 | 388 \fBonline_pipe = \fIfile\fR |
| 0 | 389 |
| 34 | 390 This is the name of the executable which will be called to determine the online status. |
| 391 This executable should just print the name of the current connection to | |
| 392 the standard output and return a zero status code. | |
| 393 masqmail assumes it is offline if the script returns with a non zero status. | |
| 394 Simple example: | |
| 0 | 395 |
| 396 #!/bin/sh | |
| 397 | |
|
37
4fee89792559
updated config example and man page to new default online file
meillo@marmaro.de
parents:
34
diff
changeset
|
398 [ \-e /var/run/masqmail/masqmail-route ] || exit 1 |
| 0 | 399 |
|
37
4fee89792559
updated config example and man page to new default online file
meillo@marmaro.de
parents:
34
diff
changeset
|
400 cat /var/run/masqmail/masqmail-route |
| 0 | 401 |
| 402 exit 0 | |
| 403 | |
|
129
8f371bdc7571
small typographic fix (`file' is a value)
meillo@marmaro.de
parents:
120
diff
changeset
|
404 Of course, instead of the example above you could as well use \fIfile\fR as |
| 34 | 405 the online detection method, but you can do something more sophisticated. |
| 406 | |
|
158
91b8b44ba619
documented that online_pipe must contain an absolute path
meillo@marmaro.de
parents:
157
diff
changeset
|
407 \fIfile\fR must contain an absolute path to an executable program. |
|
91b8b44ba619
documented that online_pipe must contain an absolute path
meillo@marmaro.de
parents:
157
diff
changeset
|
408 It can contain optional arguments. |
| 0 | 409 |
|
158
91b8b44ba619
documented that online_pipe must contain an absolute path
meillo@marmaro.de
parents:
157
diff
changeset
|
410 Example: \fI/bin/echo foo\fR |
|
91b8b44ba619
documented that online_pipe must contain an absolute path
meillo@marmaro.de
parents:
157
diff
changeset
|
411 (This tells masqmail to be always online with connection `foo'.) |
|
91b8b44ba619
documented that online_pipe must contain an absolute path
meillo@marmaro.de
parents:
157
diff
changeset
|
412 |
| 164 | 413 For querying a masqdialer server |
| 414 (= asking it whether a connection exists and what its name is) | |
| 415 use: | |
| 92 | 416 |
| 417 online_method=pipe | |
| 418 | |
| 164 | 419 online_pipe="/usr/bin/mservdetect localhost 224" |
| 92 | 420 |
| 0 | 421 |
| 34 | 422 .TP |
| 423 \fBget.\fIname\fR = \fIfile\fR | |
| 0 | 424 |
| 34 | 425 Replace \fIname\fR with a name to identify a get configuration. |
| 426 Set this to a filename for the get configuration. | |
| 427 These files will be used to retrieve mail when called with the \-g option. | |
| 428 | |
| 0 | 429 .TP |
| 34 | 430 \fBonline_gets.\fIname\fR = \fIlist\fR |
| 0 | 431 |
| 34 | 432 Replace \fIname\fR with a name to identify an online configuration. |
| 433 Set this to a filename (or a list of filenames) for the get configuration. | |
| 434 These files will be used to retrieve mail when called with the \-go option. | |
| 0 | 435 |
| 436 .TP | |
| 34 | 437 \fBident_trusted_nets = \fIlist\fR |
| 0 | 438 |
| 34 | 439 \fIlist\fR is a list of networks of the form a.b.c.d/e (e.g. 192.168.1.0/24), |
| 440 from which the ident given by the ident protocol will be trusted, | |
| 441 so a user can delete his mail from the queue if the ident is identical to his login name. | |
| 442 | |
| 0 | 443 .TP |
| 34 | 444 \fBerrmsg_file = \fIfile\fR |
| 0 | 445 |
| 34 | 446 Set this to a template which will be used to generate delivery failure reports. |
| 447 Variable parts within the template begin with a dollar sign and are identical | |
| 448 to those which can be used as arguments for the mda command, see \fBmda\fR above. | |
| 449 Additional information can be included with @failed_rcpts, @msg_headers and @msg_body, | |
| 450 these must be at the beginning of a line and will be replaced with the list of the failed recipients, | |
| 451 the message headers and the message body of the failed message. | |
| 0 | 452 |
| 453 Default is /usr/share/masqmail/tpl/failmsg.tpl. | |
| 454 | |
| 34 | 455 .TP |
| 456 \fBwarnmsg_file = \fIfile\fR | |
| 0 | 457 |
| 34 | 458 Set this to a template which will be used to generate delivery warning reports. |
| 459 It uses the same mechanisms for variables as \fBerrmsg_file\fR, see above. | |
| 0 | 460 |
| 461 Default is /usr/share/masqmail/tpl/warnmsg.tpl. | |
| 34 | 462 |
| 0 | 463 .TP |
| 34 | 464 \fBwarn_intervals\fR = \fIlist\fR |
| 0 | 465 |
| 34 | 466 Set this to a list of time intervals, at which delivery warnings |
| 467 (starting with the receiving time of the message) shall be generated. | |
| 0 | 468 |
| 34 | 469 A warning will only be generated just after an attempt to deliver the mail |
| 470 and if that attempt failed temporarily. | |
| 471 So a warning may be generated after a longer time, if there was no attempt before. | |
| 0 | 472 |
| 473 Default is "1h;4h;8h;1d;2d;3d" | |
| 34 | 474 |
| 0 | 475 .TP |
| 34 | 476 \fBmax_defer_time\fR = \fItime\fR |
| 0 | 477 |
| 34 | 478 This is the maximum time, in which a temporarily failed mail will be kept in the spool. |
| 479 When this time is exceeded, it will be handled as a delivery failure, | |
| 480 and the message will be bounced. | |
| 0 | 481 |
| 34 | 482 The excedence of this time will only be noticed if the message was actually tried to be delivered. |
| 483 If, for example, the message can only be delivered when online, | |
| 484 but you have not been online for that time, no bounce will be generated. | |
| 0 | 485 |
| 486 Default is 4d (4 days) | |
| 487 | |
| 34 | 488 .TP |
| 489 \fBlog_user = \fIname\fR | |
| 490 | |
| 491 Replace \fIname\fR with a valid local or remote mail address. | |
| 0 | 492 |
| 44 | 493 If this option is set, then a copy of every mail, |
| 494 that passes through the masqmail system will also be sent to the given mail address. | |
| 0 | 495 |
| 34 | 496 For example you can feed your mails into a program like hypermail |
| 497 for archiving purpose by placing an appropriate pipe command in masqmail.alias | |
| 0 | 498 |
|
117
5ec5e6637049
added server-side SMTP SIZE support (patch by Paolo)
meillo@marmaro.de
parents:
115
diff
changeset
|
499 .TP |
|
5ec5e6637049
added server-side SMTP SIZE support (patch by Paolo)
meillo@marmaro.de
parents:
115
diff
changeset
|
500 \fBmax_msg_size\fR = \fIbytes\fR |
|
5ec5e6637049
added server-side SMTP SIZE support (patch by Paolo)
meillo@marmaro.de
parents:
115
diff
changeset
|
501 |
|
5ec5e6637049
added server-side SMTP SIZE support (patch by Paolo)
meillo@marmaro.de
parents:
115
diff
changeset
|
502 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
|
503 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
|
504 session setup. |
|
5ec5e6637049
added server-side SMTP SIZE support (patch by Paolo)
meillo@marmaro.de
parents:
115
diff
changeset
|
505 Clients pretending to send, or actually send, |
|
5ec5e6637049
added server-side SMTP SIZE support (patch by Paolo)
meillo@marmaro.de
parents:
115
diff
changeset
|
506 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
|
507 |
|
120
cd59a5b4d3dd
added support for SMTP SIZE 0 (unlimited)
meillo@marmaro.de
parents:
117
diff
changeset
|
508 `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
|
509 |
|
cd59a5b4d3dd
added support for SMTP SIZE 0 (unlimited)
meillo@marmaro.de
parents:
117
diff
changeset
|
510 Default is 0 (= unlimited). |
|
117
5ec5e6637049
added server-side SMTP SIZE support (patch by Paolo)
meillo@marmaro.de
parents:
115
diff
changeset
|
511 |
|
134
43a9447c3583
documented, yet undocumented, defer_all config option
meillo@marmaro.de
parents:
133
diff
changeset
|
512 .TP |
|
43a9447c3583
documented, yet undocumented, defer_all config option
meillo@marmaro.de
parents:
133
diff
changeset
|
513 \fBdefer_all\fR = \fIboolean\fR |
|
43a9447c3583
documented, yet undocumented, defer_all config option
meillo@marmaro.de
parents:
133
diff
changeset
|
514 |
|
43a9447c3583
documented, yet undocumented, defer_all config option
meillo@marmaro.de
parents:
133
diff
changeset
|
515 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
|
516 to any SMTP request and shuts the connection down. |
|
43a9447c3583
documented, yet undocumented, defer_all config option
meillo@marmaro.de
parents:
133
diff
changeset
|
517 Note: This option is for debugging purposes only. |
|
43a9447c3583
documented, yet undocumented, defer_all config option
meillo@marmaro.de
parents:
133
diff
changeset
|
518 |
|
43a9447c3583
documented, yet undocumented, defer_all config option
meillo@marmaro.de
parents:
133
diff
changeset
|
519 Default: false |
|
43a9447c3583
documented, yet undocumented, defer_all config option
meillo@marmaro.de
parents:
133
diff
changeset
|
520 |
| 34 | 521 |
| 0 | 522 .SH AUTHOR |
| 523 | |
| 34 | 524 Masqmail was written by Oliver Kurth. |
| 525 It is now maintained by Markus Schnalke <meillo@marmaro.de>. | |
| 0 | 526 |
|
95
e01fed4846e4
masqmail's homepage moved prog.marmaro.de/masqmail -> marmaro.de/prog/masqmail
meillo@marmaro.de
parents:
92
diff
changeset
|
527 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
|
528 There is also a mailing list, you will find information about it at masqmail's main site. |
| 0 | 529 |
| 34 | 530 |
| 0 | 531 .SH BUGS |
| 532 | |
| 34 | 533 Please report bugs to the mailing list. |
| 534 | |
| 0 | 535 |
| 536 .SH SEE ALSO | |
| 537 | |
| 34 | 538 \fBmasqmail(8)\fR, \fBmasqmail.route(5)\fR, \fBmasqmail.get(5)\fR |