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