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