masqmail: 4d32eb75d3bc docs/old-manual/config.html

masqmail

view docs/old-manual/config.html @ 139:4d32eb75d3bc

/^\\fB/ in man pages indicates an option this allows automated testing if all config options are documented seems like this is just a hack, but it works ... so what?

author	meillo@marmaro.de
date	Tue, 06 Jul 2010 17:37:18 +0200
parents
children

line source

9 <HTML>

10 <HEAD>

11 <TITLE>MasqMail - Manual

12 </TITLE>

13 </HEAD>

14 <BODY TEXT="#000000" LINK="#0000ff" BGCOLOR="#ffffff">

16 <center>

17 <table width="80%">

18 <tr><td>

19 <table width="100%" bgcolor="#0000aa" cellspacing=0 cellpadding=0>

20 <tr>

21 <td>

22 <a href="manual.html">

23 <img width="20" src = "../images/u_arrow.gif" alt = "manual">

24 </a>

25 </td>

26 <td align=center width="100%">Configuration</td>

27 <td>

28 <a href="./alias.html">

29 <img width="20" src = "../images/l_arrow.gif" alt = "Alias Format">

30 </a>

31 </td>

32 <td>

33 <a href="./faq.html">

34 <img width="20" src = "../images/r_arrow.gif" alt = "Frequently Asked Questions">

35 </a>

36 </td>

37 </tr>

38 </table>

41 The configuration consists of lines of the form

43 val = expression

45 Where val is a variable name and expression a string,

46 which can be quoted with '"'. If the expression is on multiple lines

47 or contains characters other than letters, digits or the charcaters

48 '.', '-', '_', '/', it must be quoted. Unfortunately, you

49 cannot use quotes inside quotes. (Will be implemented in a later

50 version.)

52 Each val has a type, which can be boolean, numeric, string

53 or list. A boolean variable can be set with one of the values 'on',

54 'yes', and 'true' or 'off', 'no' and 'false'. List items are separated

55 with ';'. For some values patterns (like '*','?') can be used. The

56 spaces before and after the '=' are optional.

58 Most lists (exceptions: local_hosts, local_nets and

59 listen_addresses) accept files. These will be recognized by a leading

60 slash '/'. The contents of these files will be included at the

61 position of the file name, there can be items or other files before

62 and after the file entry. The format of the files is different

63 though, within these files each entry is on another line. (And not

64 separated by semicolons). This makes it easy to include large lists

65 which are common in different configuration files, so they do not have

66 to appear in every configuration file.

68 Blank lines and lines starting with '#' are ignored.

70 <h4>Main Configuration</h4>

72 run_as_user, Type: boolean, default: false

74 If this is set, masqmail runs with the user id of the user who

75 invoked it and never changes it. This is for debugging purposes

76 only. If the user is not root, masqmail will not be able to

77 listen on a port < 1000 and will not be able to deliver local mail

78 to others than the user.

80 use_syslog, Type: boolean, default: false

82 If this is set, masqmail uses syslogd for logging. It uses facility

83 MAIL. You still have to set log_dir for debug files.

85 debug_level, Type: numeric, default: 0

87 Set the debug level. Valid values are 0 to 6, increasing it further

88 makes no difference. Be careful if you set this as high as 5 or higher,

89 the logs may very soon fill your hard drive.

91 mail_dir, Type: string, default: none

93 The directory where local mail is stored, usually /var/spool/mail.

95 spool_dir, Type: string, default: none

97 The directory where masqmail stores its spool files (and later also

98 other stuff). It must have a subdirectory

99 input. Masqmail needs read and write permissions for this

100 directory. I suggest to use /var/spool/masqmail.

101

102 log_dir, Type: string, default: none

103

104 The directory where masqmail puts its log files, these are

105 masqmail.log and debug.log. Masqmail needs write

106 permission.

107

108 host_name, Type: string, default: none

109

110 This is used in different places: Masqmail identifies itself in the

111 greeting banner on incoming connections and in the HELO/EHLO command

112 for outgoing connections with this name, it is used in the Received:

113 header and to qualify the sender of a locally originating message.

114

115 It is not used to find whether an address is local. Use

116 local_hosts for that.

117

118 local_hosts, Type: list, default: none

119

120 A semicolon ';' separated list of hostnames which are considered

121 local. Normally you set it to "localhost;foo;foo.bar.com" if your host

122 has the fully qualified domain name 'foo.bar.com'.

123

124 local_nets, Type: list, default: none

125

126 A semicolon ';' separated list of hostnames which are on the

127 'local' net. Delivery to these hosts is attempted immediately. You can

128 use patterns with '*', eg. "*.bar.com".

129

