masqmail-0.2: 6eec8bcfd320 docs/old-manual/docs/masqmail.route.5.html

masqmail-0.2

view docs/old-manual/docs/masqmail.route.5.html @ 125:6eec8bcfd320

don't install the tests

author	meillo@marmaro.de
date	Thu, 01 Jul 2010 14:17:50 +0200
parents
children

line source

1 <body text="#000000" link="#0000ff" bgcolor="#ffffff"><center><table width="80%">

2 <tr><td><h1>masqmail.route</h1>

3 <h2>masqmail route configuration file</h2>

6 <h2>Description</h2>

8 This man page describes the syntax of the route configuration files

9 of <a href="masqmail.8.html">masqmail</a>. Their usual locations are in /etc/masqmail/.

13 <h2>Options</h2>

17 protocol = string

19 string can be one of 'smtp' or 'pipe', default is

20 'smtp'. If set to 'smtp', mail will be sent with the SMTP protocol to

21 its destination. If set to 'pipe', you also have to set 'pipe'

22 to a command, the message will then be piped to a program. See option 'pipe' below.

27 mail_host = string

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

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

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

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

33 transfer will be much faster if you use it.

34 You can optionally give a port number following the host name

35 and a colon, eg mail_host="mail.foo.com:25".

40 resolve_list = list

42 Specify the method how the domain of the server is resolved. Possible values are

43 dns_mx, dns_a, byname. For 'dns_mx', the domain is assumed to be an MX

44 pointer to a list of host names, these will be tried each in order

45 (lowest preference value first, equal preference values in random

46 order). For 'dns_a', the domain is assumed to be an A pointer. For

47 'byname', the library function gethostbyname (3) will be used.

48 The default is "dns_mx;dns_a;byname".

53 connect_error_fail = boolean

55 If this is set, a connection error will cause a mail delivery to

56 fail, ie. it will be bounced. If it is unset, it will just be defered.

57 Default is false. The reason for this is that masqmail is designed

58 for non permanent internet connections, where such errors may occur

59 quite often, and a bounce would be annoying.

60 For the default local_net route is is set to true.

65 helo_name = string

67 Set the name given with the HELO/EHLO command. If this is not

68 set, host_name from masqmail.conf will be used, if

69 the do_correct_helo option (see below) is unset.

74 do_correct_helo = boolean

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

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

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

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

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

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

82 set, host_name from masqmail.conf or as given with

83 the helo_name (see above) will be used.

88 do_pipelining = boolean

90 If this is set to false, masqmail will not use ESMTP PIPELINING, even

91 if the server announces that it is able to cope with it. Default is true.

92 You do not want to set this to false unless the mail setup on the

93 remote server side is really broken. Keywords: wingate.

98 allowed_mail_locals = list

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

101 allowed to send mail through this connection. If unset

102 and not_allowed_mail_locals is also unset, all users are

103 allowed.

104

105

106

107

108 not_allowed_mail_locals = list

109

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

111 not allowed to send mail through this connection. Local

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

113 are part of allowed_mail_locals (see above).

114

115

116

117

118 allowed_return_paths = list

119

120 This is a semicolon ';' separated list of addresses. Messages which

121 have one one of these addresses as the return path will be used using

122 this route (if not also in not_allowed_return_paths or an item

123 in not_allowed_mail_locals matches).

124 Patterns containing '?' and '*' can be used. The special item "<>" matches

125 the null sender address (eg. failure notices or delivery notifications).

126

127

128

129

130 not_allowed_return_paths = list

131

132 This is a semicolon ';' separated list of addresses. Messages which

133 have one one of these addresses as the return path will not be used using

134 this route (even if also in allowed_return_paths or an item

135 in allowed_mail_locals matches).

136 Patterns containing '?' and '*' can be used. The special item "<>" matches

137 the null sender address (eg. failure notices or delivery notifications).

138

139

140

141

142 allowed_rcpt_domains = list

143

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

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

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

147

148

149

150

151 not_allowed_rcpt_domains = list

152

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

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

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

