1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
|
<HTML>
<HEAD>
<!-- This HTML file has been created by texi2html 1.52
from spec on 25 November 2000 -->
<TITLE>Exim Specification - 22. Options common to the aliasfile and forwardfile directors</TITLE>
</HEAD>
<body bgcolor="#FFFFFF" text="#00005A" link="#FF6600" alink="#FF9933" vlink="#990000">
Go to the <A HREF="spec_1.html">first</A>, <A HREF="spec_21.html">previous</A>, <A HREF="spec_23.html">next</A>, <A HREF="spec_59.html">last</A> section, <A HREF="spec_toc.html">table of contents</A>.
<P><HR><P>
<H1><A NAME="SEC611" HREF="spec_toc.html#TOC611">22. Options common to the aliasfile and forwardfile directors</A></H1>
<P>
<A NAME="IDX1427"></A>
<A NAME="IDX1428"></A>
<A NAME="IDX1429"></A>
<font color=green>
The <EM>aliasfile</EM> and <EM>forwardfile</EM> directors have a lot in common. Each of them
generates a list of new destinations from an incoming address; the main
difference is in the way the list is obtained. As Exim has developed, they have
grown more and more similar, and one day they may merge into a single director.
There are a substantial number of private options that are identical in both
these directors, so in order to avoid too much duplication, these common
options are described separately in this chapter.
</P>
<P>
<P>
<A NAME="IDX1430"></A>
<A NAME="IDX1431"></A>
</P>
<P>
<A NAME="IDX1432"></A>
<H3><A NAME="SEC612" HREF="spec_toc.html#TOC612">check_ancestor</A></H3>
<P>
Type: boolean<BR>
Default: false
</P>
<P>
This option is concerned with handling generated addresses which are the same
as some address in the list of aliasing or forwarding ancestors of the current
address. Although it is turned off by default in the code, it is set in the
default configuration file for handling users' <TT>`.forward'</TT> files. It is
recommended for this use of the <EM>forwardfile</EM> director, but is not commonly set
for <EM>aliasfile</EM>.
</P>
<P>
When <EM>check_ancestor</EM> is set, if a generated address is the same as any
ancestor of the current address, it is not used, but instead a copy of the
current address is passed on to subsequent directors. This helps in the case
where local part A is aliased to B, and B has a <TT>`.forward'</TT> file pointing back
to A. For example: `Joe.Bloggs' is aliased to `jb' and <EM>~jb/.forward</EM>
contains:
<PRE>
\Joe.Bloggs, <<EM>other item(s)</EM>>
</PRE>
<P>
Without the <EM>check_ancestor</EM> setting, either local part (`jb' or `joe.bloggs')
gets processed once by each director and so ends up as it was originally. If
`jb' is the real mailbox name, mail to `jb' gets delivered (having been turned
into `joe.bloggs' by the <TT>`.forward'</TT> file and back to `jb' by the alias), but
mail to `joe.bloggs' fails. Setting <EM>check_ancestor</EM> on the <EM>forwardfile</EM>
director prevents it from turning `jb' back into `joe.bloggs' when that was the
original address.
</P>
<P>
<A NAME="IDX1433"></A>
<H3><A NAME="SEC613" HREF="spec_toc.html#TOC613">directory_transport</A></H3>
<P>
Type: string, expanded<BR>
Default: unset
</P>
<P>
An <EM>aliasfile</EM> or <EM>forwardfile</EM> director sets up a direct delivery to a
directory when a path name ending with a slash is specified as a new `address'.
The transport used is specified by this option, which, after expansion, must be
the name of a configured transport.
</P>
<P>
<A NAME="IDX1434"></A>
<H3><A NAME="SEC614" HREF="spec_toc.html#TOC614">directory2_transport</A></H3>
<P>
Type: string, expanded<BR>
Default: unset
</P>
<P>
An <EM>aliasfile</EM> or <EM>forwardfile</EM> director sets up an alternative direct delivery
to a directory when a path name ending with two slashes is specified as a new
`address'. The transport used is specified by this option, which, after
expansion, must be the name of a configured transport.
</P>
<P>
<A NAME="IDX1435"></A>
<H3><A NAME="SEC615" HREF="spec_toc.html#TOC615">file_transport</A></H3>
<P>
Type: string, expanded<BR>
Default: unset
</P>
<P>
An <EM>aliasfile</EM> or <EM>forwardfile</EM> director sets up a direct delivery to a file
when a path name not ending in a slash is specified as a new `address'. The
transport used is specified by this option, which, after expansion, must be the
name of a configured transport.
</P>
<P>
<A NAME="IDX1436"></A>
<H3><A NAME="SEC616" HREF="spec_toc.html#TOC616">forbid_file</A></H3>
<P>
Type: boolean<BR>
Default: false
</P>
<P>
<A NAME="IDX1437"></A>
If this option is true, this director may not generate a new address which
specifies delivery to a local file or directory. If it attempts to do so, a
delivery failure occurs.
</P>
<P>
<A NAME="IDX1438"></A>
<H3><A NAME="SEC617" HREF="spec_toc.html#TOC617">forbid_include</A></H3>
<P>
Type: boolean<BR>
Default: false
</P>
<P>
If this option is true, items of the form
<PRE>
:include:<<EM>path name</EM>>
</PRE>
<P>
are not permitted in alias or forward files, and if one is encountered, the
message is frozen.
</P>
<P>
<A NAME="IDX1439"></A>
<H3><A NAME="SEC618" HREF="spec_toc.html#TOC618">forbid_pipe</A></H3>
<P>
Type: boolean<BR>
Default: false
</P>
<P>
<A NAME="IDX1440"></A>
If this option is true, this director may not generate a new address which
specifies delivery to a pipe. If it attempts to do so, a delivery failure
occurs.
</P>
<P>
<A NAME="IDX1441"></A>
<H3><A NAME="SEC619" HREF="spec_toc.html#TOC619">freeze_missing_include</A></H3>
<P>
Type: boolean<BR>
Default: true
</P>
<P>
<A NAME="IDX1442"></A>
If a file named by the `include' mechanism fails to open, delivery is frozen if
this option is true. Otherwise, delivery is just deferred. Unsetting this
option can be useful if included files are NFS mounted and may not always
be available.
</P>
<P>
<A NAME="IDX1443"></A>
<H3><A NAME="SEC620" HREF="spec_toc.html#TOC620">hide_child_in_errmsg</A></H3>
<P>
Type: boolean<BR>
Default: false
</P>
<P>
If this option is set true, it prevents Exim from quoting a child address if it
generates a bounce or delay message for it. Instead it says `an address
generated from <<EM>the top level address</EM>>'. Of course, this applies only to
bounces generated locally. If a message is forwarded to another host, <EM>its</EM>
bounce may well quote the generated address.
</P>
<P>
<A NAME="IDX1444"></A>
<H3><A NAME="SEC621" HREF="spec_toc.html#TOC621">modemask</A></H3>
<P>
Type: octal integer<BR>
Default: 022
</P>
<P>
This specifies mode bits which must not be set for a forward file, or for an
alias file which is an actual file. It does not apply when aliases are being
looked up using a database query. If any of the forbidden bits is set, delivery
is deferred.
</P>
<P>
<A NAME="IDX1445"></A>
<H3><A NAME="SEC622" HREF="spec_toc.html#TOC622">one_time</A></H3>
<P>
Type: boolean<BR>
Default: false
</P>
<P>
<A NAME="IDX1446"></A>
<A NAME="IDX1447"></A>
<A NAME="IDX1448"></A>
<A NAME="IDX1449"></A>
Sometimes the fact that Exim re-evaluates aliases and reprocesses forward files
each time it tries to deliver a message causes problems. This is particularly
true in the case of mailing lists and so is more likely to be a problem with
forward files than with alias files.
</P>
<P>
If <EM>one_time</EM> is set and any addresses generated by the director fail to
deliver at the first attempt, the failing addresses are added to the message as
`top level' addresses, and the parent address that generated them is marked
`delivered'. Thus, aliasing or forwarding does not happen again at the next
delivery attempt. To ensure that the director generates only addresses (as
opposed to pipe or file deliveries or auto-replies) <EM>forbid_file</EM> and
<EM>forbid_pipe</EM> must also be set, and for <EM>forwardfile</EM> with <EM>filter</EM> set,
<EM>forbid_reply</EM> must also be set.
</P>
<P>
The original top-level address is remembered with each of the generated
addresses, and is output in any log messages. However, any intermediate parent
addresses are not recorded. This makes a difference to the log only if
<EM>log_all_parents</EM> is set. It is expected that <EM>one_time</EM> will typically be
used for mailing lists, where there is normally just one level of expansion.
</P>
<P>
<A NAME="IDX1450"></A>
<H3><A NAME="SEC623" HREF="spec_toc.html#TOC623">owners</A></H3>
<P>
Type: string list<BR>
Default: unset
</P>
<P>
<A NAME="IDX1451"></A>
<A NAME="IDX1452"></A>
<A NAME="IDX1453"></A>
<A NAME="IDX1454"></A>
This specifies a list of permitted owners for a forward file, or for an alias
file which is an actual file. It does not apply when aliases are being looked
up using a database query. In the case of <EM>forwardfile</EM>, this list is in
addition to the local user when <EM>check_local_user</EM> is set. If <EM>owners</EM> is
unset (and <EM>check_local_user</EM> is false for <EM>forwardfile</EM>), no check on the
ownership is done. If the file is not correctly owned, delivery is deferred and
the message is frozen.
</P>
<P>
<A NAME="IDX1455"></A>
<H3><A NAME="SEC624" HREF="spec_toc.html#TOC624">owngroups</A></H3>
<P>
Type: string list<BR>
Default: unset
</P>
<P>
This specifies a list of permitted groups for a forward file, or for an alias
file which is an actual file. It does not apply when aliases are being looked
up using a database query. In the case of <EM>forwardfile</EM>, the list is addition
to the local user's group in the case when <EM>check_local_user</EM> is set.
However, group ownership of forward files is checked only when <EM>check_group</EM>
(an option private to <EM>forwardfile</EM>) is set. If <EM>owngroups</EM> is unset, no check
on the file's group is done. If the file's group is incorrect, the
delivery is deferred and the message is frozen.
</P>
<P>
<A NAME="IDX1456"></A>
<H3><A NAME="SEC625" HREF="spec_toc.html#TOC625">pipe_transport</A></H3>
<P>
Type: string, expanded<BR>
Default: unset
</P>
<P>
An <EM>aliasfile</EM> or <EM>forwardfile</EM> director sets up a direct delivery to a pipe
when a string starting with a vertical bar character is specified as a new
`address'. The transport used is specified by this option, which, after
expansion, must be the name of a configured transport.
</P>
<P>
<A NAME="IDX1457"></A>
<H3><A NAME="SEC626" HREF="spec_toc.html#TOC626">qualify_preserve_domain</A></H3>
<P>
Type: boolean<BR>
Default: false
</P>
<P>
<A NAME="IDX1458"></A>
<A NAME="IDX1459"></A>
If this is set and an unqualified address (one without a domain) is generated,
it is qualified with the domain of the incoming address instead of the global
setting in <EM>qualify_recipient</EM>.
</P>
<P>
<A NAME="IDX1460"></A>
<H3><A NAME="SEC627" HREF="spec_toc.html#TOC627">rewrite</A></H3>
<P>
Type: boolean<BR>
Default: true
</P>
<P>
If this option is set false, addresses generated by the director are not
subject to address rewriting. Otherwise, they are treated like new addresses.
</P>
<P>
<A NAME="IDX1461"></A>
<H3><A NAME="SEC628" HREF="spec_toc.html#TOC628">skip_syntax_errors</A></H3>
<P>
Type: boolean<BR>
Default: false
</P>
<P>
<A NAME="IDX1462"></A>
<A NAME="IDX1463"></A>
<A NAME="IDX1464"></A>
If <EM>skip_syntax_errors</EM> is set, a malformed address in an alias list or a
non-filter forward file that causes a parsing error is skipped, and an entry is
written to the main log. This may be useful for mailing lists that are
automatically managed, but note the inherent danger.
</P>
<P>
For <EM>aliasfile</EM>, Exim always considers it to be an error if no addresses at all
are generated, even if this option is set. However, for <EM>forwardfile</EM>, if all
the addresses in the list are malformed, the original address is passed on to
subsequent directors.
</P>
<P>
If <EM>skip_syntax_errors</EM> is set for an Exim filter file, any syntax error in
the filter file causes filtering to be abandoned, the incident is logged, and
the address is passed on to the next director.
</P>
<P>
<A NAME="IDX1465"></A>
<H3><A NAME="SEC629" HREF="spec_toc.html#TOC629">syntax_errors_text</A></H3>
<P>
Type: string, expanded<BR>
Default: unset
</P>
<P>
See <EM>syntax_errors_to</EM>.
</P>
<P>
<A NAME="IDX1466"></A>
<H3><A NAME="SEC630" HREF="spec_toc.html#TOC630">syntax_errors_to</A></H3>
<P>
Type: string<BR>
Default: unset
</P>
<P>
This option applies only when <EM>skip_syntax_errors</EM> is set. If any addresses
are skipped because of syntax errors, a mail message is sent to the address
specified by <EM>syntax_errors_to</EM>, giving details of the failing address(es).
If <EM>syntax_errors_text</EM> is set, its contents are expanded and placed at the
head of the error message. Often it will be appropriate to set
<EM>syntax_errors_to</EM> to be the same address as the generic <EM>errors_to</EM> option.
</P>
<P>
</font>
</P>
<P><HR><P>
Go to the <A HREF="spec_1.html">first</A>, <A HREF="spec_21.html">previous</A>, <A HREF="spec_23.html">next</A>, <A HREF="spec_59.html">last</A> section, <A HREF="spec_toc.html">table of contents</A>.
</BODY>
</HTML>
|