130 listen_addresses, Type: list, default: none

131

132 A semicolon ';' separated list of interfaces on which connections

133 will be accepted. An interface ist defined by a hostname, optionally

134 followed by a colon ':' and a number for the port. If this is left out,

135 port 25 will be used.

136

137 You can set this to "localhost:25;foo:25" if your hostname is 'foo'.

138

139 do_queue, Type: boolean, default: false

140

141 If this is set, mail will not be delivered immediately when

142 accepted. Same as calling masqmail with the -odq option.

143

144 connect_route.<name>, Type: string, default: none

145

146 Replace <name> with a name to identify a connection. Set this

147 to a filename for the special route configuration for that

148 connection. You will use that name to call masqmail with the -qo option

149 every time a connection to your ISP is set up.

150

151 Example: Your ISP has the name FastNet. Then you write the

152 following line in the main configuration:

153

154 <pre>connect_route.FastNet = "/etc/masqmail/fastnet.route"</pre>

155

156 /etc/masqmail/fastnet.route is the route configuration file, see

157 below. As soon as a link to FastNet has been set up, you call masqmail

158 -qoFastNet. Masqmail will then read the specified file and send the

159 mails.

160

161 local_net_route, Type: string, default: none

162

163 This is similar to connect_route.<name> but for the

164 local net. Recipient addresses that are in local_nets will be

165 routed using this route configuration. Main purpose is to define a

166 mail server with mail_host in your local network. In simple

167 environments this can be left unset. If unset, a default route

168 configuration will be used.

169

170 alias_file

171

172 Set this to the location of your alias file. If unset, no aliasing

173 will be done.

174

175 online_detect, Type: string, default: none

176

177 Defines the method MasqMail uses to detect whether there is

178 currently an online connection. It can have the values file

179 or mserver.

180

181 When it is set to file, MasqMail first checks for the

182 existence of online_file (see below) and if it exists, it reads

183 it. The content of the file should be the name of the current

184 connection as defined with connect_route.<name> (without

185 a trailing newline character).

186

187 When it is set to mserver, MasqMail connects to the

188 masqdialer server using the value of mserver_iface and asks it

189 whether a connection exists and for the name, which should be the name

190 of the current connection as defined with

191 connect_route.<name>.

192

193 The online status is checked either when masqmail receives a mail

194 with an address outside your LAN or when called with the -qo option

195 (without arguments).

196

197 online_file, Type: string, default: none

198

199 This is the name of the file checked for when MasqMail determines

200 whether it is online. The file should only exist when there is

201 currently a connection. Create it in your ip-up script with eg.

202

203 <pre>

204 echo -n <name> > /tmp/connect_route

205 chmod 0644 /tmp/connect_route

206 </pre>

207

208 Do not forget to delete it in your ip-down script.

209

210 mserver_iface, Type: string, default: none

211

212 The interface the masqdialer server is listening to. Usually this

213 will be "localhost:224" if mserver is running on the same host as

214 masqmail. But using this option, you can also let masqmail run on

215 another host by setting mserver_iface to another hostname,

216 eg. "foo:224".

217

218 get.<name>, Type: string, default: none

219

220 Replace <name> with a name to identify a get

221 configuration. Set this to a filename for the get

222 configuration. These files will be used to retrieve mail when called

223 with the -g option.

224

225 <h4>Route Configuration</h4>

226

227 mail_host, Type: string, default: none

228

229 This is preferably the mail server of your ISP. All outgoing

230 messages will be sent to this host which will distribute them to their

231 destinations. If you do not set this mails will be sent

232 directly. Because the mail server is probably 'near' to you, mail

233 transfer will be much faster if you use it.

234

235 do_correct_helo, Type: boolean, default: false

236

237 If this is set, masqmail tries to look up your host name as it

238 appears on the internet and sends this in the HELO/EHLO command. Some

239 servers are so picky that they want this. Which is really

240 crazy. It just does not make any sense to lie about ones own identity,

241 because it can always be looked up by the server. Nobody should

242 believe in the name given by HELO/EHLO anyway. If this is not

243 set, host_name will be used.

244

245 allowed_mail_locals, Type: list, default: none(all)

246

247 This is a semicolon ';' separated list of local parts which will be

248 allowed to send mail through this connection. If unset and

249 not_allowed_mail_locals is also unset, all users are

250 allowed.

251

252 not_allowed_mail_locals, Type: list, default: none

253

254 This is a semicolon ';' separated list of local parts which will be

255 not allowed to send mail through this connection. Local

256 parts in this list will not be allowed to use this route even if they

257 are part of allowed_mail_locals (see above).

258

259 allowed_rcpt_domains, Type: list, default: none(all)

