File: spec_26.html

package info (click to toggle)
exim-html 3.20-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k, sarge, woody
  • size: 2,868 kB
  • ctags: 4,188
  • sloc: makefile: 40; sh: 19
file content (283 lines) | stat: -rw-r--r-- 7,521 bytes parent folder | download
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
<HTML>
<HEAD>
<!-- This HTML file has been created by texi2html 1.52
     from spec on 25 November 2000 -->

<TITLE>Exim Specification - 26. The smartuser director</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_25.html">previous</A>, <A HREF="spec_27.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="SEC674" HREF="spec_toc.html#TOC674">26. The smartuser director</A></H1>
<P>
<A NAME="IDX1559"></A>
The <EM>smartuser</EM> director matches <EM>any</EM> local part, so it can be used to
handle local addresses that all other directors have declined. It is, of course,
subject to the generic director options, so specific instances can be used for
all addresses in certain domains, or all local parts with certain prefixes or
suffixes, or specific local parts, or any other generic condition.

</P>
<P>
If a transport is specified, <EM>smartuser</EM> directs the message to that transport,
either using the original address, or, if <EM>new_address</EM> is set, using a new
envelope address. No checking for duplication takes place. The original address
is available to the transport via the expansion variables
$<EM>original_local_part</EM> and $<EM>original_domain</EM>.

</P>
<P>
If no transport is specified, <EM>new_address</EM> must be set, and <EM>smartuser</EM>
treats its value as if it were a line from an alias file. It must consist of a
comma-separated list of items as defined in section 23.3. The
special values <EM>:blackhole:</EM>, <EM>:defer:</EM>, and <EM>:fail:</EM> (but not <EM>:include:</EM>) may
be used,
<font color=green>
and file or pipe items may also appear.
</font>
If any new address is a duplicate of any other address in the message, it is
discarded.

</P>

<P>

<P>
<A NAME="IDX1560"></A>

</P>
<P>
<font color=green>
<A NAME="IDX1561"></A>


<H3><A NAME="SEC675" HREF="spec_toc.html#TOC675">directory_transport (smartuser)</A></H3>

<P>
Type: string, expanded<BR>
Default: unset

</P>
<P>
A <EM>smartuser</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="IDX1562"></A>


<H3><A NAME="SEC676" HREF="spec_toc.html#TOC676">directory2_transport (smartuser)</A></H3>

<P>
Type: string, expanded<BR>
Default: unset

</P>
<P>
A <EM>smartuser</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="IDX1563"></A>


<H3><A NAME="SEC677" HREF="spec_toc.html#TOC677">file_transport (smartuser)</A></H3>

<P>
Type: string, expanded<BR>
Default: unset

</P>
<P>
A <EM>smartuser</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="IDX1564"></A>


<H3><A NAME="SEC678" HREF="spec_toc.html#TOC678">forbid_file (smartuser)</A></H3>

<P>
Type: boolean<BR>
Default: false

</P>
<P>
<A NAME="IDX1565"></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="IDX1566"></A>


<H3><A NAME="SEC679" HREF="spec_toc.html#TOC679">forbid_pipe (smartuser)</A></H3>

<P>
Type: boolean<BR>
Default: false

</P>
<P>
<A NAME="IDX1567"></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="IDX1568"></A>


<H3><A NAME="SEC680" HREF="spec_toc.html#TOC680">hide_child_in_errmsg (smartuser)</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 &#60;<EM>the top level address</EM>&#62;'. 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.
</font>

</P>
<P>
<A NAME="IDX1569"></A>


<H3><A NAME="SEC681" HREF="spec_toc.html#TOC681">new_address (smartuser)</A></H3>

<P>
Type: string, expanded<BR>
Default: unset

</P>
<P>
When <EM>transport</EM> is not set, this option is treated like a line from an alias
file. Any unqualified addresses it contains are qualified using the value of
<EM>qualify_recipient</EM>.
<font color=green>
This is the most common configuration for <EM>smartuser</EM>.
</font>

</P>
<P>
When <EM>transport</EM> is set, <EM>new_address</EM> specifies a single new address, to
replace the current one in the message's envelope when it is transported. The
address must be qualified (that is, contain an @ character).

</P>
<P>
In both cases, new addresses are rewritten by Exim's normal rewriting rules
(see chapter 34) unless the <EM>rewrite</EM> option is turned off.

</P>
<P>
The value of <EM>new_address</EM> is expanded, so settings such as

<PRE>
new_address = $local_part@some.new.host
</PRE>

<P>
can be used, or a file lookup on the local part can be done. If the expansion
fails as a result of an explicit `fail' item in an expansion sub-expression,
the director just declines to handle the address. Otherwise, an expansion
failure is treated as a serious configuration error, and causes a panic, unless
<EM>panic_expansion_fail</EM> is set false, in which case the same action is taken
as for `fail'.

</P>
<P>
<A NAME="IDX1570"></A>


<H3><A NAME="SEC682" HREF="spec_toc.html#TOC682">panic_expansion_fail (smartuser)</A></H3>

<P>
Type: boolean<BR>
Default: true

</P>
<P>
See <EM>new_address</EM> above.

</P>
<P>
<font color=green>
<A NAME="IDX1571"></A>


<H3><A NAME="SEC683" HREF="spec_toc.html#TOC683">pipe_transport (smartuser)</A></H3>

<P>
Type: string, expanded<BR>
Default: unset

</P>
<P>
A <EM>smartuser</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="IDX1572"></A>


<H3><A NAME="SEC684" HREF="spec_toc.html#TOC684">qualify_preserve_domain (smartuser)</A></H3>

<P>
Type: boolean<BR>
Default: false

</P>
<P>
<A NAME="IDX1573"></A>
<A NAME="IDX1574"></A>
If this is set and an unqualified address (one without a domain) is present in
<EM>new_address</EM>, it is qualified with the domain of the incoming address instead
of the global setting in <EM>qualify_recipient</EM>.
</font>

</P>
<P>
<A NAME="IDX1575"></A>


<H3><A NAME="SEC685" HREF="spec_toc.html#TOC685">rewrite (smartuser)</A></H3>

<P>
Type: boolean<BR>
Default: true

</P>
<P>
If this option is set false, addresses specified by <EM>new_address</EM> are not
subject to rewriting.

</P>

<P><HR><P>
Go to the <A HREF="spec_1.html">first</A>, <A HREF="spec_25.html">previous</A>, <A HREF="spec_27.html">next</A>, <A HREF="spec_59.html">last</A> section, <A HREF="spec_toc.html">table of contents</A>.
</BODY>
</HTML>