156 because they use a dialup list (eg. <a href = "http://maps.vix.com/dul/">http://maps.vix.com/dul/</a>. If any domain

157 matches both allowed_rcpt_domains and not_allowed_rcpt_domains,

158 mail will not be sent to this domain. Patterns containing '?' and '*' can be used.

159

160

161

162

163 set_h_from_domain = string

164

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

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

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

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

169 set_return_path_domain, see below.

170

171

172

173

174 set_return_path_domain = string

175

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

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

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

179 a valid address, because some mail servers also check

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

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

182 configuration of your mailer. Only the domain part will

183 be changed, the local part remains unchanged. Use

184 map_return_path_addresses for rewriting local parts.

185

186

187

188

189 map_h_from_addresses = list

190

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

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

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

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

195

196 Example:

197

198 map_h_from_addresses = "john: John Smith <jsmith@mail.academic.edu>;

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

200 You can use patterns, eg. * as keys.

201

202

203

204

205 map_h_reply_to_addresses = list

206

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

208

209

210

211

212 map_h_mail_followup_to_addresses = list

213

214 Same as map_h_from_addresses, but for the 'Mail-Followup-To:'

215 header. Useful when replying to mailing lists.

216

217

218

219

220 map_return_path_addresses = list

221

222 This is similar to set_return_path_domain, but more

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

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

225 separated from the addresses (the values) by colons

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

227 while map_h_from_addresses takes RFC 822 addresses. The

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

229 name.

230

231 Example:

232

233 map_return_path_addresses =

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

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

236

237 You can use patterns, eg. * as keys.

238

239

240

241

242 expand_h_sender_address = boolean

243

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

245 header to the same address as in the envelope return path address

246 (which can be set by either set_return_path_domain or map_return_path_addresses).

247 This is for mail clients (eg. Microsoft Outlook) which use this address as the sender

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

249 821. If <a href="http://www.fetchmail.org">fetchmail</a> encounters an unqualified Sender:

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

251 almost never correct. Default is true.

252

253

254

255

256 expand_h_sender_domain = boolean

257

258 Like expand_h_sender_address, but sets the domain only.

259 Deprecated, will be removed in a later version.

260

261

262

263

264 last_route = boolean

265

266 If this is set, a mail which would have been delivered using this

267 route, but has failed temporarily, will not be tried to be delivered

268 using the next route.

269 If you have set up a special route with filters using the lists

270 'allowed_rcpt_domains', 'allowed_return_paths', and

271 'allowed_mail_locals' or their complements (not_), and the mail

272 passing these rules should be delivered using this route only, you

273 should set this to 'true'. Otherwise the mail would be passed to the

274 next route (if any), unless that route has rules which prevent

275 that.

276 Default is false.

277

278

279

280

281 auth_name = string

282

283 Set the authentication type for ESMTP AUTH authentification.

284 Currently only 'cram-md5' and 'login' are supported.

285

286

287

288

289 auth_login = string

290

291 Your account name for ESMTP AUTH authentification.

292

293

294

295

296 auth_secret = string

297

298 Your secret for ESMTP AUTH authentification.

299

300

301

302

303 pop3_login = file

304

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

306 get configuration (see <a href="masqmail.get.5.html">masqmail.get</a>).

307 If you login to the POP server

308 before you send, this is not necessary.

309

310

311

312

313 wrapper = command

314

315 If set, instead of opening a connection to a remote server, command will

316 be called and all traffic will be piped to its

317 stdin and from its stdout. Purpose is to tunnel ip traffic, eg. for ssl.

318 Example for ssl tunneling:

319 wrapper="/usr/bin/openssl s_client -quiet -connect pop.gmx.net:995 2>/dev/null"

320

321

322

323

324 pipe = command

325

326 If set, and protocol is set to 'pipe', command will be

327 called and the message will be piped to its stdin. Purpose is to use

328 gateways to uucp, fax, sms or whatever else.

329 You can use variables to give as arguments to the command, these

330 are the same as for the mda in the main configuration, see <a href="masqmail.conf.5.html">masqmail.conf</a>.

331

332

333

334

335 pipe_fromline = boolean

336

337 If this is set, and protocol is set to 'pipe', a from line will be prepended to the output stream whenever

338 a pipe command is called. Default is false.

339

340

341

342

343 pipe_fromhack = boolean

344

345 If this is set, and protocol is set to 'pipe', each line beginning with 'From '

346 is replaced with '>From ' whenever a pipe command is called. You probably want this if you have

347 set pipe_fromline above. Default is false.

348

349

350

351

352

353 <h2>Author</h2>

354

355 masqmail was written by Oliver Kurth

356 <oku@masqmail.cx>You will find the newest version of

357 masqmail at <a href = "http://masqmail.cx/masqmail/">http://masqmail.cx/masqmail/</a> or search for it

358 in freshmeat (<a href = "http://www.freshmeat.net">http://www.freshmeat.net</a>). There is also a mailing list,

359 you will find information about it at masqmails main site.

360

361

362

363 <h2>Bugs</h2>

364

365 You should report them to the mailing list.

366

367

368

369 <h2>See also</h2>

370

371

372 <a href="masqmail.8.html">masqmail</a>, <a href="masqmail.conf.5.html">masqmail.conf</a>, <a href="masqmail.get.5.html">masqmail.get</a>

373

374

375

376

377 <h2>Comments</h2>

378

379 This man page was written using <a href="http://masqmail.cx/xml2man/">xml2man</a> by the same

380 author.

381

382

383

384 </td></tr></table></center>

385 </body>