260

261 A list of recipient domains where mail will be sent to. This is for

262 example useful if you use this route configuration when connected to

263 another LAN via ppp. Patterns containing '?' and '*' can be used.

264

265 not_allowed_rcpt_domains, Type: list, default: none

266

267 A list of recipient domains where mail will not be sent

268 to. This is for example useful if you send mail directly (mail_host

269 ist not set) and you know of hosts that will not accept mail from you

270 because they use a dialup list (eg. <a

271 href="http://maps.vix.com/dul/"> maps.vix.com/dul/</a>). If any domain

272 matches both allowed_rcpt_domains and

273 not_allowed_rcpt_domains, mail will not be sent to

274 this domain. Patterns containing '?' and '*' can be used.

275

276 set_h_from_domain, Type: string, default: none

277

278 Replace the domain part in 'From:' headers with this value. This

279 may be useful if you use a private, outside unknown address on your

280 local LAN and want this to be replaced by the domain of the address of

281 your email addrsss on the internet. Note that this is different to

282 set_return_path_domain, see below.

283

284 set_h_reply_to_domain, Type: string, default: none

285

286 Same as set_h_from_domain, but for the 'Reply-To' header.

287

288 set_return_path_domain, Type: string, default: none

289

290 Sets the domain part of the envelope from address. Some hosts check

291 whether this is the same as the net the connection is coming from. If

292 not, they reject the mail because they suspect spamming. It should be

293 a valid address, because some mail servers also check

294 that. You can also use this to set it to your usual address on the

295 internet and put a local address only known on your LAN in the

296 configuration of your mailer. Only the domain part will

297 be changed, the local part remains unchanged. Use

298 map_return_path_addresses for rewriting local parts.

299

300 map_h_from_addresses, Type: list, default: none

301

302 This is similar to set_h_from_domain, but more flexible. Set

303 this to a list which maps local parts to a full RFC 822 compliant

304 email address, the local parts (the keys) are separated from

305 the addresses (the values) by colons (':').

306

307 Example:

308

309 <pre>

310 map_h_from_addresses =

311 "john: John Smith <jsmith@mail.academic.edu>;

312 charlie: Charlie Miller <cmiller@mx.commercial.com>"

313 </pre>

314

315 map_h_reply_to_addresses, Type: list, default: none

316

317 Same as map_h_from_addresses, but for the 'Reply-To:' header.

318

319 map_return_path_addresses, Type: list, default: none

320

321 This is similar to set_return_path_domain, but more

322 flexible. Set this to a list which maps local parts to a full RFC 821

323 compliant email address, the local parts (the keys) are

324 separated from the addresses (the values) by colons

325 (':'). Note that this option takes RFC 821 addresses

326 while map_h_from_addresses takes RFC 822 addresses. The

327 most important difference is that RFC 821 addresses have no full

328 name.

329

330 Example:

331 <pre>

332 map_return_path_addresses =

333 "john: <jsmith@mail.academic.edu>;

334 charlie: <cmiller@mx.commercial.com>"

335 </pre>

336

337 expand_h_sender_domain, Type: boolean, default: true

338

339 This sets the domain of the sender address as given by the Sender:

340 header to the same domain as in the envelope return path address

341 (which can be set by either set_return_path_domain or

342 map_return_path_addresses). This is for mail clients

343 (eg. Microsoft Outlook) which use this address as the sender

344 address. Though they should use the From: address, see RFC

345 821. If fetchmail encounters an unqualified Sender:

346 address, it will be expanded to the domain of the pop server, which is

347 almost never correct.

348

349 auth_name, Type: string, default: none

350

351 Set the authentication type for ESMTP AUTH authentification.

352 Currently only 'cram-md5' is supported.

353

354 auth_login, Type: string, default: none

355

356 Your account name for ESMTP AUTH authentification.

357

358 auth_secret, Type: string, default: none

359

360 Your secret for ESMTP AUTH authentification.

361

362 pop_login, Type: string, default: none

363

364 If your Mail server requires SMTP-after-POP, set this to a

365 get configuration. If you login to the POP server

366 before you send, this is not necessary. See the <a href =

367 "get.html"</a>get configuration</a> for more information.

368

369 </td></tr>

370

371 <tr><td>

372

373 <hr>

374 <address><a href = "mailto:kurth@innominate.de">Oliver Kurth</a></address>

375 Last modified: Tue May 30 15:19:56 CEST 2000

376

377 This page was created using <a href="http://www.freddyfrog.com/hacks/genpage/">Genpage</a> - Version: 1.0.6

378

379

380 </table>

381 </center>

382

383 </BODY>

384 </HEAD>

385