fix the previous commit
[exim-website.git] / docbook / 4.83 / spec.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
3
4
5 <?sdop
6   foot_right_recto="&chaptertitle; (&chapternumber;)"
7   foot_right_verso="&chaptertitle; (&chapternumber;)"
8   toc_chapter_blanks="yes,yes"
9   table_warn_overflow="overprint"
10 ?>
11 <book>
12 <bookinfo>
13 <title>Specification of the Exim Mail Transfer Agent</title>
14 <titleabbrev>The Exim MTA</titleabbrev>
15 <date>
16 21 Jul 2014
17 </date>
18 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
19 <authorinitials>EM</authorinitials>
20 <revhistory><revision>
21 <revnumber>4.83</revnumber>
22 <date>21 Jul 2014</date>
23   <authorinitials>EM</authorinitials>
24 </revision></revhistory>
25 <copyright><year>
26 2014
27            </year><holder>University of Cambridge</holder></copyright>
28 </bookinfo>
29 <chapter id="CHID1">
30 <title>Introduction</title>
31
32 <indexterm role="variable">
33   <primary>$1, $2, etc.</primary>
34   <see><emphasis>numerical variables</emphasis></see>
35 </indexterm>
36 <indexterm role="concept">
37   <primary>address</primary>
38   <secondary>rewriting</secondary>
39   <see><emphasis>rewriting</emphasis></see>
40 </indexterm>
41 <indexterm role="concept">
42   <primary>Bounce Address Tag Validation</primary>
43   <see><emphasis>BATV</emphasis></see>
44 </indexterm>
45 <indexterm role="concept">
46   <primary>Client SMTP Authorization</primary>
47   <see><emphasis>CSA</emphasis></see>
48 </indexterm>
49 <indexterm role="concept">
50   <primary>CR character</primary>
51   <see><emphasis>carriage return</emphasis></see>
52 </indexterm>
53 <indexterm role="concept">
54   <primary>CRL</primary>
55   <see><emphasis>certificate revocation list</emphasis></see>
56 </indexterm>
57 <indexterm role="concept">
58   <primary>delivery</primary>
59   <secondary>failure report</secondary>
60   <see><emphasis>bounce message</emphasis></see>
61 </indexterm>
62 <indexterm role="concept">
63   <primary>dialup</primary>
64   <see><emphasis>intermittently connected hosts</emphasis></see>
65 </indexterm>
66 <indexterm role="concept">
67   <primary>exiscan</primary>
68   <see><emphasis>content scanning</emphasis></see>
69 </indexterm>
70 <indexterm role="concept">
71   <primary>failover</primary>
72   <see><emphasis>fallback</emphasis></see>
73 </indexterm>
74 <indexterm role="concept">
75   <primary>fallover</primary>
76   <see><emphasis>fallback</emphasis></see>
77 </indexterm>
78 <indexterm role="concept">
79   <primary>filter</primary>
80   <secondary>Sieve</secondary>
81   <see><emphasis>Sieve filter</emphasis></see>
82 </indexterm>
83 <indexterm role="concept">
84   <primary>ident</primary>
85   <see><emphasis>RFC 1413</emphasis></see>
86 </indexterm>
87 <indexterm role="concept">
88   <primary>LF character</primary>
89   <see><emphasis>linefeed</emphasis></see>
90 </indexterm>
91 <indexterm role="concept">
92   <primary>maximum</primary>
93   <seealso><emphasis>limit</emphasis></seealso>
94 </indexterm>
95 <indexterm role="concept">
96   <primary>monitor</primary>
97   <see><emphasis>Exim monitor</emphasis></see>
98 </indexterm>
99 <indexterm role="concept">
100   <primary>no_<emphasis>xxx</emphasis></primary>
101   <see>entry for xxx</see>
102 </indexterm>
103 <indexterm role="concept">
104   <primary>NUL</primary>
105   <see><emphasis>binary zero</emphasis></see>
106 </indexterm>
107 <indexterm role="concept">
108   <primary>passwd file</primary>
109   <see><emphasis>/etc/passwd</emphasis></see>
110 </indexterm>
111 <indexterm role="concept">
112   <primary>process id</primary>
113   <see><emphasis>pid</emphasis></see>
114 </indexterm>
115 <indexterm role="concept">
116   <primary>RBL</primary>
117   <see><emphasis>DNS list</emphasis></see>
118 </indexterm>
119 <indexterm role="concept">
120   <primary>redirection</primary>
121   <see><emphasis>address redirection</emphasis></see>
122 </indexterm>
123 <indexterm role="concept">
124   <primary>return path</primary>
125   <seealso><emphasis>envelope sender</emphasis></seealso>
126 </indexterm>
127 <indexterm role="concept">
128   <primary>scanning</primary>
129   <see><emphasis>content scanning</emphasis></see>
130 </indexterm>
131 <indexterm role="concept">
132   <primary>SSL</primary>
133   <see><emphasis>TLS</emphasis></see>
134 </indexterm>
135 <indexterm role="concept">
136   <primary>string</primary>
137   <secondary>expansion</secondary>
138   <see><emphasis>expansion</emphasis></see>
139 </indexterm>
140 <indexterm role="concept">
141   <primary>top bit</primary>
142   <see><emphasis>8-bit characters</emphasis></see>
143 </indexterm>
144 <indexterm role="concept">
145   <primary>variables</primary>
146   <see><emphasis>expansion, variables</emphasis></see>
147 </indexterm>
148 <indexterm role="concept">
149   <primary>zero, binary</primary>
150   <see><emphasis>binary zero</emphasis></see>
151 </indexterm>
152
153 <para>
154 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
155 Unix-like operating systems. It was designed on the assumption that it would be
156 run on hosts that are permanently connected to the Internet. However, it can be
157 used on intermittently connected hosts with suitable configuration adjustments.
158 </para>
159 <para>
160 Configuration files currently exist for the following operating systems: AIX,
161 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
162 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
163 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
164 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
165 Some of these operating systems are no longer current and cannot easily be
166 tested, so the configuration files may no longer work in practice.
167 </para>
168 <para>
169 There are also configuration files for compiling Exim in the Cygwin environment
170 that can be installed on systems running Windows. However, this document does
171 not contain any information about running Exim in the Cygwin environment.
172 </para>
173 <para>
174 The terms and conditions for the use and distribution of Exim are contained in
175 the file <filename>NOTICE</filename>. Exim is distributed under the terms of the GNU General
176 Public Licence, a copy of which may be found in the file <filename>LICENCE</filename>.
177 </para>
178 <para>
179 The use, supply or promotion of Exim for the purpose of sending bulk,
180 unsolicited electronic mail is incompatible with the basic aims of the program,
181 which revolve around the free provision of a service that enhances the quality
182 of personal communications. The author of Exim regards indiscriminate
183 mass-mailing as an antisocial, irresponsible abuse of the Internet.
184 </para>
185 <para>
186 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
187 experience of running and working on the Smail 3 code, I could never have
188 contemplated starting to write a new MTA. Many of the ideas and user interfaces
189 were originally taken from Smail 3, though the actual code of Exim is entirely
190 new, and has developed far beyond the initial concept.
191 </para>
192 <para>
193 Many people, both in Cambridge and around the world, have contributed to the
194 development and the testing of Exim, and to porting it to various operating
195 systems. I am grateful to them all. The distribution now contains a file called
196 <filename>ACKNOWLEDGMENTS</filename>, in which I have started recording the names of
197 contributors.
198 </para>
199 <section id="SECID1">
200 <title>Exim documentation</title>
201 <para revisionflag="changed">
202 <indexterm role="concept">
203 <primary>documentation</primary>
204 </indexterm>
205 This edition of the Exim specification applies to version 4.83 of Exim.
206 Substantive changes from the 4.80 edition are marked in some
207 renditions of the document; this paragraph is so marked if the rendition is
208 capable of showing a change indicator.
209 </para>
210 <para>
211 This document is very much a reference manual; it is not a tutorial. The reader
212 is expected to have some familiarity with the SMTP mail transfer protocol and
213 with general Unix system administration. Although there are some discussions
214 and examples in places, the information is mostly organized in a way that makes
215 it easy to look up, rather than in a natural order for sequential reading.
216 Furthermore, the manual aims to cover every aspect of Exim in detail, including
217 a number of rarely-used, special-purpose features that are unlikely to be of
218 very wide interest.
219 </para>
220 <para>
221 <indexterm role="concept">
222 <primary>books about Exim</primary>
223 </indexterm>
224 An <quote>easier</quote> discussion of Exim which provides more in-depth explanatory,
225 introductory, and tutorial material can be found in a book entitled <emphasis>The Exim
226 SMTP Mail Server</emphasis> (second edition, 2007), published by UIT Cambridge
227 (<emphasis role="bold"><ulink url="http://www.uit.co.uk/exim-book/">http://www.uit.co.uk/exim-book/</ulink></emphasis>).
228 </para>
229 <para>
230 This book also contains a chapter that gives a general introduction to SMTP and
231 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
232 with the latest release of Exim. (Note that the earlier book about Exim,
233 published by O&#x2019;Reilly, covers Exim 3, and many things have changed in Exim 4.)
234 </para>
235 <para>
236 <indexterm role="concept">
237 <primary>Debian</primary>
238 <secondary>information sources</secondary>
239 </indexterm>
240 If you are using a Debian distribution of Exim, you will find information about
241 Debian-specific features in the file
242 <filename>/usr/share/doc/exim4-base/README.Debian</filename>.
243 The command <command>man update-exim.conf</command> is another source of Debian-specific
244 information.
245 </para>
246 <para>
247 <indexterm role="concept">
248 <primary><filename>doc/NewStuff</filename></primary>
249 </indexterm>
250 <indexterm role="concept">
251 <primary><filename>doc/ChangeLog</filename></primary>
252 </indexterm>
253 <indexterm role="concept">
254 <primary>change log</primary>
255 </indexterm>
256 As the program develops, there may be features in newer versions that have not
257 yet made it into this document, which is updated only when the most significant
258 digit of the fractional part of the version number changes. Specifications of
259 new features that are not yet in this manual are placed in the file
260 <filename>doc/NewStuff</filename> in the Exim distribution.
261 </para>
262 <para>
263 Some features may be classified as <quote>experimental</quote>. These may change
264 incompatibly while they are developing, or even be withdrawn. For this reason,
265 they are not documented in this manual. Information about experimental features
266 can be found in the file <filename>doc/experimental.txt</filename>.
267 </para>
268 <para>
269 All changes to the program (whether new features, bug fixes, or other kinds of
270 change) are noted briefly in the file called <filename>doc/ChangeLog</filename>.
271 </para>
272 <para>
273 <indexterm role="concept">
274 <primary><filename>doc/spec.txt</filename></primary>
275 </indexterm>
276 This specification itself is available as an ASCII file in <filename>doc/spec.txt</filename> so
277 that it can easily be searched with a text editor. Other files in the <filename>doc</filename>
278 directory are:
279 </para>
280 <informaltable frame="none">
281 <tgroup cols="2" colsep="0" rowsep="0">
282 <colspec colwidth="100pt" align="left"/>
283 <colspec colwidth="254pt" align="left"/>
284 <tbody>
285 <row>
286 <entry><filename>OptionLists.txt</filename></entry>
287 <entry>list of all options in alphabetical order</entry>
288 </row>
289 <row>
290 <entry><filename>dbm.discuss.txt</filename></entry>
291 <entry>discussion about DBM libraries</entry>
292 </row>
293 <row>
294 <entry><filename>exim.8</filename></entry>
295 <entry>a man page of Exim&#x2019;s command line options</entry>
296 </row>
297 <row>
298 <entry><filename>experimental.txt</filename></entry>
299 <entry>documentation of experimental features</entry>
300 </row>
301 <row>
302 <entry><filename>filter.txt</filename></entry>
303 <entry>specification of the filter language</entry>
304 </row>
305 <row>
306 <entry><filename>Exim3.upgrade</filename></entry>
307 <entry>upgrade notes from release 2 to release 3</entry>
308 </row>
309 <row>
310 <entry><filename>Exim4.upgrade</filename></entry>
311 <entry>upgrade notes from release 3 to release 4</entry>
312 </row>
313 </tbody>
314 </tgroup>
315 </informaltable>
316 <para>
317 The main specification and the specification of the filtering language are also
318 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
319 <xref linkend="SECTavail"/> below tells you how to get hold of these.
320 </para>
321 </section>
322 <section id="SECID2">
323 <title>FTP and web sites</title>
324 <para>
325 <indexterm role="concept">
326 <primary>web site</primary>
327 </indexterm>
328 <indexterm role="concept">
329 <primary>FTP site</primary>
330 </indexterm>
331 The primary site for Exim source distributions is currently the University of
332 Cambridge&#x2019;s FTP site, whose contents are described in <emphasis>Where to find the Exim
333 distribution</emphasis> below. In addition, there is a web site and an FTP site at
334 <option>exim.org</option>. These are now also hosted at the University of Cambridge. The
335 <option>exim.org</option> site was previously hosted for a number of years by Energis
336 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
337 </para>
338 <para>
339 <indexterm role="concept">
340 <primary>wiki</primary>
341 </indexterm>
342 <indexterm role="concept">
343 <primary>FAQ</primary>
344 </indexterm>
345 As well as Exim distribution tar files, the Exim web site contains a number of
346 differently formatted versions of the documentation. A recent addition to the
347 online information is the Exim wiki (<emphasis role="bold"><ulink url="http://wiki.exim.org">http://wiki.exim.org</ulink></emphasis>),
348 which contains what used to be a separate FAQ, as well as various other
349 examples, tips, and know-how that have been contributed by Exim users.
350 </para>
351 <para>
352 <indexterm role="concept">
353 <primary>Bugzilla</primary>
354 </indexterm>
355 An Exim Bugzilla exists at <emphasis role="bold"><ulink url="http://bugs.exim.org">http://bugs.exim.org</ulink></emphasis>. You can use
356 this to report bugs, and also to add items to the wish list. Please search
357 first to check that you are not duplicating a previous entry.
358 </para>
359 </section>
360 <section id="SECID3">
361 <title>Mailing lists</title>
362 <para>
363 <indexterm role="concept">
364 <primary>mailing lists</primary>
365 <secondary>for Exim users</secondary>
366 </indexterm>
367 The following Exim mailing lists exist:
368 </para>
369 <informaltable frame="none">
370 <tgroup cols="2" colsep="0" rowsep="0">
371 <colspec colwidth="140pt" align="left"/>
372 <colspec colwidth="254pt" align="left"/>
373 <tbody>
374 <row>
375 <entry><emphasis>exim-announce@exim.org</emphasis></entry>
376 <entry>Moderated, low volume announcements list</entry>
377 </row>
378 <row>
379 <entry><emphasis>exim-users@exim.org</emphasis></entry>
380 <entry>General discussion list</entry>
381 </row>
382 <row>
383 <entry><emphasis>exim-dev@exim.org</emphasis></entry>
384 <entry>Discussion of bugs, enhancements, etc.</entry>
385 </row>
386 <row>
387 <entry><emphasis>exim-cvs@exim.org</emphasis></entry>
388 <entry>Automated commit messages from the VCS</entry>
389 </row>
390 </tbody>
391 </tgroup>
392 </informaltable>
393 <para>
394 You can subscribe to these lists, change your existing subscriptions, and view
395 or search the archives via the mailing lists link on the Exim home page.
396 <indexterm role="concept">
397 <primary>Debian</primary>
398 <secondary>mailing list for</secondary>
399 </indexterm>
400 If you are using a Debian distribution of Exim, you may wish to subscribe to
401 the Debian-specific mailing list <emphasis>pkg-exim4-users@lists.alioth.debian.org</emphasis>
402 via this web page:
403 </para>
404 <literallayout>
405 <emphasis role="bold"><ulink url="http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users">http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users</ulink></emphasis>
406 </literallayout>
407 <para>
408 Please ask Debian-specific questions on this list and not on the general Exim
409 lists.
410 </para>
411 </section>
412 <section id="SECID4">
413 <title>Exim training</title>
414 <para>
415 <indexterm role="concept">
416 <primary>training courses</primary>
417 </indexterm>
418 Training courses in Cambridge (UK) used to be run annually by the author of
419 Exim, before he retired. At the time of writing, there are no plans to run
420 further Exim courses in Cambridge. However, if that changes, relevant
421 information will be posted at <emphasis role="bold"><ulink url="http://www-tus.csx.cam.ac.uk/courses/exim/">http://www-tus.csx.cam.ac.uk/courses/exim/</ulink></emphasis>.
422 </para>
423 </section>
424 <section id="SECID5">
425 <title>Bug reports</title>
426 <para>
427 <indexterm role="concept">
428 <primary>bug reports</primary>
429 </indexterm>
430 <indexterm role="concept">
431 <primary>reporting bugs</primary>
432 </indexterm>
433 Reports of obvious bugs can be emailed to <emphasis>bugs@exim.org</emphasis> or reported
434 via the Bugzilla (<emphasis role="bold"><ulink url="http://bugs.exim.org">http://bugs.exim.org</ulink></emphasis>). However, if you are unsure
435 whether some behaviour is a bug or not, the best thing to do is to post a
436 message to the <emphasis>exim-dev</emphasis> mailing list and have it discussed.
437 </para>
438 </section>
439 <section id="SECTavail">
440 <title>Where to find the Exim distribution</title>
441 <para>
442 <indexterm role="concept">
443 <primary>FTP site</primary>
444 </indexterm>
445 <indexterm role="concept">
446 <primary>distribution</primary>
447 <secondary>ftp site</secondary>
448 </indexterm>
449 The master ftp site for the Exim distribution is
450 </para>
451 <literallayout>
452 <emphasis role="bold">ftp://ftp.csx.cam.ac.uk/pub/software/email/exim</emphasis>
453 </literallayout>
454 <para>
455 This is mirrored by
456 </para>
457 <literallayout>
458 <emphasis role="bold">ftp://ftp.exim.org/pub/exim</emphasis>
459 </literallayout>
460 <para>
461 The file references that follow are relative to the <filename>exim</filename> directories at
462 these sites. There are now quite a number of independent mirror sites around
463 the world. Those that I know about are listed in the file called <filename>Mirrors</filename>.
464 </para>
465 <para>
466 Within the <filename>exim</filename> directory there are subdirectories called <filename>exim3</filename> (for
467 previous Exim 3 distributions), <filename>exim4</filename> (for the latest Exim 4
468 distributions), and <filename>Testing</filename> for testing versions. In the <filename>exim4</filename>
469 subdirectory, the current release can always be found in files called
470 </para>
471 <literallayout>
472 <filename>exim-n.nn.tar.gz</filename>
473 <filename>exim-n.nn.tar.bz2</filename>
474 </literallayout>
475 <para>
476 where <emphasis>n.nn</emphasis> is the highest such version number in the directory. The two
477 files contain identical data; the only difference is the type of compression.
478 The <filename>.bz2</filename> file is usually a lot smaller than the <filename>.gz</filename> file.
479 </para>
480 <para>
481 <indexterm role="concept">
482 <primary>distribution</primary>
483 <secondary>signing details</secondary>
484 </indexterm>
485 <indexterm role="concept">
486 <primary>distribution</primary>
487 <secondary>public key</secondary>
488 </indexterm>
489 <indexterm role="concept">
490 <primary>public key for signed distribution</primary>
491 </indexterm>
492 The distributions will be PGP signed by an individual key of the Release
493 Coordinator.  This key will have a uid containing an email address in the
494 <emphasis>exim.org</emphasis> domain and will have signatures from other people, including
495 other Exim maintainers.  We expect that the key will be in the "strong set" of
496 PGP keys.  There should be a trust path to that key from Nigel Metheringham&#x2019;s
497 PGP key, a version of which can be found in the release directory in the file
498 <filename>nigel-pubkey.asc</filename>.  All keys used will be available in public keyserver pools,
499 such as <emphasis>pool.sks-keyservers.net</emphasis>.
500 </para>
501 <para>
502 At time of last update, releases were being made by Phil Pennock and signed with
503 key <emphasis>0x403043153903637F</emphasis>, although that key is expected to be replaced in 2013.
504 A trust path from Nigel&#x2019;s key to Phil&#x2019;s can be observed at
505 <emphasis role="bold"><ulink url="https://www.security.spodhuis.org/exim-trustpath">https://www.security.spodhuis.org/exim-trustpath</ulink></emphasis>.
506 </para>
507 <para>
508 Releases have also been authorized to be performed by Todd Lyons who signs with
509 key <emphasis>0xC4F4F94804D29EBA</emphasis>. A direct trust path exists between previous RE Phil
510 Pennock and Todd Lyons through a common associate.
511 </para>
512 <para>
513 The signatures for the tar bundles are in:
514 </para>
515 <literallayout>
516 <filename>exim-n.nn.tar.gz.asc</filename>
517 <filename>exim-n.nn.tar.bz2.asc</filename>
518 </literallayout>
519 <para>
520 For each released version, the log of changes is made separately available in a
521 separate file in the directory <filename>ChangeLogs</filename> so that it is possible to
522 find out what has changed without having to download the entire distribution.
523 </para>
524 <para>
525 <indexterm role="concept">
526 <primary>documentation</primary>
527 <secondary>available formats</secondary>
528 </indexterm>
529 The main distribution contains ASCII versions of this specification and other
530 documentation; other formats of the documents are available in separate files
531 inside the <filename>exim4</filename> directory of the FTP site:
532 </para>
533 <literallayout>
534 <filename>exim-html-n.nn.tar.gz</filename>
535 <filename>exim-pdf-n.nn.tar.gz</filename>
536 <filename>exim-postscript-n.nn.tar.gz</filename>
537 <filename>exim-texinfo-n.nn.tar.gz</filename>
538 </literallayout>
539 <para>
540 These tar files contain only the <filename>doc</filename> directory, not the complete
541 distribution, and are also available in <filename>.bz2</filename> as well as <filename>.gz</filename> forms.
542 </para>
543 </section>
544 <section id="SECID6">
545 <title>Limitations</title>
546 <itemizedlist>
547 <listitem>
548 <para>
549 <indexterm role="concept">
550 <primary>limitations of Exim</primary>
551 </indexterm>
552 <indexterm role="concept">
553 <primary>bang paths</primary>
554 <secondary>not handled by Exim</secondary>
555 </indexterm>
556 Exim is designed for use as an Internet MTA, and therefore handles addresses in
557 RFC 2822 domain format only. It cannot handle UUCP <quote>bang paths</quote>, though
558 simple two-component bang paths can be converted by a straightforward rewriting
559 configuration. This restriction does not prevent Exim from being interfaced to
560 UUCP as a transport mechanism, provided that domain addresses are used.
561 </para>
562 </listitem>
563 <listitem>
564 <para>
565 <indexterm role="concept">
566 <primary>domainless addresses</primary>
567 </indexterm>
568 <indexterm role="concept">
569 <primary>address</primary>
570 <secondary>without domain</secondary>
571 </indexterm>
572 Exim insists that every address it handles has a domain attached. For incoming
573 local messages, domainless addresses are automatically qualified with a
574 configured domain value. Configuration options specify from which remote
575 systems unqualified addresses are acceptable. These are then qualified on
576 arrival.
577 </para>
578 </listitem>
579 <listitem>
580 <para>
581 <indexterm role="concept">
582 <primary>transport</primary>
583 <secondary>external</secondary>
584 </indexterm>
585 <indexterm role="concept">
586 <primary>external transports</primary>
587 </indexterm>
588 The only external transport mechanisms that are currently implemented are SMTP
589 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
590 transport is available, and there are facilities for writing messages to files
591 and pipes, optionally in <emphasis>batched SMTP</emphasis> format; these facilities can be used
592 to send messages to other transport mechanisms such as UUCP, provided they can
593 handle domain-style addresses. Batched SMTP input is also catered for.
594 </para>
595 </listitem>
596 <listitem>
597 <para>
598 Exim is not designed for storing mail for dial-in hosts. When the volumes of
599 such mail are large, it is better to get the messages <quote>delivered</quote> into files
600 (that is, off Exim&#x2019;s queue) and subsequently passed on to the dial-in hosts by
601 other means.
602 </para>
603 </listitem>
604 <listitem>
605 <para>
606 Although Exim does have basic facilities for scanning incoming messages, these
607 are not comprehensive enough to do full virus or spam scanning. Such operations
608 are best carried out using additional specialized software packages. If you
609 compile Exim with the content-scanning extension, straightforward interfaces to
610 a number of common scanners are provided.
611 </para>
612 </listitem>
613 </itemizedlist>
614 </section>
615 <section id="SECID7">
616 <title>Run time configuration</title>
617 <para>
618 Exim&#x2019;s run time configuration is held in a single text file that is divided
619 into a number of sections. The entries in this file consist of keywords and
620 values, in the style of Smail 3 configuration files. A default configuration
621 file which is suitable for simple online installations is provided in the
622 distribution, and is described in chapter <xref linkend="CHAPdefconfil"/> below.
623 </para>
624 </section>
625 <section id="SECID8">
626 <title>Calling interface</title>
627 <para>
628 <indexterm role="concept">
629 <primary>Sendmail compatibility</primary>
630 <secondary>command line interface</secondary>
631 </indexterm>
632 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
633 can be a straight replacement for <filename>/usr/lib/sendmail</filename> or
634 <filename>/usr/sbin/sendmail</filename> when sending mail, but you do not need to know anything
635 about Sendmail in order to run Exim. For actions other than sending messages,
636 Sendmail-compatible options also exist, but those that produce output (for
637 example, <option>-bp</option>, which lists the messages on the queue) do so in Exim&#x2019;s own
638 format. There are also some additional options that are compatible with Smail
639 3, and some further options that are new to Exim. Chapter <xref linkend="CHAPcommandline"/>
640 documents all Exim&#x2019;s command line options. This information is automatically
641 made into the man page that forms part of the Exim distribution.
642 </para>
643 <para>
644 Control of messages on the queue can be done via certain privileged command
645 line options. There is also an optional monitor program called <emphasis>eximon</emphasis>,
646 which displays current information in an X window, and which contains a menu
647 interface to Exim&#x2019;s command line administration options.
648 </para>
649 </section>
650 <section id="SECID9">
651 <title>Terminology</title>
652 <para>
653 <indexterm role="concept">
654 <primary>terminology definitions</primary>
655 </indexterm>
656 <indexterm role="concept">
657 <primary>body of message</primary>
658 <secondary>definition of</secondary>
659 </indexterm>
660 The <emphasis>body</emphasis> of a message is the actual data that the sender wants to transmit.
661 It is the last part of a message, and is separated from the <emphasis>header</emphasis> (see
662 below) by a blank line.
663 </para>
664 <para>
665 <indexterm role="concept">
666 <primary>bounce message</primary>
667 <secondary>definition of</secondary>
668 </indexterm>
669 When a message cannot be delivered, it is normally returned to the sender in a
670 delivery failure message or a <quote>non-delivery report</quote> (NDR). The term
671 <emphasis>bounce</emphasis> is commonly used for this action, and the error reports are often
672 called <emphasis>bounce messages</emphasis>. This is a convenient shorthand for <quote>delivery
673 failure error report</quote>. Such messages have an empty sender address in the
674 message&#x2019;s <emphasis>envelope</emphasis> (see below) to ensure that they cannot themselves give
675 rise to further bounce messages.
676 </para>
677 <para>
678 The term <emphasis>default</emphasis> appears frequently in this manual. It is used to qualify a
679 value which is used in the absence of any setting in the configuration. It may
680 also qualify an action which is taken unless a configuration setting specifies
681 otherwise.
682 </para>
683 <para>
684 The term <emphasis>defer</emphasis> is used when the delivery of a message to a specific
685 destination cannot immediately take place for some reason (a remote host may be
686 down, or a user&#x2019;s local mailbox may be full). Such deliveries are <emphasis>deferred</emphasis>
687 until a later time.
688 </para>
689 <para>
690 The word <emphasis>domain</emphasis> is sometimes used to mean all but the first component of a
691 host&#x2019;s name. It is <emphasis>not</emphasis> used in that sense here, where it normally refers to
692 the part of an email address following the @ sign.
693 </para>
694 <para>
695 <indexterm role="concept">
696 <primary>envelope, definition of</primary>
697 </indexterm>
698 <indexterm role="concept">
699 <primary>sender</primary>
700 <secondary>definition of</secondary>
701 </indexterm>
702 A message in transit has an associated <emphasis>envelope</emphasis>, as well as a header and a
703 body. The envelope contains a sender address (to which bounce messages should
704 be delivered), and any number of recipient addresses. References to the
705 sender or the recipients of a message usually mean the addresses in the
706 envelope. An MTA uses these addresses for delivery, and for returning bounce
707 messages, not the addresses that appear in the header lines.
708 </para>
709 <para>
710 <indexterm role="concept">
711 <primary>message</primary>
712 <secondary>header, definition of</secondary>
713 </indexterm>
714 <indexterm role="concept">
715 <primary>header section</primary>
716 <secondary>definition of</secondary>
717 </indexterm>
718 The <emphasis>header</emphasis> of a message is the first part of a message&#x2019;s text, consisting
719 of a number of lines, each of which has a name such as <emphasis>From:</emphasis>, <emphasis>To:</emphasis>,
720 <emphasis>Subject:</emphasis>, etc. Long header lines can be split over several text lines by
721 indenting the continuations. The header is separated from the body by a blank
722 line.
723 </para>
724 <para>
725 <indexterm role="concept">
726 <primary>local part</primary>
727 <secondary>definition of</secondary>
728 </indexterm>
729 <indexterm role="concept">
730 <primary>domain</primary>
731 <secondary>definition of</secondary>
732 </indexterm>
733 The term <emphasis>local part</emphasis>, which is taken from RFC 2822, is used to refer to that
734 part of an email address that precedes the @ sign. The part that follows the
735 @ sign is called the <emphasis>domain</emphasis> or <emphasis>mail domain</emphasis>.
736 </para>
737 <para>
738 <indexterm role="concept">
739 <primary>local delivery</primary>
740 <secondary>definition of</secondary>
741 </indexterm>
742 <indexterm role="concept">
743 <primary>remote delivery, definition of</primary>
744 </indexterm>
745 The terms <emphasis>local delivery</emphasis> and <emphasis>remote delivery</emphasis> are used to distinguish
746 delivery to a file or a pipe on the local host from delivery by SMTP over
747 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
748 host it is running on are <emphasis>remote</emphasis>.
749 </para>
750 <para>
751 <indexterm role="concept">
752 <primary>return path</primary>
753 <secondary>definition of</secondary>
754 </indexterm>
755 <emphasis>Return path</emphasis> is another name that is used for the sender address in a
756 message&#x2019;s envelope.
757 </para>
758 <para>
759 <indexterm role="concept">
760 <primary>queue</primary>
761 <secondary>definition of</secondary>
762 </indexterm>
763 The term <emphasis>queue</emphasis> is used to refer to the set of messages awaiting delivery,
764 because this term is in widespread use in the context of MTAs. However, in
765 Exim&#x2019;s case the reality is more like a pool than a queue, because there is
766 normally no ordering of waiting messages.
767 </para>
768 <para>
769 <indexterm role="concept">
770 <primary>queue runner</primary>
771 <secondary>definition of</secondary>
772 </indexterm>
773 The term <emphasis>queue runner</emphasis> is used to describe a process that scans the queue
774 and attempts to deliver those messages whose retry times have come. This term
775 is used by other MTAs, and also relates to the command <option>runq</option>, but in Exim
776 the waiting messages are normally processed in an unpredictable order.
777 </para>
778 <para>
779 <indexterm role="concept">
780 <primary>spool directory</primary>
781 <secondary>definition of</secondary>
782 </indexterm>
783 The term <emphasis>spool directory</emphasis> is used for a directory in which Exim keeps the
784 messages on its queue &ndash; that is, those that it is in the process of
785 delivering. This should not be confused with the directory in which local
786 mailboxes are stored, which is called a <quote>spool directory</quote> by some people. In
787 the Exim documentation, <quote>spool</quote> is always used in the first sense.
788 </para>
789 </section>
790 </chapter>
791
792 <chapter id="CHID2">
793 <title>Incorporated code</title>
794 <para>
795 <indexterm role="concept">
796 <primary>incorporated code</primary>
797 </indexterm>
798 <indexterm role="concept">
799 <primary>regular expressions</primary>
800 <secondary>library</secondary>
801 </indexterm>
802 <indexterm role="concept">
803 <primary>PCRE</primary>
804 </indexterm>
805 <indexterm role="concept">
806 <primary>OpenDMARC</primary>
807 </indexterm>
808 A number of pieces of external code are included in the Exim distribution.
809 </para>
810 <itemizedlist>
811 <listitem>
812 <para>
813 Regular expressions are supported in the main Exim program and in the
814 Exim monitor using the freely-distributable PCRE library, copyright
815 &copy; University of Cambridge. The source to PCRE is no longer shipped with
816 Exim, so you will need to use the version of PCRE shipped with your system,
817 or obtain and install the full version of the library from
818 <emphasis role="bold"><ulink url="ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre">ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre</ulink></emphasis>.
819 </para>
820 </listitem>
821 <listitem>
822 <para>
823 <indexterm role="concept">
824 <primary>cdb</primary>
825 <secondary>acknowledgment</secondary>
826 </indexterm>
827 Support for the cdb (Constant DataBase) lookup method is provided by code
828 contributed by Nigel Metheringham of (at the time he contributed it) Planet
829 Online Ltd. The implementation is completely contained within the code of Exim.
830 It does not link against an external cdb library. The code contains the
831 following statements:
832 </para>
833 <blockquote>
834 <para>
835 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
836 </para>
837 <para>
838 This program is free software; you can redistribute it and/or modify it under
839 the terms of the GNU General Public License as published by the Free Software
840 Foundation; either version 2 of the License, or (at your option) any later
841 version.
842 This code implements Dan Bernstein&#x2019;s Constant DataBase (cdb) spec. Information,
843 the spec and sample code for cdb can be obtained from
844 <emphasis role="bold"><ulink url="http://www.pobox.com/~djb/cdb.html">http://www.pobox.com/~djb/cdb.html</ulink></emphasis>. This implementation borrows
845 some code from Dan Bernstein&#x2019;s implementation (which has no license
846 restrictions applied to it).
847 </para>
848 </blockquote>
849 </listitem>
850 <listitem>
851 <para>
852 <indexterm role="concept">
853 <primary>SPA authentication</primary>
854 </indexterm>
855 <indexterm role="concept">
856 <primary>Samba project</primary>
857 </indexterm>
858 <indexterm role="concept">
859 <primary>Microsoft Secure Password Authentication</primary>
860 </indexterm>
861 Client support for Microsoft&#x2019;s <emphasis>Secure Password Authentication</emphasis> is provided
862 by code contributed by Marc Prud&#x2019;hommeaux. Server support was contributed by
863 Tom Kistner. This includes code taken from the Samba project, which is released
864 under the Gnu GPL.
865 </para>
866 </listitem>
867 <listitem>
868 <para>
869 <indexterm role="concept">
870 <primary>Cyrus</primary>
871 </indexterm>
872 <indexterm role="concept">
873 <primary><emphasis>pwcheck</emphasis> daemon</primary>
874 </indexterm>
875 <indexterm role="concept">
876 <primary><emphasis>pwauthd</emphasis> daemon</primary>
877 </indexterm>
878 Support for calling the Cyrus <emphasis>pwcheck</emphasis> and <emphasis>saslauthd</emphasis> daemons is provided
879 by code taken from the Cyrus-SASL library and adapted by Alexander S.
880 Sabourenkov. The permission notice appears below, in accordance with the
881 conditions expressed therein.
882 </para>
883 <blockquote>
884 <para>
885 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
886 </para>
887 <para>
888 Redistribution and use in source and binary forms, with or without
889 modification, are permitted provided that the following conditions
890 are met:
891 </para>
892 <orderedlist numeration="arabic">
893 <listitem>
894 <para>
895 Redistributions of source code must retain the above copyright
896 notice, this list of conditions and the following disclaimer.
897 </para>
898 </listitem>
899 <listitem>
900 <para>
901 Redistributions in binary form must reproduce the above copyright
902 notice, this list of conditions and the following disclaimer in
903 the documentation and/or other materials provided with the
904 distribution.
905 </para>
906 </listitem>
907 <listitem>
908 <para>
909 The name <quote>Carnegie Mellon University</quote> must not be used to
910 endorse or promote products derived from this software without
911 prior written permission. For permission or any other legal
912 details, please contact
913 </para>
914 <literallayout>
915               Office of Technology Transfer
916               Carnegie Mellon University
917               5000 Forbes Avenue
918               Pittsburgh, PA  15213-3890
919               (412) 268-4387, fax: (412) 268-7395
920               tech-transfer@andrew.cmu.edu
921 </literallayout>
922 </listitem>
923 <listitem>
924 <para>
925 Redistributions of any form whatsoever must retain the following
926 acknowledgment:
927 </para>
928 <para>
929 <quote>This product includes software developed by Computing Services
930 at Carnegie Mellon University (<emphasis role="bold"><ulink url="http://www.cmu.edu/computing/">http://www.cmu.edu/computing/</ulink></emphasis>.</quote>
931 </para>
932 <para>
933 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
934 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
935 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
936 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
937 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
938 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
939 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
940 </para>
941 </listitem>
942 </orderedlist>
943 </blockquote>
944 </listitem>
945 <listitem>
946 <para>
947 <indexterm role="concept">
948 <primary>Exim monitor</primary>
949 <secondary>acknowledgment</secondary>
950 </indexterm>
951 <indexterm role="concept">
952 <primary>X-windows</primary>
953 </indexterm>
954 <indexterm role="concept">
955 <primary>Athena</primary>
956 </indexterm>
957 The Exim Monitor program, which is an X-Window application, includes
958 modified versions of the Athena StripChart and TextPop widgets.
959 This code is copyright by DEC and MIT, and their permission notice appears
960 below, in accordance with the conditions expressed therein.
961 </para>
962 <blockquote>
963 <para>
964 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
965 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
966 </para>
967 <para>
968 All Rights Reserved
969 </para>
970 <para>
971 Permission to use, copy, modify, and distribute this software and its
972 documentation for any purpose and without fee is hereby granted,
973 provided that the above copyright notice appear in all copies and that
974 both that copyright notice and this permission notice appear in
975 supporting documentation, and that the names of Digital or MIT not be
976 used in advertising or publicity pertaining to distribution of the
977 software without specific, written prior permission.
978 </para>
979 <para>
980 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
981 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
982 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
983 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
984 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
985 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
986 SOFTWARE.
987 </para>
988 </blockquote>
989 </listitem>
990 <listitem>
991 <para>
992 <indexterm role="concept">
993 <primary>opendmarc</primary>
994 <secondary>acknowledgment</secondary>
995 </indexterm>
996 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
997 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
998 derived code are indicated in the respective source files. The full OpenDMARC
999 license is provided in the LICENSE.opendmarc file contained in the distributed
1000 source code.
1001 </para>
1002 </listitem>
1003 <listitem>
1004 <para>
1005 Many people have contributed code fragments, some large, some small, that were
1006 not covered by any specific licence requirements. It is assumed that the
1007 contributors are happy to see their code incorporated into Exim under the GPL.
1008 </para>
1009 </listitem>
1010 </itemizedlist>
1011 </chapter>
1012
1013 <chapter id="CHID11">
1014 <title>How Exim receives and delivers mail</title>
1015 <titleabbrev>Receiving and delivering mail</titleabbrev>
1016 <section id="SECID10">
1017 <title>Overall philosophy</title>
1018 <para>
1019 <indexterm role="concept">
1020 <primary>design philosophy</primary>
1021 </indexterm>
1022 Exim is designed to work efficiently on systems that are permanently connected
1023 to the Internet and are handling a general mix of mail. In such circumstances,
1024 most messages can be delivered immediately. Consequently, Exim does not
1025 maintain independent queues of messages for specific domains or hosts, though
1026 it does try to send several messages in a single SMTP connection after a host
1027 has been down, and it also maintains per-host retry information.
1028 </para>
1029 </section>
1030 <section id="SECID11">
1031 <title>Policy control</title>
1032 <para>
1033 <indexterm role="concept">
1034 <primary>policy control</primary>
1035 <secondary>overview</secondary>
1036 </indexterm>
1037 Policy controls are now an important feature of MTAs that are connected to the
1038 Internet. Perhaps their most important job is to stop MTAs being abused as
1039 <quote>open relays</quote> by misguided individuals who send out vast amounts of
1040 unsolicited junk, and want to disguise its source. Exim provides flexible
1041 facilities for specifying policy controls on incoming mail:
1042 </para>
1043 <itemizedlist>
1044 <listitem>
1045 <para>
1046 <indexterm role="concept">
1047 <primary>access control lists (ACLs)</primary>
1048 <secondary>introduction</secondary>
1049 </indexterm>
1050 Exim 4 (unlike previous versions of Exim) implements policy controls on
1051 incoming mail by means of <emphasis>Access Control Lists</emphasis> (ACLs). Each list is a
1052 series of statements that may either grant or deny access. ACLs can be used at
1053 several places in the SMTP dialogue while receiving a message from a remote
1054 host. However, the most common places are after each RCPT command, and at the
1055 very end of the message. The sysadmin can specify conditions for accepting or
1056 rejecting individual recipients or the entire message, respectively, at these
1057 two points (see chapter <xref linkend="CHAPACL"/>). Denial of access results in an SMTP
1058 error code.
1059 </para>
1060 </listitem>
1061 <listitem>
1062 <para>
1063 An ACL is also available for locally generated, non-SMTP messages. In this
1064 case, the only available actions are to accept or deny the entire message.
1065 </para>
1066 </listitem>
1067 <listitem>
1068 <para>
1069 When Exim is compiled with the content-scanning extension, facilities are
1070 provided in the ACL mechanism for passing the message to external virus and/or
1071 spam scanning software. The result of such a scan is passed back to the ACL,
1072 which can then use it to decide what to do with the message.
1073 </para>
1074 </listitem>
1075 <listitem>
1076 <para>
1077 When a message has been received, either from a remote host or from the local
1078 host, but before the final acknowledgment has been sent, a locally supplied C
1079 function called <function>local_scan()</function> can be run to inspect the message and decide
1080 whether to accept it or not (see chapter <xref linkend="CHAPlocalscan"/>). If the message
1081 is accepted, the list of recipients can be modified by the function.
1082 </para>
1083 </listitem>
1084 <listitem>
1085 <para>
1086 Using the <function>local_scan()</function> mechanism is another way of calling external scanner
1087 software. The <option>SA-Exim</option> add-on package works this way. It does not require
1088 Exim to be compiled with the content-scanning extension.
1089 </para>
1090 </listitem>
1091 <listitem>
1092 <para>
1093 After a message has been accepted, a further checking mechanism is available in
1094 the form of the <emphasis>system filter</emphasis> (see chapter <xref linkend="CHAPsystemfilter"/>). This
1095 runs at the start of every delivery process.
1096 </para>
1097 </listitem>
1098 </itemizedlist>
1099 </section>
1100 <section id="SECID12">
1101 <title>User filters</title>
1102 <para>
1103 <indexterm role="concept">
1104 <primary>filter</primary>
1105 <secondary>introduction</secondary>
1106 </indexterm>
1107 <indexterm role="concept">
1108 <primary>Sieve filter</primary>
1109 </indexterm>
1110 In a conventional Exim configuration, users are able to run private filters by
1111 setting up appropriate <filename>.forward</filename> files in their home directories. See
1112 chapter <xref linkend="CHAPredirect"/> (about the <command>redirect</command> router) for the
1113 configuration needed to support this, and the separate document entitled
1114 <emphasis>Exim&#x2019;s interfaces to mail filtering</emphasis> for user details. Two different kinds
1115 of filtering are available:
1116 </para>
1117 <itemizedlist>
1118 <listitem>
1119 <para>
1120 Sieve filters are written in the standard filtering language that is defined
1121 by RFC 3028.
1122 </para>
1123 </listitem>
1124 <listitem>
1125 <para>
1126 Exim filters are written in a syntax that is unique to Exim, but which is more
1127 powerful than Sieve, which it pre-dates.
1128 </para>
1129 </listitem>
1130 </itemizedlist>
1131 <para>
1132 User filters are run as part of the routing process, described below.
1133 </para>
1134 </section>
1135 <section id="SECTmessiden">
1136 <title>Message identification</title>
1137 <para>
1138 <indexterm role="concept">
1139 <primary>message ids</primary>
1140 <secondary>details of format</secondary>
1141 </indexterm>
1142 <indexterm role="concept">
1143 <primary>format</primary>
1144 <secondary>of message id</secondary>
1145 </indexterm>
1146 <indexterm role="concept">
1147 <primary>id of message</primary>
1148 </indexterm>
1149 <indexterm role="concept">
1150 <primary>base62</primary>
1151 </indexterm>
1152 <indexterm role="concept">
1153 <primary>base36</primary>
1154 </indexterm>
1155 <indexterm role="concept">
1156 <primary>Darwin</primary>
1157 </indexterm>
1158 <indexterm role="concept">
1159 <primary>Cygwin</primary>
1160 </indexterm>
1161 Every message handled by Exim is given a <emphasis>message id</emphasis> which is sixteen
1162 characters long. It is divided into three parts, separated by hyphens, for
1163 example <literal>16VDhn-0001bo-D3</literal>. Each part is a sequence of letters and digits,
1164 normally encoding numbers in base 62. However, in the Darwin operating
1165 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
1166 (avoiding the use of lower case letters) is used instead, because the message
1167 id is used to construct file names, and the names of files in those systems are
1168 not always case-sensitive.
1169 </para>
1170 <para>
1171 <indexterm role="concept">
1172 <primary>pid (process id)</primary>
1173 <secondary>re-use of</secondary>
1174 </indexterm>
1175 The detail of the contents of the message id have changed as Exim has evolved.
1176 Earlier versions relied on the operating system not re-using a process id (pid)
1177 within one second. On modern operating systems, this assumption can no longer
1178 be made, so the algorithm had to be changed. To retain backward compatibility,
1179 the format of the message id was retained, which is why the following rules are
1180 somewhat eccentric:
1181 </para>
1182 <itemizedlist>
1183 <listitem>
1184 <para>
1185 The first six characters of the message id are the time at which the message
1186 started to be received, to a granularity of one second. That is, this field
1187 contains the number of seconds since the start of the epoch (the normal Unix
1188 way of representing the date and time of day).
1189 </para>
1190 </listitem>
1191 <listitem>
1192 <para>
1193 After the first hyphen, the next six characters are the id of the process that
1194 received the message.
1195 </para>
1196 </listitem>
1197 <listitem>
1198 <para>
1199 There are two different possibilities for the final two characters:
1200 </para>
1201 <orderedlist numeration="arabic">
1202 <listitem>
1203 <para>
1204 <indexterm role="option">
1205 <primary><option>localhost_number</option></primary>
1206 </indexterm>
1207 If <option>localhost_number</option> is not set, this value is the fractional part of the
1208 time of reception, normally in units of 1/2000 of a second, but for systems
1209 that must use base 36 instead of base 62 (because of case-insensitive file
1210 systems), the units are 1/1000 of a second.
1211 </para>
1212 </listitem>
1213 <listitem>
1214 <para>
1215 If <option>localhost_number</option> is set, it is multiplied by 200 (100) and added to
1216 the fractional part of the time, which in this case is in units of 1/200
1217 (1/100) of a second.
1218 </para>
1219 </listitem>
1220 </orderedlist>
1221 </listitem>
1222 </itemizedlist>
1223 <para>
1224 After a message has been received, Exim waits for the clock to tick at the
1225 appropriate resolution before proceeding, so that if another message is
1226 received by the same process, or by another process with the same (re-used)
1227 pid, it is guaranteed that the time will be different. In most cases, the clock
1228 will already have ticked while the message was being received.
1229 </para>
1230 </section>
1231 <section id="SECID13">
1232 <title>Receiving mail</title>
1233 <para>
1234 <indexterm role="concept">
1235 <primary>receiving mail</primary>
1236 </indexterm>
1237 <indexterm role="concept">
1238 <primary>message</primary>
1239 <secondary>reception</secondary>
1240 </indexterm>
1241 The only way Exim can receive mail from another host is using SMTP over
1242 TCP/IP, in which case the sender and recipient addresses are transferred using
1243 SMTP commands. However, from a locally running process (such as a user&#x2019;s MUA),
1244 there are several possibilities:
1245 </para>
1246 <itemizedlist>
1247 <listitem>
1248 <para>
1249 If the process runs Exim with the <option>-bm</option> option, the message is read
1250 non-interactively (usually via a pipe), with the recipients taken from the
1251 command line, or from the body of the message if <option>-t</option> is also used.
1252 </para>
1253 </listitem>
1254 <listitem>
1255 <para>
1256 If the process runs Exim with the <option>-bS</option> option, the message is also read
1257 non-interactively, but in this case the recipients are listed at the start of
1258 the message in a series of SMTP RCPT commands, terminated by a DATA
1259 command. This is so-called <quote>batch SMTP</quote> format,
1260 but it isn&#x2019;t really SMTP. The SMTP commands are just another way of passing
1261 envelope addresses in a non-interactive submission.
1262 </para>
1263 </listitem>
1264 <listitem>
1265 <para>
1266 If the process runs Exim with the <option>-bs</option> option, the message is read
1267 interactively, using the SMTP protocol. A two-way pipe is normally used for
1268 passing data between the local process and the Exim process.
1269 This is <quote>real</quote> SMTP and is handled in the same way as SMTP over TCP/IP. For
1270 example, the ACLs for SMTP commands are used for this form of submission.
1271 </para>
1272 </listitem>
1273 <listitem>
1274 <para>
1275 A local process may also make a TCP/IP call to the host&#x2019;s loopback address
1276 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1277 does not treat the loopback address specially. It treats all such connections
1278 in the same way as connections from other hosts.
1279 </para>
1280 </listitem>
1281 </itemizedlist>
1282 <para>
1283 <indexterm role="concept">
1284 <primary>message sender, constructed by Exim</primary>
1285 </indexterm>
1286 <indexterm role="concept">
1287 <primary>sender</primary>
1288 <secondary>constructed by Exim</secondary>
1289 </indexterm>
1290 In the three cases that do not involve TCP/IP, the sender address is
1291 constructed from the login name of the user that called Exim and a default
1292 qualification domain (which can be set by the <option>qualify_domain</option> configuration
1293 option). For local or batch SMTP, a sender address that is passed using the
1294 SMTP MAIL command is ignored. However, the system administrator may allow
1295 certain users (<quote>trusted users</quote>) to specify a different sender address
1296 unconditionally, or all users to specify certain forms of different sender
1297 address. The <option>-f</option> option or the SMTP MAIL command is used to specify these
1298 different addresses. See section <xref linkend="SECTtrustedadmin"/> for details of trusted
1299 users, and the <option>untrusted_set_sender</option> option for a way of allowing untrusted
1300 users to change sender addresses.
1301 </para>
1302 <para>
1303 Messages received by either of the non-interactive mechanisms are subject to
1304 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1305 (either over TCP/IP, or interacting with a local process) can be checked by a
1306 number of ACLs that operate at different times during the SMTP session. Either
1307 individual recipients, or the entire message, can be rejected if local policy
1308 requirements are not met. The <function>local_scan()</function> function (see chapter
1309 <xref linkend="CHAPlocalscan"/>) is run for all incoming messages.
1310 </para>
1311 <para>
1312 Exim can be configured not to start a delivery process when a message is
1313 received; this can be unconditional, or depend on the number of incoming SMTP
1314 connections or the system load. In these situations, new messages wait on the
1315 queue until a queue runner process picks them up. However, in standard
1316 configurations under normal conditions, delivery is started as soon as a
1317 message is received.
1318 </para>
1319 </section>
1320 <section id="SECID14">
1321 <title>Handling an incoming message</title>
1322 <para>
1323 <indexterm role="concept">
1324 <primary>spool directory</primary>
1325 <secondary>files that hold a message</secondary>
1326 </indexterm>
1327 <indexterm role="concept">
1328 <primary>file</primary>
1329 <secondary>how a message is held</secondary>
1330 </indexterm>
1331 When Exim accepts a message, it writes two files in its spool directory. The
1332 first contains the envelope information, the current status of the message, and
1333 the header lines, and the second contains the body of the message. The names of
1334 the two spool files consist of the message id, followed by <literal>-H</literal> for the
1335 file containing the envelope and header, and <literal>-D</literal> for the data file.
1336 </para>
1337 <para>
1338 <indexterm role="concept">
1339 <primary>spool directory</primary>
1340 <secondary><filename>input</filename> sub-directory</secondary>
1341 </indexterm>
1342 By default all these message files are held in a single directory called
1343 <filename>input</filename> inside the general Exim spool directory. Some operating systems do
1344 not perform very well if the number of files in a directory gets large; to
1345 improve performance in such cases, the <option>split_spool_directory</option> option can be
1346 used. This causes Exim to split up the input files into 62 sub-directories
1347 whose names are single letters or digits. When this is done, the queue is
1348 processed one sub-directory at a time instead of all at once, which can improve
1349 overall performance even when there are not enough files in each directory to
1350 affect file system performance.
1351 </para>
1352 <para>
1353 The envelope information consists of the address of the message&#x2019;s sender and
1354 the addresses of the recipients. This information is entirely separate from
1355 any addresses contained in the header lines. The status of the message includes
1356 a list of recipients who have already received the message. The format of the
1357 first spool file is described in chapter <xref linkend="CHAPspool"/>.
1358 </para>
1359 <para>
1360 <indexterm role="concept">
1361 <primary>rewriting</primary>
1362 <secondary>addresses</secondary>
1363 </indexterm>
1364 Address rewriting that is specified in the rewrite section of the configuration
1365 (see chapter <xref linkend="CHAPrewrite"/>) is done once and for all on incoming addresses,
1366 both in the header lines and the envelope, at the time the message is accepted.
1367 If during the course of delivery additional addresses are generated (for
1368 example, via aliasing), these new addresses are rewritten as soon as they are
1369 generated. At the time a message is actually delivered (transported) further
1370 rewriting can take place; because this is a transport option, it can be
1371 different for different forms of delivery. It is also possible to specify the
1372 addition or removal of certain header lines at the time the message is
1373 delivered (see chapters <xref linkend="CHAProutergeneric"/> and
1374 <xref linkend="CHAPtransportgeneric"/>).
1375 </para>
1376 </section>
1377 <section id="SECID15">
1378 <title>Life of a message</title>
1379 <para>
1380 <indexterm role="concept">
1381 <primary>message</primary>
1382 <secondary>life of</secondary>
1383 </indexterm>
1384 <indexterm role="concept">
1385 <primary>message</primary>
1386 <secondary>frozen</secondary>
1387 </indexterm>
1388 A message remains in the spool directory until it is completely delivered to
1389 its recipients or to an error address, or until it is deleted by an
1390 administrator or by the user who originally created it. In cases when delivery
1391 cannot proceed &ndash; for example, when a message can neither be delivered to its
1392 recipients nor returned to its sender, the message is marked <quote>frozen</quote> on the
1393 spool, and no more deliveries are attempted.
1394 </para>
1395 <para>
1396 <indexterm role="concept">
1397 <primary>frozen messages</primary>
1398 <secondary>thawing</secondary>
1399 </indexterm>
1400 <indexterm role="concept">
1401 <primary>message</primary>
1402 <secondary>thawing frozen</secondary>
1403 </indexterm>
1404 An administrator can <quote>thaw</quote> such messages when the problem has been
1405 corrected, and can also freeze individual messages by hand if necessary. In
1406 addition, an administrator can force a delivery error, causing a bounce message
1407 to be sent.
1408 </para>
1409 <para>
1410 <indexterm role="option">
1411 <primary><option>timeout_frozen_after</option></primary>
1412 </indexterm>
1413 <indexterm role="option">
1414 <primary><option>ignore_bounce_errors_after</option></primary>
1415 </indexterm>
1416 There are options called <option>ignore_bounce_errors_after</option> and
1417 <option>timeout_frozen_after</option>, which discard frozen messages after a certain time.
1418 The first applies only to frozen bounces, the second to any frozen messages.
1419 </para>
1420 <para>
1421 <indexterm role="concept">
1422 <primary>message</primary>
1423 <secondary>log file for</secondary>
1424 </indexterm>
1425 <indexterm role="concept">
1426 <primary>log</primary>
1427 <secondary>file for each message</secondary>
1428 </indexterm>
1429 While Exim is working on a message, it writes information about each delivery
1430 attempt to its main log file. This includes successful, unsuccessful, and
1431 delayed deliveries for each recipient (see chapter <xref linkend="CHAPlog"/>). The log
1432 lines are also written to a separate <emphasis>message log</emphasis> file for each message.
1433 These logs are solely for the benefit of the administrator, and are normally
1434 deleted along with the spool files when processing of a message is complete.
1435 The use of individual message logs can be disabled by setting
1436 <option>no_message_logs</option>; this might give an improvement in performance on very busy
1437 systems.
1438 </para>
1439 <para>
1440 <indexterm role="concept">
1441 <primary>journal file</primary>
1442 </indexterm>
1443 <indexterm role="concept">
1444 <primary>file</primary>
1445 <secondary>journal</secondary>
1446 </indexterm>
1447 All the information Exim itself needs to set up a delivery is kept in the first
1448 spool file, along with the header lines. When a successful delivery occurs, the
1449 address is immediately written at the end of a journal file, whose name is the
1450 message id followed by <literal>-J</literal>. At the end of a delivery run, if there are some
1451 addresses left to be tried again later, the first spool file (the <literal>-H</literal> file)
1452 is updated to indicate which these are, and the journal file is then deleted.
1453 Updating the spool file is done by writing a new file and renaming it, to
1454 minimize the possibility of data loss.
1455 </para>
1456 <para>
1457 Should the system or the program crash after a successful delivery but before
1458 the spool file has been updated, the journal is left lying around. The next
1459 time Exim attempts to deliver the message, it reads the journal file and
1460 updates the spool file before proceeding. This minimizes the chances of double
1461 deliveries caused by crashes.
1462 </para>
1463 </section>
1464 <section id="SECTprocaddress">
1465 <title>Processing an address for delivery</title>
1466 <para>
1467 <indexterm role="concept">
1468 <primary>drivers</primary>
1469 <secondary>definition of</secondary>
1470 </indexterm>
1471 <indexterm role="concept">
1472 <primary>router</primary>
1473 <secondary>definition of</secondary>
1474 </indexterm>
1475 <indexterm role="concept">
1476 <primary>transport</primary>
1477 <secondary>definition of</secondary>
1478 </indexterm>
1479 The main delivery processing elements of Exim are called <emphasis>routers</emphasis> and
1480 <emphasis>transports</emphasis>, and collectively these are known as <emphasis>drivers</emphasis>. Code for a
1481 number of them is provided in the source distribution, and compile-time options
1482 specify which ones are included in the binary. Run time options specify which
1483 ones are actually used for delivering messages.
1484 </para>
1485 <para>
1486 <indexterm role="concept">
1487 <primary>drivers</primary>
1488 <secondary>instance definition</secondary>
1489 </indexterm>
1490 Each driver that is specified in the run time configuration is an <emphasis>instance</emphasis>
1491 of that particular driver type. Multiple instances are allowed; for example,
1492 you can set up several different <command>smtp</command> transports, each with different
1493 option values that might specify different ports or different timeouts. Each
1494 instance has its own identifying name. In what follows we will normally use the
1495 instance name when discussing one particular instance (that is, one specific
1496 configuration of the driver), and the generic driver name when discussing
1497 the driver&#x2019;s features in general.
1498 </para>
1499 <para>
1500 A <emphasis>router</emphasis> is a driver that operates on an address, either determining how
1501 its delivery should happen, by assigning it to a specific transport, or
1502 converting the address into one or more new addresses (for example, via an
1503 alias file). A router may also explicitly choose to fail an address, causing it
1504 to be bounced.
1505 </para>
1506 <para>
1507 A <emphasis>transport</emphasis> is a driver that transmits a copy of the message from Exim&#x2019;s
1508 spool to some destination. There are two kinds of transport: for a <emphasis>local</emphasis>
1509 transport, the destination is a file or a pipe on the local host, whereas for a
1510 <emphasis>remote</emphasis> transport the destination is some other host. A message is passed
1511 to a specific transport as a result of successful routing. If a message has
1512 several recipients, it may be passed to a number of different transports.
1513 </para>
1514 <para>
1515 <indexterm role="concept">
1516 <primary>preconditions</primary>
1517 <secondary>definition of</secondary>
1518 </indexterm>
1519 An address is processed by passing it to each configured router instance in
1520 turn, subject to certain preconditions, until a router accepts the address or
1521 specifies that it should be bounced. We will describe this process in more
1522 detail shortly. First, as a simple example, we consider how each recipient
1523 address in a message is processed in a small configuration of three routers.
1524 </para>
1525 <para>
1526 To make this a more concrete example, it is described in terms of some actual
1527 routers, but remember, this is only an example. You can configure Exim&#x2019;s
1528 routers in many different ways, and there may be any number of routers in a
1529 configuration.
1530 </para>
1531 <para>
1532 The first router that is specified in a configuration is often one that handles
1533 addresses in domains that are not recognized specially by the local host. These
1534 are typically addresses for arbitrary domains on the Internet. A precondition
1535 is set up which looks for the special domains known to the host (for example,
1536 its own domain name), and the router is run for addresses that do <emphasis>not</emphasis>
1537 match. Typically, this is a router that looks up domains in the DNS in order to
1538 find the hosts to which this address routes. If it succeeds, the address is
1539 assigned to a suitable SMTP transport; if it does not succeed, the router is
1540 configured to fail the address.
1541 </para>
1542 <para>
1543 The second router is reached only when the domain is recognized as one that
1544 <quote>belongs</quote> to the local host. This router does redirection &ndash; also known as
1545 aliasing and forwarding. When it generates one or more new addresses from the
1546 original, each of them is routed independently from the start. Otherwise, the
1547 router may cause an address to fail, or it may simply decline to handle the
1548 address, in which case the address is passed to the next router.
1549 </para>
1550 <para>
1551 The final router in many configurations is one that checks to see if the
1552 address belongs to a local mailbox. The precondition may involve a check to
1553 see if the local part is the name of a login account, or it may look up the
1554 local part in a file or a database. If its preconditions are not met, or if
1555 the router declines, we have reached the end of the routers. When this happens,
1556 the address is bounced.
1557 </para>
1558 </section>
1559 <section id="SECID16">
1560 <title>Processing an address for verification</title>
1561 <para>
1562 <indexterm role="concept">
1563 <primary>router</primary>
1564 <secondary>for verification</secondary>
1565 </indexterm>
1566 <indexterm role="concept">
1567 <primary>verifying address</primary>
1568 <secondary>overview</secondary>
1569 </indexterm>
1570 As well as being used to decide how to deliver to an address, Exim&#x2019;s routers
1571 are also used for <emphasis>address verification</emphasis>. Verification can be requested as
1572 one of the checks to be performed in an ACL for incoming messages, on both
1573 sender and recipient addresses, and it can be tested using the <option>-bv</option> and
1574 <option>-bvs</option> command line options.
1575 </para>
1576 <para>
1577 When an address is being verified, the routers are run in <quote>verify mode</quote>. This
1578 does not affect the way the routers work, but it is a state that can be
1579 detected. By this means, a router can be skipped or made to behave differently
1580 when verifying. A common example is a configuration in which the first router
1581 sends all messages to a message-scanning program, unless they have been
1582 previously scanned. Thus, the first router accepts all addresses without any
1583 checking, making it useless for verifying. Normally, the <option>no_verify</option> option
1584 would be set for such a router, causing it to be skipped in verify mode.
1585 </para>
1586 </section>
1587 <section id="SECTrunindrou">
1588 <title>Running an individual router</title>
1589 <para>
1590 <indexterm role="concept">
1591 <primary>router</primary>
1592 <secondary>running details</secondary>
1593 </indexterm>
1594 <indexterm role="concept">
1595 <primary>preconditions</primary>
1596 <secondary>checking</secondary>
1597 </indexterm>
1598 <indexterm role="concept">
1599 <primary>router</primary>
1600 <secondary>result of running</secondary>
1601 </indexterm>
1602 As explained in the example above, a number of preconditions are checked before
1603 running a router. If any are not met, the router is skipped, and the address is
1604 passed to the next router. When all the preconditions on a router <emphasis>are</emphasis> met,
1605 the router is run. What happens next depends on the outcome, which is one of
1606 the following:
1607 </para>
1608 <itemizedlist>
1609 <listitem>
1610 <para>
1611 <emphasis>accept</emphasis>: The router accepts the address, and either assigns it to a
1612 transport, or generates one or more <quote>child</quote> addresses. Processing the
1613 original address ceases,
1614 <indexterm role="option">
1615 <primary><option>unseen</option></primary>
1616 </indexterm>
1617 unless the <option>unseen</option> option is set on the router. This option
1618 can be used to set up multiple deliveries with different routing (for example,
1619 for keeping archive copies of messages). When <option>unseen</option> is set, the address is
1620 passed to the next router. Normally, however, an <emphasis>accept</emphasis> return marks the
1621 end of routing.
1622 </para>
1623 <para>
1624 Any child addresses generated by the router are processed independently,
1625 starting with the first router by default. It is possible to change this by
1626 setting the <option>redirect_router</option> option to specify which router to start at for
1627 child addresses. Unlike <option>pass_router</option> (see below) the router specified by
1628 <option>redirect_router</option> may be anywhere in the router configuration.
1629 </para>
1630 </listitem>
1631 <listitem>
1632 <para>
1633 <emphasis>pass</emphasis>: The router recognizes the address, but cannot handle it itself. It
1634 requests that the address be passed to another router. By default the address
1635 is passed to the next router, but this can be changed by setting the
1636 <option>pass_router</option> option. However, (unlike <option>redirect_router</option>) the named router
1637 must be below the current router (to avoid loops).
1638 </para>
1639 </listitem>
1640 <listitem>
1641 <para>
1642 <emphasis>decline</emphasis>: The router declines to accept the address because it does not
1643 recognize it at all. By default, the address is passed to the next router, but
1644 this can be prevented by setting the <option>no_more</option> option. When <option>no_more</option> is
1645 set, all the remaining routers are skipped. In effect, <option>no_more</option> converts
1646 <emphasis>decline</emphasis> into <emphasis>fail</emphasis>.
1647 </para>
1648 </listitem>
1649 <listitem>
1650 <para>
1651 <emphasis>fail</emphasis>: The router determines that the address should fail, and queues it for
1652 the generation of a bounce message. There is no further processing of the
1653 original address unless <option>unseen</option> is set on the router.
1654 </para>
1655 </listitem>
1656 <listitem>
1657 <para>
1658 <emphasis>defer</emphasis>: The router cannot handle the address at the present time. (A
1659 database may be offline, or a DNS lookup may have timed out.) No further
1660 processing of the address happens in this delivery attempt. It is tried again
1661 next time the message is considered for delivery.
1662 </para>
1663 </listitem>
1664 <listitem>
1665 <para>
1666 <emphasis>error</emphasis>: There is some error in the router (for example, a syntax error in
1667 its configuration). The action is as for defer.
1668 </para>
1669 </listitem>
1670 </itemizedlist>
1671 <para>
1672 If an address reaches the end of the routers without having been accepted by
1673 any of them, it is bounced as unrouteable. The default error message in this
1674 situation is <quote>unrouteable address</quote>, but you can set your own message by
1675 making use of the <option>cannot_route_message</option> option. This can be set for any
1676 router; the value from the last router that <quote>saw</quote> the address is used.
1677 </para>
1678 <para>
1679 Sometimes while routing you want to fail a delivery when some conditions are
1680 met but others are not, instead of passing the address on for further routing.
1681 You can do this by having a second router that explicitly fails the delivery
1682 when the relevant conditions are met. The <command>redirect</command> router has a <quote>fail</quote>
1683 facility for this purpose.
1684 </para>
1685 </section>
1686 <section id="SECID17">
1687 <title>Duplicate addresses</title>
1688 <para>
1689 <indexterm role="concept">
1690 <primary>case of local parts</primary>
1691 </indexterm>
1692 <indexterm role="concept">
1693 <primary>address duplicate, discarding</primary>
1694 </indexterm>
1695 <indexterm role="concept">
1696 <primary>duplicate addresses</primary>
1697 </indexterm>
1698 Once routing is complete, Exim scans the addresses that are assigned to local
1699 and remote transports, and discards any duplicates that it finds. During this
1700 check, local parts are treated as case-sensitive. This happens only when
1701 actually delivering a message; when testing routers with <option>-bt</option>, all the
1702 routed addresses are shown.
1703 </para>
1704 </section>
1705 <section id="SECTrouprecon">
1706 <title>Router preconditions</title>
1707 <para>
1708 <indexterm role="concept">
1709 <primary>router</primary>
1710 <secondary>preconditions, order of processing</secondary>
1711 </indexterm>
1712 <indexterm role="concept">
1713 <primary>preconditions</primary>
1714 <secondary>order of processing</secondary>
1715 </indexterm>
1716 The preconditions that are tested for each router are listed below, in the
1717 order in which they are tested. The individual configuration options are
1718 described in more detail in chapter <xref linkend="CHAProutergeneric"/>.
1719 </para>
1720 <itemizedlist>
1721 <listitem>
1722 <para>
1723 The <option>local_part_prefix</option> and <option>local_part_suffix</option> options can specify that
1724 the local parts handled by the router may or must have certain prefixes and/or
1725 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1726 skipped. These conditions are tested first. When an affix is present, it is
1727 removed from the local part before further processing, including the evaluation
1728 of any other conditions.
1729 </para>
1730 </listitem>
1731 <listitem>
1732 <para>
1733 Routers can be designated for use only when not verifying an address, that is,
1734 only when routing it for delivery (or testing its delivery routing). If the
1735 <option>verify</option> option is set false, the router is skipped when Exim is verifying an
1736 address.
1737 Setting the <option>verify</option> option actually sets two options, <option>verify_sender</option> and
1738 <option>verify_recipient</option>, which independently control the use of the router for
1739 sender and recipient verification. You can set these options directly if
1740 you want a router to be used for only one type of verification.
1741 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1742 </para>
1743 </listitem>
1744 <listitem>
1745 <para>
1746 If the <option>address_test</option> option is set false, the router is skipped when Exim is
1747 run with the <option>-bt</option> option to test an address routing. This can be helpful
1748 when the first router sends all new messages to a scanner of some sort; it
1749 makes it possible to use <option>-bt</option> to test subsequent delivery routing without
1750 having to simulate the effect of the scanner.
1751 </para>
1752 </listitem>
1753 <listitem>
1754 <para>
1755 Routers can be designated for use only when verifying an address, as
1756 opposed to routing it for delivery. The <option>verify_only</option> option controls this.
1757 Again, cutthrough delivery counts as a verification.
1758 </para>
1759 </listitem>
1760 <listitem>
1761 <para>
1762 Individual routers can be explicitly skipped when running the routers to
1763 check an address given in the SMTP EXPN command (see the <option>expn</option> option).
1764 </para>
1765 </listitem>
1766 <listitem>
1767 <para>
1768 If the <option>domains</option> option is set, the domain of the address must be in the set
1769 of domains that it defines.
1770 </para>
1771 </listitem>
1772 <listitem>
1773 <para>
1774 <indexterm role="variable">
1775 <primary><varname>$local_part_prefix</varname></primary>
1776 </indexterm>
1777 <indexterm role="variable">
1778 <primary><varname>$local_part</varname></primary>
1779 </indexterm>
1780 <indexterm role="variable">
1781 <primary><varname>$local_part_suffix</varname></primary>
1782 </indexterm>
1783 If the <option>local_parts</option> option is set, the local part of the address must be in
1784 the set of local parts that it defines. If <option>local_part_prefix</option> or
1785 <option>local_part_suffix</option> is in use, the prefix or suffix is removed from the local
1786 part before this check. If you want to do precondition tests on local parts
1787 that include affixes, you can do so by using a <option>condition</option> option (see below)
1788 that uses the variables <varname>$local_part</varname>, <varname>$local_part_prefix</varname>, and
1789 <varname>$local_part_suffix</varname> as necessary.
1790 </para>
1791 </listitem>
1792 <listitem>
1793 <para>
1794 <indexterm role="variable">
1795 <primary><varname>$local_user_uid</varname></primary>
1796 </indexterm>
1797 <indexterm role="variable">
1798 <primary><varname>$local_user_gid</varname></primary>
1799 </indexterm>
1800 <indexterm role="variable">
1801 <primary><varname>$home</varname></primary>
1802 </indexterm>
1803 If the <option>check_local_user</option> option is set, the local part must be the name of
1804 an account on the local host. If this check succeeds, the uid and gid of the
1805 local user are placed in <varname>$local_user_uid</varname> and <varname>$local_user_gid</varname> and the
1806 user&#x2019;s home directory is placed in <varname>$home</varname>; these values can be used in the
1807 remaining preconditions.
1808 </para>
1809 </listitem>
1810 <listitem>
1811 <para>
1812 If the <option>router_home_directory</option> option is set, it is expanded at this point,
1813 because it overrides the value of <varname>$home</varname>. If this expansion were left till
1814 later, the value of <varname>$home</varname> as set by <option>check_local_user</option> would be used in
1815 subsequent tests. Having two different values of <varname>$home</varname> in the same router
1816 could lead to confusion.
1817 </para>
1818 </listitem>
1819 <listitem>
1820 <para>
1821 If the <option>senders</option> option is set, the envelope sender address must be in the
1822 set of addresses that it defines.
1823 </para>
1824 </listitem>
1825 <listitem>
1826 <para>
1827 If the <option>require_files</option> option is set, the existence or non-existence of
1828 specified files is tested.
1829 </para>
1830 </listitem>
1831 <listitem>
1832 <para>
1833 <indexterm role="concept">
1834 <primary>customizing</primary>
1835 <secondary>precondition</secondary>
1836 </indexterm>
1837 If the <option>condition</option> option is set, it is evaluated and tested. This option
1838 uses an expanded string to allow you to set up your own custom preconditions.
1839 Expanded strings are described in chapter <xref linkend="CHAPexpand"/>.
1840 </para>
1841 </listitem>
1842 </itemizedlist>
1843 <para>
1844 Note that <option>require_files</option> comes near the end of the list, so you cannot use
1845 it to check for the existence of a file in which to lookup up a domain, local
1846 part, or sender. However, as these options are all expanded, you can use the
1847 <option>exists</option> expansion condition to make such tests within each condition. The
1848 <option>require_files</option> option is intended for checking files that the router may be
1849 going to use internally, or which are needed by a specific transport (for
1850 example, <filename>.procmailrc</filename>).
1851 </para>
1852 </section>
1853 <section id="SECID18">
1854 <title>Delivery in detail</title>
1855 <para>
1856 <indexterm role="concept">
1857 <primary>delivery</primary>
1858 <secondary>in detail</secondary>
1859 </indexterm>
1860 When a message is to be delivered, the sequence of events is as follows:
1861 </para>
1862 <itemizedlist>
1863 <listitem>
1864 <para>
1865 If a system-wide filter file is specified, the message is passed to it. The
1866 filter may add recipients to the message, replace the recipients, discard the
1867 message, cause a new message to be generated, or cause the message delivery to
1868 fail. The format of the system filter file is the same as for Exim user filter
1869 files, described in the separate document entitled <emphasis>Exim&#x2019;s interfaces to mail
1870 filtering</emphasis>.
1871 <indexterm role="concept">
1872 <primary>Sieve filter</primary>
1873 <secondary>not available for system filter</secondary>
1874 </indexterm>
1875 (<emphasis role="bold">Note</emphasis>: Sieve cannot be used for system filter files.)
1876 </para>
1877 <para>
1878 Some additional features are available in system filters &ndash; see chapter
1879 <xref linkend="CHAPsystemfilter"/> for details. Note that a message is passed to the system
1880 filter only once per delivery attempt, however many recipients it has. However,
1881 if there are several delivery attempts because one or more addresses could not
1882 be immediately delivered, the system filter is run each time. The filter
1883 condition <option>first_delivery</option> can be used to detect the first run of the system
1884 filter.
1885 </para>
1886 </listitem>
1887 <listitem>
1888 <para>
1889 Each recipient address is offered to each configured router in turn, subject to
1890 its preconditions, until one is able to handle it. If no router can handle the
1891 address, that is, if they all decline, the address is failed. Because routers
1892 can be targeted at particular domains, several locally handled domains can be
1893 processed entirely independently of each other.
1894 </para>
1895 </listitem>
1896 <listitem>
1897 <para>
1898 <indexterm role="concept">
1899 <primary>routing</primary>
1900 <secondary>loops in</secondary>
1901 </indexterm>
1902 <indexterm role="concept">
1903 <primary>loop</primary>
1904 <secondary>while routing</secondary>
1905 </indexterm>
1906 A router that accepts an address may assign it to a local or a remote
1907 transport. However, the transport is not run at this time. Instead, the address
1908 is placed on a list for the particular transport, which will be run later.
1909 Alternatively, the router may generate one or more new addresses (typically
1910 from alias, forward, or filter files). New addresses are fed back into this
1911 process from the top, but in order to avoid loops, a router ignores any address
1912 which has an identically-named ancestor that was processed by itself.
1913 </para>
1914 </listitem>
1915 <listitem>
1916 <para>
1917 When all the routing has been done, addresses that have been successfully
1918 handled are passed to their assigned transports. When local transports are
1919 doing real local deliveries, they handle only one address at a time, but if a
1920 local transport is being used as a pseudo-remote transport (for example, to
1921 collect batched SMTP messages for transmission by some other means) multiple
1922 addresses can be handled. Remote transports can always handle more than one
1923 address at a time, but can be configured not to do so, or to restrict multiple
1924 addresses to the same domain.
1925 </para>
1926 </listitem>
1927 <listitem>
1928 <para>
1929 Each local delivery to a file or a pipe runs in a separate process under a
1930 non-privileged uid, and these deliveries are run one at a time. Remote
1931 deliveries also run in separate processes, normally under a uid that is private
1932 to Exim (<quote>the Exim user</quote>), but in this case, several remote deliveries can be
1933 run in parallel. The maximum number of simultaneous remote deliveries for any
1934 one message is set by the <option>remote_max_parallel</option> option.
1935 The order in which deliveries are done is not defined, except that all local
1936 deliveries happen before any remote deliveries.
1937 </para>
1938 </listitem>
1939 <listitem>
1940 <para>
1941 <indexterm role="concept">
1942 <primary>queue runner</primary>
1943 </indexterm>
1944 When it encounters a local delivery during a queue run, Exim checks its retry
1945 database to see if there has been a previous temporary delivery failure for the
1946 address before running the local transport. If there was a previous failure,
1947 Exim does not attempt a new delivery until the retry time for the address is
1948 reached. However, this happens only for delivery attempts that are part of a
1949 queue run. Local deliveries are always attempted when delivery immediately
1950 follows message reception, even if retry times are set for them. This makes for
1951 better behaviour if one particular message is causing problems (for example,
1952 causing quota overflow, or provoking an error in a filter file).
1953 </para>
1954 </listitem>
1955 <listitem>
1956 <para>
1957 <indexterm role="concept">
1958 <primary>delivery</primary>
1959 <secondary>retry in remote transports</secondary>
1960 </indexterm>
1961 Remote transports do their own retry handling, since an address may be
1962 deliverable to one of a number of hosts, each of which may have a different
1963 retry time. If there have been previous temporary failures and no host has
1964 reached its retry time, no delivery is attempted, whether in a queue run or
1965 not. See chapter <xref linkend="CHAPretry"/> for details of retry strategies.
1966 </para>
1967 </listitem>
1968 <listitem>
1969 <para>
1970 If there were any permanent errors, a bounce message is returned to an
1971 appropriate address (the sender in the common case), with details of the error
1972 for each failing address. Exim can be configured to send copies of bounce
1973 messages to other addresses.
1974 </para>
1975 </listitem>
1976 <listitem>
1977 <para>
1978 <indexterm role="concept">
1979 <primary>delivery</primary>
1980 <secondary>deferral</secondary>
1981 </indexterm>
1982 If one or more addresses suffered a temporary failure, the message is left on
1983 the queue, to be tried again later. Delivery of these addresses is said to be
1984 <emphasis>deferred</emphasis>.
1985 </para>
1986 </listitem>
1987 <listitem>
1988 <para>
1989 When all the recipient addresses have either been delivered or bounced,
1990 handling of the message is complete. The spool files and message log are
1991 deleted, though the message log can optionally be preserved if required.
1992 </para>
1993 </listitem>
1994 </itemizedlist>
1995 </section>
1996 <section id="SECID19">
1997 <title>Retry mechanism</title>
1998 <para>
1999 <indexterm role="concept">
2000 <primary>delivery</primary>
2001 <secondary>retry mechanism</secondary>
2002 </indexterm>
2003 <indexterm role="concept">
2004 <primary>retry</primary>
2005 <secondary>description of mechanism</secondary>
2006 </indexterm>
2007 <indexterm role="concept">
2008 <primary>queue runner</primary>
2009 </indexterm>
2010 Exim&#x2019;s mechanism for retrying messages that fail to get delivered at the first
2011 attempt is the queue runner process. You must either run an Exim daemon that
2012 uses the <option>-q</option> option with a time interval to start queue runners at regular
2013 intervals, or use some other means (such as <emphasis>cron</emphasis>) to start them. If you do
2014 not arrange for queue runners to be run, messages that fail temporarily at the
2015 first attempt will remain on your queue for ever. A queue runner process works
2016 its way through the queue, one message at a time, trying each delivery that has
2017 passed its retry time.
2018 You can run several queue runners at once.
2019 </para>
2020 <para>
2021 Exim uses a set of configured rules to determine when next to retry the failing
2022 address (see chapter <xref linkend="CHAPretry"/>). These rules also specify when Exim
2023 should give up trying to deliver to the address, at which point it generates a
2024 bounce message. If no retry rules are set for a particular host, address, and
2025 error combination, no retries are attempted, and temporary errors are treated
2026 as permanent.
2027 </para>
2028 </section>
2029 <section id="SECID20">
2030 <title>Temporary delivery failure</title>
2031 <para>
2032 <indexterm role="concept">
2033 <primary>delivery</primary>
2034 <secondary>temporary failure</secondary>
2035 </indexterm>
2036 There are many reasons why a message may not be immediately deliverable to a
2037 particular address. Failure to connect to a remote machine (because it, or the
2038 connection to it, is down) is one of the most common. Temporary failures may be
2039 detected during routing as well as during the transport stage of delivery.
2040 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
2041 is on a file system where the user is over quota. Exim can be configured to
2042 impose its own quotas on local mailboxes; where system quotas are set they will
2043 also apply.
2044 </para>
2045 <para>
2046 If a host is unreachable for a period of time, a number of messages may be
2047 waiting for it by the time it recovers, and sending them in a single SMTP
2048 connection is clearly beneficial. Whenever a delivery to a remote host is
2049 deferred,
2050 <indexterm role="concept">
2051 <primary>hints database</primary>
2052 </indexterm>
2053 Exim makes a note in its hints database, and whenever a successful
2054 SMTP delivery has happened, it looks to see if any other messages are waiting
2055 for the same host. If any are found, they are sent over the same SMTP
2056 connection, subject to a configuration limit as to the maximum number in any
2057 one connection.
2058 </para>
2059 </section>
2060 <section id="SECID21">
2061 <title>Permanent delivery failure</title>
2062 <para>
2063 <indexterm role="concept">
2064 <primary>delivery</primary>
2065 <secondary>permanent failure</secondary>
2066 </indexterm>
2067 <indexterm role="concept">
2068 <primary>bounce message</primary>
2069 <secondary>when generated</secondary>
2070 </indexterm>
2071 When a message cannot be delivered to some or all of its intended recipients, a
2072 bounce message is generated. Temporary delivery failures turn into permanent
2073 errors when their timeout expires. All the addresses that fail in a given
2074 delivery attempt are listed in a single message. If the original message has
2075 many recipients, it is possible for some addresses to fail in one delivery
2076 attempt and others to fail subsequently, giving rise to more than one bounce
2077 message. The wording of bounce messages can be customized by the administrator.
2078 See chapter <xref linkend="CHAPemsgcust"/> for details.
2079 </para>
2080 <para>
2081 <indexterm role="concept">
2082 <primary><emphasis>X-Failed-Recipients:</emphasis> header line</primary>
2083 </indexterm>
2084 Bounce messages contain an <emphasis>X-Failed-Recipients:</emphasis> header line that lists the
2085 failed addresses, for the benefit of programs that try to analyse such messages
2086 automatically.
2087 </para>
2088 <para>
2089 <indexterm role="concept">
2090 <primary>bounce message</primary>
2091 <secondary>recipient of</secondary>
2092 </indexterm>
2093 A bounce message is normally sent to the sender of the original message, as
2094 obtained from the message&#x2019;s envelope. For incoming SMTP messages, this is the
2095 address given in the MAIL command. However, when an address is expanded via a
2096 forward or alias file, an alternative address can be specified for delivery
2097 failures of the generated addresses. For a mailing list expansion (see section
2098 <xref linkend="SECTmailinglists"/>) it is common to direct bounce messages to the manager
2099 of the list.
2100 </para>
2101 </section>
2102 <section id="SECID22">
2103 <title>Failures to deliver bounce messages</title>
2104 <para>
2105 <indexterm role="concept">
2106 <primary>bounce message</primary>
2107 <secondary>failure to deliver</secondary>
2108 </indexterm>
2109 If a bounce message (either locally generated or received from a remote host)
2110 itself suffers a permanent delivery failure, the message is left on the queue,
2111 but it is frozen, awaiting the attention of an administrator. There are options
2112 that can be used to make Exim discard such failed messages, or to keep them
2113 for only a short time (see <option>timeout_frozen_after</option> and
2114 <option>ignore_bounce_errors_after</option>).
2115 </para>
2116 </section>
2117 </chapter>
2118
2119 <chapter id="CHID3">
2120 <title>Building and installing Exim</title>
2121 <para>
2122 <indexterm role="concept" id="IIDbuex" class="startofrange">
2123 <primary>building Exim</primary>
2124 </indexterm>
2125 </para>
2126 <section id="SECID23">
2127 <title>Unpacking</title>
2128 <para>
2129 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
2130 creates a directory with the name of the current release (for example,
2131 <filename>exim-4.83</filename>) into which the following files are placed:
2132 </para>
2133 <informaltable frame="none">
2134 <tgroup cols="2" colsep="0" rowsep="0">
2135 <colspec colwidth="140pt" align="left"/>
2136 <colspec colwidth="254pt" align="left"/>
2137 <tbody>
2138 <row>
2139 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<filename>ACKNOWLEDGMENTS</filename></entry>
2140 <entry>contains some acknowledgments</entry>
2141 </row>
2142 <row>
2143 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<filename>CHANGES</filename></entry>
2144 <entry>contains a reference to where changes are documented</entry>
2145 </row>
2146 <row>
2147 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<filename>LICENCE</filename></entry>
2148 <entry>the GNU General Public Licence</entry>
2149 </row>
2150 <row>
2151 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<filename>Makefile</filename></entry>
2152 <entry>top-level make file</entry>
2153 </row>
2154 <row>
2155 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<filename>NOTICE</filename></entry>
2156 <entry>conditions for the use of Exim</entry>
2157 </row>
2158 <row>
2159 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<filename>README</filename></entry>
2160 <entry>list of files, directories and simple build instructions</entry>
2161 </row>
2162 </tbody>
2163 </tgroup>
2164 </informaltable>
2165 <para>
2166 Other files whose names begin with <filename>README</filename> may also be present. The
2167 following subdirectories are created:
2168 </para>
2169 <informaltable frame="none">
2170 <tgroup cols="2" colsep="0" rowsep="0">
2171 <colspec colwidth="140pt" align="left"/>
2172 <colspec colwidth="254pt" align="left"/>
2173 <tbody>
2174 <row>
2175 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<filename>Local</filename></entry>
2176 <entry>an empty directory for local configuration files</entry>
2177 </row>
2178 <row>
2179 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<filename>OS</filename></entry>
2180 <entry>OS-specific files</entry>
2181 </row>
2182 <row>
2183 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<filename>doc</filename></entry>
2184 <entry>documentation files</entry>
2185 </row>
2186 <row>
2187 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<filename>exim_monitor</filename></entry>
2188 <entry>source files for the Exim monitor</entry>
2189 </row>
2190 <row>
2191 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<filename>scripts</filename></entry>
2192 <entry>scripts used in the build process</entry>
2193 </row>
2194 <row>
2195 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<filename>src</filename></entry>
2196 <entry>remaining source files</entry>
2197 </row>
2198 <row>
2199 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<filename>util</filename></entry>
2200 <entry>independent utilities</entry>
2201 </row>
2202 </tbody>
2203 </tgroup>
2204 </informaltable>
2205 <para>
2206 The main utility programs are contained in the <filename>src</filename> directory, and are built
2207 with the Exim binary. The <filename>util</filename> directory contains a few optional scripts
2208 that may be useful to some sites.
2209 </para>
2210 </section>
2211 <section id="SECID24">
2212 <title>Multiple machine architectures and operating systems</title>
2213 <para>
2214 <indexterm role="concept">
2215 <primary>building Exim</primary>
2216 <secondary>multiple OS/architectures</secondary>
2217 </indexterm>
2218 The building process for Exim is arranged to make it easy to build binaries for
2219 a number of different architectures and operating systems from the same set of
2220 source files. Compilation does not take place in the <filename>src</filename> directory.
2221 Instead, a <emphasis>build directory</emphasis> is created for each architecture and operating
2222 system.
2223 <indexterm role="concept">
2224 <primary>symbolic link</primary>
2225 <secondary>to build directory</secondary>
2226 </indexterm>
2227 Symbolic links to the sources are installed in this directory, which is where
2228 the actual building takes place. In most cases, Exim can discover the machine
2229 architecture and operating system for itself, but the defaults can be
2230 overridden if necessary.
2231 </para>
2232 </section>
2233 <section id="SECTpcre">
2234 <title>PCRE library</title>
2235 <para>
2236 <indexterm role="concept">
2237 <primary>PCRE library</primary>
2238 </indexterm>
2239 Exim no longer has an embedded PCRE library as the vast majority of
2240 modern systems include PCRE as a system library, although you may need
2241 to install the PCRE or PCRE development package for your operating
2242 system. If your system has a normal PCRE installation the Exim build
2243 process will need no further configuration. If the library or the
2244 headers are in an unusual location you will need to either set the PCRE_LIBS
2245 and INCLUDE directives appropriately,
2246 or set PCRE_CONFIG=yes to use the installed <command>pcre-config</command> command.
2247 If your operating system has no
2248 PCRE support then you will need to obtain and build the current PCRE
2249 from <emphasis role="bold"><ulink url="ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/">ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/</ulink></emphasis>.
2250 More information on PCRE is available at <emphasis role="bold"><ulink url="http://www.pcre.org/">http://www.pcre.org/</ulink></emphasis>.
2251 </para>
2252 </section>
2253 <section id="SECTdb">
2254 <title>DBM libraries</title>
2255 <para>
2256 <indexterm role="concept">
2257 <primary>DBM libraries</primary>
2258 <secondary>discussion of</secondary>
2259 </indexterm>
2260 <indexterm role="concept">
2261 <primary>hints database</primary>
2262 <secondary>DBM files used for</secondary>
2263 </indexterm>
2264 Even if you do not use any DBM files in your configuration, Exim still needs a
2265 DBM library in order to operate, because it uses indexed files for its hints
2266 databases. Unfortunately, there are a number of DBM libraries in existence, and
2267 different operating systems often have different ones installed.
2268 </para>
2269 <para>
2270 <indexterm role="concept">
2271 <primary>Solaris</primary>
2272 <secondary>DBM library for</secondary>
2273 </indexterm>
2274 <indexterm role="concept">
2275 <primary>IRIX, DBM library for</primary>
2276 </indexterm>
2277 <indexterm role="concept">
2278 <primary>BSD, DBM library for</primary>
2279 </indexterm>
2280 <indexterm role="concept">
2281 <primary>Linux, DBM library for</primary>
2282 </indexterm>
2283 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
2284 Linux distribution, the DBM configuration should happen automatically, and you
2285 may be able to ignore this section. Otherwise, you may have to learn more than
2286 you would like about DBM libraries from what follows.
2287 </para>
2288 <para>
2289 <indexterm role="concept">
2290 <primary><emphasis>ndbm</emphasis> DBM library</primary>
2291 </indexterm>
2292 Licensed versions of Unix normally contain a library of DBM functions operating
2293 via the <emphasis>ndbm</emphasis> interface, and this is what Exim expects by default. Free
2294 versions of Unix seem to vary in what they contain as standard. In particular,
2295 some early versions of Linux have no default DBM library, and different
2296 distributors have chosen to bundle different libraries with their packaged
2297 versions. However, the more recent releases seem to have standardized on the
2298 Berkeley DB library.
2299 </para>
2300 <para>
2301 Different DBM libraries have different conventions for naming the files they
2302 use. When a program opens a file called <filename>dbmfile</filename>, there are several
2303 possibilities:
2304 </para>
2305 <orderedlist numeration="arabic">
2306 <listitem>
2307 <para>
2308 A traditional <emphasis>ndbm</emphasis> implementation, such as that supplied as part of
2309 Solaris, operates on two files called <filename>dbmfile.dir</filename> and <filename>dbmfile.pag</filename>.
2310 </para>
2311 </listitem>
2312 <listitem>
2313 <para>
2314 <indexterm role="concept">
2315 <primary><emphasis>gdbm</emphasis> DBM library</primary>
2316 </indexterm>
2317 The GNU library, <emphasis>gdbm</emphasis>, operates on a single file. If used via its <emphasis>ndbm</emphasis>
2318 compatibility interface it makes two different hard links to it with names
2319 <filename>dbmfile.dir</filename> and <filename>dbmfile.pag</filename>, but if used via its native interface, the
2320 file name is used unmodified.
2321 </para>
2322 </listitem>
2323 <listitem>
2324 <para>
2325 <indexterm role="concept">
2326 <primary>Berkeley DB library</primary>
2327 </indexterm>
2328 The Berkeley DB package, if called via its <emphasis>ndbm</emphasis> compatibility interface,
2329 operates on a single file called <filename>dbmfile.db</filename>, but otherwise looks to the
2330 programmer exactly the same as the traditional <emphasis>ndbm</emphasis> implementation.
2331 </para>
2332 </listitem>
2333 <listitem>
2334 <para>
2335 If the Berkeley package is used in its native mode, it operates on a single
2336 file called <filename>dbmfile</filename>; the programmer&#x2019;s interface is somewhat different to
2337 the traditional <emphasis>ndbm</emphasis> interface.
2338 </para>
2339 </listitem>
2340 <listitem>
2341 <para>
2342 To complicate things further, there are several very different versions of the
2343 Berkeley DB package. Version 1.85 was stable for a very long time, releases
2344 2.<emphasis>x</emphasis> and 3.<emphasis>x</emphasis> were current for a while, but the latest versions are now
2345 numbered 4.<emphasis>x</emphasis>. Maintenance of some of the earlier releases has ceased. All
2346 versions of Berkeley DB can be obtained from
2347 <emphasis role="bold"><ulink url="http://www.sleepycat.com/">http://www.sleepycat.com/</ulink></emphasis>.
2348 </para>
2349 </listitem>
2350 <listitem>
2351 <para>
2352 <indexterm role="concept">
2353 <primary><emphasis>tdb</emphasis> DBM library</primary>
2354 </indexterm>
2355 Yet another DBM library, called <emphasis>tdb</emphasis>, is available from
2356 <emphasis role="bold"><ulink url="http://download.sourceforge.net/tdb">http://download.sourceforge.net/tdb</ulink></emphasis>. It has its own interface, and also
2357 operates on a single file.
2358 </para>
2359 </listitem>
2360 </orderedlist>
2361 <para>
2362 <indexterm role="concept">
2363 <primary>USE_DB</primary>
2364 </indexterm>
2365 <indexterm role="concept">
2366 <primary>DBM libraries</primary>
2367 <secondary>configuration for building</secondary>
2368 </indexterm>
2369 Exim and its utilities can be compiled to use any of these interfaces. In order
2370 to use any version of the Berkeley DB package in native mode, you must set
2371 USE_DB in an appropriate configuration file (typically
2372 <filename>Local/Makefile</filename>). For example:
2373 </para>
2374 <literallayout class="monospaced">
2375 USE_DB=yes
2376 </literallayout>
2377 <para>
2378 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
2379 error is diagnosed if you set more than one of these.
2380 </para>
2381 <para>
2382 At the lowest level, the build-time configuration sets none of these options,
2383 thereby assuming an interface of type (1). However, some operating system
2384 configuration files (for example, those for the BSD operating systems and
2385 Linux) assume type (4) by setting USE_DB as their default, and the
2386 configuration files for Cygwin set USE_GDBM. Anything you set in
2387 <filename>Local/Makefile</filename>, however, overrides these system defaults.
2388 </para>
2389 <para>
2390 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
2391 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
2392 in one of these lines:
2393 </para>
2394 <literallayout class="monospaced">
2395 DBMLIB = -ldb
2396 DBMLIB = -ltdb
2397 </literallayout>
2398 <para>
2399 Settings like that will work if the DBM library is installed in the standard
2400 place. Sometimes it is not, and the library&#x2019;s header file may also not be in
2401 the default path. You may need to set INCLUDE to specify where the header
2402 file is, and to specify the path to the library more fully in DBMLIB, as in
2403 this example:
2404 </para>
2405 <literallayout class="monospaced">
2406 INCLUDE=-I/usr/local/include/db-4.1
2407 DBMLIB=/usr/local/lib/db-4.1/libdb.a
2408 </literallayout>
2409 <para>
2410 There is further detailed discussion about the various DBM libraries in the
2411 file <filename>doc/dbm.discuss.txt</filename> in the Exim distribution.
2412 </para>
2413 </section>
2414 <section id="SECID25">
2415 <title>Pre-building configuration</title>
2416 <para>
2417 <indexterm role="concept">
2418 <primary>building Exim</primary>
2419 <secondary>pre-building configuration</secondary>
2420 </indexterm>
2421 <indexterm role="concept">
2422 <primary>configuration for building Exim</primary>
2423 </indexterm>
2424 <indexterm role="concept">
2425 <primary><filename>Local/Makefile</filename></primary>
2426 </indexterm>
2427 <indexterm role="concept">
2428 <primary><filename>src/EDITME</filename></primary>
2429 </indexterm>
2430 Before building Exim, a local configuration file that specifies options
2431 independent of any operating system has to be created with the name
2432 <filename>Local/Makefile</filename>. A template for this file is supplied as the file
2433 <filename>src/EDITME</filename>, and it contains full descriptions of all the option settings
2434 therein. These descriptions are therefore not repeated here. If you are
2435 building Exim for the first time, the simplest thing to do is to copy
2436 <filename>src/EDITME</filename> to <filename>Local/Makefile</filename>, then read it and edit it appropriately.
2437 </para>
2438 <para>
2439 There are three settings that you must supply, because Exim will not build
2440 without them. They are the location of the run time configuration file
2441 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
2442 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
2443 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
2444 a colon-separated list of file names; Exim uses the first of them that exists.
2445 </para>
2446 <para>
2447 There are a few other parameters that can be specified either at build time or
2448 at run time, to enable the same binary to be used on a number of different
2449 machines. However, if the locations of Exim&#x2019;s spool directory and log file
2450 directory (if not within the spool directory) are fixed, it is recommended that
2451 you specify them in <filename>Local/Makefile</filename> instead of at run time, so that errors
2452 detected early in Exim&#x2019;s execution (such as a malformed configuration file) can
2453 be logged.
2454 </para>
2455 <para>
2456 <indexterm role="concept">
2457 <primary>content scanning</primary>
2458 <secondary>specifying at build time</secondary>
2459 </indexterm>
2460 Exim&#x2019;s interfaces for calling virus and spam scanning software directly from
2461 access control lists are not compiled by default. If you want to include these
2462 facilities, you need to set
2463 </para>
2464 <literallayout class="monospaced">
2465 WITH_CONTENT_SCAN=yes
2466 </literallayout>
2467 <para>
2468 in your <filename>Local/Makefile</filename>. For details of the facilities themselves, see
2469 chapter <xref linkend="CHAPexiscan"/>.
2470 </para>
2471 <para>
2472 <indexterm role="concept">
2473 <primary><filename>Local/eximon.conf</filename></primary>
2474 </indexterm>
2475 <indexterm role="concept">
2476 <primary><filename>exim_monitor/EDITME</filename></primary>
2477 </indexterm>
2478 If you are going to build the Exim monitor, a similar configuration process is
2479 required. The file <filename>exim_monitor/EDITME</filename> must be edited appropriately for
2480 your installation and saved under the name <filename>Local/eximon.conf</filename>. If you are
2481 happy with the default settings described in <filename>exim_monitor/EDITME</filename>,
2482 <filename>Local/eximon.conf</filename> can be empty, but it must exist.
2483 </para>
2484 <para>
2485 This is all the configuration that is needed in straightforward cases for known
2486 operating systems. However, the building process is set up so that it is easy
2487 to override options that are set by default or by operating-system-specific
2488 configuration files, for example to change the name of the C compiler, which
2489 defaults to <option>gcc</option>. See section <xref linkend="SECToverride"/> below for details of how to
2490 do this.
2491 </para>
2492 </section>
2493 <section id="SECID26">
2494 <title>Support for iconv()</title>
2495 <para>
2496 <indexterm role="concept">
2497 <primary><function>iconv()</function> support</primary>
2498 </indexterm>
2499 <indexterm role="concept">
2500 <primary>RFC 2047</primary>
2501 </indexterm>
2502 The contents of header lines in messages may be encoded according to the rules
2503 described RFC 2047. This makes it possible to transmit characters that are not
2504 in the ASCII character set, and to label them as being in a particular
2505 character set. When Exim is inspecting header lines by means of the <option>$h_</option>
2506 mechanism, it decodes them, and translates them into a specified character set
2507 (default ISO-8859-1). The translation is possible only if the operating system
2508 supports the <function>iconv()</function> function.
2509 </para>
2510 <para>
2511 However, some of the operating systems that supply <function>iconv()</function> do not support
2512 very many conversions. The GNU <option>libiconv</option> library (available from
2513 <emphasis role="bold"><ulink url="http://www.gnu.org/software/libiconv/">http://www.gnu.org/software/libiconv/</ulink></emphasis>) can be installed on such
2514 systems to remedy this deficiency, as well as on systems that do not supply
2515 <function>iconv()</function> at all. After installing <option>libiconv</option>, you should add
2516 </para>
2517 <literallayout class="monospaced">
2518 HAVE_ICONV=yes
2519 </literallayout>
2520 <para>
2521 to your <filename>Local/Makefile</filename> and rebuild Exim.
2522 </para>
2523 </section>
2524 <section id="SECTinctlsssl">
2525 <title>Including TLS/SSL encryption support</title>
2526 <para>
2527 <indexterm role="concept">
2528 <primary>TLS</primary>
2529 <secondary>including support for TLS</secondary>
2530 </indexterm>
2531 <indexterm role="concept">
2532 <primary>encryption</primary>
2533 <secondary>including support for</secondary>
2534 </indexterm>
2535 <indexterm role="concept">
2536 <primary>SUPPORT_TLS</primary>
2537 </indexterm>
2538 <indexterm role="concept">
2539 <primary>OpenSSL</primary>
2540 <secondary>building Exim with</secondary>
2541 </indexterm>
2542 <indexterm role="concept">
2543 <primary>GnuTLS</primary>
2544 <secondary>building Exim with</secondary>
2545 </indexterm>
2546 Exim can be built to support encrypted SMTP connections, using the STARTTLS
2547 command as per RFC 2487. It can also support legacy clients that expect to
2548 start a TLS session immediately on connection to a non-standard port (see the
2549 <option>tls_on_connect_ports</option> runtime option and the <option>-tls-on-connect</option> command
2550 line option).
2551 </para>
2552 <para>
2553 If you want to build Exim with TLS support, you must first install either the
2554 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
2555 implementing SSL.
2556 </para>
2557 <para>
2558 If OpenSSL is installed, you should set
2559 </para>
2560 <literallayout class="monospaced">
2561 SUPPORT_TLS=yes
2562 TLS_LIBS=-lssl -lcrypto
2563 </literallayout>
2564 <para>
2565 in <filename>Local/Makefile</filename>. You may also need to specify the locations of the
2566 OpenSSL library and include files. For example:
2567 </para>
2568 <literallayout class="monospaced">
2569 SUPPORT_TLS=yes
2570 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
2571 TLS_INCLUDE=-I/usr/local/openssl/include/
2572 </literallayout>
2573 <para>
2574 <indexterm role="concept">
2575 <primary>pkg-config</primary>
2576 <secondary>OpenSSL</secondary>
2577 </indexterm>
2578 If you have <emphasis>pkg-config</emphasis> available, then instead you can just use:
2579 </para>
2580 <literallayout class="monospaced">
2581 SUPPORT_TLS=yes
2582 USE_OPENSSL_PC=openssl
2583 </literallayout>
2584 <para>
2585 <indexterm role="concept">
2586 <primary>USE_GNUTLS</primary>
2587 </indexterm>
2588 If GnuTLS is installed, you should set
2589 </para>
2590 <literallayout class="monospaced">
2591 SUPPORT_TLS=yes
2592 USE_GNUTLS=yes
2593 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
2594 </literallayout>
2595 <para>
2596 in <filename>Local/Makefile</filename>, and again you may need to specify the locations of the
2597 library and include files. For example:
2598 </para>
2599 <literallayout class="monospaced">
2600 SUPPORT_TLS=yes
2601 USE_GNUTLS=yes
2602 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
2603 TLS_INCLUDE=-I/usr/gnu/include
2604 </literallayout>
2605 <para>
2606 <indexterm role="concept">
2607 <primary>pkg-config</primary>
2608 <secondary>GnuTLS</secondary>
2609 </indexterm>
2610 If you have <emphasis>pkg-config</emphasis> available, then instead you can just use:
2611 </para>
2612 <literallayout class="monospaced">
2613 SUPPORT_TLS=yes
2614 USE_GNUTLS=yes
2615 USE_GNUTLS_PC=gnutls
2616 </literallayout>
2617 <para>
2618 You do not need to set TLS_INCLUDE if the relevant directory is already
2619 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
2620 given in chapter <xref linkend="CHAPTLS"/>.
2621 </para>
2622 </section>
2623 <section id="SECID27">
2624 <title>Use of tcpwrappers</title>
2625 <para>
2626 <indexterm role="concept">
2627 <primary>tcpwrappers, building Exim to support</primary>
2628 </indexterm>
2629 <indexterm role="concept">
2630 <primary>USE_TCP_WRAPPERS</primary>
2631 </indexterm>
2632 <indexterm role="concept">
2633 <primary>TCP_WRAPPERS_DAEMON_NAME</primary>
2634 </indexterm>
2635 <indexterm role="concept">
2636 <primary>tcp_wrappers_daemon_name</primary>
2637 </indexterm>
2638 Exim can be linked with the <emphasis>tcpwrappers</emphasis> library in order to check incoming
2639 SMTP calls using the <emphasis>tcpwrappers</emphasis> control files. This may be a convenient
2640 alternative to Exim&#x2019;s own checking facilities for installations that are
2641 already making use of <emphasis>tcpwrappers</emphasis> for other purposes. To do this, you
2642 should set USE_TCP_WRAPPERS in <filename>Local/Makefile</filename>, arrange for the file
2643 <filename>tcpd.h</filename> to be available at compile time, and also ensure that the library
2644 <filename>libwrap.a</filename> is available at link time, typically by including <option>-lwrap</option> in
2645 EXTRALIBS_EXIM. For example, if <emphasis>tcpwrappers</emphasis> is installed in <filename>/usr/local</filename>,
2646 you might have
2647 </para>
2648 <literallayout class="monospaced">
2649 USE_TCP_WRAPPERS=yes
2650 CFLAGS=-O -I/usr/local/include
2651 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
2652 </literallayout>
2653 <para>
2654 in <filename>Local/Makefile</filename>. The daemon name to use in the <emphasis>tcpwrappers</emphasis> control
2655 files is <quote>exim</quote>. For example, the line
2656 </para>
2657 <literallayout class="monospaced">
2658 exim : LOCAL  192.168.1.  .friendly.domain.example
2659 </literallayout>
2660 <para>
2661 in your <filename>/etc/hosts.allow</filename> file allows connections from the local host, from
2662 the subnet 192.168.1.0/24, and from all hosts in <emphasis>friendly.domain.example</emphasis>.
2663 All other connections are denied. The daemon name used by <emphasis>tcpwrappers</emphasis>
2664 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
2665 <filename>Local/Makefile</filename>, or by setting tcp_wrappers_daemon_name in the
2666 configure file. Consult the <emphasis>tcpwrappers</emphasis> documentation for
2667 further details.
2668 </para>
2669 </section>
2670 <section id="SECID28">
2671 <title>Including support for IPv6</title>
2672 <para>
2673 <indexterm role="concept">
2674 <primary>IPv6</primary>
2675 <secondary>including support for</secondary>
2676 </indexterm>
2677 Exim contains code for use on systems that have IPv6 support. Setting
2678 <literal>HAVE_IPV6=YES</literal> in <filename>Local/Makefile</filename> causes the IPv6 code to be included;
2679 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
2680 where the IPv6 support is not fully integrated into the normal include and
2681 library files.
2682 </para>
2683 <para>
2684 Two different types of DNS record for handling IPv6 addresses have been
2685 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2686 currently seen as the mainstream. Another record type called A6 was proposed
2687 as better than AAAA because it had more flexibility. However, it was felt to be
2688 over-complex, and its status was reduced to <quote>experimental</quote>. It is not known
2689 if anyone is actually using A6 records. Exim has support for A6 records, but
2690 this is included only if you set <literal>SUPPORT_A6=YES</literal> in <filename>Local/Makefile</filename>. The
2691 support has not been tested for some time.
2692 </para>
2693 </section>
2694 <section id="SECTdynamicmodules">
2695 <title>Dynamically loaded lookup module support</title>
2696 <para>
2697 <indexterm role="concept">
2698 <primary>lookup modules</primary>
2699 </indexterm>
2700 <indexterm role="concept">
2701 <primary>dynamic modules</primary>
2702 </indexterm>
2703 <indexterm role="concept">
2704 <primary>.so building</primary>
2705 </indexterm>
2706 On some platforms, Exim supports not compiling all lookup types directly into
2707 the main binary, instead putting some into external modules which can be loaded
2708 on demand.
2709 This permits packagers to build Exim with support for lookups with extensive
2710 library dependencies without requiring all users to install all of those
2711 dependencies.
2712 Most, but not all, lookup types can be built this way.
2713 </para>
2714 <para>
2715 Set <literal>LOOKUP_MODULE_DIR</literal> to the directory into which the modules will be
2716 installed; Exim will only load modules from that directory, as a security
2717 measure.  You will need to set <literal>CFLAGS_DYNAMIC</literal> if not already defined
2718 for your OS; see <filename>OS/Makefile-Linux</filename> for an example.
2719 Some other requirements for adjusting <literal>EXTRALIBS</literal> may also be necessary,
2720 see <filename>src/EDITME</filename> for details.
2721 </para>
2722 <para>
2723 Then, for each module to be loaded dynamically, define the relevant
2724 <literal>LOOKUP_</literal>&lt;<emphasis>lookup_type</emphasis>&gt; flags to have the value "2" instead of "yes".
2725 For example, this will build in lsearch but load sqlite and mysql support
2726 on demand:
2727 </para>
2728 <literallayout class="monospaced">
2729 LOOKUP_LSEARCH=yes
2730 LOOKUP_SQLITE=2
2731 LOOKUP_MYSQL=2
2732 </literallayout>
2733 </section>
2734 <section id="SECID29">
2735 <title>The building process</title>
2736 <para>
2737 <indexterm role="concept">
2738 <primary>build directory</primary>
2739 </indexterm>
2740 Once <filename>Local/Makefile</filename> (and <filename>Local/eximon.conf</filename>, if required) have been
2741 created, run <emphasis>make</emphasis> at the top level. It determines the architecture and
2742 operating system types, and creates a build directory if one does not exist.
2743 For example, on a Sun system running Solaris 8, the directory
2744 <filename>build-SunOS5-5.8-sparc</filename> is created.
2745 <indexterm role="concept">
2746 <primary>symbolic link</primary>
2747 <secondary>to source files</secondary>
2748 </indexterm>
2749 Symbolic links to relevant source files are installed in the build directory.
2750 </para>
2751 <para>
2752 <emphasis role="bold">Warning</emphasis>: The <option>-j</option> (parallel) flag must not be used with <emphasis>make</emphasis>; the
2753 building process fails if it is set.
2754 </para>
2755 <para>
2756 If this is the first time <emphasis>make</emphasis> has been run, it calls a script that builds
2757 a make file inside the build directory, using the configuration files from the
2758 <filename>Local</filename> directory. The new make file is then passed to another instance of
2759 <emphasis>make</emphasis>. This does the real work, building a number of utility scripts, and
2760 then compiling and linking the binaries for the Exim monitor (if configured), a
2761 number of utility programs, and finally Exim itself. The command <literal>make
2762 makefile</literal> can be used to force a rebuild of the make file in the build
2763 directory, should this ever be necessary.
2764 </para>
2765 <para>
2766 If you have problems building Exim, check for any comments there may be in the
2767 <filename>README</filename> file concerning your operating system, and also take a look at the
2768 FAQ, where some common problems are covered.
2769 </para>
2770 </section>
2771 <section id="SECID283">
2772 <title>Output from <quote>make</quote></title>
2773 <para>
2774 The output produced by the <emphasis>make</emphasis> process for compile lines is often very
2775 unreadable, because these lines can be very long. For this reason, the normal
2776 output is suppressed by default, and instead output similar to that which
2777 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2778 each module that is being compiled or linked. However, it is still possible to
2779 get the full output, by calling <emphasis>make</emphasis> like this:
2780 </para>
2781 <literallayout class="monospaced">
2782 FULLECHO='' make -e
2783 </literallayout>
2784 <para>
2785 The value of FULLECHO defaults to <quote>@</quote>, the flag character that suppresses
2786 command reflection in <emphasis>make</emphasis>. When you ask for the full output, it is
2787 given in addition to the short output.
2788 </para>
2789 </section>
2790 <section id="SECToverride">
2791 <title>Overriding build-time options for Exim</title>
2792 <para>
2793 <indexterm role="concept">
2794 <primary>build-time options, overriding</primary>
2795 </indexterm>
2796 The main make file that is created at the beginning of the building process
2797 consists of the concatenation of a number of files which set configuration
2798 values, followed by a fixed set of <emphasis>make</emphasis> instructions. If a value is set
2799 more than once, the last setting overrides any previous ones. This provides a
2800 convenient way of overriding defaults. The files that are concatenated are, in
2801 order:
2802 </para>
2803 <literallayout>
2804 <filename>OS/Makefile-Default</filename>
2805 <filename>OS/Makefile-</filename>&lt;<emphasis>ostype</emphasis>&gt;
2806 <filename>Local/Makefile</filename>
2807 <filename>Local/Makefile-</filename>&lt;<emphasis>ostype</emphasis>&gt;
2808 <filename>Local/Makefile-</filename>&lt;<emphasis>archtype</emphasis>&gt;
2809 <filename>Local/Makefile-</filename>&lt;<emphasis>ostype</emphasis>&gt;-&lt;<emphasis>archtype</emphasis>&gt;
2810 <filename>OS/Makefile-Base</filename>
2811 </literallayout>
2812 <para>
2813 <indexterm role="concept">
2814 <primary><filename>Local/Makefile</filename></primary>
2815 </indexterm>
2816 <indexterm role="concept">
2817 <primary>building Exim</primary>
2818 <secondary>operating system type</secondary>
2819 </indexterm>
2820 <indexterm role="concept">
2821 <primary>building Exim</primary>
2822 <secondary>architecture type</secondary>
2823 </indexterm>
2824 where &lt;<emphasis>ostype</emphasis>&gt; is the operating system type and &lt;<emphasis>archtype</emphasis>&gt; is the
2825 architecture type. <filename>Local/Makefile</filename> is required to exist, and the building
2826 process fails if it is absent. The other three <filename>Local</filename> files are optional,
2827 and are often not needed.
2828 </para>
2829 <para>
2830 The values used for &lt;<emphasis>ostype</emphasis>&gt; and &lt;<emphasis>archtype</emphasis>&gt; are obtained from scripts
2831 called <filename>scripts/os-type</filename> and <filename>scripts/arch-type</filename> respectively. If either of
2832 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2833 values are used, thereby providing a means of forcing particular settings.
2834 Otherwise, the scripts try to get values from the <option>uname</option> command. If this
2835 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2836 of <emphasis>ad hoc</emphasis> transformations are then applied, to produce the standard names
2837 that Exim expects. You can run these scripts directly from the shell in order
2838 to find out what values are being used on your system.
2839 </para>
2840 <para>
2841 <filename>OS/Makefile-Default</filename> contains comments about the variables that are set
2842 therein. Some (but not all) are mentioned below. If there is something that
2843 needs changing, review the contents of this file and the contents of the make
2844 file for your operating system (<filename>OS/Makefile-&lt;ostype&gt;</filename>) to see what the
2845 default values are.
2846 </para>
2847 <para>
2848 <indexterm role="concept">
2849 <primary>building Exim</primary>
2850 <secondary>overriding default settings</secondary>
2851 </indexterm>
2852 If you need to change any of the values that are set in <filename>OS/Makefile-Default</filename>
2853 or in <filename>OS/Makefile-&lt;ostype&gt;</filename>, or to add any new definitions, you do not
2854 need to change the original files. Instead, you should make the changes by
2855 putting the new values in an appropriate <filename>Local</filename> file. For example,
2856 <indexterm role="concept">
2857 <primary>Tru64-Unix build-time settings</primary>
2858 </indexterm>
2859 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2860 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2861 compiler is called <emphasis>cc</emphasis> rather than <emphasis>gcc</emphasis>. Also, the compiler must be
2862 called with the option <option>-std1</option>, to make it recognize some of the features of
2863 Standard C that Exim uses. (Most other compilers recognize Standard C by
2864 default.) To do this, you should create a file called <filename>Local/Makefile-OSF1</filename>
2865 containing the lines
2866 </para>
2867 <literallayout class="monospaced">
2868 CC=cc
2869 CFLAGS=-std1
2870 </literallayout>
2871 <para>
2872 If you are compiling for just one operating system, it may be easier to put
2873 these lines directly into <filename>Local/Makefile</filename>.
2874 </para>
2875 <para>
2876 Keeping all your local configuration settings separate from the distributed
2877 files makes it easy to transfer them to new versions of Exim simply by copying
2878 the contents of the <filename>Local</filename> directory.
2879 </para>
2880 <para>
2881 <indexterm role="concept">
2882 <primary>NIS lookup type</primary>
2883 <secondary>including support for</secondary>
2884 </indexterm>
2885 <indexterm role="concept">
2886 <primary>NIS+ lookup type</primary>
2887 <secondary>including support for</secondary>
2888 </indexterm>
2889 <indexterm role="concept">
2890 <primary>LDAP</primary>
2891 <secondary>including support for</secondary>
2892 </indexterm>
2893 <indexterm role="concept">
2894 <primary>lookup</primary>
2895 <secondary>inclusion in binary</secondary>
2896 </indexterm>
2897 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2898 lookup, but not all systems have these components installed, so the default is
2899 not to include the relevant code in the binary. All the different kinds of file
2900 and database lookup that Exim supports are implemented as separate code modules
2901 which are included only if the relevant compile-time options are set. In the
2902 case of LDAP, NIS, and NIS+, the settings for <filename>Local/Makefile</filename> are:
2903 </para>
2904 <literallayout class="monospaced">
2905 LOOKUP_LDAP=yes
2906 LOOKUP_NIS=yes
2907 LOOKUP_NISPLUS=yes
2908 </literallayout>
2909 <para>
2910 and similar settings apply to the other lookup types. They are all listed in
2911 <filename>src/EDITME</filename>. In many cases the relevant include files and interface
2912 libraries need to be installed before compiling Exim.
2913 <indexterm role="concept">
2914 <primary>cdb</primary>
2915 <secondary>including support for</secondary>
2916 </indexterm>
2917 However, there are some optional lookup types (such as cdb) for which
2918 the code is entirely contained within Exim, and no external include
2919 files or libraries are required. When a lookup type is not included in the
2920 binary, attempts to configure Exim to use it cause run time configuration
2921 errors.
2922 </para>
2923 <para>
2924 <indexterm role="concept">
2925 <primary>pkg-config</primary>
2926 <secondary>lookups</secondary>
2927 </indexterm>
2928 <indexterm role="concept">
2929 <primary>pkg-config</primary>
2930 <secondary>authenticators</secondary>
2931 </indexterm>
2932 Many systems now use a tool called <emphasis>pkg-config</emphasis> to encapsulate information
2933 about how to compile against a library; Exim has some initial support for
2934 being able to use pkg-config for lookups and authenticators.  For any given
2935 makefile variable which starts <literal>LOOKUP_</literal> or <literal>AUTH_</literal>, you can add a new
2936 variable with the <literal>_PC</literal> suffix in the name and assign as the value the
2937 name of the package to be queried.  The results of querying via the
2938 <emphasis>pkg-config</emphasis> command will be added to the appropriate Makefile variables
2939 with <literal>+=</literal> directives, so your version of <emphasis>make</emphasis> will need to support that
2940 syntax.  For instance:
2941 </para>
2942 <literallayout class="monospaced">
2943 LOOKUP_SQLITE=yes
2944 LOOKUP_SQLITE_PC=sqlite3
2945 AUTH_GSASL=yes
2946 AUTH_GSASL_PC=libgsasl
2947 AUTH_HEIMDAL_GSSAPI=yes
2948 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2949 </literallayout>
2950 <para>
2951 <indexterm role="concept">
2952 <primary>Perl</primary>
2953 <secondary>including support for</secondary>
2954 </indexterm>
2955 Exim can be linked with an embedded Perl interpreter, allowing Perl
2956 subroutines to be called during string expansion. To enable this facility,
2957 </para>
2958 <literallayout class="monospaced">
2959 EXIM_PERL=perl.o
2960 </literallayout>
2961 <para>
2962 must be defined in <filename>Local/Makefile</filename>. Details of this facility are given in
2963 chapter <xref linkend="CHAPperl"/>.
2964 </para>
2965 <para>
2966 <indexterm role="concept">
2967 <primary>X11 libraries, location of</primary>
2968 </indexterm>
2969 The location of the X11 libraries is something that varies a lot between
2970 operating systems, and there may be different versions of X11 to cope
2971 with. Exim itself makes no use of X11, but if you are compiling the Exim
2972 monitor, the X11 libraries must be available.
2973 The following three variables are set in <filename>OS/Makefile-Default</filename>:
2974 </para>
2975 <literallayout class="monospaced">
2976 X11=/usr/X11R6
2977 XINCLUDE=-I$(X11)/include
2978 XLFLAGS=-L$(X11)/lib
2979 </literallayout>
2980 <para>
2981 These are overridden in some of the operating-system configuration files. For
2982 example, in <filename>OS/Makefile-SunOS5</filename> there is
2983 </para>
2984 <literallayout class="monospaced">
2985 X11=/usr/openwin
2986 XINCLUDE=-I$(X11)/include
2987 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2988 </literallayout>
2989 <para>
2990 If you need to override the default setting for your operating system, place a
2991 definition of all three of these variables into your
2992 <filename>Local/Makefile-&lt;ostype&gt;</filename> file.
2993 </para>
2994 <para>
2995 <indexterm role="concept">
2996 <primary>EXTRALIBS</primary>
2997 </indexterm>
2998 If you need to add any extra libraries to the link steps, these can be put in a
2999 variable called EXTRALIBS, which appears in all the link commands, but by
3000 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
3001 command for linking the main Exim binary, and not for any associated utilities.
3002 </para>
3003 <para>
3004 <indexterm role="concept">
3005 <primary>DBM libraries</primary>
3006 <secondary>configuration for building</secondary>
3007 </indexterm>
3008 There is also DBMLIB, which appears in the link commands for binaries that
3009 use DBM functions (see also section <xref linkend="SECTdb"/>). Finally, there is
3010 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
3011 binary, and which can be used, for example, to include additional X11
3012 libraries.
3013 </para>
3014 <para>
3015 <indexterm role="concept">
3016 <primary>configuration file</primary>
3017 <secondary>editing</secondary>
3018 </indexterm>
3019 The make file copes with rebuilding Exim correctly if any of the configuration
3020 files are edited. However, if an optional configuration file is deleted, it is
3021 necessary to touch the associated non-optional file (that is,
3022 <filename>Local/Makefile</filename> or <filename>Local/eximon.conf</filename>) before rebuilding.
3023 </para>
3024 </section>
3025 <section id="SECID30">
3026 <title>OS-specific header files</title>
3027 <para>
3028 <indexterm role="concept">
3029 <primary><filename>os.h</filename></primary>
3030 </indexterm>
3031 <indexterm role="concept">
3032 <primary>building Exim</primary>
3033 <secondary>OS-specific C header files</secondary>
3034 </indexterm>
3035 The <filename>OS</filename> directory contains a number of files with names of the form
3036 <filename>os.h-&lt;ostype&gt;</filename>. These are system-specific C header files that should not
3037 normally need to be changed. There is a list of macro settings that are
3038 recognized in the file <filename>OS/os.configuring</filename>, which should be consulted if you
3039 are porting Exim to a new operating system.
3040 </para>
3041 </section>
3042 <section id="SECID31">
3043 <title>Overriding build-time options for the monitor</title>
3044 <para>
3045 <indexterm role="concept">
3046 <primary>building Eximon</primary>
3047 </indexterm>
3048 A similar process is used for overriding things when building the Exim monitor,
3049 where the files that are involved are
3050 </para>
3051 <literallayout>
3052 <filename>OS/eximon.conf-Default</filename>
3053 <filename>OS/eximon.conf-</filename>&lt;<emphasis>ostype</emphasis>&gt;
3054 <filename>Local/eximon.conf</filename>
3055 <filename>Local/eximon.conf-</filename>&lt;<emphasis>ostype</emphasis>&gt;
3056 <filename>Local/eximon.conf-</filename>&lt;<emphasis>archtype</emphasis>&gt;
3057 <filename>Local/eximon.conf-</filename>&lt;<emphasis>ostype</emphasis>&gt;-&lt;<emphasis>archtype</emphasis>&gt;
3058 </literallayout>
3059 <para>
3060 <indexterm role="concept">
3061 <primary><filename>Local/eximon.conf</filename></primary>
3062 </indexterm>
3063 As with Exim itself, the final three files need not exist, and in this case the
3064 <filename>OS/eximon.conf-&lt;ostype&gt;</filename> file is also optional. The default values in
3065 <filename>OS/eximon.conf-Default</filename> can be overridden dynamically by setting environment
3066 variables of the same name, preceded by EXIMON_. For example, setting
3067 EXIMON_LOG_DEPTH in the environment overrides the value of
3068 LOG_DEPTH at run time.
3069 <indexterm role="concept" startref="IIDbuex" class="endofrange"/>
3070 </para>
3071 </section>
3072 <section id="SECID32">
3073 <title>Installing Exim binaries and scripts</title>
3074 <para>
3075 <indexterm role="concept">
3076 <primary>installing Exim</primary>
3077 </indexterm>
3078 <indexterm role="concept">
3079 <primary>BIN_DIRECTORY</primary>
3080 </indexterm>
3081 The command <literal>make install</literal> runs the <command>exim_install</command> script with no
3082 arguments. The script copies binaries and utility scripts into the directory
3083 whose name is specified by the BIN_DIRECTORY setting in <filename>Local/Makefile</filename>.
3084 <indexterm role="concept">
3085 <primary>setuid</primary>
3086 <secondary>installing Exim with</secondary>
3087 </indexterm>
3088 The install script copies files only if they are newer than the files they are
3089 going to replace. The Exim binary is required to be owned by root and have the
3090 <emphasis>setuid</emphasis> bit set, for normal configurations. Therefore, you must run <literal>make
3091 install</literal> as root so that it can set up the Exim binary in this way. However, in
3092 some special situations (for example, if a host is doing no local deliveries)
3093 it may be possible to run Exim without making the binary setuid root (see
3094 chapter <xref linkend="CHAPsecurity"/> for details).
3095 </para>
3096 <para>
3097 <indexterm role="concept">
3098 <primary>CONFIGURE_FILE</primary>
3099 </indexterm>
3100 Exim&#x2019;s run time configuration file is named by the CONFIGURE_FILE setting
3101 in <filename>Local/Makefile</filename>. If this names a single file, and the file does not
3102 exist, the default configuration file <filename>src/configure.default</filename> is copied there
3103 by the installation script. If a run time configuration file already exists, it
3104 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
3105 alternative files, no default is installed.
3106 </para>
3107 <para>
3108 <indexterm role="concept">
3109 <primary>system aliases file</primary>
3110 </indexterm>
3111 <indexterm role="concept">
3112 <primary><filename>/etc/aliases</filename></primary>
3113 </indexterm>
3114 One change is made to the default configuration file when it is installed: the
3115 default configuration contains a router that references a system aliases file.
3116 The path to this file is set to the value specified by
3117 SYSTEM_ALIASES_FILE in <filename>Local/Makefile</filename> (<filename>/etc/aliases</filename> by default).
3118 If the system aliases file does not exist, the installation script creates it,
3119 and outputs a comment to the user.
3120 </para>
3121 <para>
3122 The created file contains no aliases, but it does contain comments about the
3123 aliases a site should normally have. Mail aliases have traditionally been
3124 kept in <filename>/etc/aliases</filename>. However, some operating systems are now using
3125 <filename>/etc/mail/aliases</filename>. You should check if yours is one of these, and change
3126 Exim&#x2019;s configuration if necessary.
3127 </para>
3128 <para>
3129 The default configuration uses the local host&#x2019;s name as the only local domain,
3130 and is set up to do local deliveries into the shared directory <filename>/var/mail</filename>,
3131 running as the local user. System aliases and <filename>.forward</filename> files in users&#x2019; home
3132 directories are supported, but no NIS or NIS+ support is configured. Domains
3133 other than the name of the local host are routed using the DNS, with delivery
3134 over SMTP.
3135 </para>
3136 <para>
3137 It is possible to install Exim for special purposes (such as building a binary
3138 distribution) in a private part of the file system. You can do this by a
3139 command such as
3140 </para>
3141 <literallayout class="monospaced">
3142 make DESTDIR=/some/directory/ install
3143 </literallayout>
3144 <para>
3145 This has the effect of pre-pending the specified directory to all the file
3146 paths, except the name of the system aliases file that appears in the default
3147 configuration. (If a default alias file is created, its name <emphasis>is</emphasis> modified.)
3148 For backwards compatibility, ROOT is used if DESTDIR is not set,
3149 but this usage is deprecated.
3150 </para>
3151 <para>
3152 <indexterm role="concept">
3153 <primary>installing Exim</primary>
3154 <secondary>what is not installed</secondary>
3155 </indexterm>
3156 Running <emphasis>make install</emphasis> does not copy the Exim 4 conversion script
3157 <emphasis>convert4r4</emphasis>. You will probably run this only once if you are
3158 upgrading from Exim 3. None of the documentation files in the <filename>doc</filename>
3159 directory are copied, except for the info files when you have set
3160 INFO_DIRECTORY, as described in section <xref linkend="SECTinsinfdoc"/> below.
3161 </para>
3162 <para>
3163 For the utility programs, old versions are renamed by adding the suffix <filename>.O</filename>
3164 to their names. The Exim binary itself, however, is handled differently. It is
3165 installed under a name that includes the version number and the compile number,
3166 for example <filename>exim-4.83-1</filename>. The script then arranges for a symbolic link
3167 called <filename>exim</filename> to point to the binary. If you are updating a previous version
3168 of Exim, the script takes care to ensure that the name <filename>exim</filename> is never absent
3169 from the directory (as seen by other processes).
3170 </para>
3171 <para>
3172 <indexterm role="concept">
3173 <primary>installing Exim</primary>
3174 <secondary>testing the script</secondary>
3175 </indexterm>
3176 If you want to see what the <emphasis>make install</emphasis> will do before running it for
3177 real, you can pass the <option>-n</option> option to the installation script by this
3178 command:
3179 </para>
3180 <literallayout class="monospaced">
3181 make INSTALL_ARG=-n install
3182 </literallayout>
3183 <para>
3184 The contents of the variable INSTALL_ARG are passed to the installation
3185 script. You do not need to be root to run this test. Alternatively, you can run
3186 the installation script directly, but this must be from within the build
3187 directory. For example, from the top-level Exim directory you could use this
3188 command:
3189 </para>
3190 <literallayout class="monospaced">
3191 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
3192 </literallayout>
3193 <para>
3194 <indexterm role="concept">
3195 <primary>installing Exim</primary>
3196 <secondary>install script options</secondary>
3197 </indexterm>
3198 There are two other options that can be supplied to the installation script.
3199 </para>
3200 <itemizedlist>
3201 <listitem>
3202 <para>
3203 <option>-no_chown</option> bypasses the call to change the owner of the installed binary
3204 to root, and the call to make it a setuid binary.
3205 </para>
3206 </listitem>
3207 <listitem>
3208 <para>
3209 <option>-no_symlink</option> bypasses the setting up of the symbolic link <filename>exim</filename> to the
3210 installed binary.
3211 </para>
3212 </listitem>
3213 </itemizedlist>
3214 <para>
3215 INSTALL_ARG can be used to pass these options to the script. For example:
3216 </para>
3217 <literallayout class="monospaced">
3218 make INSTALL_ARG=-no_symlink install
3219 </literallayout>
3220 <para>
3221 The installation script can also be given arguments specifying which files are
3222 to be copied. For example, to install just the Exim binary, and nothing else,
3223 without creating the symbolic link, you could use:
3224 </para>
3225 <literallayout class="monospaced">
3226 make INSTALL_ARG='-no_symlink exim' install
3227 </literallayout>
3228 </section>
3229 <section id="SECTinsinfdoc">
3230 <title>Installing info documentation</title>
3231 <para>
3232 <indexterm role="concept">
3233 <primary>installing Exim</primary>
3234 <secondary><emphasis>info</emphasis> documentation</secondary>
3235 </indexterm>
3236 Not all systems use the GNU <emphasis>info</emphasis> system for documentation, and for this
3237 reason, the Texinfo source of Exim&#x2019;s documentation is not included in the main
3238 distribution. Instead it is available separately from the ftp site (see section
3239 <xref linkend="SECTavail"/>).
3240 </para>
3241 <para>
3242 If you have defined INFO_DIRECTORY in <filename>Local/Makefile</filename> and the Texinfo
3243 source of the documentation is found in the source tree, running <literal>make
3244 install</literal> automatically builds the info files and installs them.
3245 </para>
3246 </section>
3247 <section id="SECID33">
3248 <title>Setting up the spool directory</title>
3249 <para>
3250 <indexterm role="concept">
3251 <primary>spool directory</primary>
3252 <secondary>creating</secondary>
3253 </indexterm>
3254 When it starts up, Exim tries to create its spool directory if it does not
3255 exist. The Exim uid and gid are used for the owner and group of the spool
3256 directory. Sub-directories are automatically created in the spool directory as
3257 necessary.
3258 </para>
3259 </section>
3260 <section id="SECID34">
3261 <title>Testing</title>
3262 <para>
3263 <indexterm role="concept">
3264 <primary>testing</primary>
3265 <secondary>installation</secondary>
3266 </indexterm>
3267 Having installed Exim, you can check that the run time configuration file is
3268 syntactically valid by running the following command, which assumes that the
3269 Exim binary directory is within your PATH environment variable:
3270 </para>
3271 <literallayout class="monospaced">
3272 exim -bV
3273 </literallayout>
3274 <para>
3275 If there are any errors in the configuration file, Exim outputs error messages.
3276 Otherwise it outputs the version number and build date,
3277 the DBM library that is being used, and information about which drivers and
3278 other optional code modules are included in the binary.
3279 Some simple routing tests can be done by using the address testing option. For
3280 example,
3281 </para>
3282 <literallayout>
3283 <literal>exim -bt</literal> &lt;<emphasis>local username</emphasis>&gt;
3284 </literallayout>
3285 <para>
3286 should verify that it recognizes a local mailbox, and
3287 </para>
3288 <literallayout>
3289 <literal>exim -bt</literal> &lt;<emphasis>remote address</emphasis>&gt;
3290 </literallayout>
3291 <para>
3292 a remote one. Then try getting it to deliver mail, both locally and remotely.
3293 This can be done by passing messages directly to Exim, without going through a
3294 user agent. For example:
3295 </para>
3296 <literallayout class="monospaced">
3297 exim -v postmaster@your.domain.example
3298 From: user@your.domain.example
3299 To: postmaster@your.domain.example
3300 Subject: Testing Exim
3301
3302 This is a test message.
3303 ^D
3304 </literallayout>
3305 <para>
3306 The <option>-v</option> option causes Exim to output some verification of what it is doing.
3307 In this case you should see copies of three log lines, one for the message&#x2019;s
3308 arrival, one for its delivery, and one containing <quote>Completed</quote>.
3309 </para>
3310 <para>
3311 <indexterm role="concept">
3312 <primary>delivery</primary>
3313 <secondary>problems with</secondary>
3314 </indexterm>
3315 If you encounter problems, look at Exim&#x2019;s log files (<emphasis>mainlog</emphasis> and
3316 <emphasis>paniclog</emphasis>) to see if there is any relevant information there. Another source
3317 of information is running Exim with debugging turned on, by specifying the
3318 <option>-d</option> option. If a message is stuck on Exim&#x2019;s spool, you can force a delivery
3319 with debugging turned on by a command of the form
3320 </para>
3321 <literallayout>
3322 <literal>exim -d -M</literal> &lt;<emphasis>exim-message-id</emphasis>&gt;
3323 </literallayout>
3324 <para>
3325 You must be root or an <quote>admin user</quote> in order to do this. The <option>-d</option> option
3326 produces rather a lot of output, but you can cut this down to specific areas.
3327 For example, if you use <option>-d-all+route</option> only the debugging information
3328 relevant to routing is included. (See the <option>-d</option> option in chapter
3329 <xref linkend="CHAPcommandline"/> for more details.)
3330 </para>
3331 <para>
3332 <indexterm role="concept">
3333 <primary><quote>sticky</quote> bit</primary>
3334 </indexterm>
3335 <indexterm role="concept">
3336 <primary>lock files</primary>
3337 </indexterm>
3338 One specific problem that has shown up on some sites is the inability to do
3339 local deliveries into a shared mailbox directory, because it does not have the
3340 <quote>sticky bit</quote> set on it. By default, Exim tries to create a lock file before
3341 writing to a mailbox file, and if it cannot create the lock file, the delivery
3342 is deferred. You can get round this either by setting the <quote>sticky bit</quote> on the
3343 directory, or by setting a specific group for local deliveries and allowing
3344 that group to create files in the directory (see the comments above the
3345 <command>local_delivery</command> transport in the default configuration file). Another
3346 approach is to configure Exim not to use lock files, but just to rely on
3347 <function>fcntl()</function> locking instead. However, you should do this only if all user
3348 agents also use <function>fcntl()</function> locking. For further discussion of locking issues,
3349 see chapter <xref linkend="CHAPappendfile"/>.
3350 </para>
3351 <para>
3352 One thing that cannot be tested on a system that is already running an MTA is
3353 the receipt of incoming SMTP mail on the standard SMTP port. However, the
3354 <option>-oX</option> option can be used to run an Exim daemon that listens on some other
3355 port, or <emphasis>inetd</emphasis> can be used to do this. The <option>-bh</option> option and the
3356 <emphasis>exim_checkaccess</emphasis> utility can be used to check out policy controls on
3357 incoming SMTP mail.
3358 </para>
3359 <para>
3360 Testing a new version on a system that is already running Exim can most easily
3361 be done by building a binary with a different CONFIGURE_FILE setting. From
3362 within the run time configuration, all other file and directory names
3363 that Exim uses can be altered, in order to keep it entirely clear of the
3364 production version.
3365 </para>
3366 </section>
3367 <section id="SECID35">
3368 <title>Replacing another MTA with Exim</title>
3369 <para>
3370 <indexterm role="concept">
3371 <primary>replacing another MTA</primary>
3372 </indexterm>
3373 Building and installing Exim for the first time does not of itself put it in
3374 general use. The name by which the system&#x2019;s MTA is called by mail user agents
3375 is either <filename>/usr/sbin/sendmail</filename>, or <filename>/usr/lib/sendmail</filename> (depending on the
3376 operating system), and it is necessary to make this name point to the <emphasis>exim</emphasis>
3377 binary in order to get the user agents to pass messages to Exim. This is
3378 normally done by renaming any existing file and making <filename>/usr/sbin/sendmail</filename>
3379 or <filename>/usr/lib/sendmail</filename>
3380 <indexterm role="concept">
3381 <primary>symbolic link</primary>
3382 <secondary>to <emphasis>exim</emphasis> binary</secondary>
3383 </indexterm>
3384 a symbolic link to the <emphasis>exim</emphasis> binary. It is a good idea to remove any setuid
3385 privilege and executable status from the old MTA. It is then necessary to stop
3386 and restart the mailer daemon, if one is running.
3387 </para>
3388 <para>
3389 <indexterm role="concept">
3390 <primary>FreeBSD, MTA indirection</primary>
3391 </indexterm>
3392 <indexterm role="concept">
3393 <primary><filename>/etc/mail/mailer.conf</filename></primary>
3394 </indexterm>
3395 Some operating systems have introduced alternative ways of switching MTAs. For
3396 example, if you are running FreeBSD, you need to edit the file
3397 <filename>/etc/mail/mailer.conf</filename> instead of setting up a symbolic link as just
3398 described. A typical example of the contents of this file for running Exim is
3399 as follows:
3400 </para>
3401 <literallayout class="monospaced">
3402 sendmail            /usr/exim/bin/exim
3403 send-mail           /usr/exim/bin/exim
3404 mailq               /usr/exim/bin/exim -bp
3405 newaliases          /usr/bin/true
3406 </literallayout>
3407 <para>
3408 Once you have set up the symbolic link, or edited <filename>/etc/mail/mailer.conf</filename>,
3409 your Exim installation is <quote>live</quote>. Check it by sending a message from your
3410 favourite user agent.
3411 </para>
3412 <para>
3413 You should consider what to tell your users about the change of MTA. Exim may
3414 have different capabilities to what was previously running, and there are
3415 various operational differences such as the text of messages produced by
3416 command line options and in bounce messages. If you allow your users to make
3417 use of Exim&#x2019;s filtering capabilities, you should make the document entitled
3418 <emphasis>Exim&#x2019;s interface to mail filtering</emphasis> available to them.
3419 </para>
3420 </section>
3421 <section id="SECID36">
3422 <title>Upgrading Exim</title>
3423 <para>
3424 <indexterm role="concept">
3425 <primary>upgrading Exim</primary>
3426 </indexterm>
3427 If you are already running Exim on your host, building and installing a new
3428 version automatically makes it available to MUAs, or any other programs that
3429 call the MTA directly. However, if you are running an Exim daemon, you do need
3430 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
3431 new binary. You do not need to stop processing mail in order to install a new
3432 version of Exim. The install script does not modify an existing runtime
3433 configuration file.
3434 </para>
3435 </section>
3436 <section id="SECID37">
3437 <title>Stopping the Exim daemon on Solaris</title>
3438 <para>
3439 <indexterm role="concept">
3440 <primary>Solaris</primary>
3441 <secondary>stopping Exim on</secondary>
3442 </indexterm>
3443 The standard command for stopping the mailer daemon on Solaris is
3444 </para>
3445 <literallayout class="monospaced">
3446 /etc/init.d/sendmail stop
3447 </literallayout>
3448 <para>
3449 If <filename>/usr/lib/sendmail</filename> has been turned into a symbolic link, this script
3450 fails to stop Exim because it uses the command <emphasis>ps -e</emphasis> and greps the output
3451 for the text <quote>sendmail</quote>; this is not present because the actual program name
3452 (that is, <quote>exim</quote>) is given by the <emphasis>ps</emphasis> command with these options. A
3453 solution is to replace the line that finds the process id with something like
3454 </para>
3455 <literallayout class="monospaced">
3456 pid=`cat /var/spool/exim/exim-daemon.pid`
3457 </literallayout>
3458 <para>
3459 to obtain the daemon&#x2019;s pid directly from the file that Exim saves it in.
3460 </para>
3461 <para>
3462 Note, however, that stopping the daemon does not <quote>stop Exim</quote>. Messages can
3463 still be received from local processes, and if automatic delivery is configured
3464 (the normal case), deliveries will still occur.
3465 </para>
3466 </section>
3467 </chapter>
3468
3469 <chapter id="CHAPcommandline">
3470 <title>The Exim command line</title>
3471 <para>
3472 <indexterm role="concept" id="IIDclo1" class="startofrange">
3473 <primary>command line</primary>
3474 <secondary>options</secondary>
3475 </indexterm>
3476 <indexterm role="concept" id="IIDclo2" class="startofrange">
3477 <primary>options</primary>
3478 <secondary>command line</secondary>
3479 </indexterm>
3480 Exim&#x2019;s command line takes the standard Unix form of a sequence of options,
3481 each starting with a hyphen character, followed by a number of arguments. The
3482 options are compatible with the main options of Sendmail, and there are also
3483 some additional options, some of which are compatible with Smail 3. Certain
3484 combinations of options do not make sense, and provoke an error if used.
3485 The form of the arguments depends on which options are set.
3486 </para>
3487 <section id="SECID38">
3488 <title>Setting options by program name</title>
3489 <para>
3490 <indexterm role="concept">
3491 <primary><emphasis>mailq</emphasis></primary>
3492 </indexterm>
3493 If Exim is called under the name <emphasis>mailq</emphasis>, it behaves as if the option <option>-bp</option>
3494 were present before any other options.
3495 The <option>-bp</option> option requests a listing of the contents of the mail queue on the
3496 standard output.
3497 This feature is for compatibility with some systems that contain a command of
3498 that name in one of the standard libraries, symbolically linked to
3499 <filename>/usr/sbin/sendmail</filename> or <filename>/usr/lib/sendmail</filename>.
3500 </para>
3501 <para>
3502 <indexterm role="concept">
3503 <primary><emphasis>rsmtp</emphasis></primary>
3504 </indexterm>
3505 If Exim is called under the name <emphasis>rsmtp</emphasis> it behaves as if the option <option>-bS</option>
3506 were present before any other options, for compatibility with Smail. The
3507 <option>-bS</option> option is used for reading in a number of messages in batched SMTP
3508 format.
3509 </para>
3510 <para>
3511 <indexterm role="concept">
3512 <primary><emphasis>rmail</emphasis></primary>
3513 </indexterm>
3514 If Exim is called under the name <emphasis>rmail</emphasis> it behaves as if the <option>-i</option> and
3515 <option>-oee</option> options were present before any other options, for compatibility with
3516 Smail. The name <emphasis>rmail</emphasis> is used as an interface by some UUCP systems.
3517 </para>
3518 <para>
3519 <indexterm role="concept">
3520 <primary><emphasis>runq</emphasis></primary>
3521 </indexterm>
3522 <indexterm role="concept">
3523 <primary>queue runner</primary>
3524 </indexterm>
3525 If Exim is called under the name <emphasis>runq</emphasis> it behaves as if the option <option>-q</option>
3526 were present before any other options, for compatibility with Smail. The <option>-q</option>
3527 option causes a single queue runner process to be started.
3528 </para>
3529 <para>
3530 <indexterm role="concept">
3531 <primary><emphasis>newaliases</emphasis></primary>
3532 </indexterm>
3533 <indexterm role="concept">
3534 <primary>alias file</primary>
3535 <secondary>building</secondary>
3536 </indexterm>
3537 <indexterm role="concept">
3538 <primary>Sendmail compatibility</primary>
3539 <secondary>calling Exim as <emphasis>newaliases</emphasis></secondary>
3540 </indexterm>
3541 If Exim is called under the name <emphasis>newaliases</emphasis> it behaves as if the option
3542 <option>-bi</option> were present before any other options, for compatibility with Sendmail.
3543 This option is used for rebuilding Sendmail&#x2019;s alias file. Exim does not have
3544 the concept of a single alias file, but can be configured to run a given
3545 command if called with the <option>-bi</option> option.
3546 </para>
3547 </section>
3548 <section id="SECTtrustedadmin">
3549 <title>Trusted and admin users</title>
3550 <para>
3551 Some Exim options are available only to <emphasis>trusted users</emphasis> and others are
3552 available only to <emphasis>admin users</emphasis>. In the description below, the phrases <quote>Exim
3553 user</quote> and <quote>Exim group</quote> mean the user and group defined by EXIM_USER and
3554 EXIM_GROUP in <filename>Local/Makefile</filename> or set by the <option>exim_user</option> and
3555 <option>exim_group</option> options. These do not necessarily have to use the name <quote>exim</quote>.
3556 </para>
3557 <itemizedlist>
3558 <listitem>
3559 <para>
3560 <indexterm role="concept">
3561 <primary>trusted users</primary>
3562 <secondary>definition of</secondary>
3563 </indexterm>
3564 <indexterm role="concept">
3565 <primary>user</primary>
3566 <secondary>trusted definition of</secondary>
3567 </indexterm>
3568 The trusted users are root, the Exim user, any user listed in the
3569 <option>trusted_users</option> configuration option, and any user whose current group or any
3570 supplementary group is one of those listed in the <option>trusted_groups</option>
3571 configuration option. Note that the Exim group is not automatically trusted.
3572 </para>
3573 <para>
3574 <indexterm role="concept">
3575 <primary><quote>From</quote> line</primary>
3576 </indexterm>
3577 <indexterm role="concept">
3578 <primary>envelope sender</primary>
3579 </indexterm>
3580 Trusted users are always permitted to use the <option>-f</option> option or a leading
3581 <quote>From&nbsp;</quote> line to specify the envelope sender of a message that is passed to
3582 Exim through the local interface (see the <option>-bm</option> and <option>-f</option> options below).
3583 See the <option>untrusted_set_sender</option> option for a way of permitting non-trusted
3584 users to set envelope senders.
3585 </para>
3586 <para>
3587 <indexterm role="concept">
3588 <primary><emphasis>From:</emphasis> header line</primary>
3589 </indexterm>
3590 <indexterm role="concept">
3591 <primary><emphasis>Sender:</emphasis> header line</primary>
3592 </indexterm>
3593 For a trusted user, there is never any check on the contents of the <emphasis>From:</emphasis>
3594 header line, and a <emphasis>Sender:</emphasis> line is never added. Furthermore, any existing
3595 <emphasis>Sender:</emphasis> line in incoming local (non-TCP/IP) messages is not removed.
3596 </para>
3597 <para>
3598 Trusted users may also specify a host name, host address, interface address,
3599 protocol name, ident value, and authentication data when submitting a message
3600 locally. Thus, they are able to insert messages into Exim&#x2019;s queue locally that
3601 have the characteristics of messages received from a remote host. Untrusted
3602 users may in some circumstances use <option>-f</option>, but can never set the other values
3603 that are available to trusted users.
3604 </para>
3605 </listitem>
3606 <listitem>
3607 <para>
3608 <indexterm role="concept">
3609 <primary>user</primary>
3610 <secondary>admin definition of</secondary>
3611 </indexterm>
3612 <indexterm role="concept">
3613 <primary>admin user</primary>
3614 <secondary>definition of</secondary>
3615 </indexterm>
3616 The admin users are root, the Exim user, and any user that is a member of the
3617 Exim group or of any group listed in the <option>admin_groups</option> configuration option.
3618 The current group does not have to be one of these groups.
3619 </para>
3620 <para>
3621 Admin users are permitted to list the queue, and to carry out certain
3622 operations on messages, for example, to force delivery failures. It is also
3623 necessary to be an admin user in order to see the full information provided by
3624 the Exim monitor, and full debugging output.
3625 </para>
3626 <para>
3627 By default, the use of the <option>-M</option>, <option>-q</option>, <option>-R</option>, and <option>-S</option> options to cause
3628 Exim to attempt delivery of messages on its queue is restricted to admin users.
3629 However, this restriction can be relaxed by setting the <option>prod_requires_admin</option>
3630 option false (that is, specifying <option>no_prod_requires_admin</option>).
3631 </para>
3632 <para>
3633 Similarly, the use of the <option>-bp</option> option to list all the messages in the queue
3634 is restricted to admin users unless <option>queue_list_requires_admin</option> is set
3635 false.
3636 </para>
3637 </listitem>
3638 </itemizedlist>
3639 <para>
3640 <emphasis role="bold">Warning</emphasis>: If you configure your system so that admin users are able to
3641 edit Exim&#x2019;s configuration file, you are giving those users an easy way of
3642 getting root. There is further discussion of this issue at the start of chapter
3643 <xref linkend="CHAPconf"/>.
3644 </para>
3645 </section>
3646 <section id="SECID39">
3647 <title>Command line options</title>
3648 <para>
3649 Exim&#x2019;s command line options are described in alphabetical order below. If none
3650 of the options that specifies a specific action (such as starting the daemon or
3651 a queue runner, or testing an address, or receiving a message in a specific
3652 format, or listing the queue) are present, and there is at least one argument
3653 on the command line, <option>-bm</option> (accept a local message on the standard input,
3654 with the arguments specifying the recipients) is assumed. Otherwise, Exim
3655 outputs a brief message about itself and exits.
3656 </para>
3657 <!-- === Start of command line options === -->
3658 <variablelist>
3659 <varlistentry>
3660 <term><option>--</option></term>
3661 <listitem>
3662 <para>
3663 <indexterm role="option">
3664 <primary>--</primary>
3665 </indexterm>
3666 <indexterm role="concept">
3667 <primary>options</primary>
3668 <secondary>command line; terminating</secondary>
3669 </indexterm>
3670 This is a pseudo-option whose only purpose is to terminate the options and
3671 therefore to cause subsequent command line items to be treated as arguments
3672 rather than options, even if they begin with hyphens.
3673 </para>
3674 </listitem></varlistentry>
3675 <varlistentry>
3676 <term><option>--help</option></term>
3677 <listitem>
3678 <para>
3679 <indexterm role="option">
3680 <primary><option>--help</option></primary>
3681 </indexterm>
3682 This option causes Exim to output a few sentences stating what it is.
3683 The same output is generated if the Exim binary is called with no options and
3684 no arguments.
3685 </para>
3686 </listitem></varlistentry>
3687 <varlistentry>
3688 <term><option>--version</option></term>
3689 <listitem>
3690 <para>
3691 <indexterm role="option">
3692 <primary><option>--version</option></primary>
3693 </indexterm>
3694 This option is an alias for <option>-bV</option> and causes version information to be
3695 displayed.
3696 </para>
3697 </listitem></varlistentry>
3698 <varlistentry>
3699 <term><option>-Ac</option></term>
3700 <term><option>-Am</option></term>
3701 <listitem>
3702 <para>
3703 <indexterm role="option">
3704 <primary><option>-Ac</option></primary>
3705 </indexterm>
3706 <indexterm role="option">
3707 <primary><option>-Am</option></primary>
3708 </indexterm>
3709 These options are used by Sendmail for selecting configuration files and are
3710 ignored by Exim.
3711 </para>
3712 </listitem></varlistentry>
3713 <varlistentry>
3714 <term><option>-B</option>&lt;<emphasis>type</emphasis>&gt;</term>
3715 <listitem>
3716 <para>
3717 <indexterm role="option">
3718 <primary><option>-B</option></primary>
3719 </indexterm>
3720 <indexterm role="concept">
3721 <primary>8-bit characters</primary>
3722 </indexterm>
3723 <indexterm role="concept">
3724 <primary>Sendmail compatibility</primary>
3725 <secondary>8-bit characters</secondary>
3726 </indexterm>
3727 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
3728 clean; it ignores this option.
3729 </para>
3730 </listitem></varlistentry>
3731 <varlistentry>
3732 <term><option>-bd</option></term>
3733 <listitem>
3734 <para>
3735 <indexterm role="option">
3736 <primary><option>-bd</option></primary>
3737 </indexterm>
3738 <indexterm role="concept">
3739 <primary>daemon</primary>
3740 </indexterm>
3741 <indexterm role="concept">
3742 <primary>SMTP</primary>
3743 <secondary>listener</secondary>
3744 </indexterm>
3745 <indexterm role="concept">
3746 <primary>queue runner</primary>
3747 </indexterm>
3748 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
3749 the <option>-bd</option> option is combined with the <option>-q</option>&lt;<emphasis>time</emphasis>&gt; option, to specify
3750 that the daemon should also initiate periodic queue runs.
3751 </para>
3752 <para>
3753 The <option>-bd</option> option can be used only by an admin user. If either of the <option>-d</option>
3754 (debugging) or <option>-v</option> (verifying) options are set, the daemon does not
3755 disconnect from the controlling terminal. When running this way, it can be
3756 stopped by pressing ctrl-C.
3757 </para>
3758 <para>
3759 By default, Exim listens for incoming connections to the standard SMTP port on
3760 all the host&#x2019;s running interfaces. However, it is possible to listen on other
3761 ports, on multiple ports, and only on specific interfaces. Chapter
3762 <xref linkend="CHAPinterfaces"/> contains a description of the options that control this.
3763 </para>
3764 <para>
3765 When a listening daemon
3766 <indexterm role="concept">
3767 <primary>daemon</primary>
3768 <secondary>process id (pid)</secondary>
3769 </indexterm>
3770 <indexterm role="concept">
3771 <primary>pid (process id)</primary>
3772 <secondary>of daemon</secondary>
3773 </indexterm>
3774 is started without the use of <option>-oX</option> (that is, without overriding the normal
3775 configuration), it writes its process id to a file called <filename>exim-daemon.pid</filename>
3776 in Exim&#x2019;s spool directory. This location can be overridden by setting
3777 PID_FILE_PATH in <filename>Local/Makefile</filename>. The file is written while Exim is still
3778 running as root.
3779 </para>
3780 <para>
3781 When <option>-oX</option> is used on the command line to start a listening daemon, the
3782 process id is not written to the normal pid file path. However, <option>-oP</option> can be
3783 used to specify a path on the command line if a pid file is required.
3784 </para>
3785 <para>
3786 The SIGHUP signal
3787 <indexterm role="concept">
3788 <primary>SIGHUP</primary>
3789 </indexterm>
3790 <indexterm role="concept">
3791 <primary>daemon</primary>
3792 <secondary>restarting</secondary>
3793 </indexterm>
3794 can be used to cause the daemon to re-execute itself. This should be done
3795 whenever Exim&#x2019;s configuration file, or any file that is incorporated into it by
3796 means of the <option>.include</option> facility, is changed, and also whenever a new version
3797 of Exim is installed. It is not necessary to do this when other files that are
3798 referenced from the configuration (for example, alias files) are changed,
3799 because these are reread each time they are used.
3800 </para>
3801 </listitem></varlistentry>
3802 <varlistentry>
3803 <term><option>-bdf</option></term>
3804 <listitem>
3805 <para>
3806 <indexterm role="option">
3807 <primary><option>-bdf</option></primary>
3808 </indexterm>
3809 This option has the same effect as <option>-bd</option> except that it never disconnects
3810 from the controlling terminal, even when no debugging is specified.
3811 </para>
3812 </listitem></varlistentry>
3813 <varlistentry>
3814 <term><option>-be</option></term>
3815 <listitem>
3816 <para>
3817 <indexterm role="option">
3818 <primary><option>-be</option></primary>
3819 </indexterm>
3820 <indexterm role="concept">
3821 <primary>testing</primary>
3822 <secondary>string expansion</secondary>
3823 </indexterm>
3824 <indexterm role="concept">
3825 <primary>expansion</primary>
3826 <secondary>testing</secondary>
3827 </indexterm>
3828 Run Exim in expansion testing mode. Exim discards its root privilege, to
3829 prevent ordinary users from using this mode to read otherwise inaccessible
3830 files. If no arguments are given, Exim runs interactively, prompting for lines
3831 of data. Otherwise, it processes each argument in turn.
3832 </para>
3833 <para>
3834 If Exim was built with USE_READLINE=yes in <filename>Local/Makefile</filename>, it tries
3835 to load the <option>libreadline</option> library dynamically whenever the <option>-be</option> option is
3836 used without command line arguments. If successful, it uses the <function>readline()</function>
3837 function, which provides extensive line-editing facilities, for reading the
3838 test data. A line history is supported.
3839 </para>
3840 <para>
3841 Long expansion expressions can be split over several lines by using backslash
3842 continuations. As in Exim&#x2019;s run time configuration, white space at the start of
3843 continuation lines is ignored. Each argument or data line is passed through the
3844 string expansion mechanism, and the result is output. Variable values from the
3845 configuration file (for example, <varname>$qualify_domain</varname>) are available, but no
3846 message-specific values (such as <varname>$sender_domain</varname>) are set, because no message
3847 is being processed (but see <option>-bem</option> and <option>-Mset</option>).
3848 </para>
3849 <para>
3850 <emphasis role="bold">Note</emphasis>: If you use this mechanism to test lookups, and you change the data
3851 files or databases you are using, you must exit and restart Exim before trying
3852 the same lookup again. Otherwise, because each Exim process caches the results
3853 of lookups, you will just get the same result as before.
3854 </para>
3855 </listitem></varlistentry>
3856 <varlistentry>
3857 <term><option>-bem</option>&nbsp;&lt;<emphasis>filename</emphasis>&gt;</term>
3858 <listitem>
3859 <para>
3860 <indexterm role="option">
3861 <primary><option>-bem</option></primary>
3862 </indexterm>
3863 <indexterm role="concept">
3864 <primary>testing</primary>
3865 <secondary>string expansion</secondary>
3866 </indexterm>
3867 <indexterm role="concept">
3868 <primary>expansion</primary>
3869 <secondary>testing</secondary>
3870 </indexterm>
3871 This option operates like <option>-be</option> except that it must be followed by the name
3872 of a file. For example:
3873 </para>
3874 <literallayout class="monospaced">
3875 exim -bem /tmp/testmessage
3876 </literallayout>
3877 <para>
3878 The file is read as a message (as if receiving a locally-submitted non-SMTP
3879 message) before any of the test expansions are done. Thus, message-specific
3880 variables such as <varname>$message_size</varname> and <varname>$header_from:</varname> are available. However,
3881 no <emphasis>Received:</emphasis> header is added to the message. If the <option>-t</option> option is set,
3882 recipients are read from the headers in the normal way, and are shown in the
3883 <varname>$recipients</varname> variable. Note that recipients cannot be given on the command
3884 line, because further arguments are taken as strings to expand (just like
3885 <option>-be</option>).
3886 </para>
3887 </listitem></varlistentry>
3888 <varlistentry>
3889 <term><option>-bF</option>&nbsp;&lt;<emphasis>filename</emphasis>&gt;</term>
3890 <listitem>
3891 <para>
3892 <indexterm role="option">
3893 <primary><option>-bF</option></primary>
3894 </indexterm>
3895 <indexterm role="concept">
3896 <primary>system filter</primary>
3897 <secondary>testing</secondary>
3898 </indexterm>
3899 <indexterm role="concept">
3900 <primary>testing</primary>
3901 <secondary>system filter</secondary>
3902 </indexterm>
3903 This option is the same as <option>-bf</option> except that it assumes that the filter being
3904 tested is a system filter. The additional commands that are available only in
3905 system filters are recognized.
3906 </para>
3907 </listitem></varlistentry>
3908 <varlistentry>
3909 <term><option>-bf</option>&nbsp;&lt;<emphasis>filename</emphasis>&gt;</term>
3910 <listitem>
3911 <para>
3912 <indexterm role="option">
3913 <primary><option>-bf</option></primary>
3914 </indexterm>
3915 <indexterm role="concept">
3916 <primary>filter</primary>
3917 <secondary>testing</secondary>
3918 </indexterm>
3919 <indexterm role="concept">
3920 <primary>testing</primary>
3921 <secondary>filter file</secondary>
3922 </indexterm>
3923 <indexterm role="concept">
3924 <primary>forward file</primary>
3925 <secondary>testing</secondary>
3926 </indexterm>
3927 <indexterm role="concept">
3928 <primary>testing</primary>
3929 <secondary>forward file</secondary>
3930 </indexterm>
3931 <indexterm role="concept">
3932 <primary>Sieve filter</primary>
3933 <secondary>testing</secondary>
3934 </indexterm>
3935 This option runs Exim in user filter testing mode; the file is the filter file
3936 to be tested, and a test message must be supplied on the standard input. If
3937 there are no message-dependent tests in the filter, an empty file can be
3938 supplied.
3939 </para>
3940 <para>
3941 If you want to test a system filter file, use <option>-bF</option> instead of <option>-bf</option>. You
3942 can use both <option>-bF</option> and <option>-bf</option> on the same command, in order to test a system
3943 filter and a user filter in the same run. For example:
3944 </para>
3945 <literallayout class="monospaced">
3946 exim -bF /system/filter -bf /user/filter &lt;/test/message
3947 </literallayout>
3948 <para>
3949 This is helpful when the system filter adds header lines or sets filter
3950 variables that are used by the user filter.
3951 </para>
3952 <para>
3953 If the test filter file does not begin with one of the special lines
3954 </para>
3955 <literallayout class="monospaced">
3956 # Exim filter
3957 # Sieve filter
3958 </literallayout>
3959 <para>
3960 it is taken to be a normal <filename>.forward</filename> file, and is tested for validity under
3961 that interpretation. See sections <xref linkend="SECTitenonfilred"/> to
3962 <xref linkend="SECTspecitredli"/> for a description of the possible contents of non-filter
3963 redirection lists.
3964 </para>
3965 <para>
3966 The result of an Exim command that uses <option>-bf</option>, provided no errors are
3967 detected, is a list of the actions that Exim would try to take if presented
3968 with the message for real. More details of filter testing are given in the
3969 separate document entitled <emphasis>Exim&#x2019;s interfaces to mail filtering</emphasis>.
3970 </para>
3971 <para>
3972 When testing a filter file,
3973 <indexterm role="concept">
3974 <primary><quote>From</quote> line</primary>
3975 </indexterm>
3976 <indexterm role="concept">
3977 <primary>envelope sender</primary>
3978 </indexterm>
3979 <indexterm role="option">
3980 <primary><option>-f</option></primary>
3981 <secondary>for filter testing</secondary>
3982 </indexterm>
3983 the envelope sender can be set by the <option>-f</option> option,
3984 or by a <quote>From&nbsp;</quote> line at the start of the test message. Various parameters
3985 that would normally be taken from the envelope recipient address of the message
3986 can be set by means of additional command line options (see the next four
3987 options).
3988 </para>
3989 </listitem></varlistentry>
3990 <varlistentry>
3991 <term><option>-bfd</option>&nbsp;&lt;<emphasis>domain</emphasis>&gt;</term>
3992 <listitem>
3993 <para>
3994 <indexterm role="option">
3995 <primary><option>-bfd</option></primary>
3996 </indexterm>
3997 <indexterm role="variable">
3998 <primary><varname>$qualify_domain</varname></primary>
3999 </indexterm>
4000 This sets the domain of the recipient address when a filter file is being
4001 tested by means of the <option>-bf</option> option. The default is the value of
4002 <varname>$qualify_domain</varname>.
4003 </para>
4004 </listitem></varlistentry>
4005 <varlistentry>
4006 <term><option>-bfl</option>&nbsp;&lt;<emphasis>local&nbsp;part</emphasis>&gt;</term>
4007 <listitem>
4008 <para>
4009 <indexterm role="option">
4010 <primary><option>-bfl</option></primary>
4011 </indexterm>
4012 This sets the local part of the recipient address when a filter file is being
4013 tested by means of the <option>-bf</option> option. The default is the username of the
4014 process that calls Exim. A local part should be specified with any prefix or
4015 suffix stripped, because that is how it appears to the filter when a message is
4016 actually being delivered.
4017 </para>
4018 </listitem></varlistentry>
4019 <varlistentry>
4020 <term><option>-bfp</option>&nbsp;&lt;<emphasis>prefix</emphasis>&gt;</term>
4021 <listitem>
4022 <para>
4023 <indexterm role="option">
4024 <primary><option>-bfp</option></primary>
4025 </indexterm>
4026 This sets the prefix of the local part of the recipient address when a filter
4027 file is being tested by means of the <option>-bf</option> option. The default is an empty
4028 prefix.
4029 </para>
4030 </listitem></varlistentry>
4031 <varlistentry>
4032 <term><option>-bfs</option>&nbsp;&lt;<emphasis>suffix</emphasis>&gt;</term>
4033 <listitem>
4034 <para>
4035 <indexterm role="option">
4036 <primary><option>-bfs</option></primary>
4037 </indexterm>
4038 This sets the suffix of the local part of the recipient address when a filter
4039 file is being tested by means of the <option>-bf</option> option. The default is an empty
4040 suffix.
4041 </para>
4042 </listitem></varlistentry>
4043 <varlistentry>
4044 <term><option>-bh</option>&nbsp;&lt;<emphasis>IP&nbsp;address</emphasis>&gt;</term>
4045 <listitem>
4046 <para>
4047 <indexterm role="option">
4048 <primary><option>-bh</option></primary>
4049 </indexterm>
4050 <indexterm role="concept">
4051 <primary>testing</primary>
4052 <secondary>incoming SMTP</secondary>
4053 </indexterm>
4054 <indexterm role="concept">
4055 <primary>SMTP</primary>
4056 <secondary>testing incoming</secondary>
4057 </indexterm>
4058 <indexterm role="concept">
4059 <primary>testing</primary>
4060 <secondary>relay control</secondary>
4061 </indexterm>
4062 <indexterm role="concept">
4063 <primary>relaying</primary>
4064 <secondary>testing configuration</secondary>
4065 </indexterm>
4066 <indexterm role="concept">
4067 <primary>policy control</primary>
4068 <secondary>testing</secondary>
4069 </indexterm>
4070 <indexterm role="concept">
4071 <primary>debugging</primary>
4072 <secondary><option>-bh</option> option</secondary>
4073 </indexterm>
4074 This option runs a fake SMTP session as if from the given IP address, using the
4075 standard input and output. The IP address may include a port number at the end,
4076 after a full stop. For example:
4077 </para>
4078 <literallayout class="monospaced">
4079 exim -bh 10.9.8.7.1234
4080 exim -bh fe80::a00:20ff:fe86:a061.5678
4081 </literallayout>
4082 <para>
4083 When an IPv6 address is given, it is converted into canonical form. In the case
4084 of the second example above, the value of <varname>$sender_host_address</varname> after
4085 conversion to the canonical form is
4086 <literal>fe80:0000:0000:0a00:20ff:fe86:a061.5678</literal>.
4087 </para>
4088 <para>
4089 Comments as to what is going on are written to the standard error file. These
4090 include lines beginning with <quote>LOG</quote> for anything that would have been logged.
4091 This facility is provided for testing configuration options for incoming
4092 messages, to make sure they implement the required policy. For example, you can
4093 test your relay controls using <option>-bh</option>.
4094 </para>
4095 <para>
4096 <emphasis role="bold">Warning 1</emphasis>:
4097 <indexterm role="concept">
4098 <primary>RFC 1413</primary>
4099 </indexterm>
4100 You can test features of the configuration that rely on ident (RFC 1413)
4101 information by using the <option>-oMt</option> option. However, Exim cannot actually perform
4102 an ident callout when testing using <option>-bh</option> because there is no incoming SMTP
4103 connection.
4104 </para>
4105 <para>
4106 <emphasis role="bold">Warning 2</emphasis>: Address verification callouts (see section <xref linkend="SECTcallver"/>)
4107 are also skipped when testing using <option>-bh</option>. If you want these callouts to
4108 occur, use <option>-bhc</option> instead.
4109 </para>
4110 <para>
4111 Messages supplied during the testing session are discarded, and nothing is
4112 written to any of the real log files. There may be pauses when DNS (and other)
4113 lookups are taking place, and of course these may time out. The <option>-oMi</option> option
4114 can be used to specify a specific IP interface and port if this is important,
4115 and <option>-oMaa</option> and <option>-oMai</option> can be used to set parameters as if the SMTP
4116 session were authenticated.
4117 </para>
4118 <para>
4119 The <emphasis>exim_checkaccess</emphasis> utility is a <quote>packaged</quote> version of <option>-bh</option> whose
4120 output just states whether a given recipient address from a given host is
4121 acceptable or not. See section <xref linkend="SECTcheckaccess"/>.
4122 </para>
4123 <para>
4124 Features such as authentication and encryption, where the client input is not
4125 plain text, cannot easily be tested with <option>-bh</option>. Instead, you should use a
4126 specialized SMTP test program such as
4127 <emphasis role="bold"><ulink url="http://jetmore.org/john/code/#swaks">swaks</ulink></emphasis>.
4128 </para>
4129 </listitem></varlistentry>
4130 <varlistentry>
4131 <term><option>-bhc</option>&nbsp;&lt;<emphasis>IP&nbsp;address</emphasis>&gt;</term>
4132 <listitem>
4133 <para>
4134 <indexterm role="option">
4135 <primary><option>-bhc</option></primary>
4136 </indexterm>
4137 This option operates in the same way as <option>-bh</option>, except that address
4138 verification callouts are performed if required. This includes consulting and
4139 updating the callout cache database.
4140 </para>
4141 </listitem></varlistentry>
4142 <varlistentry>
4143 <term><option>-bi</option></term>
4144 <listitem>
4145 <para>
4146 <indexterm role="option">
4147 <primary><option>-bi</option></primary>
4148 </indexterm>
4149 <indexterm role="concept">
4150 <primary>alias file</primary>
4151 <secondary>building</secondary>
4152 </indexterm>
4153 <indexterm role="concept">
4154 <primary>building alias file</primary>
4155 </indexterm>
4156 <indexterm role="concept">
4157 <primary>Sendmail compatibility</primary>
4158 <secondary><option>-bi</option> option</secondary>
4159 </indexterm>
4160 Sendmail interprets the <option>-bi</option> option as a request to rebuild its alias file.
4161 Exim does not have the concept of a single alias file, and so it cannot mimic
4162 this behaviour. However, calls to <filename>/usr/lib/sendmail</filename> with the <option>-bi</option> option
4163 tend to appear in various scripts such as NIS make files, so the option must be
4164 recognized.
4165 </para>
4166 <para>
4167 If <option>-bi</option> is encountered, the command specified by the <option>bi_command</option>
4168 configuration option is run, under the uid and gid of the caller of Exim. If
4169 the <option>-oA</option> option is used, its value is passed to the command as an argument.
4170 The command set by <option>bi_command</option> may not contain arguments. The command can
4171 use the <emphasis>exim_dbmbuild</emphasis> utility, or some other means, to rebuild alias files
4172 if this is required. If the <option>bi_command</option> option is not set, calling Exim with
4173 <option>-bi</option> is a no-op.
4174 </para>
4175 </listitem></varlistentry>
4176 <varlistentry>
4177 <term><option>-bI:help</option></term>
4178 <listitem>
4179 <para>
4180 <indexterm role="option">
4181 <primary><option>-bI:help</option></primary>
4182 </indexterm>
4183 <indexterm role="concept">
4184 <primary>querying exim information</primary>
4185 </indexterm>
4186 We shall provide various options starting <literal>-bI:</literal> for querying Exim for
4187 information.  The output of many of these will be intended for machine
4188 consumption.  This one is not.  The <option>-bI:help</option> option asks Exim for a
4189 synopsis of supported options beginning <literal>-bI:</literal>.  Use of any of these
4190 options shall cause Exim to exit after producing the requested output.
4191 </para>
4192 </listitem></varlistentry>
4193 <varlistentry>
4194 <term><option>-bI:dscp</option></term>
4195 <listitem>
4196 <para>
4197 <indexterm role="option">
4198 <primary><option>-bI:dscp</option></primary>
4199 </indexterm>
4200 <indexterm role="concept">
4201 <primary>DSCP</primary>
4202 <secondary>values</secondary>
4203 </indexterm>
4204 This option causes Exim to emit an alphabetically sorted list of all
4205 recognised DSCP names.
4206 </para>
4207 </listitem></varlistentry>
4208 <varlistentry>
4209 <term><option>-bI:sieve</option></term>
4210 <listitem>
4211 <para>
4212 <indexterm role="option">
4213 <primary><option>-bI:sieve</option></primary>
4214 </indexterm>
4215 <indexterm role="concept">
4216 <primary>Sieve filter</primary>
4217 <secondary>capabilities</secondary>
4218 </indexterm>
4219 This option causes Exim to emit an alphabetically sorted list of all supported
4220 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
4221 useful for ManageSieve (RFC 5804) implementations, in providing that protocol&#x2019;s
4222 <literal>SIEVE</literal> capability response line.  As the precise list may depend upon
4223 compile-time build options, which this option will adapt to, this is the only
4224 way to guarantee a correct response.
4225 </para>
4226 </listitem></varlistentry>
4227 <varlistentry>
4228 <term><option>-bm</option></term>
4229 <listitem>
4230 <para>
4231 <indexterm role="option">
4232 <primary><option>-bm</option></primary>
4233 </indexterm>
4234 <indexterm role="concept">
4235 <primary>local message reception</primary>
4236 </indexterm>
4237 This option runs an Exim receiving process that accepts an incoming,
4238 locally-generated message on the standard input. The recipients are given as the
4239 command arguments (except when <option>-t</option> is also present &ndash; see below). Each
4240 argument can be a comma-separated list of RFC 2822 addresses. This is the
4241 default option for selecting the overall action of an Exim call; it is assumed
4242 if no other conflicting option is present.
4243 </para>
4244 <para>
4245 If any addresses in the message are unqualified (have no domain), they are
4246 qualified by the values of the <option>qualify_domain</option> or <option>qualify_recipient</option>
4247 options, as appropriate. The <option>-bnq</option> option (see below) provides a way of
4248 suppressing this for special cases.
4249 </para>
4250 <para>
4251 Policy checks on the contents of local messages can be enforced by means of
4252 the non-SMTP ACL. See chapter <xref linkend="CHAPACL"/> for details.
4253 </para>
4254 <para>
4255 <indexterm role="concept">
4256 <primary>return code</primary>
4257 <secondary>for <option>-bm</option></secondary>
4258 </indexterm>
4259 The return code is zero if the message is successfully accepted. Otherwise, the
4260 action is controlled by the <option>-oe</option><emphasis>x</emphasis> option setting &ndash; see below.
4261 </para>
4262 <para>
4263 The format
4264 <indexterm role="concept">
4265 <primary>message</primary>
4266 <secondary>format</secondary>
4267 </indexterm>
4268 <indexterm role="concept">
4269 <primary>format</primary>
4270 <secondary>message</secondary>
4271 </indexterm>
4272 <indexterm role="concept">
4273 <primary><quote>From</quote> line</primary>
4274 </indexterm>
4275 <indexterm role="concept">
4276 <primary>UUCP</primary>
4277 <secondary><quote>From</quote> line</secondary>
4278 </indexterm>
4279 <indexterm role="concept">
4280 <primary>Sendmail compatibility</primary>
4281 <secondary><quote>From</quote> line</secondary>
4282 </indexterm>
4283 of the message must be as defined in RFC 2822, except that, for
4284 compatibility with Sendmail and Smail, a line in one of the forms
4285 </para>
4286 <literallayout class="monospaced">
4287 From sender Fri Jan  5 12:55 GMT 1997
4288 From sender Fri, 5 Jan 97 12:55:01
4289 </literallayout>
4290 <para>
4291 (with the weekday optional, and possibly with additional text after the date)
4292 is permitted to appear at the start of the message. There appears to be no
4293 authoritative specification of the format of this line. Exim recognizes it by
4294 matching against the regular expression defined by the <option>uucp_from_pattern</option>
4295 option, which can be changed if necessary.
4296 </para>
4297 <para>
4298 <indexterm role="option">
4299 <primary><option>-f</option></primary>
4300 <secondary>overriding <quote>From</quote> line</secondary>
4301 </indexterm>
4302 The specified sender is treated as if it were given as the argument to the
4303 <option>-f</option> option, but if a <option>-f</option> option is also present, its argument is used in
4304 preference to the address taken from the message. The caller of Exim must be a
4305 trusted user for the sender of a message to be set in this way.
4306 </para>
4307 </listitem></varlistentry>
4308 <varlistentry>
4309 <term><option>-bmalware</option>&nbsp;&lt;<emphasis>filename</emphasis>&gt;</term>
4310 <listitem>
4311 <para>
4312 <indexterm role="option">
4313 <primary><option>-bmalware</option></primary>
4314 </indexterm>
4315 <indexterm role="concept">
4316 <primary>testing</primary>
4317 <secondary>,</secondary>
4318 </indexterm>
4319 <indexterm role="concept">
4320 <primary>malware scan test</primary>
4321 </indexterm>
4322 This debugging option causes Exim to scan the given file,
4323 using the malware scanning framework.  The option of <option>av_scanner</option> influences
4324 this option, so if <option>av_scanner</option>&#x2019;s value is dependent upon an expansion then
4325 the expansion should have defaults which apply to this invocation.  ACLs are
4326 not invoked, so if <option>av_scanner</option> references an ACL variable then that variable
4327 will never be populated and <option>-bmalware</option> will fail.
4328 </para>
4329 <para>
4330 Exim will have changed working directory before resolving the filename, so
4331 using fully qualified pathnames is advisable.  Exim will be running as the Exim
4332 user when it tries to open the file, rather than as the invoking user.
4333 This option requires admin privileges.
4334 </para>
4335 <para>
4336 The <option>-bmalware</option> option will not be extended to be more generally useful,
4337 there are better tools for file-scanning.  This option exists to help
4338 administrators verify their Exim and AV scanner configuration.
4339 </para>
4340 </listitem></varlistentry>
4341 <varlistentry>
4342 <term><option>-bnq</option></term>
4343 <listitem>
4344 <para>
4345 <indexterm role="option">
4346 <primary><option>-bnq</option></primary>
4347 </indexterm>
4348 <indexterm role="concept">
4349 <primary>address qualification, suppressing</primary>
4350 </indexterm>
4351 By default, Exim automatically qualifies unqualified addresses (those
4352 without domains) that appear in messages that are submitted locally (that
4353 is, not over TCP/IP). This qualification applies both to addresses in
4354 envelopes, and addresses in header lines. Sender addresses are qualified using
4355 <option>qualify_domain</option>, and recipient addresses using <option>qualify_recipient</option> (which
4356 defaults to the value of <option>qualify_domain</option>).
4357 </para>
4358 <para>
4359 Sometimes, qualification is not wanted. For example, if <option>-bS</option> (batch SMTP) is
4360 being used to re-submit messages that originally came from remote hosts after
4361 content scanning, you probably do not want to qualify unqualified addresses in
4362 header lines. (Such lines will be present only if you have not enabled a header
4363 syntax check in the appropriate ACL.)
4364 </para>
4365 <para>
4366 The <option>-bnq</option> option suppresses all qualification of unqualified addresses in
4367 messages that originate on the local host. When this is used, unqualified
4368 addresses in the envelope provoke errors (causing message rejection) and
4369 unqualified addresses in header lines are left alone.
4370 </para>
4371 </listitem></varlistentry>
4372 <varlistentry>
4373 <term><option>-bP</option></term>
4374 <listitem>
4375 <para>
4376 <indexterm role="option">
4377 <primary><option>-bP</option></primary>
4378 </indexterm>
4379 <indexterm role="concept">
4380 <primary>configuration options</primary>
4381 <secondary>extracting</secondary>
4382 </indexterm>
4383 <indexterm role="concept">
4384 <primary>options</primary>
4385 <secondary>configuration &ndash; extracting</secondary>
4386 </indexterm>
4387 If this option is given with no arguments, it causes the values of all Exim&#x2019;s
4388 main configuration options to be written to the standard output. The values
4389 of one or more specific options can be requested by giving their names as
4390 arguments, for example:
4391 </para>
4392 <literallayout class="monospaced">
4393 exim -bP qualify_domain hold_domains
4394 </literallayout>
4395 <para>
4396 <indexterm role="concept">
4397 <primary>hiding configuration option values</primary>
4398 </indexterm>
4399 <indexterm role="concept">
4400 <primary>configuration options</primary>
4401 <secondary>hiding value of</secondary>
4402 </indexterm>
4403 <indexterm role="concept">
4404 <primary>options</primary>
4405 <secondary>hiding value of</secondary>
4406 </indexterm>
4407 However, any option setting that is preceded by the word <quote>hide</quote> in the
4408 configuration file is not shown in full, except to an admin user. For other
4409 users, the output is as in this example:
4410 </para>
4411 <literallayout class="monospaced">
4412 mysql_servers = &lt;value not displayable&gt;
4413 </literallayout>
4414 <para>
4415 If <option>configure_file</option> is given as an argument, the name of the run time
4416 configuration file is output.
4417 If a list of configuration files was supplied, the value that is output here
4418 is the name of the file that was actually used.
4419 </para>
4420 <para>
4421 <indexterm role="concept">
4422 <primary>options</primary>
4423 <secondary>hiding name of</secondary>
4424 </indexterm>
4425 If the <option>-n</option> flag is given, then for most modes of <option>-bP</option> operation the
4426 name will not be output.
4427 </para>
4428 <para>
4429 <indexterm role="concept">
4430 <primary>daemon</primary>
4431 <secondary>process id (pid)</secondary>
4432 </indexterm>
4433 <indexterm role="concept">
4434 <primary>pid (process id)</primary>
4435 <secondary>of daemon</secondary>
4436 </indexterm>
4437 If <option>log_file_path</option> or <option>pid_file_path</option> are given, the names of the
4438 directories where log files and daemon pid files are written are output,
4439 respectively. If these values are unset, log files are written in a
4440 sub-directory of the spool directory called <option>log</option>, and the pid file is
4441 written directly into the spool directory.
4442 </para>
4443 <para>
4444 If <option>-bP</option> is followed by a name preceded by <literal>+</literal>, for example,
4445 </para>
4446 <literallayout class="monospaced">
4447 exim -bP +local_domains
4448 </literallayout>
4449 <para>
4450 it searches for a matching named list of any type (domain, host, address, or
4451 local part) and outputs what it finds.
4452 </para>
4453 <para>
4454 <indexterm role="concept">
4455 <primary>options</primary>
4456 <secondary>router &ndash; extracting</secondary>
4457 </indexterm>
4458 <indexterm role="concept">
4459 <primary>options</primary>
4460 <secondary>transport &ndash; extracting</secondary>
4461 </indexterm>
4462 <indexterm role="concept">
4463 <primary>options</primary>
4464 <secondary>authenticator &ndash; extracting</secondary>
4465 </indexterm>
4466 If one of the words <option>router</option>, <option>transport</option>, or <option>authenticator</option> is given,
4467 followed by the name of an appropriate driver instance, the option settings for
4468 that driver are output. For example:
4469 </para>
4470 <literallayout class="monospaced">
4471 exim -bP transport local_delivery
4472 </literallayout>
4473 <para>
4474 The generic driver options are output first, followed by the driver&#x2019;s private
4475 options. A list of the names of drivers of a particular type can be obtained by
4476 using one of the words <option>router_list</option>, <option>transport_list</option>, or
4477 <option>authenticator_list</option>, and a complete list of all drivers with their option
4478 settings can be obtained by using <option>routers</option>, <option>transports</option>, or
4479 <option>authenticators</option>.
4480 </para>
4481 <para>
4482 <indexterm role="concept">
4483 <primary>options</primary>
4484 <secondary>macro &ndash; extracting</secondary>
4485 </indexterm>
4486 If invoked by an admin user, then <option>macro</option>, <option>macro_list</option> and <option>macros</option>
4487 are available, similarly to the drivers.  Because macros are sometimes used
4488 for storing passwords, this option is restricted.
4489 The output format is one item per line.
4490 </para>
4491 </listitem></varlistentry>
4492 <varlistentry>
4493 <term><option>-bp</option></term>
4494 <listitem>
4495 <para>
4496 <indexterm role="option">
4497 <primary><option>-bp</option></primary>
4498 </indexterm>
4499 <indexterm role="concept">
4500 <primary>queue</primary>
4501 <secondary>listing messages on</secondary>
4502 </indexterm>
4503 <indexterm role="concept">
4504 <primary>listing</primary>
4505 <secondary>messages on the queue</secondary>
4506 </indexterm>
4507 This option requests a listing of the contents of the mail queue on the
4508 standard output. If the <option>-bp</option> option is followed by a list of message ids,
4509 just those messages are listed. By default, this option can be used only by an
4510 admin user. However, the <option>queue_list_requires_admin</option> option can be set false
4511 to allow any user to see the queue.
4512 </para>
4513 <para>
4514 Each message on the queue is displayed as in the following example:
4515 </para>
4516 <literallayout class="monospaced">
4517 25m  2.9K 0t5C6f-0000c8-00 &lt;alice@wonderland.fict.example&gt;
4518           red.king@looking-glass.fict.example
4519           &lt;other addresses&gt;
4520 </literallayout>
4521 <para>
4522 <indexterm role="concept">
4523 <primary>message</primary>
4524 <secondary>size in queue listing</secondary>
4525 </indexterm>
4526 <indexterm role="concept">
4527 <primary>size</primary>
4528 <secondary>of message</secondary>
4529 </indexterm>
4530 The first line contains the length of time the message has been on the queue
4531 (in this case 25 minutes), the size of the message (2.9K), the unique local
4532 identifier for the message, and the message sender, as contained in the
4533 envelope. For bounce messages, the sender address is empty, and appears as
4534 <quote>&lt;&gt;</quote>. If the message was submitted locally by an untrusted user who overrode
4535 the default sender address, the user&#x2019;s login name is shown in parentheses
4536 before the sender address.
4537 </para>
4538 <para>
4539 <indexterm role="concept">
4540 <primary>frozen messages</primary>
4541 <secondary>in queue listing</secondary>
4542 </indexterm>
4543 If the message is frozen (attempts to deliver it are suspended) then the text
4544 <quote>*** frozen ***</quote> is displayed at the end of this line.
4545 </para>
4546 <para>
4547 The recipients of the message (taken from the envelope, not the headers) are
4548 displayed on subsequent lines. Those addresses to which the message has already
4549 been delivered are marked with the letter D. If an original address gets
4550 expanded into several addresses via an alias or forward file, the original is
4551 displayed with a D only when deliveries for all of its child addresses are
4552 complete.
4553 </para>
4554 </listitem></varlistentry>
4555 <varlistentry>
4556 <term><option>-bpa</option></term>
4557 <listitem>
4558 <para>
4559 <indexterm role="option">
4560 <primary><option>-bpa</option></primary>
4561 </indexterm>
4562 This option operates like <option>-bp</option>, but in addition it shows delivered addresses
4563 that were generated from the original top level address(es) in each message by
4564 alias or forwarding operations. These addresses are flagged with <quote>+D</quote> instead
4565 of just <quote>D</quote>.
4566 </para>
4567 </listitem></varlistentry>
4568 <varlistentry>
4569 <term><option>-bpc</option></term>
4570 <listitem>
4571 <para>
4572 <indexterm role="option">
4573 <primary><option>-bpc</option></primary>
4574 </indexterm>
4575 <indexterm role="concept">
4576 <primary>queue</primary>
4577 <secondary>count of messages on</secondary>
4578 </indexterm>
4579 This option counts the number of messages on the queue, and writes the total
4580 to the standard output. It is restricted to admin users, unless
4581 <option>queue_list_requires_admin</option> is set false.
4582 </para>
4583 </listitem></varlistentry>
4584 <varlistentry>
4585 <term><option>-bpr</option></term>
4586 <listitem>
4587 <para>
4588 <indexterm role="option">
4589 <primary><option>-bpr</option></primary>
4590 </indexterm>
4591 This option operates like <option>-bp</option>, but the output is not sorted into
4592 chronological order of message arrival. This can speed it up when there are
4593 lots of messages on the queue, and is particularly useful if the output is
4594 going to be post-processed in a way that doesn&#x2019;t need the sorting.
4595 </para>
4596 </listitem></varlistentry>
4597 <varlistentry>
4598 <term><option>-bpra</option></term>
4599 <listitem>
4600 <para>
4601 <indexterm role="option">
4602 <primary><option>-bpra</option></primary>
4603 </indexterm>
4604 This option is a combination of <option>-bpr</option> and <option>-bpa</option>.
4605 </para>
4606 </listitem></varlistentry>
4607 <varlistentry>
4608 <term><option>-bpru</option></term>
4609 <listitem>
4610 <para>
4611 <indexterm role="option">
4612 <primary><option>-bpru</option></primary>
4613 </indexterm>
4614 This option is a combination of <option>-bpr</option> and <option>-bpu</option>.
4615 </para>
4616 </listitem></varlistentry>
4617 <varlistentry>
4618 <term><option>-bpu</option></term>
4619 <listitem>
4620 <para>
4621 <indexterm role="option">
4622 <primary><option>-bpu</option></primary>
4623 </indexterm>
4624 This option operates like <option>-bp</option> but shows only undelivered top-level
4625 addresses for each message displayed. Addresses generated by aliasing or
4626 forwarding are not shown, unless the message was deferred after processing by a
4627 router with the <option>one_time</option> option set.
4628 </para>
4629 </listitem></varlistentry>
4630 <varlistentry>
4631 <term><option>-brt</option></term>
4632 <listitem>
4633 <para>
4634 <indexterm role="option">
4635 <primary><option>-brt</option></primary>
4636 </indexterm>
4637 <indexterm role="concept">
4638 <primary>testing</primary>
4639 <secondary>retry configuration</secondary>
4640 </indexterm>
4641 <indexterm role="concept">
4642 <primary>retry</primary>
4643 <secondary>configuration testing</secondary>
4644 </indexterm>
4645 This option is for testing retry rules, and it must be followed by up to three
4646 arguments. It causes Exim to look for a retry rule that matches the values
4647 and to write it to the standard output. For example:
4648 </para>
4649 <literallayout class="monospaced">
4650 exim -brt bach.comp.mus.example
4651 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
4652 </literallayout>
4653 <para>
4654 See chapter <xref linkend="CHAPretry"/> for a description of Exim&#x2019;s retry rules. The first
4655 argument, which is required, can be a complete address in the form
4656 <emphasis>local_part@domain</emphasis>, or it can be just a domain name. If the second argument
4657 contains a dot, it is interpreted as an optional second domain name; if no
4658 retry rule is found for the first argument, the second is tried. This ties in
4659 with Exim&#x2019;s behaviour when looking for retry rules for remote hosts &ndash; if no
4660 rule is found that matches the host, one that matches the mail domain is
4661 sought. Finally, an argument that is the name of a specific delivery error, as
4662 used in setting up retry rules, can be given. For example:
4663 </para>
4664 <literallayout class="monospaced">
4665 exim -brt haydn.comp.mus.example quota_3d
4666 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
4667 </literallayout>
4668 </listitem></varlistentry>
4669 <varlistentry>
4670 <term><option>-brw</option></term>
4671 <listitem>
4672 <para>
4673 <indexterm role="option">
4674 <primary><option>-brw</option></primary>
4675 </indexterm>
4676 <indexterm role="concept">
4677 <primary>testing</primary>
4678 <secondary>rewriting</secondary>
4679 </indexterm>
4680 <indexterm role="concept">
4681 <primary>rewriting</primary>
4682 <secondary>testing</secondary>
4683 </indexterm>
4684 This option is for testing address rewriting rules, and it must be followed by
4685 a single argument, consisting of either a local part without a domain, or a
4686 complete address with a fully qualified domain. Exim outputs how this address
4687 would be rewritten for each possible place it might appear. See chapter
4688 <xref linkend="CHAPrewrite"/> for further details.
4689 </para>
4690 </listitem></varlistentry>
4691 <varlistentry>
4692 <term><option>-bS</option></term>
4693 <listitem>
4694 <para>
4695 <indexterm role="option">
4696 <primary><option>-bS</option></primary>
4697 </indexterm>
4698 <indexterm role="concept">
4699 <primary>SMTP</primary>
4700 <secondary>batched incoming</secondary>
4701 </indexterm>
4702 <indexterm role="concept">
4703 <primary>batched SMTP input</primary>
4704 </indexterm>
4705 This option is used for batched SMTP input, which is an alternative interface
4706 for non-interactive local message submission. A number of messages can be
4707 submitted in a single run. However, despite its name, this is not really SMTP
4708 input. Exim reads each message&#x2019;s envelope from SMTP commands on the standard
4709 input, but generates no responses. If the caller is trusted, or
4710 <option>untrusted_set_sender</option> is set, the senders in the SMTP MAIL commands are
4711 believed; otherwise the sender is always the caller of Exim.
4712 </para>
4713 <para>
4714 The message itself is read from the standard input, in SMTP format (leading
4715 dots doubled), terminated by a line containing just a single dot. An error is
4716 provoked if the terminating dot is missing. A further message may then follow.
4717 </para>
4718 <para>
4719 As for other local message submissions, the contents of incoming batch SMTP
4720 messages can be checked using the non-SMTP ACL (see chapter <xref linkend="CHAPACL"/>).
4721 Unqualified addresses are automatically qualified using <option>qualify_domain</option> and
4722 <option>qualify_recipient</option>, as appropriate, unless the <option>-bnq</option> option is used.
4723 </para>
4724 <para>
4725 Some other SMTP commands are recognized in the input. HELO and EHLO act
4726 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
4727 QUIT quits, ignoring the rest of the standard input.
4728 </para>
4729 <para>
4730 <indexterm role="concept">
4731 <primary>return code</primary>
4732 <secondary>for <option>-bS</option></secondary>
4733 </indexterm>
4734 If any error is encountered, reports are written to the standard output and
4735 error streams, and Exim gives up immediately. The return code is 0 if no error
4736 was detected; it is 1 if one or more messages were accepted before the error
4737 was detected; otherwise it is 2.
4738 </para>
4739 <para>
4740 More details of input using batched SMTP are given in section
4741 <xref linkend="SECTincomingbatchedSMTP"/>.
4742 </para>
4743 </listitem></varlistentry>
4744 <varlistentry>
4745 <term><option>-bs</option></term>
4746 <listitem>
4747 <para>
4748 <indexterm role="option">
4749 <primary><option>-bs</option></primary>
4750 </indexterm>
4751 <indexterm role="concept">
4752 <primary>SMTP</primary>
4753 <secondary>local input</secondary>
4754 </indexterm>
4755 <indexterm role="concept">
4756 <primary>local SMTP input</primary>
4757 </indexterm>
4758 This option causes Exim to accept one or more messages by reading SMTP commands
4759 on the standard input, and producing SMTP replies on the standard output. SMTP
4760 policy controls, as defined in ACLs (see chapter <xref linkend="CHAPACL"/>) are applied.
4761 Some user agents use this interface as a way of passing locally-generated
4762 messages to the MTA.
4763 </para>
4764 <para>
4765 In
4766 <indexterm role="concept">
4767 <primary>sender</primary>
4768 <secondary>source of</secondary>
4769 </indexterm>
4770 this usage, if the caller of Exim is trusted, or <option>untrusted_set_sender</option> is
4771 set, the senders of messages are taken from the SMTP MAIL commands.
4772 Otherwise the content of these commands is ignored and the sender is set up as
4773 the calling user. Unqualified addresses are automatically qualified using
4774 <option>qualify_domain</option> and <option>qualify_recipient</option>, as appropriate, unless the
4775 <option>-bnq</option> option is used.
4776 </para>
4777 <para>
4778 <indexterm role="concept">
4779 <primary>inetd</primary>
4780 </indexterm>
4781 The
4782 <option>-bs</option> option is also used to run Exim from <emphasis>inetd</emphasis>, as an alternative to
4783 using a listening daemon. Exim can distinguish the two cases by checking
4784 whether the standard input is a TCP/IP socket. When Exim is called from
4785 <emphasis>inetd</emphasis>, the source of the mail is assumed to be remote, and the comments
4786 above concerning senders and qualification do not apply. In this situation,
4787 Exim behaves in exactly the same way as it does when receiving a message via
4788 the listening daemon.
4789 </para>
4790 </listitem></varlistentry>
4791 <varlistentry>
4792 <term><option>-bt</option></term>
4793 <listitem>
4794 <para>
4795 <indexterm role="option">
4796 <primary><option>-bt</option></primary>
4797 </indexterm>
4798 <indexterm role="concept">
4799 <primary>testing</primary>
4800 <secondary>addresses</secondary>
4801 </indexterm>
4802 <indexterm role="concept">
4803 <primary>address</primary>
4804 <secondary>testing</secondary>
4805 </indexterm>
4806 This option runs Exim in address testing mode, in which each argument is taken
4807 as a recipient address to be tested for deliverability. The results are
4808 written to the standard output. If a test fails, and the caller is not an admin
4809 user, no details of the failure are output, because these might contain
4810 sensitive information such as usernames and passwords for database lookups.
4811 </para>
4812 <para>
4813 If no arguments are given, Exim runs in an interactive manner, prompting with a
4814 right angle bracket for addresses to be tested.
4815 </para>
4816 <para>
4817 Unlike the <option>-be</option> test option, you cannot arrange for Exim to use the
4818 <function>readline()</function> function, because it is running as <emphasis>root</emphasis> and there are
4819 security issues.
4820 </para>
4821 <para>
4822 Each address is handled as if it were the recipient address of a message
4823 (compare the <option>-bv</option> option). It is passed to the routers and the result is
4824 written to the standard output. However, any router that has
4825 <option>no_address_test</option> set is bypassed. This can make <option>-bt</option> easier to use for
4826 genuine routing tests if your first router passes everything to a scanner
4827 program.
4828 </para>
4829 <para>
4830 <indexterm role="concept">
4831 <primary>return code</primary>
4832 <secondary>for <option>-bt</option></secondary>
4833 </indexterm>
4834 The return code is 2 if any address failed outright; it is 1 if no address
4835 failed outright but at least one could not be resolved for some reason. Return
4836 code 0 is given only when all addresses succeed.
4837 </para>
4838 <para>
4839 <indexterm role="concept">
4840 <primary>duplicate addresses</primary>
4841 </indexterm>
4842 <emphasis role="bold">Note</emphasis>: When actually delivering a message, Exim removes duplicate recipient
4843 addresses after routing is complete, so that only one delivery takes place.
4844 This does not happen when testing with <option>-bt</option>; the full results of routing are
4845 always shown.
4846 </para>
4847 <para>
4848 <emphasis role="bold">Warning</emphasis>: <option>-bt</option> can only do relatively simple testing. If any of the
4849 routers in the configuration makes any tests on the sender address of a
4850 message,
4851 <indexterm role="option">
4852 <primary><option>-f</option></primary>
4853 <secondary>for address testing</secondary>
4854 </indexterm>
4855 you can use the <option>-f</option> option to set an appropriate sender when running
4856 <option>-bt</option> tests. Without it, the sender is assumed to be the calling user at the
4857 default qualifying domain. However, if you have set up (for example) routers
4858 whose behaviour depends on the contents of an incoming message, you cannot test
4859 those conditions using <option>-bt</option>. The <option>-N</option> option provides a possible way of
4860 doing such tests.
4861 </para>
4862 </listitem></varlistentry>
4863 <varlistentry>
4864 <term><option>-bV</option></term>
4865 <listitem>
4866 <para>
4867 <indexterm role="option">
4868 <primary><option>-bV</option></primary>
4869 </indexterm>
4870 <indexterm role="concept">
4871 <primary>version number of Exim</primary>
4872 </indexterm>
4873 This option causes Exim to write the current version number, compilation
4874 number, and compilation date of the <emphasis>exim</emphasis> binary to the standard output.
4875 It also lists the DBM library that is being used, the optional modules (such as
4876 specific lookup types), the drivers that are included in the binary, and the
4877 name of the run time configuration file that is in use.
4878 </para>
4879 <para>
4880 As part of its operation, <option>-bV</option> causes Exim to read and syntax check its
4881 configuration file. However, this is a static check only. It cannot check
4882 values that are to be expanded. For example, although a misspelt ACL verb is
4883 detected, an error in the verb&#x2019;s arguments is not. You cannot rely on <option>-bV</option>
4884 alone to discover (for example) all the typos in the configuration; some
4885 realistic testing is needed. The <option>-bh</option> and <option>-N</option> options provide more
4886 dynamic testing facilities.
4887 </para>
4888 </listitem></varlistentry>
4889 <varlistentry>
4890 <term><option>-bv</option></term>
4891 <listitem>
4892 <para>
4893 <indexterm role="option">
4894 <primary><option>-bv</option></primary>
4895 </indexterm>
4896 <indexterm role="concept">
4897 <primary>verifying address</primary>
4898 <secondary>using <option>-bv</option></secondary>
4899 </indexterm>
4900 <indexterm role="concept">
4901 <primary>address</primary>
4902 <secondary>verification</secondary>
4903 </indexterm>
4904 This option runs Exim in address verification mode, in which each argument is
4905 taken as a recipient address to be verified by the routers. (This does
4906 not involve any verification callouts). During normal operation, verification
4907 happens mostly as a consequence processing a <option>verify</option> condition in an ACL
4908 (see chapter <xref linkend="CHAPACL"/>). If you want to test an entire ACL, possibly
4909 including callouts, see the <option>-bh</option> and <option>-bhc</option> options.
4910 </para>
4911 <para>
4912 If verification fails, and the caller is not an admin user, no details of the
4913 failure are output, because these might contain sensitive information such as
4914 usernames and passwords for database lookups.
4915 </para>
4916 <para>
4917 If no arguments are given, Exim runs in an interactive manner, prompting with a
4918 right angle bracket for addresses to be verified.
4919 </para>
4920 <para>
4921 Unlike the <option>-be</option> test option, you cannot arrange for Exim to use the
4922 <function>readline()</function> function, because it is running as <emphasis>exim</emphasis> and there are
4923 security issues.
4924 </para>
4925 <para>
4926 Verification differs from address testing (the <option>-bt</option> option) in that routers
4927 that have <option>no_verify</option> set are skipped, and if the address is accepted by a
4928 router that has <option>fail_verify</option> set, verification fails. The address is
4929 verified as a recipient if <option>-bv</option> is used; to test verification for a sender
4930 address, <option>-bvs</option> should be used.
4931 </para>
4932 <para>
4933 If the <option>-v</option> option is not set, the output consists of a single line for each
4934 address, stating whether it was verified or not, and giving a reason in the
4935 latter case. Without <option>-v</option>, generating more than one address by redirection
4936 causes verification to end successfully, without considering the generated
4937 addresses. However, if just one address is generated, processing continues,
4938 and the generated address must verify successfully for the overall verification
4939 to succeed.
4940 </para>
4941 <para>
4942 When <option>-v</option> is set, more details are given of how the address has been handled,
4943 and in the case of address redirection, all the generated addresses are also
4944 considered. Verification may succeed for some and fail for others.
4945 </para>
4946 <para>
4947 The
4948 <indexterm role="concept">
4949 <primary>return code</primary>
4950 <secondary>for <option>-bv</option></secondary>
4951 </indexterm>
4952 return code is 2 if any address failed outright; it is 1 if no address
4953 failed outright but at least one could not be resolved for some reason. Return
4954 code 0 is given only when all addresses succeed.
4955 </para>
4956 <para>
4957 If any of the routers in the configuration makes any tests on the sender
4958 address of a message, you should use the <option>-f</option> option to set an appropriate
4959 sender when running <option>-bv</option> tests. Without it, the sender is assumed to be the
4960 calling user at the default qualifying domain.
4961 </para>
4962 </listitem></varlistentry>
4963 <varlistentry>
4964 <term><option>-bvs</option></term>
4965 <listitem>
4966 <para>
4967 <indexterm role="option">
4968 <primary><option>-bvs</option></primary>
4969 </indexterm>
4970 This option acts like <option>-bv</option>, but verifies the address as a sender rather
4971 than a recipient address. This affects any rewriting and qualification that
4972 might happen.
4973 </para>
4974 </listitem></varlistentry>
4975 <varlistentry>
4976 <term><option>-bw</option></term>
4977 <listitem>
4978 <para>
4979 <indexterm role="option">
4980 <primary><option>-bw</option></primary>
4981 </indexterm>
4982 <indexterm role="concept">
4983 <primary>daemon</primary>
4984 </indexterm>
4985 <indexterm role="concept">
4986 <primary>inetd</primary>
4987 </indexterm>
4988 <indexterm role="concept">
4989 <primary>inetd</primary>
4990 <secondary>wait mode</secondary>
4991 </indexterm>
4992 This option runs Exim as a daemon, awaiting incoming SMTP connections,
4993 similarly to the <option>-bd</option> option.  All port specifications on the command-line
4994 and in the configuration file are ignored.  Queue-running may not be specified.
4995 </para>
4996 <para>
4997 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
4998 listening for connections.  This permits the system to start up and have
4999 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
5000 each port only when the first connection is received.
5001 </para>
5002 <para>
5003 If the option is given as <option>-bw</option>&lt;<emphasis>time</emphasis>&gt; then the time is a timeout, after
5004 which the daemon will exit, which should cause inetd to listen once more.
5005 </para>
5006 </listitem></varlistentry>
5007 <varlistentry>
5008 <term><option>-C</option>&nbsp;&lt;<emphasis>filelist</emphasis>&gt;</term>
5009 <listitem>
5010 <para>
5011 <indexterm role="option">
5012 <primary><option>-C</option></primary>
5013 </indexterm>
5014 <indexterm role="concept">
5015 <primary>configuration file</primary>
5016 <secondary>alternate</secondary>
5017 </indexterm>
5018 <indexterm role="concept">
5019 <primary>CONFIGURE_FILE</primary>
5020 </indexterm>
5021 <indexterm role="concept">
5022 <primary>alternate configuration file</primary>
5023 </indexterm>
5024 This option causes Exim to find the run time configuration file from the given
5025 list instead of from the list specified by the CONFIGURE_FILE
5026 compile-time setting. Usually, the list will consist of just a single file
5027 name, but it can be a colon-separated list of names. In this case, the first
5028 file that exists is used. Failure to open an existing file stops Exim from
5029 proceeding any further along the list, and an error is generated.
5030 </para>
5031 <para>
5032 When this option is used by a caller other than root, and the list is different
5033 from the compiled-in list, Exim gives up its root privilege immediately, and
5034 runs with the real and effective uid and gid set to those of the caller.
5035 However, if a TRUSTED_CONFIG_LIST file is defined in <filename>Local/Makefile</filename>, that
5036 file contains a list of full pathnames, one per line, for configuration files
5037 which are trusted. Root privilege is retained for any configuration file so
5038 listed, as long as the caller is the Exim user (or the user specified in the
5039 CONFIGURE_OWNER option, if any), and as long as the configuration file is
5040 not writeable by inappropriate users or groups.
5041 </para>
5042 <para>
5043 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
5044 configuration using <option>-C</option> right through message reception and delivery,
5045 even if the caller is root. The reception works, but by that time, Exim is
5046 running as the Exim user, so when it re-executes to regain privilege for the
5047 delivery, the use of <option>-C</option> causes privilege to be lost. However, root can
5048 test reception and delivery using two separate commands (one to put a message
5049 on the queue, using <option>-odq</option>, and another to do the delivery, using <option>-M</option>).
5050 </para>
5051 <para>
5052 If ALT_CONFIG_PREFIX is defined <filename>in Local/Makefile</filename>, it specifies a
5053 prefix string with which any file named in a <option>-C</option> command line option
5054 must start. In addition, the file name must not contain the sequence <literal>/../</literal>.
5055 However, if the value of the <option>-C</option> option is identical to the value of
5056 CONFIGURE_FILE in <filename>Local/Makefile</filename>, Exim ignores <option>-C</option> and proceeds as
5057 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
5058 unset, any file name can be used with <option>-C</option>.
5059 </para>
5060 <para>
5061 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
5062 to a directory to which only root has access. This prevents someone who has
5063 broken into the Exim account from running a privileged Exim with an arbitrary
5064 configuration file.
5065 </para>
5066 <para>
5067 The <option>-C</option> facility is useful for ensuring that configuration files are
5068 syntactically correct, but cannot be used for test deliveries, unless the
5069 caller is privileged, or unless it is an exotic configuration that does not
5070 require privilege. No check is made on the owner or group of the files
5071 specified by this option.
5072 </para>
5073 </listitem></varlistentry>
5074 <varlistentry>
5075 <term><option>-D</option>&lt;<emphasis>macro</emphasis>&gt;=&lt;<emphasis>value</emphasis>&gt;</term>
5076 <listitem>
5077 <para>
5078 <indexterm role="option">
5079 <primary><option>-D</option></primary>
5080 </indexterm>
5081 <indexterm role="concept">
5082 <primary>macro</primary>
5083 <secondary>setting on command line</secondary>
5084 </indexterm>
5085 This option can be used to override macro definitions in the configuration file
5086 (see section <xref linkend="SECTmacrodefs"/>). However, like <option>-C</option>, if it is used by an
5087 unprivileged caller, it causes Exim to give up its root privilege.
5088 If DISABLE_D_OPTION is defined in <filename>Local/Makefile</filename>, the use of <option>-D</option> is
5089 completely disabled, and its use causes an immediate error exit.
5090 </para>
5091 <para>
5092 If WHITELIST_D_MACROS is defined in <filename>Local/Makefile</filename> then it should be a
5093 colon-separated list of macros which are considered safe and, if <option>-D</option> only
5094 supplies macros from this list, and the values are acceptable, then Exim will
5095 not give up root privilege if the caller is root, the Exim run-time user, or
5096 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
5097 to be removed in the future.  Acceptable values for the macros satisfy the
5098 regexp: <literal>^[A-Za-z0-9_/.-]*$</literal>
5099 </para>
5100 <para>
5101 The entire option (including equals sign if present) must all be within one
5102 command line item. <option>-D</option> can be used to set the value of a macro to the empty
5103 string, in which case the equals sign is optional. These two commands are
5104 synonymous:
5105 </para>
5106 <literallayout class="monospaced">
5107 exim -DABC  ...
5108 exim -DABC= ...
5109 </literallayout>
5110 <para>
5111 To include spaces in a macro definition item, quotes must be used. If you use
5112 quotes, spaces are permitted around the macro name and the equals sign. For
5113 example:
5114 </para>
5115 <literallayout class="monospaced">
5116 exim '-D ABC = something' ...
5117 </literallayout>
5118 <para>
5119 <option>-D</option> may be repeated up to 10 times on a command line.
5120 </para>
5121 </listitem></varlistentry>
5122 <varlistentry>
5123 <term><option>-d</option>&lt;<emphasis>debug&nbsp;options</emphasis>&gt;</term>
5124 <listitem>
5125 <para>
5126 <indexterm role="option">
5127 <primary><option>-d</option></primary>
5128 </indexterm>
5129 <indexterm role="concept">
5130 <primary>debugging</primary>
5131 <secondary>list of selectors</secondary>
5132 </indexterm>
5133 <indexterm role="concept">
5134 <primary>debugging</primary>
5135 <secondary><option>-d</option> option</secondary>
5136 </indexterm>
5137 This option causes debugging information to be written to the standard
5138 error stream. It is restricted to admin users because debugging output may show
5139 database queries that contain password information. Also, the details of users&#x2019;
5140 filter files should be protected. If a non-admin user uses <option>-d</option>, Exim
5141 writes an error message to the standard error stream and exits with a non-zero
5142 return code.
5143 </para>
5144 <para>
5145 When <option>-d</option> is used, <option>-v</option> is assumed. If <option>-d</option> is given on its own, a lot of
5146 standard debugging data is output. This can be reduced, or increased to include
5147 some more rarely needed information, by directly following <option>-d</option> with a string
5148 made up of names preceded by plus or minus characters. These add or remove sets
5149 of debugging data, respectively. For example, <option>-d+filter</option> adds filter
5150 debugging, whereas <option>-d-all+filter</option> selects only filter debugging. Note that
5151 no spaces are allowed in the debug setting. The available debugging categories
5152 are:
5153 </para>
5154 <literallayout>
5155 <literal>acl            </literal> ACL interpretation
5156 <literal>auth           </literal> authenticators
5157 <literal>deliver        </literal> general delivery logic
5158 <literal>dns            </literal> DNS lookups (see also resolver)
5159 <literal>dnsbl          </literal> DNS black list (aka RBL) code
5160 <literal>exec           </literal> arguments for <function>execv()</function> calls
5161 <literal>expand         </literal> detailed debugging for string expansions
5162 <literal>filter         </literal> filter handling
5163 <literal>hints_lookup   </literal> hints data lookups
5164 <literal>host_lookup    </literal> all types of name-to-IP address handling
5165 <literal>ident          </literal> ident lookup
5166 <literal>interface      </literal> lists of local interfaces
5167 <literal>lists          </literal> matching things in lists
5168 <literal>load           </literal> system load checks
5169 <literal>local_scan     </literal> can be used by <function>local_scan()</function> (see chapter <xref linkend="CHAPlocalscan"/>)
5170 <literal>lookup         </literal> general lookup code and all lookups
5171 <literal>memory         </literal> memory handling
5172 <literal>pid            </literal> add pid to debug output lines
5173 <literal>process_info   </literal> setting info for the process log
5174 <literal>queue_run      </literal> queue runs
5175 <literal>receive        </literal> general message reception logic
5176 <literal>resolver       </literal> turn on the DNS resolver&#x2019;s debugging output
5177 <literal>retry          </literal> retry handling
5178 <literal>rewrite        </literal> address rewriting
5179 <literal>route          </literal> address routing
5180 <literal>timestamp      </literal> add timestamp to debug output lines
5181 <literal>tls            </literal> TLS logic
5182 <literal>transport      </literal> transports
5183 <literal>uid            </literal> changes of uid/gid and looking up uid/gid
5184 <literal>verify         </literal> address verification logic
5185 <literal>all            </literal> almost all of the above (see below), and also <option>-v</option>
5186 </literallayout>
5187 <para>
5188 The <literal>all</literal> option excludes <literal>memory</literal> when used as <literal>+all</literal>, but includes it
5189 for <literal>-all</literal>. The reason for this is that <literal>+all</literal> is something that people
5190 tend to use when generating debug output for Exim maintainers. If <literal>+memory</literal>
5191 is included, an awful lot of output that is very rarely of interest is
5192 generated, so it now has to be explicitly requested. However, <literal>-all</literal> does
5193 turn everything off.
5194 </para>
5195 <para>
5196 <indexterm role="concept">
5197 <primary>resolver, debugging output</primary>
5198 </indexterm>
5199 <indexterm role="concept">
5200 <primary>DNS resolver, debugging output</primary>
5201 </indexterm>
5202 The <literal>resolver</literal> option produces output only if the DNS resolver was compiled
5203 with DEBUG enabled. This is not the case in some operating systems. Also,
5204 unfortunately, debugging output from the DNS resolver is written to stdout
5205 rather than stderr.
5206 </para>
5207 <para>
5208 The default (<option>-d</option> with no argument) omits <literal>expand</literal>, <literal>filter</literal>,
5209 <literal>interface</literal>, <literal>load</literal>, <literal>memory</literal>, <literal>pid</literal>, <literal>resolver</literal>, and <literal>timestamp</literal>.
5210 However, the <literal>pid</literal> selector is forced when debugging is turned on for a
5211 daemon, which then passes it on to any re-executed Exims. Exim also
5212 automatically adds the pid to debug lines when several remote deliveries are
5213 run in parallel.
5214 </para>
5215 <para>
5216 The <literal>timestamp</literal> selector causes the current time to be inserted at the start
5217 of all debug output lines. This can be useful when trying to track down delays
5218 in processing.
5219 </para>
5220 <para>
5221 If the <option>debug_print</option> option is set in any driver, it produces output whenever
5222 any debugging is selected, or if <option>-v</option> is used.
5223 </para>
5224 </listitem></varlistentry>
5225 <varlistentry>
5226 <term><option>-dd</option>&lt;<emphasis>debug&nbsp;options</emphasis>&gt;</term>
5227 <listitem>
5228 <para>
5229 <indexterm role="option">
5230 <primary><option>-dd</option></primary>
5231 </indexterm>
5232 This option behaves exactly like <option>-d</option> except when used on a command that
5233 starts a daemon process. In that case, debugging is turned off for the
5234 subprocesses that the daemon creates. Thus, it is useful for monitoring the
5235 behaviour of the daemon without creating as much output as full debugging does.
5236 </para>
5237 </listitem></varlistentry>
5238 <varlistentry>
5239 <term><option>-dropcr</option></term>
5240 <listitem>
5241 <para>
5242 <indexterm role="option">
5243 <primary><option>-dropcr</option></primary>
5244 </indexterm>
5245 This is an obsolete option that is now a no-op. It used to affect the way Exim
5246 handled CR and LF characters in incoming messages. What happens now is
5247 described in section <xref linkend="SECTlineendings"/>.
5248 </para>
5249 </listitem></varlistentry>
5250 <varlistentry>
5251 <term><option>-E</option></term>
5252 <listitem>
5253 <para>
5254 <indexterm role="option">
5255 <primary><option>-E</option></primary>
5256 </indexterm>
5257 <indexterm role="concept">
5258 <primary>bounce message</primary>
5259 <secondary>generating</secondary>
5260 </indexterm>
5261 This option specifies that an incoming message is a locally-generated delivery
5262 failure report. It is used internally by Exim when handling delivery failures
5263 and is not intended for external use. Its only effect is to stop Exim
5264 generating certain messages to the postmaster, as otherwise message cascades
5265 could occur in some situations. As part of the same option, a message id may
5266 follow the characters <option>-E</option>. If it does, the log entry for the receipt of the
5267 new message contains the id, following <quote>R=</quote>, as a cross-reference.
5268 </para>
5269 </listitem></varlistentry>
5270 <varlistentry>
5271 <term><option>-e</option><emphasis>x</emphasis></term>
5272 <listitem>
5273 <para>
5274 <indexterm role="option">
5275 <primary><option>-e</option><emphasis>x</emphasis></primary>
5276 </indexterm>
5277 There are a number of Sendmail options starting with <option>-oe</option> which seem to be
5278 called by various programs without the leading <option>o</option> in the option. For
5279 example, the <option>vacation</option> program uses <option>-eq</option>. Exim treats all options of the
5280 form <option>-e</option><emphasis>x</emphasis> as synonymous with the corresponding <option>-oe</option><emphasis>x</emphasis> options.
5281 </para>
5282 </listitem></varlistentry>
5283 <varlistentry>
5284 <term><option>-F</option>&nbsp;&lt;<emphasis>string</emphasis>&gt;</term>
5285 <listitem>
5286 <para>
5287 <indexterm role="option">
5288 <primary><option>-F</option></primary>
5289 </indexterm>
5290 <indexterm role="concept">
5291 <primary>sender</primary>
5292 <secondary>name</secondary>
5293 </indexterm>
5294 <indexterm role="concept">
5295 <primary>name</primary>
5296 <secondary>of sender</secondary>
5297 </indexterm>
5298 This option sets the sender&#x2019;s full name for use when a locally-generated
5299 message is being accepted. In the absence of this option, the user&#x2019;s <emphasis>gecos</emphasis>
5300 entry from the password data is used. As users are generally permitted to alter
5301 their <emphasis>gecos</emphasis> entries, no security considerations are involved. White space
5302 between <option>-F</option> and the &lt;<emphasis>string</emphasis>&gt; is optional.
5303 </para>
5304 </listitem></varlistentry>
5305 <varlistentry>
5306 <term><option>-f</option>&nbsp;&lt;<emphasis>address</emphasis>&gt;</term>
5307 <listitem>
5308 <para>
5309 <indexterm role="option">
5310 <primary><option>-f</option></primary>
5311 </indexterm>
5312 <indexterm role="concept">
5313 <primary>sender</primary>
5314 <secondary>address</secondary>
5315 </indexterm>
5316 <indexterm role="concept">
5317 <primary>address</primary>
5318 <secondary>sender</secondary>
5319 </indexterm>
5320 <indexterm role="concept">
5321 <primary>trusted users</primary>
5322 </indexterm>
5323 <indexterm role="concept">
5324 <primary>envelope sender</primary>
5325 </indexterm>
5326 <indexterm role="concept">
5327 <primary>user</primary>
5328 <secondary>trusted</secondary>
5329 </indexterm>
5330 This option sets the address of the envelope sender of a locally-generated
5331 message (also known as the return path). The option can normally be used only
5332 by a trusted user, but <option>untrusted_set_sender</option> can be set to allow untrusted
5333 users to use it.
5334 </para>
5335 <para>
5336 Processes running as root or the Exim user are always trusted. Other
5337 trusted users are defined by the <option>trusted_users</option> or <option>trusted_groups</option>
5338 options. In the absence of <option>-f</option>, or if the caller is not trusted, the sender
5339 of a local message is set to the caller&#x2019;s login name at the default qualify
5340 domain.
5341 </para>
5342 <para>
5343 There is one exception to the restriction on the use of <option>-f</option>: an empty sender
5344 can be specified by any user, trusted or not, to create a message that can
5345 never provoke a bounce. An empty sender can be specified either as an empty
5346 string, or as a pair of angle brackets with nothing between them, as in these
5347 examples of shell commands:
5348 </para>
5349 <literallayout class="monospaced">
5350 exim -f '&lt;&gt;' user@domain
5351 exim -f "" user@domain
5352 </literallayout>
5353 <para>
5354 In addition, the use of <option>-f</option> is not restricted when testing a filter file
5355 with <option>-bf</option> or when testing or verifying addresses using the <option>-bt</option> or
5356 <option>-bv</option> options.
5357 </para>
5358 <para>
5359 Allowing untrusted users to change the sender address does not of itself make
5360 it possible to send anonymous mail. Exim still checks that the <emphasis>From:</emphasis> header
5361 refers to the local user, and if it does not, it adds a <emphasis>Sender:</emphasis> header,
5362 though this can be overridden by setting <option>no_local_from_check</option>.
5363 </para>
5364 <para>
5365 White
5366 <indexterm role="concept">
5367 <primary><quote>From</quote> line</primary>
5368 </indexterm>
5369 space between <option>-f</option> and the &lt;<emphasis>address</emphasis>&gt; is optional (that is, they can be
5370 given as two arguments or one combined argument). The sender of a
5371 locally-generated message can also be set (when permitted) by an initial
5372 <quote>From&nbsp;</quote> line in the message &ndash; see the description of <option>-bm</option> above &ndash; but
5373 if <option>-f</option> is also present, it overrides <quote>From&nbsp;</quote>.
5374 </para>
5375 </listitem></varlistentry>
5376 <varlistentry>
5377 <term><option>-G</option></term>
5378 <listitem>
5379 <para>
5380 <indexterm role="option">
5381 <primary><option>-G</option></primary>
5382 </indexterm>
5383 <indexterm role="concept">
5384 <primary>submission fixups, suppressing (command-line)</primary>
5385 </indexterm>
5386 This option is equivalent to an ACL applying:
5387 </para>
5388 <literallayout class="monospaced">
5389 control = suppress_local_fixups
5390 </literallayout>
5391 <para>
5392 for every message received.  Note that Sendmail will complain about such
5393 bad formatting, where Exim silently just does not fix it up.  This may change
5394 in future.
5395 </para>
5396 <para>
5397 As this affects audit information, the caller must be a trusted user to use
5398 this option.
5399 </para>
5400 </listitem></varlistentry>
5401 <varlistentry>
5402 <term><option>-h</option>&nbsp;&lt;<emphasis>number</emphasis>&gt;</term>
5403 <listitem>
5404 <para>
5405 <indexterm role="option">
5406 <primary><option>-h</option></primary>
5407 </indexterm>
5408 <indexterm role="concept">
5409 <primary>Sendmail compatibility</primary>
5410 <secondary><option>-h</option> option ignored</secondary>
5411 </indexterm>
5412 This option is accepted for compatibility with Sendmail, but has no effect. (In
5413 Sendmail it overrides the <quote>hop count</quote> obtained by counting <emphasis>Received:</emphasis>
5414 headers.)
5415 </para>
5416 </listitem></varlistentry>
5417 <varlistentry>
5418 <term><option>-i</option></term>
5419 <listitem>
5420 <para>
5421 <indexterm role="option">
5422 <primary><option>-i</option></primary>
5423 </indexterm>
5424 <indexterm role="concept">
5425 <primary>Solaris</primary>
5426 <secondary><emphasis>mail</emphasis> command</secondary>
5427 </indexterm>
5428 <indexterm role="concept">
5429 <primary>dot</primary>
5430 <secondary>in incoming non-SMTP message</secondary>
5431 </indexterm>
5432 This option, which has the same effect as <option>-oi</option>, specifies that a dot on a
5433 line by itself should not terminate an incoming, non-SMTP message. I can find
5434 no documentation for this option in Solaris 2.4 Sendmail, but the <emphasis>mailx</emphasis>
5435 command in Solaris 2.4 uses it. See also <option>-ti</option>.
5436 </para>
5437 </listitem></varlistentry>
5438 <varlistentry>
5439 <term><option>-L</option>&nbsp;&lt;<emphasis>tag</emphasis>&gt;</term>
5440 <listitem>
5441 <para>
5442 <indexterm role="option">
5443 <primary><option>-L</option></primary>
5444 </indexterm>
5445 <indexterm role="concept">
5446 <primary>syslog</primary>
5447 <secondary>process name; set with flag</secondary>
5448 </indexterm>
5449 This option is equivalent to setting <option>syslog_processname</option> in the config
5450 file and setting <option>log_file_path</option> to <literal>syslog</literal>.
5451 Its use is restricted to administrators.  The configuration file has to be
5452 read and parsed, to determine access rights, before this is set and takes
5453 effect, so early configuration file errors will not honour this flag.
5454 </para>
5455 <para>
5456 The tag should not be longer than 32 characters.
5457 </para>
5458 </listitem></varlistentry>
5459 <varlistentry>
5460 <term><option>-M</option>&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;&nbsp;...</term>
5461 <listitem>
5462 <para>
5463 <indexterm role="option">
5464 <primary><option>-M</option></primary>
5465 </indexterm>
5466 <indexterm role="concept">
5467 <primary>forcing delivery</primary>
5468 </indexterm>
5469 <indexterm role="concept">
5470 <primary>delivery</primary>
5471 <secondary>forcing attempt</secondary>
5472 </indexterm>
5473 <indexterm role="concept">
5474 <primary>frozen messages</primary>
5475 <secondary>forcing delivery</secondary>
5476 </indexterm>
5477 This option requests Exim to run a delivery attempt on each message in turn. If
5478 any of the messages are frozen, they are automatically thawed before the
5479 delivery attempt. The settings of <option>queue_domains</option>, <option>queue_smtp_domains</option>,
5480 and <option>hold_domains</option> are ignored.
5481 </para>
5482 <para>
5483 Retry
5484 <indexterm role="concept">
5485 <primary>hints database</primary>
5486 <secondary>overriding retry hints</secondary>
5487 </indexterm>
5488 hints for any of the addresses are overridden &ndash; Exim tries to deliver even if
5489 the normal retry time has not yet been reached. This option requires the caller
5490 to be an admin user. However, there is an option called <option>prod_requires_admin</option>
5491 which can be set false to relax this restriction (and also the same requirement
5492 for the <option>-q</option>, <option>-R</option>, and <option>-S</option> options).
5493 </para>
5494 <para>
5495 The deliveries happen synchronously, that is, the original Exim process does
5496 not terminate until all the delivery attempts have finished. No output is
5497 produced unless there is a serious error. If you want to see what is happening,
5498 use the <option>-v</option> option as well, or inspect Exim&#x2019;s main log.
5499 </para>
5500 </listitem></varlistentry>
5501 <varlistentry>
5502 <term><option>-Mar</option>&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;&nbsp;&lt;<emphasis>address</emphasis>&gt;&nbsp;&lt;<emphasis>address</emphasis>&gt;&nbsp;...</term>
5503 <listitem>
5504 <para>
5505 <indexterm role="option">
5506 <primary><option>-Mar</option></primary>
5507 </indexterm>
5508 <indexterm role="concept">
5509 <primary>message</primary>
5510 <secondary>adding recipients</secondary>
5511 </indexterm>
5512 <indexterm role="concept">
5513 <primary>recipient</primary>
5514 <secondary>adding</secondary>
5515 </indexterm>
5516 This option requests Exim to add the addresses to the list of recipients of the
5517 message (<quote>ar</quote> for <quote>add recipients</quote>). The first argument must be a message
5518 id, and the remaining ones must be email addresses. However, if the message is
5519 active (in the middle of a delivery attempt), it is not altered. This option
5520 can be used only by an admin user.
5521 </para>
5522 </listitem></varlistentry>
5523 <varlistentry>
5524 <term><option>-MC</option>&nbsp;&lt;<emphasis>transport</emphasis>&gt;&nbsp;&lt;<emphasis>hostname</emphasis>&gt;&nbsp;&lt;<emphasis>sequence&nbsp;number</emphasis>&gt;&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;</term>
5525 <listitem>
5526 <para>
5527 <indexterm role="option">
5528 <primary><option>-MC</option></primary>
5529 </indexterm>
5530 <indexterm role="concept">
5531 <primary>SMTP</primary>
5532 <secondary>passed connection</secondary>
5533 </indexterm>
5534 <indexterm role="concept">
5535 <primary>SMTP</primary>
5536 <secondary>multiple deliveries</secondary>
5537 </indexterm>
5538 <indexterm role="concept">
5539 <primary>multiple SMTP deliveries</primary>
5540 </indexterm>
5541 This option is not intended for use by external callers. It is used internally
5542 by Exim to invoke another instance of itself to deliver a waiting message using
5543 an existing SMTP connection, which is passed as the standard input. Details are
5544 given in chapter <xref linkend="CHAPSMTP"/>. This must be the final option, and the caller
5545 must be root or the Exim user in order to use it.
5546 </para>
5547 </listitem></varlistentry>
5548 <varlistentry>
5549 <term><option>-MCA</option></term>
5550 <listitem>
5551 <para>
5552 <indexterm role="option">
5553 <primary><option>-MCA</option></primary>
5554 </indexterm>
5555 This option is not intended for use by external callers. It is used internally
5556 by Exim in conjunction with the <option>-MC</option> option. It signifies that the
5557 connection to the remote host has been authenticated.
5558 </para>
5559 </listitem></varlistentry>
5560 <varlistentry>
5561 <term><option>-MCP</option></term>
5562 <listitem>
5563 <para>
5564 <indexterm role="option">
5565 <primary><option>-MCP</option></primary>
5566 </indexterm>
5567 This option is not intended for use by external callers. It is used internally
5568 by Exim in conjunction with the <option>-MC</option> option. It signifies that the server to
5569 which Exim is connected supports pipelining.
5570 </para>
5571 </listitem></varlistentry>
5572 <varlistentry>
5573 <term><option>-MCQ</option>&nbsp;&lt;<emphasis>process&nbsp;id</emphasis>&gt;&nbsp;&lt;<emphasis>pipe&nbsp;fd</emphasis>&gt;</term>
5574 <listitem>
5575 <para>
5576 <indexterm role="option">
5577 <primary><option>-MCQ</option></primary>
5578 </indexterm>
5579 This option is not intended for use by external callers. It is used internally
5580 by Exim in conjunction with the <option>-MC</option> option when the original delivery was
5581 started by a queue runner. It passes on the process id of the queue runner,
5582 together with the file descriptor number of an open pipe. Closure of the pipe
5583 signals the final completion of the sequence of processes that are passing
5584 messages through the same SMTP connection.
5585 </para>
5586 </listitem></varlistentry>
5587 <varlistentry>
5588 <term><option>-MCS</option></term>
5589 <listitem>
5590 <para>
5591 <indexterm role="option">
5592 <primary><option>-MCS</option></primary>
5593 </indexterm>
5594 This option is not intended for use by external callers. It is used internally
5595 by Exim in conjunction with the <option>-MC</option> option, and passes on the fact that the
5596 SMTP SIZE option should be used on messages delivered down the existing
5597 connection.
5598 </para>
5599 </listitem></varlistentry>
5600 <varlistentry>
5601 <term><option>-MCT</option></term>
5602 <listitem>
5603 <para>
5604 <indexterm role="option">
5605 <primary><option>-MCT</option></primary>
5606 </indexterm>
5607 This option is not intended for use by external callers. It is used internally
5608 by Exim in conjunction with the <option>-MC</option> option, and passes on the fact that the
5609 host to which Exim is connected supports TLS encryption.
5610 </para>
5611 </listitem></varlistentry>
5612 <varlistentry>
5613 <term><option>-Mc</option>&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;&nbsp;...</term>
5614 <listitem>
5615 <para>
5616 <indexterm role="option">
5617 <primary><option>-Mc</option></primary>
5618 </indexterm>
5619 <indexterm role="concept">
5620 <primary>hints database</primary>
5621 <secondary>not overridden by <option>-Mc</option></secondary>
5622 </indexterm>
5623 <indexterm role="concept">
5624 <primary>delivery</primary>
5625 <secondary>manually started &ndash; not forced</secondary>
5626 </indexterm>
5627 This option requests Exim to run a delivery attempt on each message in turn,
5628 but unlike the <option>-M</option> option, it does check for retry hints, and respects any
5629 that are found. This option is not very useful to external callers. It is
5630 provided mainly for internal use by Exim when it needs to re-invoke itself in
5631 order to regain root privilege for a delivery (see chapter <xref linkend="CHAPsecurity"/>).
5632 However, <option>-Mc</option> can be useful when testing, in order to run a delivery that
5633 respects retry times and other options such as <option>hold_domains</option> that are
5634 overridden when <option>-M</option> is used. Such a delivery does not count as a queue run.
5635 If you want to run a specific delivery as if in a queue run, you should use
5636 <option>-q</option> with a message id argument. A distinction between queue run deliveries
5637 and other deliveries is made in one or two places.
5638 </para>
5639 </listitem></varlistentry>
5640 <varlistentry>
5641 <term><option>-Mes</option>&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;&nbsp;&lt;<emphasis>address</emphasis>&gt;</term>
5642 <listitem>
5643 <para>
5644 <indexterm role="option">
5645 <primary><option>-Mes</option></primary>
5646 </indexterm>
5647 <indexterm role="concept">
5648 <primary>message</primary>
5649 <secondary>changing sender</secondary>
5650 </indexterm>
5651 <indexterm role="concept">
5652 <primary>sender</primary>
5653 <secondary>changing</secondary>
5654 </indexterm>
5655 This option requests Exim to change the sender address in the message to the
5656 given address, which must be a fully qualified address or <quote>&lt;&gt;</quote> (<quote>es</quote> for
5657 <quote>edit sender</quote>). There must be exactly two arguments. The first argument must
5658 be a message id, and the second one an email address. However, if the message
5659 is active (in the middle of a delivery attempt), its status is not altered.
5660 This option can be used only by an admin user.
5661 </para>
5662 </listitem></varlistentry>
5663 <varlistentry>
5664 <term><option>-Mf</option>&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;&nbsp;...</term>
5665 <listitem>
5666 <para>
5667 <indexterm role="option">
5668 <primary><option>-Mf</option></primary>
5669 </indexterm>
5670 <indexterm role="concept">
5671 <primary>freezing messages</primary>
5672 </indexterm>
5673 <indexterm role="concept">
5674 <primary>message</primary>
5675 <secondary>manually freezing</secondary>
5676 </indexterm>
5677 This option requests Exim to mark each listed message as <quote>frozen</quote>. This
5678 prevents any delivery attempts taking place until the message is <quote>thawed</quote>,
5679 either manually or as a result of the <option>auto_thaw</option> configuration option.
5680 However, if any of the messages are active (in the middle of a delivery
5681 attempt), their status is not altered. This option can be used only by an admin
5682 user.
5683 </para>
5684 </listitem></varlistentry>
5685 <varlistentry>
5686 <term><option>-Mg</option>&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;&nbsp;...</term>
5687 <listitem>
5688 <para>
5689 <indexterm role="option">
5690 <primary><option>-Mg</option></primary>
5691 </indexterm>
5692 <indexterm role="concept">
5693 <primary>giving up on messages</primary>
5694 </indexterm>
5695 <indexterm role="concept">
5696 <primary>message</primary>
5697 <secondary>abandoning delivery attempts</secondary>
5698 </indexterm>
5699 <indexterm role="concept">
5700 <primary>delivery</primary>
5701 <secondary>abandoning further attempts</secondary>
5702 </indexterm>
5703 This option requests Exim to give up trying to deliver the listed messages,
5704 including any that are frozen. However, if any of the messages are active,
5705 their status is not altered. For non-bounce messages, a delivery error message
5706 is sent to the sender, containing the text <quote>cancelled by administrator</quote>.
5707 Bounce messages are just discarded. This option can be used only by an admin
5708 user.
5709 </para>
5710 </listitem></varlistentry>
5711 <varlistentry>
5712 <term><option>-Mmad</option>&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;&nbsp;...</term>
5713 <listitem>
5714 <para>
5715 <indexterm role="option">
5716 <primary><option>-Mmad</option></primary>
5717 </indexterm>
5718 <indexterm role="concept">
5719 <primary>delivery</primary>
5720 <secondary>cancelling all</secondary>
5721 </indexterm>
5722 This option requests Exim to mark all the recipient addresses in the messages
5723 as already delivered (<quote>mad</quote> for <quote>mark all delivered</quote>). However, if any
5724 message is active (in the middle of a delivery attempt), its status is not
5725 altered. This option can be used only by an admin user.
5726 </para>
5727 </listitem></varlistentry>
5728 <varlistentry>
5729 <term><option>-Mmd</option>&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;&nbsp;&lt;<emphasis>address</emphasis>&gt;&nbsp;&lt;<emphasis>address</emphasis>&gt;&nbsp;...</term>
5730 <listitem>
5731 <para>
5732 <indexterm role="option">
5733 <primary><option>-Mmd</option></primary>
5734 </indexterm>
5735 <indexterm role="concept">
5736 <primary>delivery</primary>
5737 <secondary>cancelling by address</secondary>
5738 </indexterm>
5739 <indexterm role="concept">
5740 <primary>recipient</primary>
5741 <secondary>removing</secondary>
5742 </indexterm>
5743 <indexterm role="concept">
5744 <primary>removing recipients</primary>
5745 </indexterm>
5746 This option requests Exim to mark the given addresses as already delivered
5747 (<quote>md</quote> for <quote>mark delivered</quote>). The first argument must be a message id, and
5748 the remaining ones must be email addresses. These are matched to recipient
5749 addresses in the message in a case-sensitive manner. If the message is active
5750 (in the middle of a delivery attempt), its status is not altered. This option
5751 can be used only by an admin user.
5752 </para>
5753 </listitem></varlistentry>
5754 <varlistentry>
5755 <term><option>-Mrm</option>&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;&nbsp;...</term>
5756 <listitem>
5757 <para>
5758 <indexterm role="option">
5759 <primary><option>-Mrm</option></primary>
5760 </indexterm>
5761 <indexterm role="concept">
5762 <primary>removing messages</primary>
5763 </indexterm>
5764 <indexterm role="concept">
5765 <primary>abandoning mail</primary>
5766 </indexterm>
5767 <indexterm role="concept">
5768 <primary>message</primary>
5769 <secondary>manually discarding</secondary>
5770 </indexterm>
5771 This option requests Exim to remove the given messages from the queue. No
5772 bounce messages are sent; each message is simply forgotten. However, if any of
5773 the messages are active, their status is not altered. This option can be used
5774 only by an admin user or by the user who originally caused the message to be
5775 placed on the queue.
5776 </para>
5777 </listitem></varlistentry>
5778 <varlistentry>
5779 <term><option>-Mset</option>&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;</term>
5780 <listitem>
5781 <para>
5782 <indexterm role="option">
5783 <primary><option>-Mset</option></primary>
5784 </indexterm>
5785 <indexterm role="concept">
5786 <primary>testing</primary>
5787 <secondary>string expansion</secondary>
5788 </indexterm>
5789 <indexterm role="concept">
5790 <primary>expansion</primary>
5791 <secondary>testing</secondary>
5792 </indexterm>
5793 This option is useful only in conjunction with <option>-be</option> (that is, when testing
5794 string expansions). Exim loads the given message from its spool before doing
5795 the test expansions, thus setting message-specific variables such as
5796 <varname>$message_size</varname> and the header variables. The <varname>$recipients</varname> variable is made
5797 available. This feature is provided to make it easier to test expansions that
5798 make use of these variables. However, this option can be used only by an admin
5799 user. See also <option>-bem</option>.
5800 </para>
5801 </listitem></varlistentry>
5802 <varlistentry>
5803 <term><option>-Mt</option>&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;&nbsp;...</term>
5804 <listitem>
5805 <para>
5806 <indexterm role="option">
5807 <primary><option>-Mt</option></primary>
5808 </indexterm>
5809 <indexterm role="concept">
5810 <primary>thawing messages</primary>
5811 </indexterm>
5812 <indexterm role="concept">
5813 <primary>unfreezing messages</primary>
5814 </indexterm>
5815 <indexterm role="concept">
5816 <primary>frozen messages</primary>
5817 <secondary>thawing</secondary>
5818 </indexterm>
5819 <indexterm role="concept">
5820 <primary>message</primary>
5821 <secondary>thawing frozen</secondary>
5822 </indexterm>
5823 This option requests Exim to <quote>thaw</quote> any of the listed messages that are
5824 <quote>frozen</quote>, so that delivery attempts can resume. However, if any of the
5825 messages are active, their status is not altered. This option can be used only
5826 by an admin user.
5827 </para>
5828 </listitem></varlistentry>
5829 <varlistentry>
5830 <term><option>-Mvb</option>&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;</term>
5831 <listitem>
5832 <para>
5833 <indexterm role="option">
5834 <primary><option>-Mvb</option></primary>
5835 </indexterm>
5836 <indexterm role="concept">
5837 <primary>listing</primary>
5838 <secondary>message body</secondary>
5839 </indexterm>
5840 <indexterm role="concept">
5841 <primary>message</primary>
5842 <secondary>listing body of</secondary>
5843 </indexterm>
5844 This option causes the contents of the message body (-D) spool file to be
5845 written to the standard output. This option can be used only by an admin user.
5846 </para>
5847 </listitem></varlistentry>
5848 <varlistentry>
5849 <term><option>-Mvc</option>&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;</term>
5850 <listitem>
5851 <para>
5852 <indexterm role="option">
5853 <primary><option>-Mvc</option></primary>
5854 </indexterm>
5855 <indexterm role="concept">
5856 <primary>message</primary>
5857 <secondary>listing in RFC 2822 format</secondary>
5858 </indexterm>
5859 <indexterm role="concept">
5860 <primary>listing</primary>
5861 <secondary>message in RFC 2822 format</secondary>
5862 </indexterm>
5863 This option causes a copy of the complete message (header lines plus body) to
5864 be written to the standard output in RFC 2822 format. This option can be used
5865 only by an admin user.
5866 </para>
5867 </listitem></varlistentry>
5868 <varlistentry>
5869 <term><option>-Mvh</option>&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;</term>
5870 <listitem>
5871 <para>
5872 <indexterm role="option">
5873 <primary><option>-Mvh</option></primary>
5874 </indexterm>
5875 <indexterm role="concept">
5876 <primary>listing</primary>
5877 <secondary>message headers</secondary>
5878 </indexterm>
5879 <indexterm role="concept">
5880 <primary>header lines</primary>
5881 <secondary>listing</secondary>
5882 </indexterm>
5883 <indexterm role="concept">
5884 <primary>message</primary>
5885 <secondary>listing header lines</secondary>
5886 </indexterm>
5887 This option causes the contents of the message headers (-H) spool file to be
5888 written to the standard output. This option can be used only by an admin user.
5889 </para>
5890 </listitem></varlistentry>
5891 <varlistentry>
5892 <term><option>-Mvl</option>&nbsp;&lt;<emphasis>message&nbsp;id</emphasis>&gt;</term>
5893 <listitem>
5894 <para>
5895 <indexterm role="option">
5896 <primary><option>-Mvl</option></primary>
5897 </indexterm>
5898 <indexterm role="concept">
5899 <primary>listing</primary>
5900 <secondary>message log</secondary>
5901 </indexterm>
5902 <indexterm role="concept">
5903 <primary>message</primary>
5904 <secondary>listing message log</secondary>
5905 </indexterm>
5906 This option causes the contents of the message log spool file to be written to
5907 the standard output. This option can be used only by an admin user.
5908 </para>
5909 </listitem></varlistentry>
5910 <varlistentry>
5911 <term><option>-m</option></term>
5912 <listitem>
5913 <para>
5914 <indexterm role="option">
5915 <primary><option>-m</option></primary>
5916 </indexterm>
5917 This is apparently a synonym for <option>-om</option> that is accepted by Sendmail, so Exim
5918 treats it that way too.
5919 </para>
5920 </listitem></varlistentry>
5921 <varlistentry>
5922 <term><option>-N</option></term>
5923 <listitem>
5924 <para>
5925 <indexterm role="option">
5926 <primary><option>-N</option></primary>
5927 </indexterm>
5928 <indexterm role="concept">
5929 <primary>debugging</primary>
5930 <secondary><option>-N</option> option</secondary>
5931 </indexterm>
5932 <indexterm role="concept">
5933 <primary>debugging</primary>
5934 <secondary>suppressing delivery</secondary>
5935 </indexterm>
5936 This is a debugging option that inhibits delivery of a message at the transport
5937 level. It implies <option>-v</option>. Exim goes through many of the motions of delivery &ndash;
5938 it just doesn&#x2019;t actually transport the message, but instead behaves as if it
5939 had successfully done so. However, it does not make any updates to the retry
5940 database, and the log entries for deliveries are flagged with <quote>*&gt;</quote> rather
5941 than <quote>=&gt;</quote>.
5942 </para>
5943 <para>
5944 Because <option>-N</option> discards any message to which it applies, only root or the Exim
5945 user are allowed to use it with <option>-bd</option>, <option>-q</option>, <option>-R</option> or <option>-M</option>. In other
5946 words, an ordinary user can use it only when supplying an incoming message to
5947 which it will apply. Although transportation never fails when <option>-N</option> is set, an
5948 address may be deferred because of a configuration problem on a transport, or a
5949 routing problem. Once <option>-N</option> has been used for a delivery attempt, it sticks to
5950 the message, and applies to any subsequent delivery attempts that may happen
5951 for that message.
5952 </para>
5953 </listitem></varlistentry>
5954 <varlistentry>
5955 <term><option>-n</option></term>
5956 <listitem>
5957 <para>
5958 <indexterm role="option">
5959 <primary><option>-n</option></primary>
5960 </indexterm>
5961 This option is interpreted by Sendmail to mean <quote>no aliasing</quote>.
5962 For normal modes of operation, it is ignored by Exim.
5963 When combined with <option>-bP</option> it suppresses the name of an option from being output.
5964 </para>
5965 </listitem></varlistentry>
5966 <varlistentry>
5967 <term><option>-O</option>&nbsp;&lt;<emphasis>data</emphasis>&gt;</term>
5968 <listitem>
5969 <para>
5970 <indexterm role="option">
5971 <primary><option>-O</option></primary>
5972 </indexterm>
5973 This option is interpreted by Sendmail to mean <literal>set option</literal>. It is ignored by
5974 Exim.
5975 </para>
5976 </listitem></varlistentry>
5977 <varlistentry>
5978 <term><option>-oA</option>&nbsp;&lt;<emphasis>file&nbsp;name</emphasis>&gt;</term>
5979 <listitem>
5980 <para>
5981 <indexterm role="option">
5982 <primary><option>-oA</option></primary>
5983 </indexterm>
5984 <indexterm role="concept">
5985 <primary>Sendmail compatibility</primary>
5986 <secondary><option>-oA</option> option</secondary>
5987 </indexterm>
5988 This option is used by Sendmail in conjunction with <option>-bi</option> to specify an
5989 alternative alias file name. Exim handles <option>-bi</option> differently; see the
5990 description above.
5991 </para>
5992 </listitem></varlistentry>
5993 <varlistentry>
5994 <term><option>-oB</option>&nbsp;&lt;<emphasis>n</emphasis>&gt;</term>
5995 <listitem>
5996 <para>
5997 <indexterm role="option">
5998 <primary><option>-oB</option></primary>
5999 </indexterm>
6000 <indexterm role="concept">
6001 <primary>SMTP</primary>
6002 <secondary>passed connection</secondary>
6003 </indexterm>
6004 <indexterm role="concept">
6005 <primary>SMTP</primary>
6006 <secondary>multiple deliveries</secondary>
6007 </indexterm>
6008 <indexterm role="concept">
6009 <primary>multiple SMTP deliveries</primary>
6010 </indexterm>
6011 This is a debugging option which limits the maximum number of messages that can
6012 be delivered down one SMTP connection, overriding the value set in any <command>smtp</command>
6013 transport. If &lt;<emphasis>n</emphasis>&gt; is omitted, the limit is set to 1.
6014 </para>
6015 </listitem></varlistentry>
6016 <varlistentry>
6017 <term><option>-odb</option></term>
6018 <listitem>
6019 <para>
6020 <indexterm role="option">
6021 <primary><option>-odb</option></primary>
6022 </indexterm>
6023 <indexterm role="concept">
6024 <primary>background delivery</primary>
6025 </indexterm>
6026 <indexterm role="concept">
6027 <primary>delivery</primary>
6028 <secondary>in the background</secondary>
6029 </indexterm>
6030 This option applies to all modes in which Exim accepts incoming messages,
6031 including the listening daemon. It requests <quote>background</quote> delivery of such
6032 messages, which means that the accepting process automatically starts a
6033 delivery process for each message received, but does not wait for the delivery
6034 processes to finish.
6035 </para>
6036 <para>
6037 When all the messages have been received, the reception process exits,
6038 leaving the delivery processes to finish in their own time. The standard output
6039 and error streams are closed at the start of each delivery process.
6040 This is the default action if none of the <option>-od</option> options are present.
6041 </para>
6042 <para>
6043 If one of the queueing options in the configuration file
6044 (<option>queue_only</option> or <option>queue_only_file</option>, for example) is in effect, <option>-odb</option>
6045 overrides it if <option>queue_only_override</option> is set true, which is the default
6046 setting. If <option>queue_only_override</option> is set false, <option>-odb</option> has no effect.
6047 </para>
6048 </listitem></varlistentry>
6049 <varlistentry>
6050 <term><option>-odf</option></term>
6051 <listitem>
6052 <para>
6053 <indexterm role="option">
6054 <primary><option>-odf</option></primary>
6055 </indexterm>
6056 <indexterm role="concept">
6057 <primary>foreground delivery</primary>
6058 </indexterm>
6059 <indexterm role="concept">
6060 <primary>delivery</primary>
6061 <secondary>in the foreground</secondary>
6062 </indexterm>
6063 This option requests <quote>foreground</quote> (synchronous) delivery when Exim has
6064 accepted a locally-generated message. (For the daemon it is exactly the same as
6065 <option>-odb</option>.) A delivery process is automatically started to deliver the message,
6066 and Exim waits for it to complete before proceeding.
6067 </para>
6068 <para>
6069 The original Exim reception process does not finish until the delivery
6070 process for the final message has ended. The standard error stream is left open
6071 during deliveries.
6072 </para>
6073 <para>
6074 However, like <option>-odb</option>, this option has no effect if <option>queue_only_override</option> is
6075 false and one of the queueing options in the configuration file is in effect.
6076 </para>
6077 <para>
6078 If there is a temporary delivery error during foreground delivery, the
6079 message is left on the queue for later delivery, and the original reception
6080 process exits. See chapter <xref linkend="CHAPnonqueueing"/> for a way of setting up a
6081 restricted configuration that never queues messages.
6082 </para>
6083 </listitem></varlistentry>
6084 <varlistentry>
6085 <term><option>-odi</option></term>
6086 <listitem>
6087 <para>
6088 <indexterm role="option">
6089 <primary><option>-odi</option></primary>
6090 </indexterm>
6091 This option is synonymous with <option>-odf</option>. It is provided for compatibility with
6092 Sendmail.
6093 </para>
6094 </listitem></varlistentry>
6095 <varlistentry>
6096 <term><option>-odq</option></term>
6097 <listitem>
6098 <para>
6099 <indexterm role="option">
6100 <primary><option>-odq</option></primary>
6101 </indexterm>
6102 <indexterm role="concept">
6103 <primary>non-immediate delivery</primary>
6104 </indexterm>
6105 <indexterm role="concept">
6106 <primary>delivery</primary>
6107 <secondary>suppressing immediate</secondary>
6108 </indexterm>
6109 <indexterm role="concept">
6110 <primary>queueing incoming messages</primary>
6111 </indexterm>
6112 This option applies to all modes in which Exim accepts incoming messages,
6113 including the listening daemon. It specifies that the accepting process should
6114 not automatically start a delivery process for each message received. Messages
6115 are placed on the queue, and remain there until a subsequent queue runner
6116 process encounters them. There are several configuration options (such as
6117 <option>queue_only</option>) that can be used to queue incoming messages under certain
6118 conditions. This option overrides all of them and also <option>-odqs</option>. It always
6119 forces queueing.
6120 </para>
6121 </listitem></varlistentry>
6122 <varlistentry>
6123 <term><option>-odqs</option></term>
6124 <listitem>
6125 <para>
6126 <indexterm role="option">
6127 <primary><option>-odqs</option></primary>
6128 </indexterm>
6129 <indexterm role="concept">
6130 <primary>SMTP</primary>
6131 <secondary>delaying delivery</secondary>
6132 </indexterm>
6133 This option is a hybrid between <option>-odb</option>/<option>-odi</option> and <option>-odq</option>.
6134 However, like <option>-odb</option> and <option>-odi</option>, this option has no effect if
6135 <option>queue_only_override</option> is false and one of the queueing options in the
6136 configuration file is in effect.
6137 </para>
6138 <para>
6139 When <option>-odqs</option> does operate, a delivery process is started for each incoming
6140 message, in the background by default, but in the foreground if <option>-odi</option> is
6141 also present. The recipient addresses are routed, and local deliveries are done
6142 in the normal way. However, if any SMTP deliveries are required, they are not
6143 done at this time, so the message remains on the queue until a subsequent queue
6144 runner process encounters it. Because routing was done, Exim knows which
6145 messages are waiting for which hosts, and so a number of messages for the same
6146 host can be sent in a single SMTP connection. The <option>queue_smtp_domains</option>
6147 configuration option has the same effect for specific domains. See also the
6148 <option>-qq</option> option.
6149 </para>
6150 </listitem></varlistentry>
6151 <varlistentry>
6152 <term><option>-oee</option></term>
6153 <listitem>
6154 <para>
6155 <indexterm role="option">
6156 <primary><option>-oee</option></primary>
6157 </indexterm>
6158 <indexterm role="concept">
6159 <primary>error</primary>
6160 <secondary>reporting</secondary>
6161 </indexterm>
6162 If an error is detected while a non-SMTP message is being received (for
6163 example, a malformed address), the error is reported to the sender in a mail
6164 message.
6165 </para>
6166 <para>
6167 <indexterm role="concept">
6168 <primary>return code</primary>
6169 <secondary>for <option>-oee</option></secondary>
6170 </indexterm>
6171 Provided
6172 this error message is successfully sent, the Exim receiving process
6173 exits with a return code of zero. If not, the return code is 2 if the problem
6174 is that the original message has no recipients, or 1 for any other error.
6175 This is the default <option>-oe</option><emphasis>x</emphasis> option if Exim is called as <emphasis>rmail</emphasis>.
6176 </para>
6177 </listitem></varlistentry>
6178 <varlistentry>
6179 <term><option>-oem</option></term>
6180 <listitem>
6181 <para>
6182 <indexterm role="option">
6183 <primary><option>-oem</option></primary>
6184 </indexterm>
6185 <indexterm role="concept">
6186 <primary>error</primary>
6187 <secondary>reporting</secondary>
6188 </indexterm>
6189 <indexterm role="concept">
6190 <primary>return code</primary>
6191 <secondary>for <option>-oem</option></secondary>
6192 </indexterm>
6193 This is the same as <option>-oee</option>, except that Exim always exits with a non-zero
6194 return code, whether or not the error message was successfully sent.
6195 This is the default <option>-oe</option><emphasis>x</emphasis> option, unless Exim is called as <emphasis>rmail</emphasis>.
6196 </para>
6197 </listitem></varlistentry>
6198 <varlistentry>
6199 <term><option>-oep</option></term>
6200 <listitem>
6201 <para>
6202 <indexterm role="option">
6203 <primary><option>-oep</option></primary>
6204 </indexterm>
6205 <indexterm role="concept">
6206 <primary>error</primary>
6207 <secondary>reporting</secondary>
6208 </indexterm>
6209 If an error is detected while a non-SMTP message is being received, the
6210 error is reported by writing a message to the standard error file (stderr).
6211 <indexterm role="concept">
6212 <primary>return code</primary>
6213 <secondary>for <option>-oep</option></secondary>
6214 </indexterm>
6215 The return code is 1 for all errors.
6216 </para>
6217 </listitem></varlistentry>
6218 <varlistentry>
6219 <term><option>-oeq</option></term>
6220 <listitem>
6221 <para>
6222 <indexterm role="option">
6223 <primary><option>-oeq</option></primary>
6224 </indexterm>
6225 <indexterm role="concept">
6226 <primary>error</primary>
6227 <secondary>reporting</secondary>
6228 </indexterm>
6229 This option is supported for compatibility with Sendmail, but has the same
6230 effect as <option>-oep</option>.
6231 </para>
6232 </listitem></varlistentry>
6233 <varlistentry>
6234 <term><option>-oew</option></term>
6235 <listitem>
6236 <para>
6237 <indexterm role="option">
6238 <primary><option>-oew</option></primary>
6239 </indexterm>
6240 <indexterm role="concept">
6241 <primary>error</primary>
6242 <secondary>reporting</secondary>
6243 </indexterm>
6244 This option is supported for compatibility with Sendmail, but has the same
6245 effect as <option>-oem</option>.
6246 </para>
6247 </listitem></varlistentry>
6248 <varlistentry>
6249 <term><option>-oi</option></term>
6250 <listitem>
6251 <para>
6252 <indexterm role="option">
6253 <primary><option>-oi</option></primary>
6254 </indexterm>
6255 <indexterm role="concept">
6256 <primary>dot</primary>
6257 <secondary>in incoming non-SMTP message</secondary>
6258 </indexterm>
6259 This option, which has the same effect as <option>-i</option>, specifies that a dot on a
6260 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
6261 single dot does terminate, though Exim does no special processing for other
6262 lines that start with a dot. This option is set by default if Exim is called as
6263 <emphasis>rmail</emphasis>. See also <option>-ti</option>.
6264 </para>
6265 </listitem></varlistentry>
6266 <varlistentry>
6267 <term><option>-oitrue</option></term>
6268 <listitem>
6269 <para>
6270 <indexterm role="option">
6271 <primary><option>-oitrue</option></primary>
6272 </indexterm>
6273 This option is treated as synonymous with <option>-oi</option>.
6274 </para>
6275 </listitem></varlistentry>
6276 <varlistentry>
6277 <term><option>-oMa</option>&nbsp;&lt;<emphasis>host&nbsp;address</emphasis>&gt;</term>
6278 <listitem>
6279 <para>
6280 <indexterm role="option">
6281 <primary><option>-oMa</option></primary>
6282 </indexterm>
6283 <indexterm role="concept">
6284 <primary>sender</primary>
6285 <secondary>host address, specifying for local message</secondary>
6286 </indexterm>
6287 A number of options starting with <option>-oM</option> can be used to set values associated
6288 with remote hosts on locally-submitted messages (that is, messages not received
6289 over TCP/IP). These options can be used by any caller in conjunction with the
6290 <option>-bh</option>, <option>-be</option>, <option>-bf</option>, <option>-bF</option>, <option>-bt</option>, or <option>-bv</option> testing options. In
6291 other circumstances, they are ignored unless the caller is trusted.
6292 </para>
6293 <para>
6294 The <option>-oMa</option> option sets the sender host address. This may include a port
6295 number at the end, after a full stop (period). For example:
6296 </para>
6297 <literallayout class="monospaced">
6298 exim -bs -oMa 10.9.8.7.1234
6299 </literallayout>
6300 <para>
6301 An alternative syntax is to enclose the IP address in square brackets,
6302 followed by a colon and the port number:
6303 </para>
6304 <literallayout class="monospaced">
6305 exim -bs -oMa [10.9.8.7]:1234
6306 </literallayout>
6307 <para>
6308 The IP address is placed in the <varname>$sender_host_address</varname> variable, and the
6309 port, if present, in <varname>$sender_host_port</varname>. If both <option>-oMa</option> and <option>-bh</option>
6310 are present on the command line, the sender host IP address is taken from
6311 whichever one is last.
6312 </para>
6313 </listitem></varlistentry>
6314 <varlistentry>
6315 <term><option>-oMaa</option>&nbsp;&lt;<emphasis>name</emphasis>&gt;</term>
6316 <listitem>
6317 <para>
6318 <indexterm role="option">
6319 <primary><option>-oMaa</option></primary>
6320 </indexterm>
6321 <indexterm role="concept">
6322 <primary>authentication</primary>
6323 <secondary>name, specifying for local message</secondary>
6324 </indexterm>
6325 See <option>-oMa</option> above for general remarks about the <option>-oM</option> options. The <option>-oMaa</option>
6326 option sets the value of <varname>$sender_host_authenticated</varname> (the authenticator
6327 name). See chapter <xref linkend="CHAPSMTPAUTH"/> for a discussion of SMTP authentication.
6328 This option can be used with <option>-bh</option> and <option>-bs</option> to set up an
6329 authenticated SMTP session without actually using the SMTP AUTH command.
6330 </para>
6331 </listitem></varlistentry>
6332 <varlistentry>
6333 <term><option>-oMai</option>&nbsp;&lt;<emphasis>string</emphasis>&gt;</term>
6334 <listitem>
6335 <para>
6336 <indexterm role="option">
6337 <primary><option>-oMai</option></primary>
6338 </indexterm>
6339 <indexterm role="concept">
6340 <primary>authentication</primary>
6341 <secondary>id, specifying for local message</secondary>
6342 </indexterm>
6343 See <option>-oMa</option> above for general remarks about the <option>-oM</option> options. The <option>-oMai</option>
6344 option sets the value of <varname>$authenticated_id</varname> (the id that was authenticated).
6345 This overrides the default value (the caller&#x2019;s login id, except with <option>-bh</option>,
6346 where there is no default) for messages from local sources. See chapter
6347 <xref linkend="CHAPSMTPAUTH"/> for a discussion of authenticated ids.
6348 </para>
6349 </listitem></varlistentry>
6350 <varlistentry>
6351 <term><option>-oMas</option>&nbsp;&lt;<emphasis>address</emphasis>&gt;</term>
6352 <listitem>
6353 <para>
6354 <indexterm role="option">
6355 <primary><option>-oMas</option></primary>
6356 </indexterm>
6357 <indexterm role="concept">
6358 <primary>authentication</primary>
6359 <secondary>sender, specifying for local message</secondary>
6360 </indexterm>
6361 See <option>-oMa</option> above for general remarks about the <option>-oM</option> options. The <option>-oMas</option>
6362 option sets the authenticated sender value in <varname>$authenticated_sender</varname>. It
6363 overrides the sender address that is created from the caller&#x2019;s login id for
6364 messages from local sources, except when <option>-bh</option> is used, when there is no
6365 default. For both <option>-bh</option> and <option>-bs</option>, an authenticated sender that is
6366 specified on a MAIL command overrides this value. See chapter
6367 <xref linkend="CHAPSMTPAUTH"/> for a discussion of authenticated senders.
6368 </para>
6369 </listitem></varlistentry>
6370 <varlistentry>
6371 <term><option>-oMi</option>&nbsp;&lt;<emphasis>interface&nbsp;address</emphasis>&gt;</term>
6372 <listitem>
6373 <para>
6374 <indexterm role="option">
6375 <primary><option>-oMi</option></primary>
6376 </indexterm>
6377 <indexterm role="concept">
6378 <primary>interface</primary>
6379 <secondary>address, specifying for local message</secondary>
6380 </indexterm>
6381 See <option>-oMa</option> above for general remarks about the <option>-oM</option> options. The <option>-oMi</option>
6382 option sets the IP interface address value. A port number may be included,
6383 using the same syntax as for <option>-oMa</option>. The interface address is placed in
6384 <varname>$received_ip_address</varname> and the port number, if present, in <varname>$received_port</varname>.
6385 </para>
6386 </listitem></varlistentry>
6387 <varlistentry>
6388 <term><option>-oMm</option>&nbsp;&lt;<emphasis>message&nbsp;reference</emphasis>&gt;</term>
6389 <listitem>
6390 <para>
6391 <indexterm role="option">
6392 <primary><option>-oMm</option></primary>
6393 </indexterm>
6394 <indexterm role="concept">
6395 <primary>message reference</primary>
6396 <secondary>message reference, specifying for local message</secondary>
6397 </indexterm>
6398 See <option>-oMa</option> above for general remarks about the <option>-oM</option> options. The <option>-oMm</option>
6399 option sets the message reference, e.g. message-id, and is logged during
6400 delivery. This is useful when some kind of audit trail is required to tie
6401 messages together. The format of the message reference is checked and will
6402 abort if the format is invalid. The option will only be accepted if exim is
6403 running in trusted mode, not as any regular user.
6404 </para>
6405 <para>
6406 The best example of a message reference is when Exim sends a bounce message.
6407 The message reference is the message-id of the original message for which Exim
6408 is sending the bounce.
6409 </para>
6410 </listitem></varlistentry>
6411 <varlistentry>
6412 <term><option>-oMr</option>&nbsp;&lt;<emphasis>protocol&nbsp;name</emphasis>&gt;</term>
6413 <listitem>
6414 <para>
6415 <indexterm role="option">
6416 <primary><option>-oMr</option></primary>
6417 </indexterm>
6418 <indexterm role="concept">
6419 <primary>protocol, specifying for local message</primary>
6420 </indexterm>
6421 <indexterm role="variable">
6422 <primary><varname>$received_protocol</varname></primary>
6423 </indexterm>
6424 See <option>-oMa</option> above for general remarks about the <option>-oM</option> options. The <option>-oMr</option>
6425 option sets the received protocol value that is stored in
6426 <varname>$received_protocol</varname>. However, it does not apply (and is ignored) when <option>-bh</option>
6427 or <option>-bs</option> is used. For <option>-bh</option>, the protocol is forced to one of the standard
6428 SMTP protocol names (see the description of <varname>$received_protocol</varname> in section
6429 <xref linkend="SECTexpvar"/>). For <option>-bs</option>, the protocol is always <quote>local-</quote> followed by
6430 one of those same names. For <option>-bS</option> (batched SMTP) however, the protocol can
6431 be set by <option>-oMr</option>.
6432 </para>
6433 </listitem></varlistentry>
6434 <varlistentry>
6435 <term><option>-oMs</option>&nbsp;&lt;<emphasis>host&nbsp;name</emphasis>&gt;</term>
6436 <listitem>
6437 <para>
6438 <indexterm role="option">
6439 <primary><option>-oMs</option></primary>
6440 </indexterm>
6441 <indexterm role="concept">
6442 <primary>sender</primary>
6443 <secondary>host name, specifying for local message</secondary>
6444 </indexterm>
6445 See <option>-oMa</option> above for general remarks about the <option>-oM</option> options. The <option>-oMs</option>
6446 option sets the sender host name in <varname>$sender_host_name</varname>. When this option is
6447 present, Exim does not attempt to look up a host name from an IP address; it
6448 uses the name it is given.
6449 </para>
6450 </listitem></varlistentry>
6451 <varlistentry>
6452 <term><option>-oMt</option>&nbsp;&lt;<emphasis>ident&nbsp;string</emphasis>&gt;</term>
6453 <listitem>
6454 <para>
6455 <indexterm role="option">
6456 <primary><option>-oMt</option></primary>
6457 </indexterm>
6458 <indexterm role="concept">
6459 <primary>sender</primary>
6460 <secondary>ident string, specifying for local message</secondary>
6461 </indexterm>
6462 See <option>-oMa</option> above for general remarks about the <option>-oM</option> options. The <option>-oMt</option>
6463 option sets the sender ident value in <varname>$sender_ident</varname>. The default setting for
6464 local callers is the login id of the calling process, except when <option>-bh</option> is
6465 used, when there is no default.
6466 </para>
6467 </listitem></varlistentry>
6468 <varlistentry>
6469 <term><option>-om</option></term>
6470 <listitem>
6471 <para>
6472 <indexterm role="option">
6473 <primary><option>-om</option></primary>
6474 </indexterm>
6475 <indexterm role="concept">
6476 <primary>Sendmail compatibility</primary>
6477 <secondary><option>-om</option> option ignored</secondary>
6478 </indexterm>
6479 In Sendmail, this option means <quote>me too</quote>, indicating that the sender of a
6480 message should receive a copy of the message if the sender appears in an alias
6481 expansion. Exim always does this, so the option does nothing.
6482 </para>
6483 </listitem></varlistentry>
6484 <varlistentry>
6485 <term><option>-oo</option></term>
6486 <listitem>
6487 <para>
6488 <indexterm role="option">
6489 <primary><option>-oo</option></primary>
6490 </indexterm>
6491 <indexterm role="concept">
6492 <primary>Sendmail compatibility</primary>
6493 <secondary><option>-oo</option> option ignored</secondary>
6494 </indexterm>
6495 This option is ignored. In Sendmail it specifies <quote>old style headers</quote>,
6496 whatever that means.
6497 </para>
6498 </listitem></varlistentry>
6499 <varlistentry>
6500 <term><option>-oP</option>&nbsp;&lt;<emphasis>path</emphasis>&gt;</term>
6501 <listitem>
6502 <para>
6503 <indexterm role="option">
6504 <primary><option>-oP</option></primary>
6505 </indexterm>
6506 <indexterm role="concept">
6507 <primary>pid (process id)</primary>
6508 <secondary>of daemon</secondary>
6509 </indexterm>
6510 <indexterm role="concept">
6511 <primary>daemon</primary>
6512 <secondary>process id (pid)</secondary>
6513 </indexterm>
6514 This option is useful only in conjunction with <option>-bd</option> or <option>-q</option> with a time
6515 value. The option specifies the file to which the process id of the daemon is
6516 written. When <option>-oX</option> is used with <option>-bd</option>, or when <option>-q</option> with a time is used
6517 without <option>-bd</option>, this is the only way of causing Exim to write a pid file,
6518 because in those cases, the normal pid file is not used.
6519 </para>
6520 </listitem></varlistentry>
6521 <varlistentry>
6522 <term><option>-or</option>&nbsp;&lt;<emphasis>time</emphasis>&gt;</term>
6523 <listitem>
6524 <para>
6525 <indexterm role="option">
6526 <primary><option>-or</option></primary>
6527 </indexterm>
6528 <indexterm role="concept">
6529 <primary>timeout</primary>
6530 <secondary>for non-SMTP input</secondary>
6531 </indexterm>
6532 This option sets a timeout value for incoming non-SMTP messages. If it is not
6533 set, Exim will wait forever for the standard input. The value can also be set
6534 by the <option>receive_timeout</option> option. The format used for specifying times is
6535 described in section <xref linkend="SECTtimeformat"/>.
6536 </para>
6537 </listitem></varlistentry>
6538 <varlistentry>
6539 <term><option>-os</option>&nbsp;&lt;<emphasis>time</emphasis>&gt;</term>
6540 <listitem>
6541 <para>
6542 <indexterm role="option">
6543 <primary><option>-os</option></primary>
6544 </indexterm>
6545 <indexterm role="concept">
6546 <primary>timeout</primary>
6547 <secondary>for SMTP input</secondary>
6548 </indexterm>
6549 <indexterm role="concept">
6550 <primary>SMTP</primary>
6551 <secondary>input timeout</secondary>
6552 </indexterm>
6553 This option sets a timeout value for incoming SMTP messages. The timeout
6554 applies to each SMTP command and block of data. The value can also be set by
6555 the <option>smtp_receive_timeout</option> option; it defaults to 5 minutes. The format used
6556 for specifying times is described in section <xref linkend="SECTtimeformat"/>.
6557 </para>
6558 </listitem></varlistentry>
6559 <varlistentry>
6560 <term><option>-ov</option></term>
6561 <listitem>
6562 <para>
6563 <indexterm role="option">
6564 <primary><option>-ov</option></primary>
6565 </indexterm>
6566 This option has exactly the same effect as <option>-v</option>.
6567 </para>
6568 </listitem></varlistentry>
6569 <varlistentry>
6570 <term><option>-oX</option>&nbsp;&lt;<emphasis>number&nbsp;or&nbsp;string</emphasis>&gt;</term>
6571 <listitem>
6572 <para>
6573 <indexterm role="option">
6574 <primary><option>-oX</option></primary>
6575 </indexterm>
6576 <indexterm role="concept">
6577 <primary>TCP/IP</primary>
6578 <secondary>setting listening ports</secondary>
6579 </indexterm>
6580 <indexterm role="concept">
6581 <primary>TCP/IP</primary>
6582 <secondary>setting listening interfaces</secondary>
6583 </indexterm>
6584 <indexterm role="concept">
6585 <primary>port</primary>
6586 <secondary>receiving TCP/IP</secondary>
6587 </indexterm>
6588 This option is relevant only when the <option>-bd</option> (start listening daemon) option
6589 is also given. It controls which ports and interfaces the daemon uses. Details
6590 of the syntax, and how it interacts with configuration file options, are given
6591 in chapter <xref linkend="CHAPinterfaces"/>. When <option>-oX</option> is used to start a daemon, no pid
6592 file is written unless <option>-oP</option> is also present to specify a pid file name.
6593 </para>
6594 </listitem></varlistentry>
6595 <varlistentry>
6596 <term><option>-pd</option></term>
6597 <listitem>
6598 <para>
6599 <indexterm role="option">
6600 <primary><option>-pd</option></primary>
6601 </indexterm>
6602 <indexterm role="concept">
6603 <primary>Perl</primary>
6604 <secondary>starting the interpreter</secondary>
6605 </indexterm>
6606 This option applies when an embedded Perl interpreter is linked with Exim (see
6607 chapter <xref linkend="CHAPperl"/>). It overrides the setting of the <option>perl_at_start</option>
6608 option, forcing the starting of the interpreter to be delayed until it is
6609 needed.
6610 </para>
6611 </listitem></varlistentry>
6612 <varlistentry>
6613 <term><option>-ps</option></term>
6614 <listitem>
6615 <para>
6616 <indexterm role="option">
6617 <primary><option>-ps</option></primary>
6618 </indexterm>
6619 <indexterm role="concept">
6620 <primary>Perl</primary>
6621 <secondary>starting the interpreter</secondary>
6622 </indexterm>
6623 This option applies when an embedded Perl interpreter is linked with Exim (see
6624 chapter <xref linkend="CHAPperl"/>). It overrides the setting of the <option>perl_at_start</option>
6625 option, forcing the starting of the interpreter to occur as soon as Exim is
6626 started.
6627 </para>
6628 </listitem></varlistentry>
6629 <varlistentry>
6630 <term><option>-p</option>&lt;<emphasis>rval</emphasis>&gt;:&lt;<emphasis>sval</emphasis>&gt;</term>
6631 <listitem>
6632 <para>
6633 <indexterm role="option">
6634 <primary><option>-p</option></primary>
6635 </indexterm>
6636 For compatibility with Sendmail, this option is equivalent to
6637 </para>
6638 <literallayout>
6639 <literal>-oMr</literal> &lt;<emphasis>rval</emphasis>&gt; <literal>-oMs</literal> &lt;<emphasis>sval</emphasis>&gt;
6640 </literallayout>
6641 <para>
6642 It sets the incoming protocol and host name (for trusted callers). The
6643 host name and its colon can be omitted when only the protocol is to be set.
6644 Note the Exim already has two private options, <option>-pd</option> and <option>-ps</option>, that refer
6645 to embedded Perl. It is therefore impossible to set a protocol value of <literal>d</literal>
6646 or <literal>s</literal> using this option (but that does not seem a real limitation).
6647 </para>
6648 </listitem></varlistentry>
6649 <varlistentry>
6650 <term><option>-q</option></term>
6651 <listitem>
6652 <para>
6653 <indexterm role="option">
6654 <primary><option>-q</option></primary>
6655 </indexterm>
6656 <indexterm role="concept">
6657 <primary>queue runner</primary>
6658 <secondary>starting manually</secondary>
6659 </indexterm>
6660 This option is normally restricted to admin users. However, there is a
6661 configuration option called <option>prod_requires_admin</option> which can be set false to
6662 relax this restriction (and also the same requirement for the <option>-M</option>, <option>-R</option>,
6663 and <option>-S</option> options).
6664 </para>
6665 <para>
6666 <indexterm role="concept">
6667 <primary>queue runner</primary>
6668 <secondary>description of operation</secondary>
6669 </indexterm>
6670 The <option>-q</option> option starts one queue runner process. This scans the queue of
6671 waiting messages, and runs a delivery process for each one in turn. It waits
6672 for each delivery process to finish before starting the next one. A delivery
6673 process may not actually do any deliveries if the retry times for the addresses
6674 have not been reached. Use <option>-qf</option> (see below) if you want to override this.
6675 </para>
6676 <para>
6677 If
6678 <indexterm role="concept">
6679 <primary>SMTP</primary>
6680 <secondary>passed connection</secondary>
6681 </indexterm>
6682 <indexterm role="concept">
6683 <primary>SMTP</primary>
6684 <secondary>multiple deliveries</secondary>
6685 </indexterm>
6686 <indexterm role="concept">
6687 <primary>multiple SMTP deliveries</primary>
6688 </indexterm>
6689 the delivery process spawns other processes to deliver other messages down
6690 passed SMTP connections, the queue runner waits for these to finish before
6691 proceeding.
6692 </para>
6693 <para>
6694 When all the queued messages have been considered, the original queue runner
6695 process terminates. In other words, a single pass is made over the waiting
6696 mail, one message at a time. Use <option>-q</option> with a time (see below) if you want
6697 this to be repeated periodically.
6698 </para>
6699 <para>
6700 Exim processes the waiting messages in an unpredictable order. It isn&#x2019;t very
6701 random, but it is likely to be different each time, which is all that matters.
6702 If one particular message screws up a remote MTA, other messages to the same
6703 MTA have a chance of getting through if they get tried first.
6704 </para>
6705 <para>
6706 It is possible to cause the messages to be processed in lexical message id
6707 order, which is essentially the order in which they arrived, by setting the
6708 <option>queue_run_in_order</option> option, but this is not recommended for normal use.
6709 </para>
6710 </listitem></varlistentry>
6711 <varlistentry>
6712 <term><option>-q</option>&lt;<emphasis>qflags</emphasis>&gt;</term>
6713 <listitem>
6714 <para>
6715 The <option>-q</option> option may be followed by one or more flag letters that change its
6716 behaviour. They are all optional, but if more than one is present, they must
6717 appear in the correct order. Each flag is described in a separate item below.
6718 </para>
6719 </listitem></varlistentry>
6720 <varlistentry>
6721 <term><option>-qq...</option></term>
6722 <listitem>
6723 <para>
6724 <indexterm role="option">
6725 <primary><option>-qq</option></primary>
6726 </indexterm>
6727 <indexterm role="concept">
6728 <primary>queue</primary>
6729 <secondary>double scanning</secondary>
6730 </indexterm>
6731 <indexterm role="concept">
6732 <primary>queue</primary>
6733 <secondary>routing</secondary>
6734 </indexterm>
6735 <indexterm role="concept">
6736 <primary>routing</primary>
6737 <secondary>whole queue before delivery</secondary>
6738 </indexterm>
6739 An option starting with <option>-qq</option> requests a two-stage queue run. In the first
6740 stage, the queue is scanned as if the <option>queue_smtp_domains</option> option matched
6741 every domain. Addresses are routed, local deliveries happen, but no remote
6742 transports are run.
6743 </para>
6744 <para>
6745 <indexterm role="concept">
6746 <primary>hints database</primary>
6747 <secondary>remembering routing</secondary>
6748 </indexterm>
6749 The hints database that remembers which messages are waiting for specific hosts
6750 is updated, as if delivery to those hosts had been deferred. After this is
6751 complete, a second, normal queue scan happens, with routing and delivery taking
6752 place as normal. Messages that are routed to the same host should mostly be
6753 delivered down a single SMTP
6754 <indexterm role="concept">
6755 <primary>SMTP</primary>
6756 <secondary>passed connection</secondary>
6757 </indexterm>
6758 <indexterm role="concept">
6759 <primary>SMTP</primary>
6760 <secondary>multiple deliveries</secondary>
6761 </indexterm>
6762 <indexterm role="concept">
6763 <primary>multiple SMTP deliveries</primary>
6764 </indexterm>
6765 connection because of the hints that were set up during the first queue scan.
6766 This option may be useful for hosts that are connected to the Internet
6767 intermittently.
6768 </para>
6769 </listitem></varlistentry>
6770 <varlistentry>
6771 <term><option>-q[q]i...</option></term>
6772 <listitem>
6773 <para>
6774 <indexterm role="option">
6775 <primary><option>-qi</option></primary>
6776 </indexterm>
6777 <indexterm role="concept">
6778 <primary>queue</primary>
6779 <secondary>initial delivery</secondary>
6780 </indexterm>
6781 If the <emphasis>i</emphasis> flag is present, the queue runner runs delivery processes only for
6782 those messages that haven&#x2019;t previously been tried. (<emphasis>i</emphasis> stands for <quote>initial
6783 delivery</quote>.) This can be helpful if you are putting messages on the queue using
6784 <option>-odq</option> and want a queue runner just to process the new messages.
6785 </para>
6786 </listitem></varlistentry>
6787 <varlistentry>
6788 <term><option>-q[q][i]f...</option></term>
6789 <listitem>
6790 <para>
6791 <indexterm role="option">
6792 <primary><option>-qf</option></primary>
6793 </indexterm>
6794 <indexterm role="concept">
6795 <primary>queue</primary>
6796 <secondary>forcing delivery</secondary>
6797 </indexterm>
6798 <indexterm role="concept">
6799 <primary>delivery</primary>
6800 <secondary>forcing in queue run</secondary>
6801 </indexterm>
6802 If one <emphasis>f</emphasis> flag is present, a delivery attempt is forced for each non-frozen
6803 message, whereas without <emphasis>f</emphasis> only those non-frozen addresses that have passed
6804 their retry times are tried.
6805 </para>
6806 </listitem></varlistentry>
6807 <varlistentry>
6808 <term><option>-q[q][i]ff...</option></term>
6809 <listitem>
6810 <para>
6811 <indexterm role="option">
6812 <primary><option>-qff</option></primary>
6813 </indexterm>
6814 <indexterm role="concept">
6815 <primary>frozen messages</primary>
6816 <secondary>forcing delivery</secondary>
6817 </indexterm>
6818 If <emphasis>ff</emphasis> is present, a delivery attempt is forced for every message, whether
6819 frozen or not.
6820 </para>
6821 </listitem></varlistentry>
6822 <varlistentry>
6823 <term><option>-q[q][i][f[f]]l</option></term>
6824 <listitem>
6825 <para>
6826 <indexterm role="option">
6827 <primary><option>-ql</option></primary>
6828 </indexterm>
6829 <indexterm role="concept">
6830 <primary>queue</primary>
6831 <secondary>local deliveries only</secondary>
6832 </indexterm>
6833 The <emphasis>l</emphasis> (the letter <quote>ell</quote>) flag specifies that only local deliveries are to
6834 be done. If a message requires any remote deliveries, it remains on the queue
6835 for later delivery.
6836 </para>
6837 </listitem></varlistentry>
6838 <varlistentry>
6839 <term><option>-q</option>&lt;<emphasis>qflags</emphasis>&gt;&nbsp;&lt;<emphasis>start&nbsp;id</emphasis>&gt;&nbsp;&lt;<emphasis>end&nbsp;id</emphasis>&gt;</term>
6840 <listitem>
6841 <para>
6842 <indexterm role="concept">
6843 <primary>queue</primary>
6844 <secondary>delivering specific messages</secondary>
6845 </indexterm>
6846 When scanning the queue, Exim can be made to skip over messages whose ids are
6847 lexically less than a given value by following the <option>-q</option> option with a
6848 starting message id. For example:
6849 </para>
6850 <literallayout class="monospaced">
6851 exim -q 0t5C6f-0000c8-00
6852 </literallayout>
6853 <para>
6854 Messages that arrived earlier than <literal>0t5C6f-0000c8-00</literal> are not inspected. If a
6855 second message id is given, messages whose ids are lexically greater than it
6856 are also skipped. If the same id is given twice, for example,
6857 </para>
6858 <literallayout class="monospaced">
6859 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
6860 </literallayout>
6861 <para>
6862 just one delivery process is started, for that message. This differs from
6863 <option>-M</option> in that retry data is respected, and it also differs from <option>-Mc</option> in
6864 that it counts as a delivery from a queue run. Note that the selection
6865 mechanism does not affect the order in which the messages are scanned. There
6866 are also other ways of selecting specific sets of messages for delivery in a
6867 queue run &ndash; see <option>-R</option> and <option>-S</option>.
6868 </para>
6869 </listitem></varlistentry>
6870 <varlistentry>
6871 <term><option>-q</option>&lt;<emphasis>qflags</emphasis>&gt;&lt;<emphasis>time</emphasis>&gt;</term>
6872 <listitem>
6873 <para>
6874 <indexterm role="concept">
6875 <primary>queue runner</primary>
6876 <secondary>starting periodically</secondary>
6877 </indexterm>
6878 <indexterm role="concept">
6879 <primary>periodic queue running</primary>
6880 </indexterm>
6881 When a time value is present, the <option>-q</option> option causes Exim to run as a daemon,
6882 starting a queue runner process at intervals specified by the given time value
6883 (whose format is described in section <xref linkend="SECTtimeformat"/>). This form of the
6884 <option>-q</option> option is commonly combined with the <option>-bd</option> option, in which case a
6885 single daemon process handles both functions. A common way of starting up a
6886 combined daemon at system boot time is to use a command such as
6887 </para>
6888 <literallayout class="monospaced">
6889 /usr/exim/bin/exim -bd -q30m
6890 </literallayout>
6891 <para>
6892 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
6893 process every 30 minutes.
6894 </para>
6895 <para>
6896 When a daemon is started by <option>-q</option> with a time value, but without <option>-bd</option>, no
6897 pid file is written unless one is explicitly requested by the <option>-oP</option> option.
6898 </para>
6899 </listitem></varlistentry>
6900 <varlistentry>
6901 <term><option>-qR</option>&lt;<emphasis>rsflags</emphasis>&gt;&nbsp;&lt;<emphasis>string</emphasis>&gt;</term>
6902 <listitem>
6903 <para>
6904 <indexterm role="option">
6905 <primary><option>-qR</option></primary>
6906 </indexterm>
6907 This option is synonymous with <option>-R</option>. It is provided for Sendmail
6908 compatibility.
6909 </para>
6910 </listitem></varlistentry>
6911 <varlistentry>
6912 <term><option>-qS</option>&lt;<emphasis>rsflags</emphasis>&gt;&nbsp;&lt;<emphasis>string</emphasis>&gt;</term>
6913 <listitem>
6914 <para>
6915 <indexterm role="option">
6916 <primary><option>-qS</option></primary>
6917 </indexterm>
6918 This option is synonymous with <option>-S</option>.
6919 </para>
6920 </listitem></varlistentry>
6921 <varlistentry>
6922 <term><option>-R</option>&lt;<emphasis>rsflags</emphasis>&gt;&nbsp;&lt;<emphasis>string</emphasis>&gt;</term>
6923 <listitem>
6924 <para>
6925 <indexterm role="option">
6926 <primary><option>-R</option></primary>
6927 </indexterm>
6928 <indexterm role="concept">
6929 <primary>queue runner</primary>
6930 <secondary>for specific recipients</secondary>
6931 </indexterm>
6932 <indexterm role="concept">
6933 <primary>delivery</primary>
6934 <secondary>to given domain</secondary>
6935 </indexterm>
6936 <indexterm role="concept">
6937 <primary>domain</primary>
6938 <secondary>delivery to</secondary>
6939 </indexterm>
6940 The &lt;<emphasis>rsflags</emphasis>&gt; may be empty, in which case the white space before the string
6941 is optional, unless the string is <emphasis>f</emphasis>, <emphasis>ff</emphasis>, <emphasis>r</emphasis>, <emphasis>rf</emphasis>, or <emphasis>rff</emphasis>,
6942 which are the possible values for &lt;<emphasis>rsflags</emphasis>&gt;. White space is required if
6943 &lt;<emphasis>rsflags</emphasis>&gt; is not empty.
6944 </para>
6945 <para>
6946 This option is similar to <option>-q</option> with no time value, that is, it causes Exim to
6947 perform a single queue run, except that, when scanning the messages on the
6948 queue, Exim processes only those that have at least one undelivered recipient
6949 address containing the given string, which is checked in a case-independent
6950 way. If the &lt;<emphasis>rsflags</emphasis>&gt; start with <emphasis>r</emphasis>, &lt;<emphasis>string</emphasis>&gt; is interpreted as a
6951 regular expression; otherwise it is a literal string.
6952 </para>
6953 <para>
6954 If you want to do periodic queue runs for messages with specific recipients,
6955 you can combine <option>-R</option> with <option>-q</option> and a time value. For example:
6956 </para>
6957 <literallayout class="monospaced">
6958 exim -q25m -R @special.domain.example
6959 </literallayout>
6960 <para>
6961 This example does a queue run for messages with recipients in the given domain
6962 every 25 minutes. Any additional flags that are specified with <option>-q</option> are
6963 applied to each queue run.
6964 </para>
6965 <para>
6966 Once a message is selected for delivery by this mechanism, all its addresses
6967 are processed. For the first selected message, Exim overrides any retry
6968 information and forces a delivery attempt for each undelivered address. This
6969 means that if delivery of any address in the first message is successful, any
6970 existing retry information is deleted, and so delivery attempts for that
6971 address in subsequently selected messages (which are processed without forcing)
6972 will run. However, if delivery of any address does not succeed, the retry
6973 information is updated, and in subsequently selected messages, the failing
6974 address will be skipped.
6975 </para>
6976 <para>
6977 <indexterm role="concept">
6978 <primary>frozen messages</primary>
6979 <secondary>forcing delivery</secondary>
6980 </indexterm>
6981 If the &lt;<emphasis>rsflags</emphasis>&gt; contain <emphasis>f</emphasis> or <emphasis>ff</emphasis>, the delivery forcing applies to
6982 all selected messages, not just the first; frozen messages are included when
6983 <emphasis>ff</emphasis> is present.
6984 </para>
6985 <para>
6986 The <option>-R</option> option makes it straightforward to initiate delivery of all messages
6987 to a given domain after a host has been down for some time. When the SMTP
6988 command ETRN is accepted by its ACL (see chapter <xref linkend="CHAPACL"/>), its default
6989 effect is to run Exim with the <option>-R</option> option, but it can be configured to run
6990 an arbitrary command instead.
6991 </para>
6992 </listitem></varlistentry>
6993 <varlistentry>
6994 <term><option>-r</option></term>
6995 <listitem>
6996 <para>
6997 <indexterm role="option">
6998 <primary><option>-r</option></primary>
6999 </indexterm>
7000 This is a documented (for Sendmail) obsolete alternative name for <option>-f</option>.
7001 </para>
7002 </listitem></varlistentry>
7003 <varlistentry>
7004 <term><option>-S</option>&lt;<emphasis>rsflags</emphasis>&gt;&nbsp;&lt;<emphasis>string</emphasis>&gt;</term>
7005 <listitem>
7006 <para>
7007 <indexterm role="option">
7008 <primary><option>-S</option></primary>
7009 </indexterm>
7010 <indexterm role="concept">
7011 <primary>delivery</primary>
7012 <secondary>from given sender</secondary>
7013 </indexterm>
7014 <indexterm role="concept">
7015 <primary>queue runner</primary>
7016 <secondary>for specific senders</secondary>
7017 </indexterm>
7018 This option acts like <option>-R</option> except that it checks the string against each
7019 message&#x2019;s sender instead of against the recipients. If <option>-R</option> is also set, both
7020 conditions must be met for a message to be selected. If either of the options
7021 has <emphasis>f</emphasis> or <emphasis>ff</emphasis> in its flags, the associated action is taken.
7022 </para>
7023 </listitem></varlistentry>
7024 <varlistentry>
7025 <term><option>-Tqt</option>&nbsp;&lt;<emphasis>times</emphasis>&gt;</term>
7026 <listitem>
7027 <para>
7028 <indexterm role="option">
7029 <primary><option>-Tqt</option></primary>
7030 </indexterm>
7031 This is an option that is exclusively for use by the Exim testing suite. It is not
7032 recognized when Exim is run normally. It allows for the setting up of explicit
7033 <quote>queue times</quote> so that various warning/retry features can be tested.
7034 </para>
7035 </listitem></varlistentry>
7036 <varlistentry>
7037 <term><option>-t</option></term>
7038 <listitem>
7039 <para>
7040 <indexterm role="option">
7041 <primary><option>-t</option></primary>
7042 </indexterm>
7043 <indexterm role="concept">
7044 <primary>recipient</primary>
7045 <secondary>extracting from header lines</secondary>
7046 </indexterm>
7047 <indexterm role="concept">
7048 <primary><emphasis>Bcc:</emphasis> header line</primary>
7049 </indexterm>
7050 <indexterm role="concept">
7051 <primary><emphasis>Cc:</emphasis> header line</primary>
7052 </indexterm>
7053 <indexterm role="concept">
7054 <primary><emphasis>To:</emphasis> header line</primary>
7055 </indexterm>
7056 When Exim is receiving a locally-generated, non-SMTP message on its standard
7057 input, the <option>-t</option> option causes the recipients of the message to be obtained
7058 from the <emphasis>To:</emphasis>, <emphasis>Cc:</emphasis>, and <emphasis>Bcc:</emphasis> header lines in the message instead of
7059 from the command arguments. The addresses are extracted before any rewriting
7060 takes place and the <emphasis>Bcc:</emphasis> header line, if present, is then removed.
7061 </para>
7062 <para>
7063 <indexterm role="concept">
7064 <primary>Sendmail compatibility</primary>
7065 <secondary><option>-t</option> option</secondary>
7066 </indexterm>
7067 If the command has any arguments, they specify addresses to which the message
7068 is <emphasis>not</emphasis> to be delivered. That is, the argument addresses are removed from
7069 the recipients list obtained from the headers. This is compatible with Smail 3
7070 and in accordance with the documented behaviour of several versions of
7071 Sendmail, as described in man pages on a number of operating systems (e.g.
7072 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail <emphasis>add</emphasis>
7073 argument addresses to those obtained from the headers, and the O&#x2019;Reilly
7074 Sendmail book documents it that way. Exim can be made to add argument addresses
7075 instead of subtracting them by setting the option
7076 <option>extract_addresses_remove_arguments</option> false.
7077 </para>
7078 <para>
7079 <indexterm role="concept">
7080 <primary><option>Resent-</option> header lines</primary>
7081 <secondary>with <option>-t</option></secondary>
7082 </indexterm>
7083 If there are any <option>Resent-</option> header lines in the message, Exim extracts
7084 recipients from all <emphasis>Resent-To:</emphasis>, <emphasis>Resent-Cc:</emphasis>, and <emphasis>Resent-Bcc:</emphasis> header
7085 lines instead of from <emphasis>To:</emphasis>, <emphasis>Cc:</emphasis>, and <emphasis>Bcc:</emphasis>. This is for compatibility
7086 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
7087 <option>-t</option> was used in conjunction with <option>Resent-</option> header lines.)
7088 </para>
7089 <para>
7090 RFC 2822 talks about different sets of <option>Resent-</option> header lines (for when a
7091 message is resent several times). The RFC also specifies that they should be
7092 added at the front of the message, and separated by <emphasis>Received:</emphasis> lines. It is
7093 not at all clear how <option>-t</option> should operate in the present of multiple sets,
7094 nor indeed exactly what constitutes a <quote>set</quote>.
7095 In practice, it seems that MUAs do not follow the RFC. The <option>Resent-</option> lines
7096 are often added at the end of the header, and if a message is resent more than
7097 once, it is common for the original set of <option>Resent-</option> headers to be renamed as
7098 <option>X-Resent-</option> when a new set is added. This removes any possible ambiguity.
7099 </para>
7100 </listitem></varlistentry>
7101 <varlistentry>
7102 <term><option>-ti</option></term>
7103 <listitem>
7104 <para>
7105 <indexterm role="option">
7106 <primary><option>-ti</option></primary>
7107 </indexterm>
7108 This option is exactly equivalent to <option>-t</option> <option>-i</option>. It is provided for
7109 compatibility with Sendmail.
7110 </para>
7111 </listitem></varlistentry>
7112 <varlistentry>
7113 <term><option>-tls-on-connect</option></term>
7114 <listitem>
7115 <para>
7116 <indexterm role="option">
7117 <primary><option>-tls-on-connect</option></primary>
7118 </indexterm>
7119 <indexterm role="concept">
7120 <primary>TLS</primary>
7121 <secondary>use without STARTTLS</secondary>
7122 </indexterm>
7123 <indexterm role="concept">
7124 <primary>TLS</primary>
7125 <secondary>automatic start</secondary>
7126 </indexterm>
7127 This option is available when Exim is compiled with TLS support. It forces all
7128 incoming SMTP connections to behave as if the incoming port is listed in the
7129 <option>tls_on_connect_ports</option> option. See section <xref linkend="SECTsupobssmt"/> and chapter
7130 <xref linkend="CHAPTLS"/> for further details.
7131 </para>
7132 </listitem></varlistentry>
7133 <varlistentry>
7134 <term><option>-U</option></term>
7135 <listitem>
7136 <para>
7137 <indexterm role="option">
7138 <primary><option>-U</option></primary>
7139 </indexterm>
7140 <indexterm role="concept">
7141 <primary>Sendmail compatibility</primary>
7142 <secondary><option>-U</option> option ignored</secondary>
7143 </indexterm>
7144 Sendmail uses this option for <quote>initial message submission</quote>, and its
7145 documentation states that in future releases, it may complain about
7146 syntactically invalid messages rather than fixing them when this flag is not
7147 set. Exim ignores this option.
7148 </para>
7149 </listitem></varlistentry>
7150 <varlistentry>
7151 <term><option>-v</option></term>
7152 <listitem>
7153 <para>
7154 <indexterm role="option">
7155 <primary><option>-v</option></primary>
7156 </indexterm>
7157 This option causes Exim to write information to the standard error stream,
7158 describing what it is doing. In particular, it shows the log lines for
7159 receiving and delivering a message, and if an SMTP connection is made, the SMTP
7160 dialogue is shown. Some of the log lines shown may not actually be written to
7161 the log if the setting of <option>log_selector</option> discards them. Any relevant
7162 selectors are shown with each log line. If none are shown, the logging is
7163 unconditional.
7164 </para>
7165 </listitem></varlistentry>
7166 <varlistentry>
7167 <term><option>-x</option></term>
7168 <listitem>
7169 <para>
7170 <indexterm role="option">
7171 <primary><option>-x</option></primary>
7172 </indexterm>
7173 AIX uses <option>-x</option> for a private purpose (<quote>mail from a local mail program has
7174 National Language Support extended characters in the body of the mail item</quote>).
7175 It sets <option>-x</option> when calling the MTA from its <option>mail</option> command. Exim ignores
7176 this option.
7177 </para>
7178 </listitem></varlistentry>
7179 <varlistentry>
7180 <term><option>-X</option>&nbsp;&lt;<emphasis>logfile</emphasis>&gt;</term>
7181 <listitem>
7182 <para>
7183 <indexterm role="option">
7184 <primary><option>-X</option></primary>
7185 </indexterm>
7186 This option is interpreted by Sendmail to cause debug information to be sent
7187 to the named file.  It is ignored by Exim.
7188 </para>
7189 </listitem></varlistentry>
7190 </variablelist>
7191 <para>
7192 <indexterm role="concept" startref="IIDclo1" class="endofrange"/>
7193 <indexterm role="concept" startref="IIDclo2" class="endofrange"/>
7194 </para>
7195 <!-- === End of command line options === -->
7196 </section>
7197 </chapter>
7198
7199 <chapter id="CHAPconf">
7200 <title>The Exim run time configuration file</title>
7201 <titleabbrev>The runtime configuration file</titleabbrev>
7202 <para>
7203 <indexterm role="concept">
7204 <primary>run time configuration</primary>
7205 </indexterm>
7206 <indexterm role="concept">
7207 <primary>configuration file</primary>
7208 <secondary>general description</secondary>
7209 </indexterm>
7210 <indexterm role="concept">
7211 <primary>CONFIGURE_FILE</primary>
7212 </indexterm>
7213 <indexterm role="concept">
7214 <primary>configuration file</primary>
7215 <secondary>errors in</secondary>
7216 </indexterm>
7217 <indexterm role="concept">
7218 <primary>error</primary>
7219 <secondary>in configuration file</secondary>
7220 </indexterm>
7221 <indexterm role="concept">
7222 <primary>return code</primary>
7223 <secondary>for bad configuration</secondary>
7224 </indexterm>
7225 Exim uses a single run time configuration file that is read whenever an Exim
7226 binary is executed. Note that in normal operation, this happens frequently,
7227 because Exim is designed to operate in a distributed manner, without central
7228 control.
7229 </para>
7230 <para>
7231 If a syntax error is detected while reading the configuration file, Exim
7232 writes a message on the standard error, and exits with a non-zero return code.
7233 The message is also written to the panic log. <emphasis role="bold">Note</emphasis>: Only simple syntax
7234 errors can be detected at this time. The values of any expanded options are
7235 not checked until the expansion happens, even when the expansion does not
7236 actually alter the string.
7237 </para>
7238 <para>
7239 The name of the configuration file is compiled into the binary for security
7240 reasons, and is specified by the CONFIGURE_FILE compilation option. In
7241 most configurations, this specifies a single file. However, it is permitted to
7242 give a colon-separated list of file names, in which case Exim uses the first
7243 existing file in the list.
7244 </para>
7245 <para>
7246 <indexterm role="concept">
7247 <primary>EXIM_USER</primary>
7248 </indexterm>
7249 <indexterm role="concept">
7250 <primary>EXIM_GROUP</primary>
7251 </indexterm>
7252 <indexterm role="concept">
7253 <primary>CONFIGURE_OWNER</primary>
7254 </indexterm>
7255 <indexterm role="concept">
7256 <primary>CONFIGURE_GROUP</primary>
7257 </indexterm>
7258 <indexterm role="concept">
7259 <primary>configuration file</primary>
7260 <secondary>ownership</secondary>
7261 </indexterm>
7262 <indexterm role="concept">
7263 <primary>ownership</primary>
7264 <secondary>configuration file</secondary>
7265 </indexterm>
7266 The run time configuration file must be owned by root or by the user that is
7267 specified at compile time by the CONFIGURE_OWNER option (if set). The
7268 configuration file must not be world-writeable, or group-writeable unless its
7269 group is the root group or the one specified at compile time by the
7270 CONFIGURE_GROUP option.
7271 </para>
7272 <para>
7273 <emphasis role="bold">Warning</emphasis>: In a conventional configuration, where the Exim binary is setuid
7274 to root, anybody who is able to edit the run time configuration file has an
7275 easy way to run commands as root. If you specify a user or group in the
7276 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
7277 who are members of that group will trivially be able to obtain root privileges.
7278 </para>
7279 <para>
7280 Up to Exim version 4.72, the run time configuration file was also permitted to
7281 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
7282 since it offered a simple privilege escalation for any attacker who managed to
7283 compromise the Exim user account.
7284 </para>
7285 <para>
7286 A default configuration file, which will work correctly in simple situations,
7287 is provided in the file <filename>src/configure.default</filename>. If CONFIGURE_FILE
7288 defines just one file name, the installation process copies the default
7289 configuration to a new file of that name if it did not previously exist. If
7290 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
7291 <xref linkend="CHAPdefconfil"/> is a <quote>walk-through</quote> discussion of the default
7292 configuration.
7293 </para>
7294 <section id="SECID40">
7295 <title>Using a different configuration file</title>
7296 <para>
7297 <indexterm role="concept">
7298 <primary>configuration file</primary>
7299 <secondary>alternate</secondary>
7300 </indexterm>
7301 A one-off alternate configuration can be specified by the <option>-C</option> command line
7302 option, which may specify a single file or a list of files. However, when
7303 <option>-C</option> is used, Exim gives up its root privilege, unless called by root (or
7304 unless the argument for <option>-C</option> is identical to the built-in value from
7305 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
7306 is the Exim user or the user specified in the CONFIGURE_OWNER setting. <option>-C</option>
7307 is useful mainly for checking the syntax of configuration files before
7308 installing them. No owner or group checks are done on a configuration file
7309 specified by <option>-C</option>, if root privilege has been dropped.
7310 </para>
7311 <para>
7312 Even the Exim user is not trusted to specify an arbitrary configuration file
7313 with the <option>-C</option> option to be used with root privileges, unless that file is
7314 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
7315 testing a configuration using <option>-C</option> right through message reception and
7316 delivery, even if the caller is root. The reception works, but by that time,
7317 Exim is running as the Exim user, so when it re-execs to regain privilege for
7318 the delivery, the use of <option>-C</option> causes privilege to be lost. However, root
7319 can test reception and delivery using two separate commands (one to put a
7320 message on the queue, using <option>-odq</option>, and another to do the delivery, using
7321 <option>-M</option>).
7322 </para>
7323 <para>
7324 If ALT_CONFIG_PREFIX is defined <filename>in Local/Makefile</filename>, it specifies a
7325 prefix string with which any file named in a <option>-C</option> command line option must
7326 start. In addition, the file name must not contain the sequence <quote><literal>/../</literal></quote>.
7327 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
7328 name can be used with <option>-C</option>.
7329 </para>
7330 <para>
7331 One-off changes to a configuration can be specified by the <option>-D</option> command line
7332 option, which defines and overrides values for macros used inside the
7333 configuration file. However, like <option>-C</option>, the use of this option by a
7334 non-privileged user causes Exim to discard its root privilege.
7335 If DISABLE_D_OPTION is defined in <filename>Local/Makefile</filename>, the use of <option>-D</option> is
7336 completely disabled, and its use causes an immediate error exit.
7337 </para>
7338 <para>
7339 The WHITELIST_D_MACROS option in <filename>Local/Makefile</filename> permits the binary builder
7340 to declare certain macro names trusted, such that root privilege will not
7341 necessarily be discarded.
7342 WHITELIST_D_MACROS defines a colon-separated list of macros which are
7343 considered safe and, if <option>-D</option> only supplies macros from this list, and the
7344 values are acceptable, then Exim will not give up root privilege if the caller
7345 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
7346 transition mechanism and is expected to be removed in the future.  Acceptable
7347 values for the macros satisfy the regexp: <literal>^[A-Za-z0-9_/.-]*$</literal>
7348 </para>
7349 <para>
7350 Some sites may wish to use the same Exim binary on different machines that
7351 share a file system, but to use different configuration files on each machine.
7352 If CONFIGURE_FILE_USE_NODE is defined in <filename>Local/Makefile</filename>, Exim first
7353 looks for a file whose name is the configuration file name followed by a dot
7354 and the machine&#x2019;s node name, as obtained from the <function>uname()</function> function. If this
7355 file does not exist, the standard name is tried. This processing occurs for
7356 each file name in the list given by CONFIGURE_FILE or <option>-C</option>.
7357 </para>
7358 <para>
7359 In some esoteric situations different versions of Exim may be run under
7360 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
7361 help with this. See the comments in <filename>src/EDITME</filename> for details.
7362 </para>
7363 </section>
7364 <section id="SECTconffilfor">
7365 <title>Configuration file format</title>
7366 <para>
7367 <indexterm role="concept">
7368 <primary>configuration file</primary>
7369 <secondary>format of</secondary>
7370 </indexterm>
7371 <indexterm role="concept">
7372 <primary>format</primary>
7373 <secondary>configuration file</secondary>
7374 </indexterm>
7375 Exim&#x2019;s configuration file is divided into a number of different parts. General
7376 option settings must always appear at the start of the file. The other parts
7377 are all optional, and may appear in any order. Each part other than the first
7378 is introduced by the word <quote>begin</quote> followed by the name of the part. The
7379 optional parts are:
7380 </para>
7381 <itemizedlist>
7382 <listitem>
7383 <para>
7384 <emphasis>ACL</emphasis>: Access control lists for controlling incoming SMTP mail (see chapter
7385 <xref linkend="CHAPACL"/>).
7386 </para>
7387 </listitem>
7388 <listitem>
7389 <para>
7390 <indexterm role="concept">
7391 <primary>AUTH</primary>
7392 <secondary>configuration</secondary>
7393 </indexterm>
7394 <emphasis>authenticators</emphasis>: Configuration settings for the authenticator drivers. These
7395 are concerned with the SMTP AUTH command (see chapter <xref linkend="CHAPSMTPAUTH"/>).
7396 </para>
7397 </listitem>
7398 <listitem>
7399 <para>
7400 <emphasis>routers</emphasis>: Configuration settings for the router drivers. Routers process
7401 addresses and determine how the message is to be delivered (see chapters
7402 <xref linkend="CHAProutergeneric"/>&ndash;<xref linkend="CHAPredirect"/>).
7403 </para>
7404 </listitem>
7405 <listitem>
7406 <para>
7407 <emphasis>transports</emphasis>: Configuration settings for the transport drivers. Transports
7408 define mechanisms for copying messages to destinations (see chapters
7409 <xref linkend="CHAPtransportgeneric"/>&ndash;<xref linkend="CHAPsmtptrans"/>).
7410 </para>
7411 </listitem>
7412 <listitem>
7413 <para>
7414 <emphasis>retry</emphasis>: Retry rules, for use when a message cannot be delivered immediately.
7415 If there is no retry section, or if it is empty (that is, no retry rules are
7416 defined), Exim will not retry deliveries. In this situation, temporary errors
7417 are treated the same as permanent errors. Retry rules are discussed in chapter
7418 <xref linkend="CHAPretry"/>.
7419 </para>
7420 </listitem>
7421 <listitem>
7422 <para>
7423 <emphasis>rewrite</emphasis>: Global address rewriting rules, for use when a message arrives and
7424 when new addresses are generated during delivery. Rewriting is discussed in
7425 chapter <xref linkend="CHAPrewrite"/>.
7426 </para>
7427 </listitem>
7428 <listitem>
7429 <para>
7430 <emphasis>local_scan</emphasis>: Private options for the <function>local_scan()</function> function. If you
7431 want to use this feature, you must set
7432 </para>
7433 <literallayout class="monospaced">
7434 LOCAL_SCAN_HAS_OPTIONS=yes
7435 </literallayout>
7436 <para>
7437 in <filename>Local/Makefile</filename> before building Exim. Details of the <function>local_scan()</function>
7438 facility are given in chapter <xref linkend="CHAPlocalscan"/>.
7439 </para>
7440 </listitem>
7441 </itemizedlist>
7442 <para>
7443 <indexterm role="concept">
7444 <primary>configuration file</primary>
7445 <secondary>leading white space in</secondary>
7446 </indexterm>
7447 <indexterm role="concept">
7448 <primary>configuration file</primary>
7449 <secondary>trailing white space in</secondary>
7450 </indexterm>
7451 <indexterm role="concept">
7452 <primary>white space</primary>
7453 <secondary>in configuration file</secondary>
7454 </indexterm>
7455 Leading and trailing white space in configuration lines is always ignored.
7456 </para>
7457 <para>
7458 Blank lines in the file, and lines starting with a # character (ignoring
7459 leading white space) are treated as comments and are ignored. <emphasis role="bold">Note</emphasis>: A
7460 # character other than at the beginning of a line is not treated specially,
7461 and does not introduce a comment.
7462 </para>
7463 <para>
7464 Any non-comment line can be continued by ending it with a backslash. Note that
7465 the general rule for white space means that trailing white space after the
7466 backslash and leading white space at the start of continuation
7467 lines is ignored. Comment lines beginning with # (but not empty lines) may
7468 appear in the middle of a sequence of continuation lines.
7469 </para>
7470 <para>
7471 A convenient way to create a configuration file is to start from the
7472 default, which is supplied in <filename>src/configure.default</filename>, and add, delete, or
7473 change settings as required.
7474 </para>
7475 <para>
7476 The ACLs, retry rules, and rewriting rules have their own syntax which is
7477 described in chapters <xref linkend="CHAPACL"/>, <xref linkend="CHAPretry"/>, and <xref linkend="CHAPrewrite"/>,
7478 respectively. The other parts of the configuration file have some syntactic
7479 items in common, and these are described below, from section <xref linkend="SECTcos"/>
7480 onwards. Before that, the inclusion, macro, and conditional facilities are
7481 described.
7482 </para>
7483 </section>
7484 <section id="SECID41">
7485 <title>File inclusions in the configuration file</title>
7486 <para>
7487 <indexterm role="concept">
7488 <primary>inclusions in configuration file</primary>
7489 </indexterm>
7490 <indexterm role="concept">
7491 <primary>configuration file</primary>
7492 <secondary>including other files</secondary>
7493 </indexterm>
7494 <indexterm role="concept">
7495 <primary><literal>.include</literal> in configuration file</primary>
7496 </indexterm>
7497 <indexterm role="concept">
7498 <primary><literal>.include_if_exists</literal> in configuration file</primary>
7499 </indexterm>
7500 You can include other files inside Exim&#x2019;s run time configuration file by
7501 using this syntax:
7502 </para>
7503 <literallayout>
7504 <literal>.include</literal> &lt;<emphasis>file name</emphasis>&gt;
7505 <literal>.include_if_exists</literal> &lt;<emphasis>file name</emphasis>&gt;
7506 </literallayout>
7507 <para>
7508 on a line by itself. Double quotes round the file name are optional. If you use
7509 the first form, a configuration error occurs if the file does not exist; the
7510 second form does nothing for non-existent files. In all cases, an absolute file
7511 name is required.
7512 </para>
7513 <para>
7514 Includes may be nested to any depth, but remember that Exim reads its
7515 configuration file often, so it is a good idea to keep them to a minimum.
7516 If you change the contents of an included file, you must HUP the daemon,
7517 because an included file is read only when the configuration itself is read.
7518 </para>
7519 <para>
7520 The processing of inclusions happens early, at a physical line level, so, like
7521 comment lines, an inclusion can be used in the middle of an option setting,
7522 for example:
7523 </para>
7524 <literallayout class="monospaced">
7525 hosts_lookup = a.b.c \
7526                .include /some/file
7527 </literallayout>
7528 <para>
7529 Include processing happens after macro processing (see below). Its effect is to
7530 process the lines of the included file as if they occurred inline where the
7531 inclusion appears.
7532 </para>
7533 </section>
7534 <section id="SECTmacrodefs">
7535 <title>Macros in the configuration file</title>
7536 <para>
7537 <indexterm role="concept">
7538 <primary>macro</primary>
7539 <secondary>description of</secondary>
7540 </indexterm>
7541 <indexterm role="concept">
7542 <primary>configuration file</primary>
7543 <secondary>macros</secondary>
7544 </indexterm>
7545 If a line in the main part of the configuration (that is, before the first
7546 <quote>begin</quote> line) begins with an upper case letter, it is taken as a macro
7547 definition, and must be of the form
7548 </para>
7549 <literallayout>
7550 &lt;<emphasis>name</emphasis>&gt; = &lt;<emphasis>rest of line</emphasis>&gt;
7551 </literallayout>
7552 <para>
7553 The name must consist of letters, digits, and underscores, and need not all be
7554 in upper case, though that is recommended. The rest of the line, including any
7555 continuations, is the replacement text, and has leading and trailing white
7556 space removed. Quotes are not removed. The replacement text can never end with
7557 a backslash character, but this doesn&#x2019;t seem to be a serious limitation.
7558 </para>
7559 <para>
7560 Macros may also be defined between router, transport, authenticator, or ACL
7561 definitions. They may not, however, be defined within an individual driver or
7562 ACL, or in the <option>local_scan</option>, retry, or rewrite sections of the configuration.
7563 </para>
7564 </section>
7565 <section id="SECID42">
7566 <title>Macro substitution</title>
7567 <para>
7568 Once a macro is defined, all subsequent lines in the file (and any included
7569 files) are scanned for the macro name; if there are several macros, the line is
7570 scanned for each in turn, in the order in which the macros are defined. The
7571 replacement text is not re-scanned for the current macro, though it is scanned
7572 for subsequently defined macros. For this reason, a macro name may not contain
7573 the name of a previously defined macro as a substring. You could, for example,
7574 define
7575 </para>
7576 <literallayout>
7577 <literal>ABCD_XYZ = </literal>&lt;<emphasis>something</emphasis>&gt;
7578 <literal>ABCD = </literal>&lt;<emphasis>something else</emphasis>&gt;
7579 </literallayout>
7580 <para>
7581 but putting the definitions in the opposite order would provoke a configuration
7582 error. Macro expansion is applied to individual physical lines from the file,
7583 before checking for line continuation or file inclusion (see above). If a line
7584 consists solely of a macro name, and the expansion of the macro is empty, the
7585 line is ignored. A macro at the start of a line may turn the line into a
7586 comment line or a <literal>.include</literal> line.
7587 </para>
7588 </section>
7589 <section id="SECID43">
7590 <title>Redefining macros</title>
7591 <para>
7592 Once defined, the value of a macro can be redefined later in the configuration
7593 (or in an included file). Redefinition is specified by using <emphasis>==</emphasis> instead of
7594 <emphasis>=</emphasis>. For example:
7595 </para>
7596 <literallayout class="monospaced">
7597 MAC =  initial value
7598 ...
7599 MAC == updated value
7600 </literallayout>
7601 <para>
7602 Redefinition does not alter the order in which the macros are applied to the
7603 subsequent lines of the configuration file. It is still the same order in which
7604 the macros were originally defined. All that changes is the macro&#x2019;s value.
7605 Redefinition makes it possible to accumulate values. For example:
7606 </para>
7607 <literallayout class="monospaced">
7608 MAC =  initial value
7609 ...
7610 MAC == MAC and something added
7611 </literallayout>
7612 <para>
7613 This can be helpful in situations where the configuration file is built
7614 from a number of other files.
7615 </para>
7616 </section>
7617 <section id="SECID44">
7618 <title>Overriding macro values</title>
7619 <para>
7620 The values set for macros in the configuration file can be overridden by the
7621 <option>-D</option> command line option, but Exim gives up its root privilege when <option>-D</option> is
7622 used, unless called by root or the Exim user. A definition on the command line
7623 using the <option>-D</option> option causes all definitions and redefinitions within the
7624 file to be ignored.
7625 </para>
7626 </section>
7627 <section id="SECID45">
7628 <title>Example of macro usage</title>
7629 <para>
7630 As an example of macro usage, consider a configuration where aliases are looked
7631 up in a MySQL database. It helps to keep the file less cluttered if long
7632 strings such as SQL statements are defined separately as macros, for example:
7633 </para>
7634 <literallayout class="monospaced">
7635 ALIAS_QUERY = select mailbox from user where \
7636               login='${quote_mysql:$local_part}';
7637 </literallayout>
7638 <para>
7639 This can then be used in a <command>redirect</command> router setting like this:
7640 </para>
7641 <literallayout class="monospaced">
7642 data = ${lookup mysql{ALIAS_QUERY}}
7643 </literallayout>
7644 <para>
7645 In earlier versions of Exim macros were sometimes used for domain, host, or
7646 address lists. In Exim 4 these are handled better by named lists &ndash; see
7647 section <xref linkend="SECTnamedlists"/>.
7648 </para>
7649 </section>
7650 <section id="SECID46">
7651 <title>Conditional skips in the configuration file</title>
7652 <para>
7653 <indexterm role="concept">
7654 <primary>configuration file</primary>
7655 <secondary>conditional skips</secondary>
7656 </indexterm>
7657 <indexterm role="concept">
7658 <primary><literal>.ifdef</literal></primary>
7659 </indexterm>
7660 You can use the directives <literal>.ifdef</literal>, <literal>.ifndef</literal>, <literal>.elifdef</literal>,
7661 <literal>.elifndef</literal>, <literal>.else</literal>, and <literal>.endif</literal> to dynamically include or exclude
7662 portions of the configuration file. The processing happens whenever the file is
7663 read (that is, when an Exim binary starts to run).
7664 </para>
7665 <para>
7666 The implementation is very simple. Instances of the first four directives must
7667 be followed by text that includes the names of one or macros. The condition
7668 that is tested is whether or not any macro substitution has taken place in the
7669 line. Thus:
7670 </para>
7671 <literallayout class="monospaced">
7672 .ifdef AAA
7673 message_size_limit = 50M
7674 .else
7675 message_size_limit = 100M
7676 .endif
7677 </literallayout>
7678 <para>
7679 sets a message size limit of 50M if the macro <literal>AAA</literal> is defined, and 100M
7680 otherwise. If there is more than one macro named on the line, the condition
7681 is true if any of them are defined. That is, it is an <quote>or</quote> condition. To
7682 obtain an <quote>and</quote> condition, you need to use nested <literal>.ifdef</literal>s.
7683 </para>
7684 <para>
7685 Although you can use a macro expansion to generate one of these directives,
7686 it is not very useful, because the condition <quote>there was a macro substitution
7687 in this line</quote> will always be true.
7688 </para>
7689 <para>
7690 Text following <literal>.else</literal> and <literal>.endif</literal> is ignored, and can be used as comment
7691 to clarify complicated nestings.
7692 </para>
7693 </section>
7694 <section id="SECTcos">
7695 <title>Common option syntax</title>
7696 <para>
7697 <indexterm role="concept">
7698 <primary>common option syntax</primary>
7699 </indexterm>
7700 <indexterm role="concept">
7701 <primary>syntax of common options</primary>
7702 </indexterm>
7703 <indexterm role="concept">
7704 <primary>configuration file</primary>
7705 <secondary>common option syntax</secondary>
7706 </indexterm>
7707 For the main set of options, driver options, and <function>local_scan()</function> options,
7708 each setting is on a line by itself, and starts with a name consisting of
7709 lower-case letters and underscores. Many options require a data value, and in
7710 these cases the name must be followed by an equals sign (with optional white
7711 space) and then the value. For example:
7712 </para>
7713 <literallayout class="monospaced">
7714 qualify_domain = mydomain.example.com
7715 </literallayout>
7716 <para>
7717 <indexterm role="concept">
7718 <primary>hiding configuration option values</primary>
7719 </indexterm>
7720 <indexterm role="concept">
7721 <primary>configuration options</primary>
7722 <secondary>hiding value of</secondary>
7723 </indexterm>
7724 <indexterm role="concept">
7725 <primary>options</primary>
7726 <secondary>hiding value of</secondary>
7727 </indexterm>
7728 Some option settings may contain sensitive data, for example, passwords for
7729 accessing databases. To stop non-admin users from using the <option>-bP</option> command
7730 line option to read these values, you can precede the option settings with the
7731 word <quote>hide</quote>. For example:
7732 </para>
7733 <literallayout class="monospaced">
7734 hide mysql_servers = localhost/users/admin/secret-password
7735 </literallayout>
7736 <para>
7737 For non-admin users, such options are displayed like this:
7738 </para>
7739 <literallayout class="monospaced">
7740 mysql_servers = &lt;value not displayable&gt;
7741 </literallayout>
7742 <para>
7743 If <quote>hide</quote> is used on a driver option, it hides the value of that option on
7744 all instances of the same driver.
7745 </para>
7746 <para>
7747 The following sections describe the syntax used for the different data types
7748 that are found in option settings.
7749 </para>
7750 </section>
7751 <section id="SECID47">
7752 <title>Boolean options</title>
7753 <para>
7754 <indexterm role="concept">
7755 <primary>format</primary>
7756 <secondary>boolean</secondary>
7757 </indexterm>
7758 <indexterm role="concept">
7759 <primary>boolean configuration values</primary>
7760 </indexterm>
7761 <indexterm role="option">
7762 <primary><option>no_</option><emphasis>xxx</emphasis></primary>
7763 </indexterm>
7764 <indexterm role="option">
7765 <primary><option>not_</option><emphasis>xxx</emphasis></primary>
7766 </indexterm>
7767 Options whose type is given as boolean are on/off switches. There are two
7768 different ways of specifying such options: with and without a data value. If
7769 the option name is specified on its own without data, the switch is turned on;
7770 if it is preceded by <quote>no_</quote> or <quote>not_</quote> the switch is turned off. However,
7771 boolean options may be followed by an equals sign and one of the words
7772 <quote>true</quote>, <quote>false</quote>, <quote>yes</quote>, or <quote>no</quote>, as an alternative syntax. For example,
7773 the following two settings have exactly the same effect:
7774 </para>
7775 <literallayout class="monospaced">
7776 queue_only
7777 queue_only = true
7778 </literallayout>
7779 <para>
7780 The following two lines also have the same (opposite) effect:
7781 </para>
7782 <literallayout class="monospaced">
7783 no_queue_only
7784 queue_only = false
7785 </literallayout>
7786 <para>
7787 You can use whichever syntax you prefer.
7788 </para>
7789 </section>
7790 <section id="SECID48">
7791 <title>Integer values</title>
7792 <para>
7793 <indexterm role="concept">
7794 <primary>integer configuration values</primary>
7795 </indexterm>
7796 <indexterm role="concept">
7797 <primary>format</primary>
7798 <secondary>integer</secondary>
7799 </indexterm>
7800 If an option&#x2019;s type is given as <quote>integer</quote>, the value can be given in decimal,
7801 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
7802 number is assumed. Otherwise, it is treated as an octal number unless it starts
7803 with the characters <quote>0x</quote>, in which case the remainder is interpreted as a
7804 hexadecimal number.
7805 </para>
7806 <para>
7807 If an integer value is followed by the letter K, it is multiplied by 1024; if
7808 it is followed by the letter M, it is multiplied by 1024x1024. When the values
7809 of integer option settings are output, values which are an exact multiple of
7810 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
7811 and M. The printing style is independent of the actual input format that was
7812 used.
7813 </para>
7814 </section>
7815 <section id="SECID49">
7816 <title>Octal integer values</title>
7817 <para>
7818 <indexterm role="concept">
7819 <primary>integer format</primary>
7820 </indexterm>
7821 <indexterm role="concept">
7822 <primary>format</primary>
7823 <secondary>octal integer</secondary>
7824 </indexterm>
7825 If an option&#x2019;s type is given as <quote>octal integer</quote>, its value is always
7826 interpreted as an octal number, whether or not it starts with the digit zero.
7827 Such options are always output in octal.
7828 </para>
7829 </section>
7830 <section id="SECID50">
7831 <title>Fixed point numbers</title>
7832 <para>
7833 <indexterm role="concept">
7834 <primary>fixed point configuration values</primary>
7835 </indexterm>
7836 <indexterm role="concept">
7837 <primary>format</primary>
7838 <secondary>fixed point</secondary>
7839 </indexterm>
7840 If an option&#x2019;s type is given as <quote>fixed-point</quote>, its value must be a decimal
7841 integer, optionally followed by a decimal point and up to three further digits.
7842 </para>
7843 </section>
7844 <section id="SECTtimeformat">
7845 <title>Time intervals</title>
7846 <para>
7847 <indexterm role="concept">
7848 <primary>time interval</primary>
7849 <secondary>specifying in configuration</secondary>
7850 </indexterm>
7851 <indexterm role="concept">
7852 <primary>format</primary>
7853 <secondary>time interval</secondary>
7854 </indexterm>
7855 A time interval is specified as a sequence of numbers, each followed by one of
7856 the following letters, with no intervening white space:
7857 </para>
7858 <informaltable frame="none">
7859 <tgroup cols="2" colsep="0" rowsep="0">
7860 <colspec colwidth="30pt" align="left"/>
7861 <colspec colwidth="254pt" align="left"/>
7862 <tbody>
7863 <row>
7864 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>s</option></entry>
7865 <entry>seconds</entry>
7866 </row>
7867 <row>
7868 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>m</option></entry>
7869 <entry>minutes</entry>
7870 </row>
7871 <row>
7872 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>h</option></entry>
7873 <entry>hours</entry>
7874 </row>
7875 <row>
7876 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>d</option></entry>
7877 <entry>days</entry>
7878 </row>
7879 <row>
7880 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>w</option></entry>
7881 <entry>weeks</entry>
7882 </row>
7883 </tbody>
7884 </tgroup>
7885 </informaltable>
7886 <para>
7887 For example, <quote>3h50m</quote> specifies 3 hours and 50 minutes. The values of time
7888 intervals are output in the same format. Exim does not restrict the values; it
7889 is perfectly acceptable, for example, to specify <quote>90m</quote> instead of <quote>1h30m</quote>.
7890 </para>
7891 </section>
7892 <section id="SECTstrings">
7893 <title>String values</title>
7894 <para>
7895 <indexterm role="concept">
7896 <primary>string</primary>
7897 <secondary>format of configuration values</secondary>
7898 </indexterm>
7899 <indexterm role="concept">
7900 <primary>format</primary>
7901 <secondary>string</secondary>
7902 </indexterm>
7903 If an option&#x2019;s type is specified as <quote>string</quote>, the value can be specified with
7904 or without double-quotes. If it does not start with a double-quote, the value
7905 consists of the remainder of the line plus any continuation lines, starting at
7906 the first character after any leading white space, with trailing white space
7907 removed, and with no interpretation of the characters in the string. Because
7908 Exim removes comment lines (those beginning with #) at an early stage, they can
7909 appear in the middle of a multi-line string. The following two settings are
7910 therefore equivalent:
7911 </para>
7912 <literallayout class="monospaced">
7913 trusted_users = uucp:mail
7914 trusted_users = uucp:\
7915                 # This comment line is ignored
7916                 mail
7917 </literallayout>
7918 <para>
7919 <indexterm role="concept">
7920 <primary>string</primary>
7921 <secondary>quoted</secondary>
7922 </indexterm>
7923 <indexterm role="concept">
7924 <primary>escape characters in quoted strings</primary>
7925 </indexterm>
7926 If a string does start with a double-quote, it must end with a closing
7927 double-quote, and any backslash characters other than those used for line
7928 continuation are interpreted as escape characters, as follows:
7929 </para>
7930 <informaltable frame="none">
7931 <tgroup cols="2" colsep="0" rowsep="0">
7932 <colspec colwidth="100pt" align="left"/>
7933 <colspec colwidth="254pt" align="left"/>
7934 <tbody>
7935 <row>
7936 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<literal>\\</literal></entry>
7937 <entry>single backslash</entry>
7938 </row>
7939 <row>
7940 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<literal>\n</literal></entry>
7941 <entry>newline</entry>
7942 </row>
7943 <row>
7944 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<literal>\r</literal></entry>
7945 <entry>carriage return</entry>
7946 </row>
7947 <row>
7948 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<literal>\t</literal></entry>
7949 <entry>tab</entry>
7950 </row>
7951 <row>
7952 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<literal>\</literal>&lt;<emphasis>octal digits</emphasis>&gt;</entry>
7953 <entry>up to 3 octal digits specify one character</entry>
7954 </row>
7955 <row>
7956 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<literal>\x</literal>&lt;<emphasis>hex digits</emphasis>&gt;</entry>
7957 <entry>up to 2 hexadecimal digits specify one character</entry>
7958 </row>
7959 </tbody>
7960 </tgroup>
7961 </informaltable>
7962 <para>
7963 If a backslash is followed by some other character, including a double-quote
7964 character, that character replaces the pair.
7965 </para>
7966 <para>
7967 Quoting is necessary only if you want to make use of the backslash escapes to
7968 insert special characters, or if you need to specify a value with leading or
7969 trailing spaces. These cases are rare, so quoting is almost never needed in
7970 current versions of Exim. In versions of Exim before 3.14, quoting was required
7971 in order to continue lines, so you may come across older configuration files
7972 and examples that apparently quote unnecessarily.
7973 </para>
7974 </section>
7975 <section id="SECID51">
7976 <title>Expanded strings</title>
7977 <para>
7978 <indexterm role="concept">
7979 <primary>expansion</primary>
7980 <secondary>definition of</secondary>
7981 </indexterm>
7982 Some strings in the configuration file are subjected to <emphasis>string expansion</emphasis>,
7983 by which means various parts of the string may be changed according to the
7984 circumstances (see chapter <xref linkend="CHAPexpand"/>). The input syntax for such strings
7985 is as just described; in particular, the handling of backslashes in quoted
7986 strings is done as part of the input process, before expansion takes place.
7987 However, backslash is also an escape character for the expander, so any
7988 backslashes that are required for that reason must be doubled if they are
7989 within a quoted configuration string.
7990 </para>
7991 </section>
7992 <section id="SECID52">
7993 <title>User and group names</title>
7994 <para>
7995 <indexterm role="concept">
7996 <primary>user name</primary>
7997 <secondary>format of</secondary>
7998 </indexterm>
7999 <indexterm role="concept">
8000 <primary>format</primary>
8001 <secondary>user name</secondary>
8002 </indexterm>
8003 <indexterm role="concept">
8004 <primary>groups</primary>
8005 <secondary>name format</secondary>
8006 </indexterm>
8007 <indexterm role="concept">
8008 <primary>format</primary>
8009 <secondary>group name</secondary>
8010 </indexterm>
8011 User and group names are specified as strings, using the syntax described
8012 above, but the strings are interpreted specially. A user or group name must
8013 either consist entirely of digits, or be a name that can be looked up using the
8014 <function>getpwnam()</function> or <function>getgrnam()</function> function, as appropriate.
8015 </para>
8016 </section>
8017 <section id="SECTlistconstruct">
8018 <title>List construction</title>
8019 <para>
8020 <indexterm role="concept">
8021 <primary>list</primary>
8022 <secondary>syntax of in configuration</secondary>
8023 </indexterm>
8024 <indexterm role="concept">
8025 <primary>format</primary>
8026 <secondary>list item in configuration</secondary>
8027 </indexterm>
8028 <indexterm role="concept">
8029 <primary>string</primary>
8030 <secondary>list, definition of</secondary>
8031 </indexterm>
8032 The data for some configuration options is a list of items, with colon as the
8033 default separator. Many of these options are shown with type <quote>string list</quote> in
8034 the descriptions later in this document. Others are listed as <quote>domain list</quote>,
8035 <quote>host list</quote>, <quote>address list</quote>, or <quote>local part list</quote>. Syntactically, they
8036 are all the same; however, those other than <quote>string list</quote> are subject to
8037 particular kinds of interpretation, as described in chapter
8038 <xref linkend="CHAPdomhosaddlists"/>.
8039 </para>
8040 <para>
8041 In all these cases, the entire list is treated as a single string as far as the
8042 input syntax is concerned. The <option>trusted_users</option> setting in section
8043 <xref linkend="SECTstrings"/> above is an example. If a colon is actually needed in an item
8044 in a list, it must be entered as two colons. Leading and trailing white space
8045 on each item in a list is ignored. This makes it possible to include items that
8046 start with a colon, and in particular, certain forms of IPv6 address. For
8047 example, the list
8048 </para>
8049 <literallayout class="monospaced">
8050 local_interfaces = 127.0.0.1 : ::::1
8051 </literallayout>
8052 <para>
8053 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
8054 </para>
8055 <para>
8056 <emphasis role="bold">Note</emphasis>: Although leading and trailing white space is ignored in individual
8057 list items, it is not ignored when parsing the list. The space after the first
8058 colon in the example above is necessary. If it were not there, the list would
8059 be interpreted as the two items 127.0.0.1:: and 1.
8060 </para>
8061 </section>
8062 <section id="SECID53">
8063 <title>Changing list separators</title>
8064 <para>
8065 <indexterm role="concept">
8066 <primary>list separator</primary>
8067 <secondary>changing</secondary>
8068 </indexterm>
8069 <indexterm role="concept">
8070 <primary>IPv6</primary>
8071 <secondary>addresses in lists</secondary>
8072 </indexterm>
8073 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
8074 introduced to allow the separator character to be changed. If a list begins
8075 with a left angle bracket, followed by any punctuation character, that
8076 character is used instead of colon as the list separator. For example, the list
8077 above can be rewritten to use a semicolon separator like this:
8078 </para>
8079 <literallayout class="monospaced">
8080 local_interfaces = &lt;; 127.0.0.1 ; ::1
8081 </literallayout>
8082 <para>
8083 This facility applies to all lists, with the exception of the list in
8084 <option>log_file_path</option>. It is recommended that the use of non-colon separators be
8085 confined to circumstances where they really are needed.
8086 </para>
8087 <para>
8088 <indexterm role="concept">
8089 <primary>list separator</primary>
8090 <secondary>newline as</secondary>
8091 </indexterm>
8092 <indexterm role="concept">
8093 <primary>newline</primary>
8094 <secondary>as list separator</secondary>
8095 </indexterm>
8096 It is also possible to use newline and other control characters (those with
8097 code values less than 32, plus DEL) as separators in lists. Such separators
8098 must be provided literally at the time the list is processed. For options that
8099 are string-expanded, you can write the separator using a normal escape
8100 sequence. This will be processed by the expander before the string is
8101 interpreted as a list. For example, if a newline-separated list of domains is
8102 generated by a lookup, you can process it directly by a line such as this:
8103 </para>
8104 <literallayout class="monospaced">
8105 domains = &lt;\n ${lookup mysql{.....}}
8106 </literallayout>
8107 <para>
8108 This avoids having to change the list separator in such data. You are unlikely
8109 to want to use a control character as a separator in an option that is not
8110 expanded, because the value is literal text. However, it can be done by giving
8111 the value in quotes. For example:
8112 </para>
8113 <literallayout class="monospaced">
8114 local_interfaces = "&lt;\n 127.0.0.1 \n ::1"
8115 </literallayout>
8116 <para>
8117 Unlike printing character separators, which can be included in list items by
8118 doubling, it is not possible to include a control character as data when it is
8119 set as the separator. Two such characters in succession are interpreted as
8120 enclosing an empty list item.
8121 </para>
8122 </section>
8123 <section id="SECTempitelis">
8124 <title>Empty items in lists</title>
8125 <para>
8126 <indexterm role="concept">
8127 <primary>list</primary>
8128 <secondary>empty item in</secondary>
8129 </indexterm>
8130 An empty item at the end of a list is always ignored. In other words, trailing
8131 separator characters are ignored. Thus, the list in
8132 </para>
8133 <literallayout class="monospaced">
8134 senders = user@domain :
8135 </literallayout>
8136 <para>
8137 contains only a single item. If you want to include an empty string as one item
8138 in a list, it must not be the last item. For example, this list contains three
8139 items, the second of which is empty:
8140 </para>
8141 <literallayout class="monospaced">
8142 senders = user1@domain : : user2@domain
8143 </literallayout>
8144 <para>
8145 <emphasis role="bold">Note</emphasis>: There must be white space between the two colons, as otherwise they
8146 are interpreted as representing a single colon data character (and the list
8147 would then contain just one item). If you want to specify a list that contains
8148 just one, empty item, you can do it as in this example:
8149 </para>
8150 <literallayout class="monospaced">
8151 senders = :
8152 </literallayout>
8153 <para>
8154 In this case, the first item is empty, and the second is discarded because it
8155 is at the end of the list.
8156 </para>
8157 </section>
8158 <section id="SECTfordricon">
8159 <title>Format of driver configurations</title>
8160 <para>
8161 <indexterm role="concept">
8162 <primary>drivers</primary>
8163 <secondary>configuration format</secondary>
8164 </indexterm>
8165 There are separate parts in the configuration for defining routers, transports,
8166 and authenticators. In each part, you are defining a number of driver
8167 instances, each with its own set of options. Each driver instance is defined by
8168 a sequence of lines like this:
8169 </para>
8170 <literallayout>
8171 &lt;<emphasis>instance name</emphasis>&gt;:
8172   &lt;<emphasis>option</emphasis>&gt;
8173   ...
8174   &lt;<emphasis>option</emphasis>&gt;
8175 </literallayout>
8176 <para>
8177 In the following example, the instance name is <command>localuser</command>, and it is
8178 followed by three options settings:
8179 </para>
8180 <literallayout class="monospaced">
8181 localuser:
8182   driver = accept
8183   check_local_user
8184   transport = local_delivery
8185 </literallayout>
8186 <para>
8187 For each driver instance, you specify which Exim code module it uses &ndash; by the
8188 setting of the <option>driver</option> option &ndash; and (optionally) some configuration
8189 settings. For example, in the case of transports, if you want a transport to
8190 deliver with SMTP you would use the <command>smtp</command> driver; if you want to deliver to
8191 a local file you would use the <command>appendfile</command> driver. Each of the drivers is
8192 described in detail in its own separate chapter later in this manual.
8193 </para>
8194 <para>
8195 You can have several routers, transports, or authenticators that are based on
8196 the same underlying driver (each must have a different instance name).
8197 </para>
8198 <para>
8199 The order in which routers are defined is important, because addresses are
8200 passed to individual routers one by one, in order. The order in which
8201 transports are defined does not matter at all. The order in which
8202 authenticators are defined is used only when Exim, as a client, is searching
8203 them to find one that matches an authentication mechanism offered by the
8204 server.
8205 </para>
8206 <para>
8207 <indexterm role="concept">
8208 <primary>generic options</primary>
8209 </indexterm>
8210 <indexterm role="concept">
8211 <primary>options</primary>
8212 <secondary>generic &ndash; definition of</secondary>
8213 </indexterm>
8214 Within a driver instance definition, there are two kinds of option: <emphasis>generic</emphasis>
8215 and <emphasis>private</emphasis>. The generic options are those that apply to all drivers of the
8216 same type (that is, all routers, all transports or all authenticators). The
8217 <option>driver</option> option is a generic option that must appear in every definition.
8218 <indexterm role="concept">
8219 <primary>private options</primary>
8220 </indexterm>
8221 The private options are special for each driver, and none need appear, because
8222 they all have default values.
8223 </para>
8224 <para>
8225 The options may appear in any order, except that the <option>driver</option> option must
8226 precede any private options, since these depend on the particular driver. For
8227 this reason, it is recommended that <option>driver</option> always be the first option.
8228 </para>
8229 <para>
8230 Driver instance names, which are used for reference in log entries and
8231 elsewhere, can be any sequence of letters, digits, and underscores (starting
8232 with a letter) and must be unique among drivers of the same type. A router and
8233 a transport (for example) can each have the same name, but no two router
8234 instances can have the same name. The name of a driver instance should not be
8235 confused with the name of the underlying driver module. For example, the
8236 configuration lines:
8237 </para>
8238 <literallayout class="monospaced">
8239 remote_smtp:
8240   driver = smtp
8241 </literallayout>
8242 <para>
8243 create an instance of the <command>smtp</command> transport driver whose name is
8244 <command>remote_smtp</command>. The same driver code can be used more than once, with
8245 different instance names and different option settings each time. A second
8246 instance of the <command>smtp</command> transport, with different options, might be defined
8247 thus:
8248 </para>
8249 <literallayout class="monospaced">
8250 special_smtp:
8251   driver = smtp
8252   port = 1234
8253   command_timeout = 10s
8254 </literallayout>
8255 <para>
8256 The names <command>remote_smtp</command> and <command>special_smtp</command> would be used to reference
8257 these transport instances from routers, and these names would appear in log
8258 lines.
8259 </para>
8260 <para>
8261 Comment lines may be present in the middle of driver specifications. The full
8262 list of option settings for any particular driver instance, including all the
8263 defaulted values, can be extracted by making use of the <option>-bP</option> command line
8264 option.
8265 </para>
8266 </section>
8267 </chapter>
8268
8269 <chapter id="CHAPdefconfil">
8270 <title>The default configuration file</title>
8271 <para>
8272 <indexterm role="concept" id="IIDconfiwal" class="startofrange">
8273 <primary>configuration file</primary>
8274 <secondary>default <quote>walk through</quote></secondary>
8275 </indexterm>
8276 <indexterm role="concept">
8277 <primary>default</primary>
8278 <secondary>configuration file <quote>walk through</quote></secondary>
8279 </indexterm>
8280 The default configuration file supplied with Exim as <filename>src/configure.default</filename>
8281 is sufficient for a host with simple mail requirements. As an introduction to
8282 the way Exim is configured, this chapter <quote>walks through</quote> the default
8283 configuration, giving brief explanations of the settings. Detailed descriptions
8284 of the options are given in subsequent chapters. The default configuration file
8285 itself contains extensive comments about ways you might want to modify the
8286 initial settings. However, note that there are many options that are not
8287 mentioned at all in the default configuration.
8288 </para>
8289 <section id="SECTdefconfmain">
8290 <title>Main configuration settings</title>
8291 <para>
8292 The main (global) configuration option settings must always come first in the
8293 file. The first thing you&#x2019;ll see in the file, after some initial comments, is
8294 the line
8295 </para>
8296 <literallayout class="monospaced">
8297 # primary_hostname =
8298 </literallayout>
8299 <para>
8300 This is a commented-out setting of the <option>primary_hostname</option> option. Exim needs
8301 to know the official, fully qualified name of your host, and this is where you
8302 can specify it. However, in most cases you do not need to set this option. When
8303 it is unset, Exim uses the <function>uname()</function> system function to obtain the host name.
8304 </para>
8305 <para>
8306 The first three non-comment configuration lines are as follows:
8307 </para>
8308 <literallayout class="monospaced">
8309 domainlist local_domains    = @
8310 domainlist relay_to_domains =
8311 hostlist   relay_from_hosts = 127.0.0.1
8312 </literallayout>
8313 <para>
8314 These are not, in fact, option settings. They are definitions of two named
8315 domain lists and one named host list. Exim allows you to give names to lists of
8316 domains, hosts, and email addresses, in order to make it easier to manage the
8317 configuration file (see section <xref linkend="SECTnamedlists"/>).
8318 </para>
8319 <para>
8320 The first line defines a domain list called <emphasis>local_domains</emphasis>; this is used
8321 later in the configuration to identify domains that are to be delivered
8322 on the local host.
8323 </para>
8324 <para>
8325 <indexterm role="concept">
8326 <primary>@ in a domain list</primary>
8327 </indexterm>
8328 There is just one item in this list, the string <quote>@</quote>. This is a special form
8329 of entry which means <quote>the name of the local host</quote>. Thus, if the local host is
8330 called <emphasis>a.host.example</emphasis>, mail to <emphasis>any.user@a.host.example</emphasis> is expected to
8331 be delivered locally. Because the local host&#x2019;s name is referenced indirectly,
8332 the same configuration file can be used on different hosts.
8333 </para>
8334 <para>
8335 The second line defines a domain list called <emphasis>relay_to_domains</emphasis>, but the
8336 list itself is empty. Later in the configuration we will come to the part that
8337 controls mail relaying through the local host; it allows relaying to any
8338 domains in this list. By default, therefore, no relaying on the basis of a mail
8339 domain is permitted.
8340 </para>
8341 <para>
8342 The third line defines a host list called <emphasis>relay_from_hosts</emphasis>. This list is
8343 used later in the configuration to permit relaying from any host or IP address
8344 that matches the list. The default contains just the IP address of the IPv4
8345 loopback interface, which means that processes on the local host are able to
8346 submit mail for relaying by sending it over TCP/IP to that interface. No other
8347 hosts are permitted to submit messages for relaying.
8348 </para>
8349 <para>
8350 Just to be sure there&#x2019;s no misunderstanding: at this point in the configuration
8351 we aren&#x2019;t actually setting up any controls. We are just defining some domains
8352 and hosts that will be used in the controls that are specified later.
8353 </para>
8354 <para>
8355 The next two configuration lines are genuine option settings:
8356 </para>
8357 <literallayout class="monospaced">
8358 acl_smtp_rcpt = acl_check_rcpt
8359 acl_smtp_data = acl_check_data
8360 </literallayout>
8361 <para>
8362 These options specify <emphasis>Access Control Lists</emphasis> (ACLs) that are to be used
8363 during an incoming SMTP session for every recipient of a message (every RCPT
8364 command), and after the contents of the message have been received,
8365 respectively. The names of the lists are <emphasis>acl_check_rcpt</emphasis> and
8366 <emphasis>acl_check_data</emphasis>, and we will come to their definitions below, in the ACL
8367 section of the configuration. The RCPT ACL controls which recipients are
8368 accepted for an incoming message &ndash; if a configuration does not provide an ACL
8369 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
8370 contents of a message to be checked.
8371 </para>
8372 <para>
8373 Two commented-out option settings are next:
8374 </para>
8375 <literallayout class="monospaced">
8376 # av_scanner = clamd:/tmp/clamd
8377 # spamd_address = 127.0.0.1 783
8378 </literallayout>
8379 <para>
8380 These are example settings that can be used when Exim is compiled with the
8381 content-scanning extension. The first specifies the interface to the virus
8382 scanner, and the second specifies the interface to SpamAssassin. Further
8383 details are given in chapter <xref linkend="CHAPexiscan"/>.
8384 </para>
8385 <para>
8386 Three more commented-out option settings follow:
8387 </para>
8388 <literallayout class="monospaced">
8389 # tls_advertise_hosts = *
8390 # tls_certificate = /etc/ssl/exim.crt
8391 # tls_privatekey = /etc/ssl/exim.pem
8392 </literallayout>
8393 <para>
8394 These are example settings that can be used when Exim is compiled with
8395 support for TLS (aka SSL) as described in section <xref linkend="SECTinctlsssl"/>. The
8396 first one specifies the list of clients that are allowed to use TLS when
8397 connecting to this server; in this case the wildcard means all clients. The
8398 other options specify where Exim should find its TLS certificate and private
8399 key, which together prove the server&#x2019;s identity to any clients that connect.
8400 More details are given in chapter <xref linkend="CHAPTLS"/>.
8401 </para>
8402 <para>
8403 Another two commented-out option settings follow:
8404 </para>
8405 <literallayout class="monospaced">
8406 # daemon_smtp_ports = 25 : 465 : 587
8407 # tls_on_connect_ports = 465
8408 </literallayout>
8409 <para>
8410 <indexterm role="concept">
8411 <primary>port</primary>
8412 <secondary>465 and 587</secondary>
8413 </indexterm>
8414 <indexterm role="concept">
8415 <primary>port</primary>
8416 <secondary>for message submission</secondary>
8417 </indexterm>
8418 <indexterm role="concept">
8419 <primary>message</primary>
8420 <secondary>submission, ports for</secondary>
8421 </indexterm>
8422 <indexterm role="concept">
8423 <primary>ssmtp protocol</primary>
8424 </indexterm>
8425 <indexterm role="concept">
8426 <primary>smtps protocol</primary>
8427 </indexterm>
8428 <indexterm role="concept">
8429 <primary>SMTP</primary>
8430 <secondary>ssmtp protocol</secondary>
8431 </indexterm>
8432 <indexterm role="concept">
8433 <primary>SMTP</primary>
8434 <secondary>smtps protocol</secondary>
8435 </indexterm>
8436 These options provide better support for roaming users who wish to use this
8437 server for message submission. They are not much use unless you have turned on
8438 TLS (as described in the previous paragraph) and authentication (about which
8439 more in section <xref linkend="SECTdefconfauth"/>). The usual SMTP port 25 is often blocked
8440 on end-user networks, so RFC 4409 specifies that message submission should use
8441 port 587 instead. However some software (notably Microsoft Outlook) cannot be
8442 configured to use port 587 correctly, so these settings also enable the
8443 non-standard <quote>smtps</quote> (aka <quote>ssmtp</quote>) port 465 (see section
8444 <xref linkend="SECTsupobssmt"/>).
8445 </para>
8446 <para>
8447 Two more commented-out options settings follow:
8448 </para>
8449 <literallayout class="monospaced">
8450 # qualify_domain =
8451 # qualify_recipient =
8452 </literallayout>
8453 <para>
8454 The first of these specifies a domain that Exim uses when it constructs a
8455 complete email address from a local login name. This is often needed when Exim
8456 receives a message from a local process. If you do not set <option>qualify_domain</option>,
8457 the value of <option>primary_hostname</option> is used. If you set both of these options,
8458 you can have different qualification domains for sender and recipient
8459 addresses. If you set only the first one, its value is used in both cases.
8460 </para>
8461 <para>
8462 <indexterm role="concept">
8463 <primary>domain literal</primary>
8464 <secondary>recognizing format</secondary>
8465 </indexterm>
8466 The following line must be uncommented if you want Exim to recognize
8467 addresses of the form <emphasis>user@[10.11.12.13]</emphasis> that is, with a <quote>domain literal</quote>
8468 (an IP address within square brackets) instead of a named domain.
8469 </para>
8470 <literallayout class="monospaced">
8471 # allow_domain_literals
8472 </literallayout>
8473 <para>
8474 The RFCs still require this form, but many people think that in the modern
8475 Internet it makes little sense to permit mail to be sent to specific hosts by
8476 quoting their IP addresses. This ancient format has been used by people who
8477 try to abuse hosts by using them for unwanted relaying. However, some
8478 people believe there are circumstances (for example, messages addressed to
8479 <emphasis>postmaster</emphasis>) where domain literals are still useful.
8480 </para>
8481 <para>
8482 The next configuration line is a kind of trigger guard:
8483 </para>
8484 <literallayout class="monospaced">
8485 never_users = root
8486 </literallayout>
8487 <para>
8488 It specifies that no delivery must ever be run as the root user. The normal
8489 convention is to set up <emphasis>root</emphasis> as an alias for the system administrator. This
8490 setting is a guard against slips in the configuration.
8491 The list of users specified by <option>never_users</option> is not, however, the complete
8492 list; the build-time configuration in <filename>Local/Makefile</filename> has an option called
8493 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
8494 contents of <option>never_users</option> are added to this list. By default
8495 FIXED_NEVER_USERS also specifies root.
8496 </para>
8497 <para>
8498 When a remote host connects to Exim in order to send mail, the only information
8499 Exim has about the host&#x2019;s identity is its IP address. The next configuration
8500 line,
8501 </para>
8502 <literallayout class="monospaced">
8503 host_lookup = *
8504 </literallayout>
8505 <para>
8506 specifies that Exim should do a reverse DNS lookup on all incoming connections,
8507 in order to get a host name. This improves the quality of the logging
8508 information, but if you feel it is too expensive, you can remove it entirely,
8509 or restrict the lookup to hosts on <quote>nearby</quote> networks.
8510 Note that it is not always possible to find a host name from an IP address,
8511 because not all DNS reverse zones are maintained, and sometimes DNS servers are
8512 unreachable.
8513 </para>
8514 <para>
8515 The next two lines are concerned with <emphasis>ident</emphasis> callbacks, as defined by RFC
8516 1413 (hence their names):
8517 </para>
8518 <literallayout class="monospaced">
8519 rfc1413_query_hosts = *
8520 rfc1413_query_timeout = 0s
8521 </literallayout>
8522 <para>
8523 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
8524 Few hosts offer RFC1413 service these days; calls have to be
8525 terminated by a timeout and this needlessly delays the startup
8526 of an incoming SMTP connection.
8527 If you have hosts for which you trust RFC1413 and need this
8528 information, you can change this.
8529 </para>
8530 <para>
8531 This line enables an efficiency SMTP option.  It is negociated by clients
8532 and not expected to cause problems but can be disabled if needed.
8533 </para>
8534 <literallayout class="monospaced">
8535 prdr_enable = true
8536 </literallayout>
8537 <para>
8538 When Exim receives messages over SMTP connections, it expects all addresses to
8539 be fully qualified with a domain, as required by the SMTP definition. However,
8540 if you are running a server to which simple clients submit messages, you may
8541 find that they send unqualified addresses. The two commented-out options:
8542 </para>
8543 <literallayout class="monospaced">
8544 # sender_unqualified_hosts =
8545 # recipient_unqualified_hosts =
8546 </literallayout>
8547 <para>
8548 show how you can specify hosts that are permitted to send unqualified sender
8549 and recipient addresses, respectively.
8550 </para>
8551 <para>
8552 The <option>percent_hack_domains</option> option is also commented out:
8553 </para>
8554 <literallayout class="monospaced">
8555 # percent_hack_domains =
8556 </literallayout>
8557 <para>
8558 It provides a list of domains for which the <quote>percent hack</quote> is to operate.
8559 This is an almost obsolete form of explicit email routing. If you do not know
8560 anything about it, you can safely ignore this topic.
8561 </para>
8562 <para>
8563 The last two settings in the main part of the default configuration are
8564 concerned with messages that have been <quote>frozen</quote> on Exim&#x2019;s queue. When a
8565 message is frozen, Exim no longer continues to try to deliver it. Freezing
8566 occurs when a bounce message encounters a permanent failure because the sender
8567 address of the original message that caused the bounce is invalid, so the
8568 bounce cannot be delivered. This is probably the most common case, but there
8569 are also other conditions that cause freezing, and frozen messages are not
8570 always bounce messages.
8571 </para>
8572 <literallayout class="monospaced">
8573 ignore_bounce_errors_after = 2d
8574 timeout_frozen_after = 7d
8575 </literallayout>
8576 <para>
8577 The first of these options specifies that failing bounce messages are to be
8578 discarded after 2 days on the queue. The second specifies that any frozen
8579 message (whether a bounce message or not) is to be timed out (and discarded)
8580 after a week. In this configuration, the first setting ensures that no failing
8581 bounce message ever lasts a week.
8582 </para>
8583 </section>
8584 <section id="SECID54">
8585 <title>ACL configuration</title>
8586 <para>
8587 <indexterm role="concept">
8588 <primary>default</primary>
8589 <secondary>ACLs</secondary>
8590 </indexterm>
8591 <indexterm role="concept">
8592 <primary>access control lists (ACLs)</primary>
8593 <secondary>default configuration</secondary>
8594 </indexterm>
8595 In the default configuration, the ACL section follows the main configuration.
8596 It starts with the line
8597 </para>
8598 <literallayout class="monospaced">
8599 begin acl
8600 </literallayout>
8601 <para>
8602 and it contains the definitions of two ACLs, called <emphasis>acl_check_rcpt</emphasis> and
8603 <emphasis>acl_check_data</emphasis>, that were referenced in the settings of <option>acl_smtp_rcpt</option>
8604 and <option>acl_smtp_data</option> above.
8605 </para>
8606 <para>
8607 <indexterm role="concept">
8608 <primary>RCPT</primary>
8609 <secondary>ACL for</secondary>
8610 </indexterm>
8611 The first ACL is used for every RCPT command in an incoming SMTP message. Each
8612 RCPT command specifies one of the message&#x2019;s recipients. The ACL statements
8613 are considered in order, until the recipient address is either accepted or
8614 rejected. The RCPT command is then accepted or rejected, according to the
8615 result of the ACL processing.
8616 </para>
8617 <literallayout class="monospaced">
8618 acl_check_rcpt:
8619 </literallayout>
8620 <para>
8621 This line, consisting of a name terminated by a colon, marks the start of the
8622 ACL, and names it.
8623 </para>
8624 <literallayout class="monospaced">
8625 accept  hosts = :
8626 </literallayout>
8627 <para>
8628 This ACL statement accepts the recipient if the sending host matches the list.
8629 But what does that strange list mean? It doesn&#x2019;t actually contain any host
8630 names or IP addresses. The presence of the colon puts an empty item in the
8631 list; Exim matches this only if the incoming message did not come from a remote
8632 host, because in that case, the remote hostname is empty. The colon is
8633 important. Without it, the list itself is empty, and can never match anything.
8634 </para>
8635 <para>
8636 What this statement is doing is to accept unconditionally all recipients in
8637 messages that are submitted by SMTP from local processes using the standard
8638 input and output (that is, not using TCP/IP). A number of MUAs operate in this
8639 manner.
8640 </para>
8641 <literallayout class="monospaced">
8642 deny    message       = Restricted characters in address
8643         domains       = +local_domains
8644         local_parts   = ^[.] : ^.*[@%!/|]
8645
8646 deny    message       = Restricted characters in address
8647         domains       = !+local_domains
8648         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
8649 </literallayout>
8650 <para>
8651 These statements are concerned with local parts that contain any of the
8652 characters <quote>@</quote>, <quote>%</quote>, <quote>!</quote>, <quote>/</quote>, <quote>|</quote>, or dots in unusual places.
8653 Although these characters are entirely legal in local parts (in the case of
8654 <quote>@</quote> and leading dots, only if correctly quoted), they do not commonly occur
8655 in Internet mail addresses.
8656 </para>
8657 <para>
8658 The first three have in the past been associated with explicitly routed
8659 addresses (percent is still sometimes used &ndash; see the <option>percent_hack_domains</option>
8660 option). Addresses containing these characters are regularly tried by spammers
8661 in an attempt to bypass relaying restrictions, and also by open relay testing
8662 programs. Unless you really need them it is safest to reject these characters
8663 at this early stage. This configuration is heavy-handed in rejecting these
8664 characters for all messages it accepts from remote hosts. This is a deliberate
8665 policy of being as safe as possible.
8666 </para>
8667 <para>
8668 The first rule above is stricter, and is applied to messages that are addressed
8669 to one of the local domains handled by this host. This is implemented by the
8670 first condition, which restricts it to domains that are listed in the
8671 <emphasis>local_domains</emphasis> domain list. The <quote>+</quote> character is used to indicate a
8672 reference to a named list. In this configuration, there is just one domain in
8673 <emphasis>local_domains</emphasis>, but in general there may be many.
8674 </para>
8675 <para>
8676 The second condition on the first statement uses two regular expressions to
8677 block local parts that begin with a dot or contain <quote>@</quote>, <quote>%</quote>, <quote>!</quote>, <quote>/</quote>,
8678 or <quote>|</quote>. If you have local accounts that include these characters, you will
8679 have to modify this rule.
8680 </para>
8681 <para>
8682 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
8683 allows them because they have been encountered in practice. (Consider the
8684 common convention of local parts constructed as
8685 <quote><emphasis>first-initial.second-initial.family-name</emphasis></quote> when applied to someone like
8686 the author of Exim, who has no second initial.) However, a local part starting
8687 with a dot or containing <quote>/../</quote> can cause trouble if it is used as part of a
8688 file name (for example, for a mailing list). This is also true for local parts
8689 that contain slashes. A pipe symbol can also be troublesome if the local part
8690 is incorporated unthinkingly into a shell command line.
8691 </para>
8692 <para>
8693 The second rule above applies to all other domains, and is less strict. This
8694 allows your own users to send outgoing messages to sites that use slashes
8695 and vertical bars in their local parts. It blocks local parts that begin
8696 with a dot, slash, or vertical bar, but allows these characters within the
8697 local part. However, the sequence <quote>/../</quote> is barred. The use of <quote>@</quote>, <quote>%</quote>,
8698 and <quote>!</quote> is blocked, as before. The motivation here is to prevent your users
8699 (or your users&#x2019; viruses) from mounting certain kinds of attack on remote sites.
8700 </para>
8701 <literallayout class="monospaced">
8702 accept  local_parts   = postmaster
8703         domains       = +local_domains
8704 </literallayout>
8705 <para>
8706 This statement, which has two conditions, accepts an incoming address if the
8707 local part is <emphasis>postmaster</emphasis> and the domain is one of those listed in the
8708 <emphasis>local_domains</emphasis> domain list. The <quote>+</quote> character is used to indicate a
8709 reference to a named list. In this configuration, there is just one domain in
8710 <emphasis>local_domains</emphasis>, but in general there may be many.
8711 </para>
8712 <para>
8713 The presence of this statement means that mail to postmaster is never blocked
8714 by any of the subsequent tests. This can be helpful while sorting out problems
8715 in cases where the subsequent tests are incorrectly denying access.
8716 </para>
8717 <literallayout class="monospaced">
8718 require verify        = sender
8719 </literallayout>
8720 <para>
8721 This statement requires the sender address to be verified before any subsequent
8722 ACL statement can be used. If verification fails, the incoming recipient
8723 address is refused. Verification consists of trying to route the address, to
8724 see if a bounce message could be delivered to it. In the case of remote
8725 addresses, basic verification checks only the domain, but <emphasis>callouts</emphasis> can be
8726 used for more verification if required. Section <xref linkend="SECTaddressverification"/>
8727 discusses the details of address verification.
8728 </para>
8729 <literallayout class="monospaced">
8730 accept  hosts         = +relay_from_hosts
8731         control       = submission
8732 </literallayout>
8733 <para>
8734 This statement accepts the address if the message is coming from one of the
8735 hosts that are defined as being allowed to relay through this host. Recipient
8736 verification is omitted here, because in many cases the clients are dumb MUAs
8737 that do not cope well with SMTP error responses. For the same reason, the
8738 second line specifies <quote>submission mode</quote> for messages that are accepted. This
8739 is described in detail in section <xref linkend="SECTsubmodnon"/>; it causes Exim to fix
8740 messages that are deficient in some way, for example, because they lack a
8741 <emphasis>Date:</emphasis> header line. If you are actually relaying out from MTAs, you should
8742 probably add recipient verification here, and disable submission mode.
8743 </para>
8744 <literallayout class="monospaced">
8745 accept  authenticated = *
8746         control       = submission
8747 </literallayout>
8748 <para>
8749 This statement accepts the address if the client host has authenticated itself.
8750 Submission mode is again specified, on the grounds that such messages are most
8751 likely to come from MUAs. The default configuration does not define any
8752 authenticators, though it does include some nearly complete commented-out
8753 examples described in <xref linkend="SECTdefconfauth"/>. This means that no client can in
8754 fact authenticate until you complete the authenticator definitions.
8755 </para>
8756 <literallayout class="monospaced">
8757 require message = relay not permitted
8758         domains = +local_domains : +relay_to_domains
8759 </literallayout>
8760 <para>
8761 This statement rejects the address if its domain is neither a local domain nor
8762 one of the domains for which this host is a relay.
8763 </para>
8764 <literallayout class="monospaced">
8765 require verify = recipient
8766 </literallayout>
8767 <para>
8768 This statement requires the recipient address to be verified; if verification
8769 fails, the address is rejected.
8770 </para>
8771 <literallayout class="monospaced">
8772 # deny    message     = rejected because $sender_host_address \
8773 #                       is in a black list at $dnslist_domain\n\
8774 #                       $dnslist_text
8775 #         dnslists    = black.list.example
8776 #
8777 # warn    dnslists    = black.list.example
8778 #         add_header  = X-Warning: $sender_host_address is in \
8779 #                       a black list at $dnslist_domain
8780 #         log_message = found in $dnslist_domain
8781 </literallayout>
8782 <para>
8783 These commented-out lines are examples of how you could configure Exim to check
8784 sending hosts against a DNS black list. The first statement rejects messages
8785 from blacklisted hosts, whereas the second just inserts a warning header
8786 line.
8787 </para>
8788 <literallayout class="monospaced">
8789 # require verify = csa
8790 </literallayout>
8791 <para>
8792 This commented-out line is an example of how you could turn on client SMTP
8793 authorization (CSA) checking. Such checks do DNS lookups for special SRV
8794 records.
8795 </para>
8796 <literallayout class="monospaced">
8797 accept
8798 </literallayout>
8799 <para>
8800 The final statement in the first ACL unconditionally accepts any recipient
8801 address that has successfully passed all the previous tests.
8802 </para>
8803 <literallayout class="monospaced">
8804 acl_check_data:
8805 </literallayout>
8806 <para>
8807 This line marks the start of the second ACL, and names it. Most of the contents
8808 of this ACL are commented out:
8809 </para>
8810 <literallayout class="monospaced">
8811 # deny    malware   = *
8812 #         message   = This message contains a virus \
8813 #                     ($malware_name).
8814 </literallayout>
8815 <para>
8816 These lines are examples of how to arrange for messages to be scanned for
8817 viruses when Exim has been compiled with the content-scanning extension, and a
8818 suitable virus scanner is installed. If the message is found to contain a
8819 virus, it is rejected with the given custom error message.
8820 </para>
8821 <literallayout class="monospaced">
8822 # warn    spam      = nobody
8823 #         message   = X-Spam_score: $spam_score\n\
8824 #                     X-Spam_score_int: $spam_score_int\n\
8825 #                     X-Spam_bar: $spam_bar\n\
8826 #                     X-Spam_report: $spam_report
8827 </literallayout>
8828 <para>
8829 These lines are an example of how to arrange for messages to be scanned by
8830 SpamAssassin when Exim has been compiled with the content-scanning extension,
8831 and SpamAssassin has been installed. The SpamAssassin check is run with
8832 <literal>nobody</literal> as its user parameter, and the results are added to the message as a
8833 series of extra header line. In this case, the message is not rejected,
8834 whatever the spam score.
8835 </para>
8836 <literallayout class="monospaced">
8837 accept
8838 </literallayout>
8839 <para>
8840 This final line in the DATA ACL accepts the message unconditionally.
8841 </para>
8842 </section>
8843 <section id="SECID55">
8844 <title>Router configuration</title>
8845 <para>
8846 <indexterm role="concept">
8847 <primary>default</primary>
8848 <secondary>routers</secondary>
8849 </indexterm>
8850 <indexterm role="concept">
8851 <primary>routers</primary>
8852 <secondary>default</secondary>
8853 </indexterm>
8854 The router configuration comes next in the default configuration, introduced
8855 by the line
8856 </para>
8857 <literallayout class="monospaced">
8858 begin routers
8859 </literallayout>
8860 <para>
8861 Routers are the modules in Exim that make decisions about where to send
8862 messages. An address is passed to each router in turn, until it is either
8863 accepted, or failed. This means that the order in which you define the routers
8864 matters. Each router is fully described in its own chapter later in this
8865 manual. Here we give only brief overviews.
8866 </para>
8867 <literallayout class="monospaced">
8868 # domain_literal:
8869 #   driver = ipliteral
8870 #   domains = !+local_domains
8871 #   transport = remote_smtp
8872 </literallayout>
8873 <para>
8874 <indexterm role="concept">
8875 <primary>domain literal</primary>
8876 <secondary>default router</secondary>
8877 </indexterm>
8878 This router is commented out because the majority of sites do not want to
8879 support domain literal addresses (those of the form <emphasis>user@[10.9.8.7]</emphasis>). If
8880 you uncomment this router, you also need to uncomment the setting of
8881 <option>allow_domain_literals</option> in the main part of the configuration.
8882 </para>
8883 <literallayout class="monospaced">
8884 dnslookup:
8885   driver = dnslookup
8886   domains = ! +local_domains
8887   transport = remote_smtp
8888   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
8889   no_more
8890 </literallayout>
8891 <para>
8892 The first uncommented router handles addresses that do not involve any local
8893 domains. This is specified by the line
8894 </para>
8895 <literallayout class="monospaced">
8896 domains = ! +local_domains
8897 </literallayout>
8898 <para>
8899 The <option>domains</option> option lists the domains to which this router applies, but the
8900 exclamation mark is a negation sign, so the router is used only for domains
8901 that are not in the domain list called <emphasis>local_domains</emphasis> (which was defined at
8902 the start of the configuration). The plus sign before <emphasis>local_domains</emphasis>
8903 indicates that it is referring to a named list. Addresses in other domains are
8904 passed on to the following routers.
8905 </para>
8906 <para>
8907 The name of the router driver is <command>dnslookup</command>,
8908 and is specified by the <option>driver</option> option. Do not be confused by the fact that
8909 the name of this router instance is the same as the name of the driver. The
8910 instance name is arbitrary, but the name set in the <option>driver</option> option must be
8911 one of the driver modules that is in the Exim binary.
8912 </para>
8913 <para>
8914 The <command>dnslookup</command> router routes addresses by looking up their domains in the
8915 DNS in order to obtain a list of hosts to which the address is routed. If the
8916 router succeeds, the address is queued for the <command>remote_smtp</command> transport, as
8917 specified by the <option>transport</option> option. If the router does not find the domain
8918 in the DNS, no further routers are tried because of the <option>no_more</option> setting, so
8919 the address fails and is bounced.
8920 </para>
8921 <para>
8922 The <option>ignore_target_hosts</option> option specifies a list of IP addresses that are to
8923 be entirely ignored. This option is present because a number of cases have been
8924 encountered where MX records in the DNS point to host names
8925 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
8926 Completely ignoring these IP addresses causes Exim to fail to route the
8927 email address, so it bounces. Otherwise, Exim would log a routing problem, and
8928 continue to try to deliver the message periodically until the address timed
8929 out.
8930 </para>
8931 <literallayout class="monospaced">
8932 system_aliases:
8933   driver = redirect
8934   allow_fail
8935   allow_defer
8936   data = ${lookup{$local_part}lsearch{/etc/aliases}}
8937 # user = exim
8938   file_transport = address_file
8939   pipe_transport = address_pipe
8940 </literallayout>
8941 <para>
8942 Control reaches this and subsequent routers only for addresses in the local
8943 domains. This router checks to see whether the local part is defined as an
8944 alias in the <filename>/etc/aliases</filename> file, and if so, redirects it according to the
8945 data that it looks up from that file. If no data is found for the local part,
8946 the value of the <option>data</option> option is empty, causing the address to be passed to
8947 the next router.
8948 </para>
8949 <para>
8950 <filename>/etc/aliases</filename> is a conventional name for the system aliases file that is
8951 often used. That is why it is referenced by from the default configuration
8952 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
8953 <filename>Local/Makefile</filename> before building Exim.
8954 </para>
8955 <literallayout class="monospaced">
8956 userforward:
8957   driver = redirect
8958   check_local_user
8959 # local_part_suffix = +* : -*
8960 # local_part_suffix_optional
8961   file = $home/.forward
8962 # allow_filter
8963   no_verify
8964   no_expn
8965   check_ancestor
8966   file_transport = address_file
8967   pipe_transport = address_pipe
8968   reply_transport = address_reply
8969 </literallayout>
8970 <para>
8971 This is the most complicated router in the default configuration. It is another
8972 redirection router, but this time it is looking for forwarding data set up by
8973 individual users. The <option>check_local_user</option> setting specifies a check that the
8974 local part of the address is the login name of a local user. If it is not, the
8975 router is skipped. The two commented options that follow <option>check_local_user</option>,
8976 namely:
8977 </para>
8978 <literallayout class="monospaced">
8979 # local_part_suffix = +* : -*
8980 # local_part_suffix_optional
8981 </literallayout>
8982 <para>
8983 <indexterm role="variable">
8984 <primary><varname>$local_part_suffix</varname></primary>
8985 </indexterm>
8986 show how you can specify the recognition of local part suffixes. If the first
8987 is uncommented, a suffix beginning with either a plus or a minus sign, followed
8988 by any sequence of characters, is removed from the local part and placed in the
8989 variable <varname>$local_part_suffix</varname>. The second suffix option specifies that the
8990 presence of a suffix in the local part is optional. When a suffix is present,
8991 the check for a local login uses the local part with the suffix removed.
8992 </para>
8993 <para>
8994 When a local user account is found, the file called <filename>.forward</filename> in the user&#x2019;s
8995 home directory is consulted. If it does not exist, or is empty, the router
8996 declines. Otherwise, the contents of <filename>.forward</filename> are interpreted as
8997 redirection data (see chapter <xref linkend="CHAPredirect"/> for more details).
8998 </para>
8999 <para>
9000 <indexterm role="concept">
9001 <primary>Sieve filter</primary>
9002 <secondary>enabling in default router</secondary>
9003 </indexterm>
9004 Traditional <filename>.forward</filename> files contain just a list of addresses, pipes, or
9005 files. Exim supports this by default. However, if <option>allow_filter</option> is set (it
9006 is commented out by default), the contents of the file are interpreted as a set
9007 of Exim or Sieve filtering instructions, provided the file begins with <quote>#Exim
9008 filter</quote> or <quote>#Sieve filter</quote>, respectively. User filtering is discussed in the
9009 separate document entitled <emphasis>Exim&#x2019;s interfaces to mail filtering</emphasis>.
9010 </para>
9011 <para>
9012 The <option>no_verify</option> and <option>no_expn</option> options mean that this router is skipped when
9013 verifying addresses, or when running as a consequence of an SMTP EXPN command.
9014 There are two reasons for doing this:
9015 </para>
9016 <orderedlist numeration="arabic">
9017 <listitem>
9018 <para>
9019 Whether or not a local user has a <filename>.forward</filename> file is not really relevant when
9020 checking an address for validity; it makes sense not to waste resources doing
9021 unnecessary work.
9022 </para>
9023 </listitem>
9024 <listitem>
9025 <para>
9026 More importantly, when Exim is verifying addresses or handling an EXPN
9027 command during an SMTP session, it is running as the Exim user, not as root.
9028 The group is the Exim group, and no additional groups are set up.
9029 It may therefore not be possible for Exim to read users&#x2019; <filename>.forward</filename> files at
9030 this time.
9031 </para>
9032 </listitem>
9033 </orderedlist>
9034 <para>
9035 The setting of <option>check_ancestor</option> prevents the router from generating a new
9036 address that is the same as any previous address that was redirected. (This
9037 works round a problem concerning a bad interaction between aliasing and
9038 forwarding &ndash; see section <xref linkend="SECTredlocmai"/>).
9039 </para>
9040 <para>
9041 The final three option settings specify the transports that are to be used when
9042 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
9043 auto-reply, respectively. For example, if a <filename>.forward</filename> file contains
9044 </para>
9045 <literallayout class="monospaced">
9046 a.nother@elsewhere.example, /home/spqr/archive
9047 </literallayout>
9048 <para>
9049 the delivery to <filename>/home/spqr/archive</filename> is done by running the <option>address_file</option>
9050 transport.
9051 </para>
9052 <literallayout class="monospaced">
9053 localuser:
9054   driver = accept
9055   check_local_user
9056 # local_part_suffix = +* : -*
9057 # local_part_suffix_optional
9058   transport = local_delivery
9059 </literallayout>
9060 <para>
9061 The final router sets up delivery into local mailboxes, provided that the local
9062 part is the name of a local login, by accepting the address and assigning it to
9063 the <command>local_delivery</command> transport. Otherwise, we have reached the end of the
9064 routers, so the address is bounced. The commented suffix settings fulfil the
9065 same purpose as they do for the <command>userforward</command> router.
9066 </para>
9067 </section>
9068 <section id="SECID56">
9069 <title>Transport configuration</title>
9070 <para>
9071 <indexterm role="concept">
9072 <primary>default</primary>
9073 <secondary>transports</secondary>
9074 </indexterm>
9075 <indexterm role="concept">
9076 <primary>transports</primary>
9077 <secondary>default</secondary>
9078 </indexterm>
9079 Transports define mechanisms for actually delivering messages. They operate
9080 only when referenced from routers, so the order in which they are defined does
9081 not matter. The transports section of the configuration starts with
9082 </para>
9083 <literallayout class="monospaced">
9084 begin transports
9085 </literallayout>
9086 <para>
9087 One remote transport and four local transports are defined.
9088 </para>
9089 <literallayout class="monospaced">
9090 remote_smtp:
9091   driver = smtp
9092   hosts_try_prdr = *
9093 </literallayout>
9094 <para>
9095 This transport is used for delivering messages over SMTP connections.
9096 The list of remote hosts comes from the router.
9097 The <option>hosts_try_prdr</option> option enables an efficiency SMTP option.
9098 It is negotiated between client and server
9099 and not expected to cause problems but can be disabled if needed.
9100 All other options are defaulted.
9101 </para>
9102 <literallayout class="monospaced">
9103 local_delivery:
9104   driver = appendfile
9105   file = /var/mail/$local_part
9106   delivery_date_add
9107   envelope_to_add
9108   return_path_add
9109 # group = mail
9110 # mode = 0660
9111 </literallayout>
9112 <para>
9113 This <command>appendfile</command> transport is used for local delivery to user mailboxes in
9114 traditional BSD mailbox format. By default it runs under the uid and gid of the
9115 local user, which requires the sticky bit to be set on the <filename>/var/mail</filename>
9116 directory. Some systems use the alternative approach of running mail deliveries
9117 under a particular group instead of using the sticky bit. The commented options
9118 show how this can be done.
9119 </para>
9120 <para>
9121 Exim adds three headers to the message as it delivers it: <emphasis>Delivery-date:</emphasis>,
9122 <emphasis>Envelope-to:</emphasis> and <emphasis>Return-path:</emphasis>. This action is requested by the three
9123 similarly-named options above.
9124 </para>
9125 <literallayout class="monospaced">
9126 address_pipe:
9127   driver = pipe
9128   return_output
9129 </literallayout>
9130 <para>
9131 This transport is used for handling deliveries to pipes that are generated by
9132 redirection (aliasing or users&#x2019; <filename>.forward</filename> files). The <option>return_output</option>
9133 option specifies that any output generated by the pipe is to be returned to the
9134 sender.
9135 </para>
9136 <literallayout class="monospaced">
9137 address_file:
9138   driver = appendfile
9139   delivery_date_add
9140   envelope_to_add
9141   return_path_add
9142 </literallayout>
9143 <para>
9144 This transport is used for handling deliveries to files that are generated by
9145 redirection. The name of the file is not specified in this instance of
9146 <command>appendfile</command>, because it comes from the <command>redirect</command> router.
9147 </para>
9148 <literallayout class="monospaced">
9149 address_reply:
9150   driver = autoreply
9151 </literallayout>
9152 <para>
9153 This transport is used for handling automatic replies generated by users&#x2019;
9154 filter files.
9155 </para>
9156 </section>
9157 <section id="SECID57">
9158 <title>Default retry rule</title>
9159 <para>
9160 <indexterm role="concept">
9161 <primary>retry</primary>
9162 <secondary>default rule</secondary>
9163 </indexterm>
9164 <indexterm role="concept">
9165 <primary>default</primary>
9166 <secondary>retry rule</secondary>
9167 </indexterm>
9168 The retry section of the configuration file contains rules which affect the way
9169 Exim retries deliveries that cannot be completed at the first attempt. It is
9170 introduced by the line
9171 </para>
9172 <literallayout class="monospaced">
9173 begin retry
9174 </literallayout>
9175 <para>
9176 In the default configuration, there is just one rule, which applies to all
9177 errors:
9178 </para>
9179 <literallayout class="monospaced">
9180 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
9181 </literallayout>
9182 <para>
9183 This causes any temporarily failing address to be retried every 15 minutes for
9184 2 hours, then at intervals starting at one hour and increasing by a factor of
9185 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
9186 is not delivered after 4 days of temporary failure, it is bounced.
9187 </para>
9188 <para>
9189 If the retry section is removed from the configuration, or is empty (that is,
9190 if no retry rules are defined), Exim will not retry deliveries. This turns
9191 temporary errors into permanent errors.
9192 </para>
9193 </section>
9194 <section id="SECID58">
9195 <title>Rewriting configuration</title>
9196 <para>
9197 The rewriting section of the configuration, introduced by
9198 </para>
9199 <literallayout class="monospaced">
9200 begin rewrite
9201 </literallayout>
9202 <para>
9203 contains rules for rewriting addresses in messages as they arrive. There are no
9204 rewriting rules in the default configuration file.
9205 </para>
9206 </section>
9207 <section id="SECTdefconfauth">
9208 <title>Authenticators configuration</title>
9209 <para>
9210 <indexterm role="concept">
9211 <primary>AUTH</primary>
9212 <secondary>configuration</secondary>
9213 </indexterm>
9214 The authenticators section of the configuration, introduced by
9215 </para>
9216 <literallayout class="monospaced">
9217 begin authenticators
9218 </literallayout>
9219 <para>
9220 defines mechanisms for the use of the SMTP AUTH command. The default
9221 configuration file contains two commented-out example authenticators
9222 which support plaintext username/password authentication using the
9223 standard PLAIN mechanism and the traditional but non-standard LOGIN
9224 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
9225 to support most MUA software.
9226 </para>
9227 <para>
9228 The example PLAIN authenticator looks like this:
9229 </para>
9230 <literallayout class="monospaced">
9231 #PLAIN:
9232 #  driver                  = plaintext
9233 #  server_set_id           = $auth2
9234 #  server_prompts          = :
9235 #  server_condition        = Authentication is not yet configured
9236 #  server_advertise_condition = ${if def:tls_in_cipher }
9237 </literallayout>
9238 <para>
9239 And the example LOGIN authenticator looks like this:
9240 </para>
9241 <literallayout class="monospaced">
9242 #LOGIN:
9243 #  driver                  = plaintext
9244 #  server_set_id           = $auth1
9245 #  server_prompts          = &lt;| Username: | Password:
9246 #  server_condition        = Authentication is not yet configured
9247 #  server_advertise_condition = ${if def:tls_in_cipher }
9248 </literallayout>
9249 <para>
9250 The <option>server_set_id</option> option makes Exim remember the authenticated username
9251 in <varname>$authenticated_id</varname>, which can be used later in ACLs or routers. The
9252 <option>server_prompts</option> option configures the <command>plaintext</command> authenticator so
9253 that it implements the details of the specific authentication mechanism,
9254 i.e. PLAIN or LOGIN. The <option>server_advertise_condition</option> setting controls
9255 when Exim offers authentication to clients; in the examples, this is only
9256 when TLS or SSL has been started, so to enable the authenticators you also
9257 need to add support for TLS as described in section <xref linkend="SECTdefconfmain"/>.
9258 </para>
9259 <para>
9260 The <option>server_condition</option> setting defines how to verify that the username and
9261 password are correct. In the examples it just produces an error message.
9262 To make the authenticators work, you can use a string expansion
9263 expression like one of the examples in chapter <xref linkend="CHAPplaintext"/>.
9264 </para>
9265 <para>
9266 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
9267 usercode and password are in different positions.
9268 Chapter <xref linkend="CHAPplaintext"/> covers both.
9269 </para>
9270 <para>
9271 <indexterm role="concept" startref="IIDconfiwal" class="endofrange"/>
9272 </para>
9273 </section>
9274 </chapter>
9275
9276 <chapter id="CHAPregexp">
9277 <title>Regular expressions</title>
9278 <para>
9279 <indexterm role="concept">
9280 <primary>regular expressions</primary>
9281 <secondary>library</secondary>
9282 </indexterm>
9283 <indexterm role="concept">
9284 <primary>PCRE</primary>
9285 </indexterm>
9286 Exim supports the use of regular expressions in many of its options. It
9287 uses the PCRE regular expression library; this provides regular expression
9288 matching that is compatible with Perl 5. The syntax and semantics of
9289 regular expressions is discussed in many Perl reference books, and also in
9290 Jeffrey Friedl&#x2019;s <emphasis>Mastering Regular Expressions</emphasis>, which is published by
9291 O&#x2019;Reilly (see <emphasis role="bold"><ulink url="http://www.oreilly.com/catalog/regex2/">http://www.oreilly.com/catalog/regex2/</ulink></emphasis>).
9292 </para>
9293 <para>
9294 The documentation for the syntax and semantics of the regular expressions that
9295 are supported by PCRE is included in the PCRE distribution, and no further
9296 description is included here. The PCRE functions are called from Exim using
9297 the default option settings (that is, with no PCRE options set), except that
9298 the PCRE_CASELESS option is set when the matching is required to be
9299 case-insensitive.
9300 </para>
9301 <para>
9302 In most cases, when a regular expression is required in an Exim configuration,
9303 it has to start with a circumflex, in order to distinguish it from plain text
9304 or an <quote>ends with</quote> wildcard. In this example of a configuration setting, the
9305 second item in the colon-separated list is a regular expression.
9306 </para>
9307 <literallayout class="monospaced">
9308 domains = a.b.c : ^\\d{3} : *.y.z : ...
9309 </literallayout>
9310 <para>
9311 The doubling of the backslash is required because of string expansion that
9312 precedes interpretation &ndash; see section <xref linkend="SECTlittext"/> for more discussion
9313 of this issue, and a way of avoiding the need for doubling backslashes. The
9314 regular expression that is eventually used in this example contains just one
9315 backslash. The circumflex is included in the regular expression, and has the
9316 normal effect of <quote>anchoring</quote> it to the start of the string that is being
9317 matched.
9318 </para>
9319 <para>
9320 There are, however, two cases where a circumflex is not required for the
9321 recognition of a regular expression: these are the <option>match</option> condition in a
9322 string expansion, and the <option>matches</option> condition in an Exim filter file. In
9323 these cases, the relevant string is always treated as a regular expression; if
9324 it does not start with a circumflex, the expression is not anchored, and can
9325 match anywhere in the subject string.
9326 </para>
9327 <para>
9328 In all cases, if you want a regular expression to match at the end of a string,
9329 you must code the $ metacharacter to indicate this. For example:
9330 </para>
9331 <literallayout class="monospaced">
9332 domains = ^\\d{3}\\.example
9333 </literallayout>
9334 <para>
9335 matches the domain <emphasis>123.example</emphasis>, but it also matches <emphasis>123.example.com</emphasis>.
9336 You need to use:
9337 </para>
9338 <literallayout class="monospaced">
9339 domains = ^\\d{3}\\.example\$
9340 </literallayout>
9341 <para>
9342 if you want <emphasis>example</emphasis> to be the top-level domain. The backslash before the
9343 $ is needed because string expansion also interprets dollar characters.
9344 </para>
9345 </chapter>
9346
9347 <chapter id="CHAPfdlookup">
9348 <title>File and database lookups</title>
9349 <para>
9350 <indexterm role="concept" id="IIDfidalo1" class="startofrange">
9351 <primary>file</primary>
9352 <secondary>lookups</secondary>
9353 </indexterm>
9354 <indexterm role="concept" id="IIDfidalo2" class="startofrange">
9355 <primary>database</primary>
9356 <secondary>lookups</secondary>
9357 </indexterm>
9358 <indexterm role="concept">
9359 <primary>lookup</primary>
9360 <secondary>description of</secondary>
9361 </indexterm>
9362 Exim can be configured to look up data in files or databases as it processes
9363 messages. Two different kinds of syntax are used:
9364 </para>
9365 <orderedlist numeration="arabic">
9366 <listitem>
9367 <para>
9368 A string that is to be expanded may contain explicit lookup requests. These
9369 cause parts of the string to be replaced by data that is obtained from the
9370 lookup. Lookups of this type are conditional expansion items. Different results
9371 can be defined for the cases of lookup success and failure. See chapter
9372 <xref linkend="CHAPexpand"/>, where string expansions are described in detail.
9373 </para>
9374 </listitem>
9375 <listitem>
9376 <para>
9377 Lists of domains, hosts, and email addresses can contain lookup requests as a
9378 way of avoiding excessively long linear lists. In this case, the data that is
9379 returned by the lookup is often (but not always) discarded; whether the lookup
9380 succeeds or fails is what really counts. These kinds of list are described in
9381 chapter <xref linkend="CHAPdomhosaddlists"/>.
9382 </para>
9383 </listitem>
9384 </orderedlist>
9385 <para>
9386 String expansions, lists, and lookups interact with each other in such a way
9387 that there is no order in which to describe any one of them that does not
9388 involve references to the others. Each of these three chapters makes more sense
9389 if you have read the other two first. If you are reading this for the first
9390 time, be aware that some of it will make a lot more sense after you have read
9391 chapters <xref linkend="CHAPdomhosaddlists"/> and <xref linkend="CHAPexpand"/>.
9392 </para>
9393 <section id="SECID60">
9394 <title>Examples of different lookup syntax</title>
9395 <para>
9396 It is easy to confuse the two different kinds of lookup, especially as the
9397 lists that may contain the second kind are always expanded before being
9398 processed as lists. Therefore, they may also contain lookups of the first kind.
9399 Be careful to distinguish between the following two examples:
9400 </para>
9401 <literallayout class="monospaced">
9402 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
9403 domains = lsearch;/some/file
9404 </literallayout>
9405 <para>
9406 The first uses a string expansion, the result of which must be a domain list.
9407 No strings have been specified for a successful or a failing lookup; the
9408 defaults in this case are the looked-up data and an empty string, respectively.
9409 The expansion takes place before the string is processed as a list, and the
9410 file that is searched could contain lines like this:
9411 </para>
9412 <literallayout class="monospaced">
9413 192.168.3.4: domain1:domain2:...
9414 192.168.1.9: domain3:domain4:...
9415 </literallayout>
9416 <para>
9417 When the lookup succeeds, the result of the expansion is a list of domains (and
9418 possibly other types of item that are allowed in domain lists).
9419 </para>
9420 <para>
9421 In the second example, the lookup is a single item in a domain list. It causes
9422 Exim to use a lookup to see if the domain that is being processed can be found
9423 in the file. The file could contains lines like this:
9424 </para>
9425 <literallayout class="monospaced">
9426 domain1:
9427 domain2:
9428 </literallayout>
9429 <para>
9430 Any data that follows the keys is not relevant when checking that the domain
9431 matches the list item.
9432 </para>
9433 <para>
9434 It is possible, though no doubt confusing, to use both kinds of lookup at once.
9435 Consider a file containing lines like this:
9436 </para>
9437 <literallayout class="monospaced">
9438 192.168.5.6: lsearch;/another/file
9439 </literallayout>
9440 <para>
9441 If the value of <varname>$sender_host_address</varname> is 192.168.5.6, expansion of the
9442 first <option>domains</option> setting above generates the second setting, which therefore
9443 causes a second lookup to occur.
9444 </para>
9445 <para>
9446 The rest of this chapter describes the different lookup types that are
9447 available. Any of them can be used in any part of the configuration where a
9448 lookup is permitted.
9449 </para>
9450 </section>
9451 <section id="SECID61">
9452 <title>Lookup types</title>
9453 <para>
9454 <indexterm role="concept">
9455 <primary>lookup</primary>
9456 <secondary>types of</secondary>
9457 </indexterm>
9458 <indexterm role="concept">
9459 <primary>single-key lookup</primary>
9460 <secondary>definition of</secondary>
9461 </indexterm>
9462 Two different types of data lookup are implemented:
9463 </para>
9464 <itemizedlist>
9465 <listitem>
9466 <para>
9467 The <emphasis>single-key</emphasis> type requires the specification of a file in which to look,
9468 and a single key to search for. The key must be a non-empty string for the
9469 lookup to succeed. The lookup type determines how the file is searched.
9470 </para>
9471 </listitem>
9472 <listitem>
9473 <para>
9474 <indexterm role="concept">
9475 <primary>query-style lookup</primary>
9476 <secondary>definition of</secondary>
9477 </indexterm>
9478 The <emphasis>query-style</emphasis> type accepts a generalized database query. No particular
9479 key value is assumed by Exim for query-style lookups. You can use whichever
9480 Exim variables you need to construct the database query.
9481 </para>
9482 </listitem>
9483 </itemizedlist>
9484 <para>
9485 The code for each lookup type is in a separate source file that is included in
9486 the binary of Exim only if the corresponding compile-time option is set. The
9487 default settings in <filename>src/EDITME</filename> are:
9488 </para>
9489 <literallayout class="monospaced">
9490 LOOKUP_DBM=yes
9491 LOOKUP_LSEARCH=yes
9492 </literallayout>
9493 <para>
9494 which means that only linear searching and DBM lookups are included by default.
9495 For some types of lookup (e.g. SQL databases), you need to install appropriate
9496 libraries and header files before building Exim.
9497 </para>
9498 </section>
9499 <section id="SECTsinglekeylookups">
9500 <title>Single-key lookup types</title>
9501 <para>
9502 <indexterm role="concept">
9503 <primary>lookup</primary>
9504 <secondary>single-key types</secondary>
9505 </indexterm>
9506 <indexterm role="concept">
9507 <primary>single-key lookup</primary>
9508 <secondary>list of types</secondary>
9509 </indexterm>
9510 The following single-key lookup types are implemented:
9511 </para>
9512 <itemizedlist>
9513 <listitem>
9514 <para>
9515 <indexterm role="concept">
9516 <primary>cdb</primary>
9517 <secondary>description of</secondary>
9518 </indexterm>
9519 <indexterm role="concept">
9520 <primary>lookup</primary>
9521 <secondary>cdb</secondary>
9522 </indexterm>
9523 <indexterm role="concept">
9524 <primary>binary zero</primary>
9525 <secondary>in lookup key</secondary>
9526 </indexterm>
9527 <command>cdb</command>: The given file is searched as a Constant DataBase file, using the key
9528 string without a terminating binary zero. The cdb format is designed for
9529 indexed files that are read frequently and never updated, except by total
9530 re-creation. As such, it is particularly suitable for large files containing
9531 aliases or other indexed data referenced by an MTA. Information about cdb can
9532 be found in several places:
9533 </para>
9534 <literallayout>
9535 <emphasis role="bold"><ulink url="http://www.pobox.com/~djb/cdb.html">http://www.pobox.com/~djb/cdb.html</ulink></emphasis>
9536 <emphasis role="bold"><ulink url="ftp://ftp.corpit.ru/pub/tinycdb/">ftp://ftp.corpit.ru/pub/tinycdb/</ulink></emphasis>
9537 <emphasis role="bold"><ulink url="http://packages.debian.org/stable/utils/freecdb.html">http://packages.debian.org/stable/utils/freecdb.html</ulink></emphasis>
9538 </literallayout>
9539 <para>
9540 A cdb distribution is not needed in order to build Exim with cdb support,
9541 because the code for reading cdb files is included directly in Exim itself.
9542 However, no means of building or testing cdb files is provided with Exim, so
9543 you need to obtain a cdb distribution in order to do this.
9544 </para>
9545 </listitem>
9546 <listitem>
9547 <para>
9548 <indexterm role="concept">
9549 <primary>DBM</primary>
9550 <secondary>lookup type</secondary>
9551 </indexterm>
9552 <indexterm role="concept">
9553 <primary>lookup</primary>
9554 <secondary>dbm</secondary>
9555 </indexterm>
9556 <indexterm role="concept">
9557 <primary>binary zero</primary>
9558 <secondary>in lookup key</secondary>
9559 </indexterm>
9560 <command>dbm</command>: Calls to DBM library functions are used to extract data from the given
9561 DBM file by looking up the record with the given key. A terminating binary
9562 zero is included in the key that is passed to the DBM library. See section
9563 <xref linkend="SECTdb"/> for a discussion of DBM libraries.
9564 </para>
9565 <para>
9566 <indexterm role="concept">
9567 <primary>Berkeley DB library</primary>
9568 <secondary>file format</secondary>
9569 </indexterm>
9570 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
9571 when building DBM files using the <option>exim_dbmbuild</option> utility. However, when
9572 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
9573 the DB_UNKNOWN option. This enables it to handle any of the types of database
9574 that the library supports, and can be useful for accessing DBM files created by
9575 other applications. (For earlier DB versions, DB_HASH is always used.)
9576 </para>
9577 </listitem>
9578 <listitem>
9579 <para>
9580 <indexterm role="concept">
9581 <primary>lookup</primary>
9582 <secondary>dbmjz</secondary>
9583 </indexterm>
9584 <indexterm role="concept">
9585 <primary>lookup</primary>
9586 <secondary>dbm &ndash; embedded NULs</secondary>
9587 </indexterm>
9588 <indexterm role="concept">
9589 <primary>sasldb2</primary>
9590 </indexterm>
9591 <indexterm role="concept">
9592 <primary>dbmjz lookup type</primary>
9593 </indexterm>
9594 <command>dbmjz</command>: This is the same as <command>dbm</command>, except that the lookup key is
9595 interpreted as an Exim list; the elements of the list are joined together with
9596 ASCII NUL characters to form the lookup key.  An example usage would be to
9597 authenticate incoming SMTP calls using the passwords from Cyrus SASL&#x2019;s
9598 <filename>/etc/sasldb2</filename> file with the <command>gsasl</command> authenticator or Exim&#x2019;s own
9599 <command>cram_md5</command> authenticator.
9600 </para>
9601 </listitem>
9602 <listitem>
9603 <para>
9604 <indexterm role="concept">
9605 <primary>lookup</primary>
9606 <secondary>dbmnz</secondary>
9607 </indexterm>
9608 <indexterm role="concept">
9609 <primary>lookup</primary>
9610 <secondary>dbm &ndash; terminating zero</secondary>
9611 </indexterm>
9612 <indexterm role="concept">
9613 <primary>binary zero</primary>
9614 <secondary>in lookup key</secondary>
9615 </indexterm>
9616 <indexterm role="concept">
9617 <primary>Courier</primary>
9618 </indexterm>
9619 <indexterm role="concept">
9620 <primary><filename>/etc/userdbshadow.dat</filename></primary>
9621 </indexterm>
9622 <indexterm role="concept">
9623 <primary>dbmnz lookup type</primary>
9624 </indexterm>
9625 <command>dbmnz</command>: This is the same as <command>dbm</command>, except that a terminating binary zero
9626 is not included in the key that is passed to the DBM library. You may need this
9627 if you want to look up data in files that are created by or shared with some
9628 other application that does not use terminating zeros. For example, you need to
9629 use <command>dbmnz</command> rather than <command>dbm</command> if you want to authenticate incoming SMTP
9630 calls using the passwords from Courier&#x2019;s <filename>/etc/userdbshadow.dat</filename> file. Exim&#x2019;s
9631 utility program for creating DBM files (<emphasis>exim_dbmbuild</emphasis>) includes the zeros
9632 by default, but has an option to omit them (see section <xref linkend="SECTdbmbuild"/>).
9633 </para>
9634 </listitem>
9635 <listitem>
9636 <para>
9637 <indexterm role="concept">
9638 <primary>lookup</primary>
9639 <secondary>dsearch</secondary>
9640 </indexterm>
9641 <indexterm role="concept">
9642 <primary>dsearch lookup type</primary>
9643 </indexterm>
9644 <command>dsearch</command>: The given file must be a directory; this is searched for an entry
9645 whose name is the key by calling the <function>lstat()</function> function. The key may not
9646 contain any forward slash characters. If <function>lstat()</function> succeeds, the result of
9647 the lookup is the name of the entry, which may be a file, directory,
9648 symbolic link, or any other kind of directory entry. An example of how this
9649 lookup can be used to support virtual domains is given in section
9650 <xref linkend="SECTvirtualdomains"/>.
9651 </para>
9652 </listitem>
9653 <listitem>
9654 <para>
9655 <indexterm role="concept">
9656 <primary>lookup</primary>
9657 <secondary>iplsearch</secondary>
9658 </indexterm>
9659 <indexterm role="concept">
9660 <primary>iplsearch lookup type</primary>
9661 </indexterm>
9662 <command>iplsearch</command>: The given file is a text file containing keys and data. A key is
9663 terminated by a colon or white space or the end of the line. The keys in the
9664 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
9665 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
9666 being interpreted as a key terminator. For example:
9667 </para>
9668 <literallayout class="monospaced">
9669 1.2.3.4:           data for 1.2.3.4
9670 192.168.0.0/16:    data for 192.168.0.0/16
9671 "abcd::cdab":      data for abcd::cdab
9672 "abcd:abcd::/32"   data for abcd:abcd::/32
9673 </literallayout>
9674 <para>
9675 The key for an <command>iplsearch</command> lookup must be an IP address (without a mask). The
9676 file is searched linearly, using the CIDR masks where present, until a matching
9677 key is found. The first key that matches is used; there is no attempt to find a
9678 <quote>best</quote> match. Apart from the way the keys are matched, the processing for
9679 <command>iplsearch</command> is the same as for <command>lsearch</command>.
9680 </para>
9681 <para>
9682 <emphasis role="bold">Warning 1</emphasis>: Unlike most other single-key lookup types, a file of data for
9683 <command>iplsearch</command> can <emphasis>not</emphasis> be turned into a DBM or cdb file, because those
9684 lookup types support only literal keys.
9685 </para>
9686 <para>
9687 <emphasis role="bold">Warning 2</emphasis>: In a host list, you must always use <command>net-iplsearch</command> so that
9688 the implicit key is the host&#x2019;s IP address rather than its name (see section
9689 <xref linkend="SECThoslispatsikey"/>).
9690 </para>
9691 </listitem>
9692 <listitem>
9693 <para>
9694 <indexterm role="concept">
9695 <primary>linear search</primary>
9696 </indexterm>
9697 <indexterm role="concept">
9698 <primary>lookup</primary>
9699 <secondary>lsearch</secondary>
9700 </indexterm>
9701 <indexterm role="concept">
9702 <primary>lsearch lookup type</primary>
9703 </indexterm>
9704 <indexterm role="concept">
9705 <primary>case sensitivity</primary>
9706 <secondary>in lsearch lookup</secondary>
9707 </indexterm>
9708 <command>lsearch</command>: The given file is a text file that is searched linearly for a
9709 line beginning with the search key, terminated by a colon or white space or the
9710 end of the line. The search is case-insensitive; that is, upper and lower case
9711 letters are treated as the same. The first occurrence of the key that is found
9712 in the file is used.
9713 </para>
9714 <para>
9715 White space between the key and the colon is permitted. The remainder of the
9716 line, with leading and trailing white space removed, is the data. This can be
9717 continued onto subsequent lines by starting them with any amount of white
9718 space, but only a single space character is included in the data at such a
9719 junction. If the data begins with a colon, the key must be terminated by a
9720 colon, for example:
9721 </para>
9722 <literallayout class="monospaced">
9723 baduser:  :fail:
9724 </literallayout>
9725 <para>
9726 Empty lines and lines beginning with # are ignored, even if they occur in the
9727 middle of an item. This is the traditional textual format of alias files. Note
9728 that the keys in an <command>lsearch</command> file are literal strings. There is no
9729 wildcarding of any kind.
9730 </para>
9731 <para>
9732 <indexterm role="concept">
9733 <primary>lookup</primary>
9734 <secondary>lsearch &ndash; colons in keys</secondary>
9735 </indexterm>
9736 <indexterm role="concept">
9737 <primary>white space</primary>
9738 <secondary>in lsearch key</secondary>
9739 </indexterm>
9740 In most <command>lsearch</command> files, keys are not required to contain colons or #
9741 characters, or white space. However, if you need this feature, it is available.
9742 If a key begins with a doublequote character, it is terminated only by a
9743 matching quote (or end of line), and the normal escaping rules apply to its
9744 contents (see section <xref linkend="SECTstrings"/>). An optional colon is permitted after
9745 quoted keys (exactly as for unquoted keys). There is no special handling of
9746 quotes for the data part of an <command>lsearch</command> line.
9747 </para>
9748 </listitem>
9749 <listitem>
9750 <para>
9751 <indexterm role="concept">
9752 <primary>NIS lookup type</primary>
9753 </indexterm>
9754 <indexterm role="concept">
9755 <primary>lookup</primary>
9756 <secondary>NIS</secondary>
9757 </indexterm>
9758 <indexterm role="concept">
9759 <primary>binary zero</primary>
9760 <secondary>in lookup key</secondary>
9761 </indexterm>
9762 <command>nis</command>: The given file is the name of a NIS map, and a NIS lookup is done with
9763 the given key, without a terminating binary zero. There is a variant called
9764 <command>nis0</command> which does include the terminating binary zero in the key. This is
9765 reportedly needed for Sun-style alias files. Exim does not recognize NIS
9766 aliases; the full map names must be used.
9767 </para>
9768 </listitem>
9769 <listitem>
9770 <para>
9771 <indexterm role="concept">
9772 <primary>wildlsearch lookup type</primary>
9773 </indexterm>
9774 <indexterm role="concept">
9775 <primary>lookup</primary>
9776 <secondary>wildlsearch</secondary>
9777 </indexterm>
9778 <indexterm role="concept">
9779 <primary>nwildlsearch lookup type</primary>
9780 </indexterm>
9781 <indexterm role="concept">
9782 <primary>lookup</primary>
9783 <secondary>nwildlsearch</secondary>
9784 </indexterm>
9785 <command>wildlsearch</command> or <command>nwildlsearch</command>: These search a file linearly, like
9786 <command>lsearch</command>, but instead of being interpreted as a literal string, each key in
9787 the file may be wildcarded. The difference between these two lookup types is
9788 that for <command>wildlsearch</command>, each key in the file is string-expanded before being
9789 used, whereas for <command>nwildlsearch</command>, no expansion takes place.
9790 </para>
9791 <para>
9792 <indexterm role="concept">
9793 <primary>case sensitivity</primary>
9794 <secondary>in (n)wildlsearch lookup</secondary>
9795 </indexterm>
9796 Like <command>lsearch</command>, the testing is done case-insensitively. However, keys in the
9797 file that are regular expressions can be made case-sensitive by the use of
9798 <literal>(-i)</literal> within the pattern. The following forms of wildcard are recognized:
9799 </para>
9800 <orderedlist numeration="arabic">
9801 <listitem>
9802 <para>
9803 The string may begin with an asterisk to mean <quote>ends with</quote>. For example:
9804 </para>
9805 <literallayout class="monospaced">
9806     *.a.b.c       data for anything.a.b.c
9807     *fish         data for anythingfish
9808 </literallayout>
9809 </listitem>
9810 <listitem>
9811 <para>
9812 The string may begin with a circumflex to indicate a regular expression. For
9813 example, for <command>wildlsearch</command>:
9814 </para>
9815 <literallayout class="monospaced">
9816     ^\N\d+\.a\.b\N    data for &lt;digits&gt;.a.b
9817 </literallayout>
9818 <para>
9819 Note the use of <literal>\N</literal> to disable expansion of the contents of the regular
9820 expression. If you are using <command>nwildlsearch</command>, where the keys are not
9821 string-expanded, the equivalent entry is:
9822 </para>
9823 <literallayout class="monospaced">
9824     ^\d+\.a\.b        data for &lt;digits&gt;.a.b
9825 </literallayout>
9826 <para>
9827 The case-insensitive flag is set at the start of compiling the regular
9828 expression, but it can be turned off by using <literal>(-i)</literal> at an appropriate point.
9829 For example, to make the entire pattern case-sensitive:
9830 </para>
9831 <literallayout class="monospaced">
9832     ^(?-i)\d+\.a\.b        data for &lt;digits&gt;.a.b
9833 </literallayout>
9834 <para>
9835 If the regular expression contains white space or colon characters, you must
9836 either quote it (see <command>lsearch</command> above), or represent these characters in other
9837 ways. For example, <literal>\s</literal> can be used for white space and <literal>\x3A</literal> for a
9838 colon. This may be easier than quoting, because if you quote, you have to
9839 escape all the backslashes inside the quotes.
9840 </para>
9841 <para>
9842 <emphasis role="bold">Note</emphasis>: It is not possible to capture substrings in a regular expression
9843 match for later use, because the results of all lookups are cached. If a lookup
9844 is repeated, the result is taken from the cache, and no actual pattern matching
9845 takes place. The values of all the numeric variables are unset after a
9846 <command>(n)wildlsearch</command> match.
9847 </para>
9848 </listitem>
9849 <listitem>
9850 <para>
9851 Although I cannot see it being of much use, the general matching function that
9852 is used to implement <command>(n)wildlsearch</command> means that the string may begin with a
9853 lookup name terminated by a semicolon, and followed by lookup data. For
9854 example:
9855 </para>
9856 <literallayout class="monospaced">
9857     cdb;/some/file  data for keys that match the file
9858 </literallayout>
9859 <para>
9860 The data that is obtained from the nested lookup is discarded.
9861 </para>
9862 </listitem>
9863 </orderedlist>
9864 <para>
9865 Keys that do not match any of these patterns are interpreted literally. The
9866 continuation rules for the data are the same as for <command>lsearch</command>, and keys may
9867 be followed by optional colons.
9868 </para>
9869 <para>
9870 <emphasis role="bold">Warning</emphasis>: Unlike most other single-key lookup types, a file of data for
9871 <command>(n)wildlsearch</command> can <emphasis>not</emphasis> be turned into a DBM or cdb file, because those
9872 lookup types support only literal keys.
9873 </para>
9874 </listitem>
9875 </itemizedlist>
9876 </section>
9877 <section id="SECID62">
9878 <title>Query-style lookup types</title>
9879 <para>
9880 <indexterm role="concept">
9881 <primary>lookup</primary>
9882 <secondary>query-style types</secondary>
9883 </indexterm>
9884 <indexterm role="concept">
9885 <primary>query-style lookup</primary>
9886 <secondary>list of types</secondary>
9887 </indexterm>
9888 The supported query-style lookup types are listed below. Further details about
9889 many of them are given in later sections.
9890 </para>
9891 <itemizedlist>
9892 <listitem>
9893 <para>
9894 <indexterm role="concept">
9895 <primary>DNS</primary>
9896 <secondary>as a lookup type</secondary>
9897 </indexterm>
9898 <indexterm role="concept">
9899 <primary>lookup</primary>
9900 <secondary>DNS</secondary>
9901 </indexterm>
9902 <command>dnsdb</command>: This does a DNS search for one or more records whose domain names
9903 are given in the supplied query. The resulting data is the contents of the
9904 records. See section <xref linkend="SECTdnsdb"/>.
9905 </para>
9906 </listitem>
9907 <listitem>
9908 <para>
9909 <indexterm role="concept">
9910 <primary>InterBase lookup type</primary>
9911 </indexterm>
9912 <indexterm role="concept">
9913 <primary>lookup</primary>
9914 <secondary>InterBase</secondary>
9915 </indexterm>
9916 <command>ibase</command>: This does a lookup in an InterBase database.
9917 </para>
9918 </listitem>
9919 <listitem>
9920 <para>
9921 <indexterm role="concept">
9922 <primary>LDAP</primary>
9923 <secondary>lookup type</secondary>
9924 </indexterm>
9925 <indexterm role="concept">
9926 <primary>lookup</primary>
9927 <secondary>LDAP</secondary>
9928 </indexterm>
9929 <command>ldap</command>: This does an LDAP lookup using a query in the form of a URL, and
9930 returns attributes from a single entry. There is a variant called <command>ldapm</command>
9931 that permits values from multiple entries to be returned. A third variant
9932 called <command>ldapdn</command> returns the Distinguished Name of a single entry instead of
9933 any attribute values. See section <xref linkend="SECTldap"/>.
9934 </para>
9935 </listitem>
9936 <listitem>
9937 <para>
9938 <indexterm role="concept">
9939 <primary>MySQL</primary>
9940 <secondary>lookup type</secondary>
9941 </indexterm>
9942 <indexterm role="concept">
9943 <primary>lookup</primary>
9944 <secondary>MySQL</secondary>
9945 </indexterm>
9946 <command>mysql</command>: The format of the query is an SQL statement that is passed to a
9947 MySQL database. See section <xref linkend="SECTsql"/>.
9948 </para>
9949 </listitem>
9950 <listitem>
9951 <para>
9952 <indexterm role="concept">
9953 <primary>NIS+ lookup type</primary>
9954 </indexterm>
9955 <indexterm role="concept">
9956 <primary>lookup</primary>
9957 <secondary>NIS+</secondary>
9958 </indexterm>
9959 <command>nisplus</command>: This does a NIS+ lookup using a query that can specify the name of
9960 the field to be returned. See section <xref linkend="SECTnisplus"/>.
9961 </para>
9962 </listitem>
9963 <listitem>
9964 <para>
9965 <indexterm role="concept">
9966 <primary>Oracle</primary>
9967 <secondary>lookup type</secondary>
9968 </indexterm>
9969 <indexterm role="concept">
9970 <primary>lookup</primary>
9971 <secondary>Oracle</secondary>
9972 </indexterm>
9973 <command>oracle</command>: The format of the query is an SQL statement that is passed to an
9974 Oracle database. See section <xref linkend="SECTsql"/>.
9975 </para>
9976 </listitem>
9977 <listitem>
9978 <para>
9979 <indexterm role="concept">
9980 <primary>lookup</primary>
9981 <secondary>passwd</secondary>
9982 </indexterm>
9983 <indexterm role="concept">
9984 <primary>passwd lookup type</primary>
9985 </indexterm>
9986 <indexterm role="concept">
9987 <primary><filename>/etc/passwd</filename></primary>
9988 </indexterm>
9989 <command>passwd</command> is a query-style lookup with queries that are just user names. The
9990 lookup calls <function>getpwnam()</function> to interrogate the system password data, and on
9991 success, the result string is the same as you would get from an <command>lsearch</command>
9992 lookup on a traditional <filename>/etc/passwd file</filename>, though with <literal>*</literal> for the
9993 password value. For example:
9994 </para>
9995 <literallayout class="monospaced">
9996 *:42:42:King Rat:/home/kr:/bin/bash
9997 </literallayout>
9998 </listitem>
9999 <listitem>
10000 <para>
10001 <indexterm role="concept">
10002 <primary>PostgreSQL lookup type</primary>
10003 </indexterm>
10004 <indexterm role="concept">
10005 <primary>lookup</primary>
10006 <secondary>PostgreSQL</secondary>
10007 </indexterm>
10008 <command>pgsql</command>: The format of the query is an SQL statement that is passed to a
10009 PostgreSQL database. See section <xref linkend="SECTsql"/>.
10010 </para>
10011 </listitem>
10012 <listitem>
10013 <para>
10014 <indexterm role="concept">
10015 <primary>sqlite lookup type</primary>
10016 </indexterm>
10017 <indexterm role="concept">
10018 <primary>lookup</primary>
10019 <secondary>sqlite</secondary>
10020 </indexterm>
10021 <command>sqlite</command>: The format of the query is a file name followed by an SQL statement
10022 that is passed to an SQLite database. See section <xref linkend="SECTsqlite"/>.
10023 </para>
10024 </listitem>
10025 <listitem>
10026 <para>
10027 <command>testdb</command>: This is a lookup type that is used for testing Exim. It is
10028 not likely to be useful in normal operation.
10029 </para>
10030 </listitem>
10031 <listitem>
10032 <para>
10033 <indexterm role="concept">
10034 <primary>whoson lookup type</primary>
10035 </indexterm>
10036 <indexterm role="concept">
10037 <primary>lookup</primary>
10038 <secondary>whoson</secondary>
10039 </indexterm>
10040 <command>whoson</command>: <emphasis>Whoson</emphasis> (<emphasis role="bold"><ulink url="http://whoson.sourceforge.net">http://whoson.sourceforge.net</ulink></emphasis>) is a protocol that
10041 allows a server to check whether a particular (dynamically allocated) IP
10042 address is currently allocated to a known (trusted) user and, optionally, to
10043 obtain the identity of the said user. For SMTP servers, <emphasis>Whoson</emphasis> was popular
10044 at one time for <quote>POP before SMTP</quote> authentication, but that approach has been
10045 superseded by SMTP authentication. In Exim, <emphasis>Whoson</emphasis> can be used to implement
10046 <quote>POP before SMTP</quote> checking using ACL statements such as
10047 </para>
10048 <literallayout class="monospaced">
10049 require condition = \
10050   ${lookup whoson {$sender_host_address}{yes}{no}}
10051 </literallayout>
10052 <para>
10053 The query consists of a single IP address. The value returned is the name of
10054 the authenticated user, which is stored in the variable <varname>$value</varname>. However, in
10055 this example, the data in <varname>$value</varname> is not used; the result of the lookup is
10056 one of the fixed strings <quote>yes</quote> or <quote>no</quote>.
10057 </para>
10058 </listitem>
10059 </itemizedlist>
10060 </section>
10061 <section id="SECID63">
10062 <title>Temporary errors in lookups</title>
10063 <para>
10064 <indexterm role="concept">
10065 <primary>lookup</primary>
10066 <secondary>temporary error in</secondary>
10067 </indexterm>
10068 Lookup functions can return temporary error codes if the lookup cannot be
10069 completed. For example, an SQL or LDAP database might be unavailable. For this
10070 reason, it is not advisable to use a lookup that might do this for critical
10071 options such as a list of local domains.
10072 </para>
10073 <para>
10074 When a lookup cannot be completed in a router or transport, delivery
10075 of the message (to the relevant address) is deferred, as for any other
10076 temporary error. In other circumstances Exim may assume the lookup has failed,
10077 or may give up altogether.
10078 </para>
10079 </section>
10080 <section id="SECTdefaultvaluelookups">
10081 <title>Default values in single-key lookups</title>
10082 <para>
10083 <indexterm role="concept">
10084 <primary>wildcard lookups</primary>
10085 </indexterm>
10086 <indexterm role="concept">
10087 <primary>lookup</primary>
10088 <secondary>default values</secondary>
10089 </indexterm>
10090 <indexterm role="concept">
10091 <primary>lookup</primary>
10092 <secondary>wildcard</secondary>
10093 </indexterm>
10094 <indexterm role="concept">
10095 <primary>lookup</primary>
10096 <secondary>* added to type</secondary>
10097 </indexterm>
10098 <indexterm role="concept">
10099 <primary>default</primary>
10100 <secondary>in single-key lookups</secondary>
10101 </indexterm>
10102 In this context, a <quote>default value</quote> is a value specified by the administrator
10103 that is to be used if a lookup fails.
10104 </para>
10105 <para>
10106 <emphasis role="bold">Note:</emphasis> This section applies only to single-key lookups. For query-style
10107 lookups, the facilities of the query language must be used. An attempt to
10108 specify a default for a query-style lookup provokes an error.
10109 </para>
10110 <para>
10111 If <quote>*</quote> is added to a single-key lookup type (for example, <option>lsearch*</option>)
10112 and the initial lookup fails, the key <quote>*</quote> is looked up in the file to
10113 provide a default value. See also the section on partial matching below.
10114 </para>
10115 <para>
10116 <indexterm role="concept">
10117 <primary>*@ with single-key lookup</primary>
10118 </indexterm>
10119 <indexterm role="concept">
10120 <primary>lookup</primary>
10121 <secondary>*@ added to type</secondary>
10122 </indexterm>
10123 <indexterm role="concept">
10124 <primary>alias file</primary>
10125 <secondary>per-domain default</secondary>
10126 </indexterm>
10127 Alternatively, if <quote>*@</quote> is added to a single-key lookup type (for example
10128 <option>dbm*@</option>) then, if the initial lookup fails and the key contains an @
10129 character, a second lookup is done with everything before the last @ replaced
10130 by *. This makes it possible to provide per-domain defaults in alias files
10131 that include the domains in the keys. If the second lookup fails (or doesn&#x2019;t
10132 take place because there is no @ in the key), <quote>*</quote> is looked up.
10133 For example, a <command>redirect</command> router might contain:
10134 </para>
10135 <literallayout class="monospaced">
10136 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
10137 </literallayout>
10138 <para>
10139 Suppose the address that is being processed is <emphasis>jane@eyre.example</emphasis>. Exim
10140 looks up these keys, in this order:
10141 </para>
10142 <literallayout class="monospaced">
10143 jane@eyre.example
10144 *@eyre.example
10145 *
10146 </literallayout>
10147 <para>
10148 The data is taken from whichever key it finds first. <emphasis role="bold">Note</emphasis>: In an
10149 <command>lsearch</command> file, this does not mean the first of these keys in the file. A
10150 complete scan is done for each key, and only if it is not found at all does
10151 Exim move on to try the next key.
10152 </para>
10153 </section>
10154 <section id="SECTpartiallookup">
10155 <title>Partial matching in single-key lookups</title>
10156 <para>
10157 <indexterm role="concept">
10158 <primary>partial matching</primary>
10159 </indexterm>
10160 <indexterm role="concept">
10161 <primary>wildcard lookups</primary>
10162 </indexterm>
10163 <indexterm role="concept">
10164 <primary>lookup</primary>
10165 <secondary>partial matching</secondary>
10166 </indexterm>
10167 <indexterm role="concept">
10168 <primary>lookup</primary>
10169 <secondary>wildcard</secondary>
10170 </indexterm>
10171 <indexterm role="concept">
10172 <primary>asterisk</primary>
10173 <secondary>in search type</secondary>
10174 </indexterm>
10175 The normal operation of a single-key lookup is to search the file for an exact
10176 match with the given key. However, in a number of situations where domains are
10177 being looked up, it is useful to be able to do partial matching. In this case,
10178 information in the file that has a key starting with <quote>*.</quote> is matched by any
10179 domain that ends with the components that follow the full stop. For example, if
10180 a key in a DBM file is
10181 </para>
10182 <literallayout class="monospaced">
10183 *.dates.fict.example
10184 </literallayout>
10185 <para>
10186 then when partial matching is enabled this is matched by (amongst others)
10187 <emphasis>2001.dates.fict.example</emphasis> and <emphasis>1984.dates.fict.example</emphasis>. It is also matched
10188 by <emphasis>dates.fict.example</emphasis>, if that does not appear as a separate key in the
10189 file.
10190 </para>
10191 <para>
10192 <emphasis role="bold">Note</emphasis>: Partial matching is not available for query-style lookups. It is
10193 also not available for any lookup items in address lists (see section
10194 <xref linkend="SECTaddresslist"/>).
10195 </para>
10196 <para>
10197 Partial matching is implemented by doing a series of separate lookups using
10198 keys constructed by modifying the original subject key. This means that it can
10199 be used with any of the single-key lookup types, provided that
10200 partial matching keys
10201 beginning with a special prefix (default <quote>*.</quote>) are included in the data file.
10202 Keys in the file that do not begin with the prefix are matched only by
10203 unmodified subject keys when partial matching is in use.
10204 </para>
10205 <para>
10206 Partial matching is requested by adding the string <quote>partial-</quote> to the front of
10207 the name of a single-key lookup type, for example, <option>partial-dbm</option>. When this
10208 is done, the subject key is first looked up unmodified; if that fails, <quote>*.</quote>
10209 is added at the start of the subject key, and it is looked up again. If that
10210 fails, further lookups are tried with dot-separated components removed from the
10211 start of the subject key, one-by-one, and <quote>*.</quote> added on the front of what
10212 remains.
10213 </para>
10214 <para>
10215 A minimum number of two non-* components are required. This can be adjusted
10216 by including a number before the hyphen in the search type. For example,
10217 <option>partial3-lsearch</option> specifies a minimum of three non-* components in the
10218 modified keys. Omitting the number is equivalent to <quote>partial2-</quote>. If the
10219 subject key is <emphasis>2250.dates.fict.example</emphasis> then the following keys are looked
10220 up when the minimum number of non-* components is two:
10221 </para>
10222 <literallayout class="monospaced">
10223 2250.dates.fict.example
10224 *.2250.dates.fict.example
10225 *.dates.fict.example
10226 *.fict.example
10227 </literallayout>
10228 <para>
10229 As soon as one key in the sequence is successfully looked up, the lookup
10230 finishes.
10231 </para>
10232 <para>
10233 <indexterm role="concept">
10234 <primary>lookup</primary>
10235 <secondary>partial matching &ndash; changing prefix</secondary>
10236 </indexterm>
10237 <indexterm role="concept">
10238 <primary>prefix</primary>
10239 <secondary>for partial matching</secondary>
10240 </indexterm>
10241 The use of <quote>*.</quote> as the partial matching prefix is a default that can be
10242 changed. The motivation for this feature is to allow Exim to operate with file
10243 formats that are used by other MTAs. A different prefix can be supplied in
10244 parentheses instead of the hyphen after <quote>partial</quote>. For example:
10245 </para>
10246 <literallayout class="monospaced">
10247 domains = partial(.)lsearch;/some/file
10248 </literallayout>
10249 <para>
10250 In this example, if the domain is <emphasis>a.b.c</emphasis>, the sequence of lookups is
10251 <literal>a.b.c</literal>, <literal>.a.b.c</literal>, and <literal>.b.c</literal> (the default minimum of 2 non-wild
10252 components is unchanged). The prefix may consist of any punctuation characters
10253 other than a closing parenthesis. It may be empty, for example:
10254 </para>
10255 <literallayout class="monospaced">
10256 domains = partial1()cdb;/some/file
10257 </literallayout>
10258 <para>
10259 For this example, if the domain is <emphasis>a.b.c</emphasis>, the sequence of lookups is
10260 <literal>a.b.c</literal>, <literal>b.c</literal>, and <literal>c</literal>.
10261 </para>
10262 <para>
10263 If <quote>partial0</quote> is specified, what happens at the end (when the lookup with
10264 just one non-wild component has failed, and the original key is shortened right
10265 down to the null string) depends on the prefix:
10266 </para>
10267 <itemizedlist>
10268 <listitem>
10269 <para>
10270 If the prefix has zero length, the whole lookup fails.
10271 </para>
10272 </listitem>
10273 <listitem>
10274 <para>
10275 If the prefix has length 1, a lookup for just the prefix is done. For
10276 example, the final lookup for <quote>partial0(.)</quote> is for <literal>.</literal> alone.
10277 </para>
10278 </listitem>
10279 <listitem>
10280 <para>
10281 Otherwise, if the prefix ends in a dot, the dot is removed, and the
10282 remainder is looked up. With the default prefix, therefore, the final lookup is
10283 for <quote>*</quote> on its own.
10284 </para>
10285 </listitem>
10286 <listitem>
10287 <para>
10288 Otherwise, the whole prefix is looked up.
10289 </para>
10290 </listitem>
10291 </itemizedlist>
10292 <para>
10293 If the search type ends in <quote>*</quote> or <quote>*@</quote> (see section
10294 <xref linkend="SECTdefaultvaluelookups"/> above), the search for an ultimate default that
10295 this implies happens after all partial lookups have failed. If <quote>partial0</quote> is
10296 specified, adding <quote>*</quote> to the search type has no effect with the default
10297 prefix, because the <quote>*</quote> key is already included in the sequence of partial
10298 lookups. However, there might be a use for lookup types such as
10299 <quote>partial0(.)lsearch*</quote>.
10300 </para>
10301 <para>
10302 The use of <quote>*</quote> in lookup partial matching differs from its use as a wildcard
10303 in domain lists and the like. Partial matching works only in terms of
10304 dot-separated components; a key such as <literal>*fict.example</literal>
10305 in a database file is useless, because the asterisk in a partial matching
10306 subject key is always followed by a dot.
10307 </para>
10308 </section>
10309 <section id="SECID64">
10310 <title>Lookup caching</title>
10311 <para>
10312 <indexterm role="concept">
10313 <primary>lookup</primary>
10314 <secondary>caching</secondary>
10315 </indexterm>
10316 <indexterm role="concept">
10317 <primary>caching</primary>
10318 <secondary>lookup data</secondary>
10319 </indexterm>
10320 Exim caches all lookup results in order to avoid needless repetition of
10321 lookups. However, because (apart from the daemon) Exim operates as a collection
10322 of independent, short-lived processes, this caching applies only within a
10323 single Exim process. There is no inter-process lookup caching facility.
10324 </para>
10325 <para>
10326 For single-key lookups, Exim keeps the relevant files open in case there is
10327 another lookup that needs them. In some types of configuration this can lead to
10328 many files being kept open for messages with many recipients. To avoid hitting
10329 the operating system limit on the number of simultaneously open files, Exim
10330 closes the least recently used file when it needs to open more files than its
10331 own internal limit, which can be changed via the <option>lookup_open_max</option> option.
10332 </para>
10333 <para>
10334 The single-key lookup files are closed and the lookup caches are flushed at
10335 strategic points during delivery &ndash; for example, after all routing is
10336 complete.
10337 </para>
10338 </section>
10339 <section id="SECID65">
10340 <title>Quoting lookup data</title>
10341 <para>
10342 <indexterm role="concept">
10343 <primary>lookup</primary>
10344 <secondary>quoting</secondary>
10345 </indexterm>
10346 <indexterm role="concept">
10347 <primary>quoting</primary>
10348 <secondary>in lookups</secondary>
10349 </indexterm>
10350 When data from an incoming message is included in a query-style lookup, there
10351 is the possibility of special characters in the data messing up the syntax of
10352 the query. For example, a NIS+ query that contains
10353 </para>
10354 <literallayout class="monospaced">
10355 [name=$local_part]
10356 </literallayout>
10357 <para>
10358 will be broken if the local part happens to contain a closing square bracket.
10359 For NIS+, data can be enclosed in double quotes like this:
10360 </para>
10361 <literallayout class="monospaced">
10362 [name="$local_part"]
10363 </literallayout>
10364 <para>
10365 but this still leaves the problem of a double quote in the data. The rule for
10366 NIS+ is that double quotes must be doubled. Other lookup types have different
10367 rules, and to cope with the differing requirements, an expansion operator
10368 of the following form is provided:
10369 </para>
10370 <literallayout class="monospaced">
10371 ${quote_&lt;lookup-type&gt;:&lt;string&gt;}
10372 </literallayout>
10373 <para>
10374 For example, the safest way to write the NIS+ query is
10375 </para>
10376 <literallayout class="monospaced">
10377 [name="${quote_nisplus:$local_part}"]
10378 </literallayout>
10379 <para>
10380 See chapter <xref linkend="CHAPexpand"/> for full coverage of string expansions. The quote
10381 operator can be used for all lookup types, but has no effect for single-key
10382 lookups, since no quoting is ever needed in their key strings.
10383 </para>
10384 </section>
10385 <section id="SECTdnsdb">
10386 <title>More about dnsdb</title>
10387 <para>
10388 <indexterm role="concept">
10389 <primary>dnsdb lookup</primary>
10390 </indexterm>
10391 <indexterm role="concept">
10392 <primary>lookup</primary>
10393 <secondary>dnsdb</secondary>
10394 </indexterm>
10395 <indexterm role="concept">
10396 <primary>DNS</primary>
10397 <secondary>as a lookup type</secondary>
10398 </indexterm>
10399 The <command>dnsdb</command> lookup type uses the DNS as its database. A simple query consists
10400 of a record type and a domain name, separated by an equals sign. For example,
10401 an expansion string could contain:
10402 </para>
10403 <literallayout class="monospaced">
10404 ${lookup dnsdb{mx=a.b.example}{$value}fail}
10405 </literallayout>
10406 <para>
10407 If the lookup succeeds, the result is placed in <varname>$value</varname>, which in this case
10408 is used on its own as the result. If the lookup does not succeed, the
10409 <literal>fail</literal> keyword causes a <emphasis>forced expansion failure</emphasis> &ndash; see section
10410 <xref linkend="SECTforexpfai"/> for an explanation of what this means.
10411 </para>
10412 <para>
10413 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, TLSA and TXT,
10414 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
10415 configured). If no type is given, TXT is assumed. When the type is PTR,
10416 the data can be an IP address, written as normal; inversion and the addition of
10417 <option>in-addr.arpa</option> or <option>ip6.arpa</option> happens automatically. For example:
10418 </para>
10419 <literallayout class="monospaced">
10420 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
10421 </literallayout>
10422 <para>
10423 If the data for a PTR record is not a syntactically valid IP address, it is not
10424 altered and nothing is added.
10425 </para>
10426 <para>
10427 <indexterm role="concept">
10428 <primary>MX record</primary>
10429 <secondary>in <command>dnsdb</command> lookup</secondary>
10430 </indexterm>
10431 <indexterm role="concept">
10432 <primary>SRV record</primary>
10433 <secondary>in <command>dnsdb</command> lookup</secondary>
10434 </indexterm>
10435 For an MX lookup, both the preference value and the host name are returned for
10436 each record, separated by a space. For an SRV lookup, the priority, weight,
10437 port, and host name are returned for each record, separated by spaces.
10438 </para>
10439 <para>
10440 For any record type, if multiple records are found (or, for A6 lookups, if a
10441 single record leads to multiple addresses), the data is returned as a
10442 concatenation, with newline as the default separator. The order, of course,
10443 depends on the DNS resolver. You can specify a different separator character
10444 between multiple records by putting a right angle-bracket followed immediately
10445 by the new separator at the start of the query. For example:
10446 </para>
10447 <literallayout class="monospaced">
10448 ${lookup dnsdb{&gt;: a=host1.example}}
10449 </literallayout>
10450 <para>
10451 It is permitted to specify a space as the separator character. Further
10452 white space is ignored.
10453 </para>
10454 <para>
10455 <indexterm role="concept">
10456 <primary>TXT record</primary>
10457 <secondary>in <command>dnsdb</command> lookup</secondary>
10458 </indexterm>
10459 <indexterm role="concept">
10460 <primary>SPF record</primary>
10461 <secondary>in <command>dnsdb</command> lookup</secondary>
10462 </indexterm>
10463 For TXT records with multiple items of data, only the first item is returned,
10464 unless a separator for them is specified using a comma after the separator
10465 character followed immediately by the TXT record item separator. To concatenate
10466 items without a separator, use a semicolon instead. For SPF records the
10467 default behaviour is to concatenate multiple items without using a separator.
10468 </para>
10469 <literallayout class="monospaced">
10470 ${lookup dnsdb{&gt;\n,: txt=a.b.example}}
10471 ${lookup dnsdb{&gt;\n; txt=a.b.example}}
10472 ${lookup dnsdb{spf=example.org}}
10473 </literallayout>
10474 <para>
10475 It is permitted to specify a space as the separator character. Further
10476 white space is ignored.
10477 </para>
10478 </section>
10479 <section id="SECID66">
10480 <title>Pseudo dnsdb record types</title>
10481 <para>
10482 <indexterm role="concept">
10483 <primary>MX record</primary>
10484 <secondary>in <command>dnsdb</command> lookup</secondary>
10485 </indexterm>
10486 By default, both the preference value and the host name are returned for
10487 each MX record, separated by a space. If you want only host names, you can use
10488 the pseudo-type MXH:
10489 </para>
10490 <literallayout class="monospaced">
10491 ${lookup dnsdb{mxh=a.b.example}}
10492 </literallayout>
10493 <para>
10494 In this case, the preference values are omitted, and just the host names are
10495 returned.
10496 </para>
10497 <para>
10498 <indexterm role="concept">
10499 <primary>name server for enclosing domain</primary>
10500 </indexterm>
10501 Another pseudo-type is ZNS (for <quote>zone NS</quote>). It performs a lookup for NS
10502 records on the given domain, but if none are found, it removes the first
10503 component of the domain name, and tries again. This process continues until NS
10504 records are found or there are no more components left (or there is a DNS
10505 error). In other words, it may return the name servers for a top-level domain,
10506 but it never returns the root name servers. If there are no NS records for the
10507 top-level domain, the lookup fails. Consider these examples:
10508 </para>
10509 <literallayout class="monospaced">
10510 ${lookup dnsdb{zns=xxx.quercite.com}}
10511 ${lookup dnsdb{zns=xxx.edu}}
10512 </literallayout>
10513 <para>
10514 Assuming that in each case there are no NS records for the full domain name,
10515 the first returns the name servers for <option>quercite.com</option>, and the second returns
10516 the name servers for <option>edu</option>.
10517 </para>
10518 <para>
10519 You should be careful about how you use this lookup because, unless the
10520 top-level domain does not exist, the lookup always returns some host names. The
10521 sort of use to which this might be put is for seeing if the name servers for a
10522 given domain are on a blacklist. You can probably assume that the name servers
10523 for the high-level domains such as <option>com</option> or <option>co.uk</option> are not going to be on
10524 such a list.
10525 </para>
10526 <para>
10527 <indexterm role="concept">
10528 <primary>CSA</primary>
10529 <secondary>in <command>dnsdb</command> lookup</secondary>
10530 </indexterm>
10531 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
10532 records according to the CSA rules, which are described in section
10533 <xref linkend="SECTverifyCSA"/>. Although <command>dnsdb</command> supports SRV lookups directly, this is
10534 not sufficient because of the extra parent domain search behaviour of CSA. The
10535 result of a successful lookup such as:
10536 </para>
10537 <literallayout class="monospaced">
10538 ${lookup dnsdb {csa=$sender_helo_name}}
10539 </literallayout>
10540 <para>
10541 has two space-separated fields: an authorization code and a target host name.
10542 The authorization code can be <quote>Y</quote> for yes, <quote>N</quote> for no, <quote>X</quote> for explicit
10543 authorization required but absent, or <quote>?</quote> for unknown.
10544 </para>
10545 <para>
10546 <indexterm role="concept">
10547 <primary>A+</primary>
10548 <secondary>in <command>dnsdb</command> lookup</secondary>
10549 </indexterm>
10550 The pseudo-type A+ performs an A6 lookup (if configured) followed by an AAAA
10551 and then an A lookup.  All results are returned; defer processing
10552 (see below) is handled separately for each lookup.  Example:
10553 </para>
10554 <literallayout class="monospaced">
10555 ${lookup dnsdb {&gt;; a+=$sender_helo_name}}
10556 </literallayout>
10557 </section>
10558 <section id="SECID67">
10559 <title>Multiple dnsdb lookups</title>
10560 <para>
10561 In the previous sections, <command>dnsdb</command> lookups for a single domain are described.
10562 However, you can specify a list of domains or IP addresses in a single
10563 <command>dnsdb</command> lookup. The list is specified in the normal Exim way, with colon as
10564 the default separator, but with the ability to change this. For example:
10565 </para>
10566 <literallayout class="monospaced">
10567 ${lookup dnsdb{one.domain.com:two.domain.com}}
10568 ${lookup dnsdb{a=one.host.com:two.host.com}}
10569 ${lookup dnsdb{ptr = &lt;; 1.2.3.4 ; 4.5.6.8}}
10570 </literallayout>
10571 <para>
10572 In order to retain backwards compatibility, there is one special case: if
10573 the lookup type is PTR and no change of separator is specified, Exim looks
10574 to see if the rest of the string is precisely one IPv6 address. In this
10575 case, it does not treat it as a list.
10576 </para>
10577 <para>
10578 The data from each lookup is concatenated, with newline separators by default,
10579 in the same way that multiple DNS records for a single item are handled. A
10580 different separator can be specified, as described above.
10581 </para>
10582 <para>
10583 Modifiers for <command>dnsdb</command> lookups are givien by optional keywords,
10584 each followed by a comma,
10585 that may appear before the record type.
10586 </para>
10587 <para>
10588 The <command>dnsdb</command> lookup fails only if all the DNS lookups fail. If there is a
10589 temporary DNS error for any of them, the behaviour is controlled by
10590 a defer-option modifier.
10591 The possible keywords are
10592 <quote>defer_strict</quote>, <quote>defer_never</quote>, and <quote>defer_lax</quote>.
10593 With <quote>strict</quote> behaviour, any temporary DNS error causes the
10594 whole lookup to defer. With <quote>never</quote> behaviour, a temporary DNS error is
10595 ignored, and the behaviour is as if the DNS lookup failed to find anything.
10596 With <quote>lax</quote> behaviour, all the queries are attempted, but a temporary DNS
10597 error causes the whole lookup to defer only if none of the other lookups
10598 succeed. The default is <quote>lax</quote>, so the following lookups are equivalent:
10599 </para>
10600 <literallayout class="monospaced">
10601 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
10602 ${lookup dnsdb{a=one.host.com:two.host.com}}
10603 </literallayout>
10604 <para>
10605 Thus, in the default case, as long as at least one of the DNS lookups
10606 yields some data, the lookup succeeds.
10607 </para>
10608 <para revisionflag="changed">
10609 <indexterm role="concept">
10610 <primary>DNSSEC</primary>
10611 <secondary>dns lookup</secondary>
10612 </indexterm>
10613 Use of <command>DNSSEC</command> is controlled by a dnssec modifier.
10614 The possible keywords are
10615 <quote>dnssec_strict</quote>, <quote>dnssec_lax</quote>, and <quote>dnssec_never</quote>.
10616 With <quote>strict</quote> or <quote>lax</quote> DNSSEC information is requested
10617 with the lookup.
10618 With <quote>strict</quote> a response from the DNS resolver that
10619 is not labelled as authenticated data
10620 is treated as equivalent to a temporary DNS error.
10621 The default is <quote>never</quote>.
10622 </para>
10623 <para revisionflag="changed">
10624 See also the <varname>$lookup_dnssec_authenticated</varname> variable.
10625 </para>
10626 </section>
10627 <section id="SECTldap">
10628 <title>More about LDAP</title>
10629 <para>
10630 <indexterm role="concept">
10631 <primary>LDAP</primary>
10632 <secondary>lookup, more about</secondary>
10633 </indexterm>
10634 <indexterm role="concept">
10635 <primary>lookup</primary>
10636 <secondary>LDAP</secondary>
10637 </indexterm>
10638 <indexterm role="concept">
10639 <primary>Solaris</primary>
10640 <secondary>LDAP</secondary>
10641 </indexterm>
10642 The original LDAP implementation came from the University of Michigan; this has
10643 become <quote>Open LDAP</quote>, and there are now two different releases. Another
10644 implementation comes from Netscape, and Solaris 7 and subsequent releases
10645 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
10646 the lookup function level, their error handling is different. For this reason
10647 it is necessary to set a compile-time variable when building Exim with LDAP, to
10648 indicate which LDAP library is in use. One of the following should appear in
10649 your <filename>Local/Makefile</filename>:
10650 </para>
10651 <literallayout class="monospaced">
10652 LDAP_LIB_TYPE=UMICHIGAN
10653 LDAP_LIB_TYPE=OPENLDAP1
10654 LDAP_LIB_TYPE=OPENLDAP2
10655 LDAP_LIB_TYPE=NETSCAPE
10656 LDAP_LIB_TYPE=SOLARIS
10657 </literallayout>
10658 <para>
10659 If LDAP_LIB_TYPE is not set, Exim assumes <literal>OPENLDAP1</literal>, which has the
10660 same interface as the University of Michigan version.
10661 </para>
10662 <para>
10663 There are three LDAP lookup types in Exim. These behave slightly differently in
10664 the way they handle the results of a query:
10665 </para>
10666 <itemizedlist>
10667 <listitem>
10668 <para>
10669 <command>ldap</command> requires the result to contain just one entry; if there are more, it
10670 gives an error.
10671 </para>
10672 </listitem>
10673 <listitem>
10674 <para>
10675 <command>ldapdn</command> also requires the result to contain just one entry, but it is the
10676 Distinguished Name that is returned rather than any attribute values.
10677 </para>
10678 </listitem>
10679 <listitem>
10680 <para>
10681 <command>ldapm</command> permits the result to contain more than one entry; the attributes
10682 from all of them are returned.
10683 </para>
10684 </listitem>
10685 </itemizedlist>
10686 <para>
10687 For <command>ldap</command> and <command>ldapm</command>, if a query finds only entries with no attributes,
10688 Exim behaves as if the entry did not exist, and the lookup fails. The format of
10689 the data returned by a successful lookup is described in the next section.
10690 First we explain how LDAP queries are coded.
10691 </para>
10692 </section>
10693 <section id="SECTforldaque">
10694 <title>Format of LDAP queries</title>
10695 <para>
10696 <indexterm role="concept">
10697 <primary>LDAP</primary>
10698 <secondary>query format</secondary>
10699 </indexterm>
10700 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
10701 the configuration of a <command>redirect</command> router one might have this setting:
10702 </para>
10703 <literallayout class="monospaced">
10704 data = ${lookup ldap \
10705   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
10706   c=UK?mailbox?base?}}
10707 </literallayout>
10708 <para>
10709 <indexterm role="concept">
10710 <primary>LDAP</primary>
10711 <secondary>with TLS</secondary>
10712 </indexterm>
10713 The URL may begin with <literal>ldap</literal> or <literal>ldaps</literal> if your LDAP library supports
10714 secure (encrypted) LDAP connections. The second of these ensures that an
10715 encrypted TLS connection is used.
10716 </para>
10717 <para>
10718 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
10719 LDAP connections, rather than the SSL-on-connect <literal>ldaps</literal>.
10720 See the <option>ldap_start_tls</option> option.
10721 </para>
10722 <para revisionflag="changed">
10723 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
10724 controlled. Every part of the TLS configuration can be configured by settings in
10725 <filename>exim.conf</filename>. Depending on the version of the client libraries installed on
10726 your system, some of the initialization may have required setting options in
10727 <filename>/etc/ldap.conf</filename> or <filename>~/.ldaprc</filename> to get TLS working with self-signed
10728 certificates. This revealed a nuance where the current UID that exim was
10729 running as could affect which config files it read. With Exim 4.83, these
10730 methods become optional, only taking effect if not specifically set in
10731 <filename>exim.conf</filename>.
10732 </para>
10733 </section>
10734 <section id="SECID68">
10735 <title>LDAP quoting</title>
10736 <para>
10737 <indexterm role="concept">
10738 <primary>LDAP</primary>
10739 <secondary>quoting</secondary>
10740 </indexterm>
10741 Two levels of quoting are required in LDAP queries, the first for LDAP itself
10742 and the second because the LDAP query is represented as a URL. Furthermore,
10743 within an LDAP query, two different kinds of quoting are required. For this
10744 reason, there are two different LDAP-specific quoting operators.
10745 </para>
10746 <para>
10747 The <option>quote_ldap</option> operator is designed for use on strings that are part of
10748 filter specifications. Conceptually, it first does the following conversions on
10749 the string:
10750 </para>
10751 <literallayout class="monospaced">
10752 *   =&gt;   \2A
10753 (   =&gt;   \28
10754 )   =&gt;   \29
10755 \   =&gt;   \5C
10756 </literallayout>
10757 <para>
10758 in accordance with RFC 2254. The resulting string is then quoted according
10759 to the rules for URLs, that is, all non-alphanumeric characters except
10760 </para>
10761 <literallayout class="monospaced">
10762 ! $ ' - . _ ( ) * +
10763 </literallayout>
10764 <para>
10765 are converted to their hex values, preceded by a percent sign. For example:
10766 </para>
10767 <literallayout class="monospaced">
10768 ${quote_ldap: a(bc)*, a&lt;yz&gt;; }
10769 </literallayout>
10770 <para>
10771 yields
10772 </para>
10773 <literallayout class="monospaced">
10774 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
10775 </literallayout>
10776 <para>
10777 Removing the URL quoting, this is (with a leading and a trailing space):
10778 </para>
10779 <literallayout class="monospaced">
10780 a\28bc\29\2A, a&lt;yz&gt;;
10781 </literallayout>
10782 <para>
10783 The <option>quote_ldap_dn</option> operator is designed for use on strings that are part of
10784 base DN specifications in queries. Conceptually, it first converts the string
10785 by inserting a backslash in front of any of the following characters:
10786 </para>
10787 <literallayout class="monospaced">
10788 , + " \ &lt; &gt; ;
10789 </literallayout>
10790 <para>
10791 It also inserts a backslash before any leading spaces or # characters, and
10792 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
10793 is then quoted according to the rules for URLs. For example:
10794 </para>
10795 <literallayout class="monospaced">
10796 ${quote_ldap_dn: a(bc)*, a&lt;yz&gt;; }
10797 </literallayout>
10798 <para>
10799 yields
10800 </para>
10801 <literallayout class="monospaced">
10802 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
10803 </literallayout>
10804 <para>
10805 Removing the URL quoting, this is (with a trailing space):
10806 </para>
10807 <literallayout class="monospaced">
10808 \ a(bc)*\, a\&lt;yz\&gt;\;\
10809 </literallayout>
10810 <para>
10811 There are some further comments about quoting in the section on LDAP
10812 authentication below.
10813 </para>
10814 </section>
10815 <section id="SECID69">
10816 <title>LDAP connections</title>
10817 <para>
10818 <indexterm role="concept">
10819 <primary>LDAP</primary>
10820 <secondary>connections</secondary>
10821 </indexterm>
10822 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
10823 is in use, via a Unix domain socket. The example given above does not specify
10824 an LDAP server. A server that is reached by TCP/IP can be specified in a query
10825 by starting it with
10826 </para>
10827 <literallayout class="monospaced">
10828 ldap://&lt;hostname&gt;:&lt;port&gt;/...
10829 </literallayout>
10830 <para>
10831 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
10832 used. When no server is specified in a query, a list of default servers is
10833 taken from the <option>ldap_default_servers</option> configuration option. This supplies a
10834 colon-separated list of servers which are tried in turn until one successfully
10835 handles a query, or there is a serious error. Successful handling either
10836 returns the requested data, or indicates that it does not exist. Serious errors
10837 are syntactical, or multiple values when only a single value is expected.
10838 Errors which cause the next server to be tried are connection failures, bind
10839 failures, and timeouts.
10840 </para>
10841 <para>
10842 For each server name in the list, a port number can be given. The standard way
10843 of specifying a host and port is to use a colon separator (RFC 1738). Because
10844 <option>ldap_default_servers</option> is a colon-separated list, such colons have to be
10845 doubled. For example
10846 </para>
10847 <literallayout class="monospaced">
10848 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
10849 </literallayout>
10850 <para>
10851 If <option>ldap_default_servers</option> is unset, a URL with no server name is passed
10852 to the LDAP library with no server name, and the library&#x2019;s default (normally
10853 the local host) is used.
10854 </para>
10855 <para>
10856 If you are using the OpenLDAP library, you can connect to an LDAP server using
10857 a Unix domain socket instead of a TCP/IP connection. This is specified by using
10858 <literal>ldapi</literal> instead of <literal>ldap</literal> in LDAP queries. What follows here applies only
10859 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
10860 not available.
10861 </para>
10862 <para>
10863 For this type of connection, instead of a host name for the server, a pathname
10864 for the socket is required, and the port number is not relevant. The pathname
10865 can be specified either as an item in <option>ldap_default_servers</option>, or inline in
10866 the query. In the former case, you can have settings such as
10867 </para>
10868 <literallayout class="monospaced">
10869 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
10870 </literallayout>
10871 <para>
10872 When the pathname is given in the query, you have to escape the slashes as
10873 <literal>%2F</literal> to fit in with the LDAP URL syntax. For example:
10874 </para>
10875 <literallayout class="monospaced">
10876 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
10877 </literallayout>
10878 <para>
10879 When Exim processes an LDAP lookup and finds that the <quote>hostname</quote> is really
10880 a pathname, it uses the Unix domain socket code, even if the query actually
10881 specifies <literal>ldap</literal> or <literal>ldaps</literal>. In particular, no encryption is used for a
10882 socket connection. This behaviour means that you can use a setting of
10883 <option>ldap_default_servers</option> such as in the example above with traditional <literal>ldap</literal>
10884 or <literal>ldaps</literal> queries, and it will work. First, Exim tries a connection via
10885 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
10886 backup host.
10887 </para>
10888 <para>
10889 If an explicit <literal>ldapi</literal> type is given in a query when a host name is
10890 specified, an error is diagnosed. However, if there are more items in
10891 <option>ldap_default_servers</option>, they are tried. In other words:
10892 </para>
10893 <itemizedlist>
10894 <listitem>
10895 <para>
10896 Using a pathname with <literal>ldap</literal> or <literal>ldaps</literal> forces the use of the Unix domain
10897 interface.
10898 </para>
10899 </listitem>
10900 <listitem>
10901 <para>
10902 Using <literal>ldapi</literal> with a host name causes an error.
10903 </para>
10904 </listitem>
10905 </itemizedlist>
10906 <para>
10907 Using <literal>ldapi</literal> with no host or path in the query, and no setting of
10908 <option>ldap_default_servers</option>, does whatever the library does by default.
10909 </para>
10910 </section>
10911 <section id="SECID70">
10912 <title>LDAP authentication and control information</title>
10913 <para>
10914 <indexterm role="concept">
10915 <primary>LDAP</primary>
10916 <secondary>authentication</secondary>
10917 </indexterm>
10918 The LDAP URL syntax provides no way of passing authentication and other control
10919 information to the server. To make this possible, the URL in an LDAP query may
10920 be preceded by any number of &lt;<emphasis>name</emphasis>&gt;=&lt;<emphasis>value</emphasis>&gt; settings, separated by
10921 spaces. If a value contains spaces it must be enclosed in double quotes, and
10922 when double quotes are used, backslash is interpreted in the usual way inside
10923 them. The following names are recognized:
10924 </para>
10925 <literallayout>
10926 <literal>DEREFERENCE</literal>  set the dereferencing parameter
10927 <literal>NETTIME    </literal>  set a timeout for a network operation
10928 <literal>USER       </literal>  set the DN, for authenticating the LDAP bind
10929 <literal>PASS       </literal>  set the password, likewise
10930 <literal>REFERRALS  </literal>  set the referrals parameter
10931 <phrase revisionflag="changed"><literal>SERVERS    </literal>  set alternate server list for this query only
10932 </phrase><literal>SIZE       </literal>  set the limit for the number of entries returned
10933 <literal>TIME       </literal>  set the maximum waiting time for a query
10934 </literallayout>
10935 <para>
10936 The value of the DEREFERENCE parameter must be one of the words <quote>never</quote>,
10937 <quote>searching</quote>, <quote>finding</quote>, or <quote>always</quote>. The value of the REFERRALS parameter
10938 must be <quote>follow</quote> (the default) or <quote>nofollow</quote>. The latter stops the LDAP
10939 library from trying to follow referrals issued by the LDAP server.
10940 </para>
10941 <para>
10942 The name CONNECT is an obsolete name for NETTIME, retained for
10943 backwards compatibility. This timeout (specified as a number of seconds) is
10944 enforced from the client end for operations that can be carried out over a
10945 network. Specifically, it applies to network connections and calls to the
10946 <emphasis>ldap_result()</emphasis> function. If the value is greater than zero, it is used if
10947 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
10948 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
10949 SDK 4.1). A value of zero forces an explicit setting of <quote>no timeout</quote> for
10950 Netscape SDK; for OpenLDAP no action is taken.
10951 </para>
10952 <para>
10953 The TIME parameter (also a number of seconds) is passed to the server to
10954 set a server-side limit on the time taken to complete a search.
10955 </para>
10956 <para revisionflag="changed">
10957 The SERVERS parameter allows you to specify an alternate list of ldap servers
10958 to use for an individual lookup.  The global ldap_servers option provides a
10959 default list of ldap servers, and a single lookup can specify a single ldap
10960 server to use.  But when you need to do a lookup with a list of servers that is
10961 different than the default list (maybe different order, maybe a completely
10962 different set of servers), the SERVERS parameter allows you to specify this
10963 alternate list.
10964 </para>
10965 <para>
10966 Here is an example of an LDAP query in an Exim lookup that uses some of these
10967 values. This is a single line, folded to fit on the page:
10968 </para>
10969 <literallayout class="monospaced">
10970 ${lookup ldap
10971   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
10972   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
10973   {$value}fail}
10974 </literallayout>
10975 <para>
10976 The encoding of spaces as <literal>%20</literal> is a URL thing which should not be done for
10977 any of the auxiliary data. Exim configuration settings that include lookups
10978 which contain password information should be preceded by <quote>hide</quote> to prevent
10979 non-admin users from using the <option>-bP</option> option to see their values.
10980 </para>
10981 <para>
10982 The auxiliary data items may be given in any order. The default is no
10983 connection timeout (the system timeout is used), no user or password, no limit
10984 on the number of entries returned, and no time limit on queries.
10985 </para>
10986 <para>
10987 When a DN is quoted in the USER= setting for LDAP authentication, Exim
10988 removes any URL quoting that it may contain before passing it LDAP. Apparently
10989 some libraries do this for themselves, but some do not. Removing the URL
10990 quoting has two advantages:
10991 </para>
10992 <itemizedlist>
10993 <listitem>
10994 <para>
10995 It makes it possible to use the same <option>quote_ldap_dn</option> expansion for USER=
10996 DNs as with DNs inside actual queries.
10997 </para>
10998 </listitem>
10999 <listitem>
11000 <para>
11001 It permits spaces inside USER= DNs.
11002 </para>
11003 </listitem>
11004 </itemizedlist>
11005 <para>
11006 For example, a setting such as
11007 </para>
11008 <literallayout class="monospaced">
11009 USER=cn=${quote_ldap_dn:$1}
11010 </literallayout>
11011 <para>
11012 should work even if <varname>$1</varname> contains spaces.
11013 </para>
11014 <para>
11015 Expanded data for the PASS= value should be quoted using the <option>quote</option>
11016 expansion operator, rather than the LDAP quote operators. The only reason this
11017 field needs quoting is to ensure that it conforms to the Exim syntax, which
11018 does not allow unquoted spaces. For example:
11019 </para>
11020 <literallayout class="monospaced">
11021 PASS=${quote:$3}
11022 </literallayout>
11023 <para>
11024 The LDAP authentication mechanism can be used to check passwords as part of
11025 SMTP authentication. See the <option>ldapauth</option> expansion string condition in chapter
11026 <xref linkend="CHAPexpand"/>.
11027 </para>
11028 </section>
11029 <section id="SECID71">
11030 <title>Format of data returned by LDAP</title>
11031 <para>
11032 <indexterm role="concept">
11033 <primary>LDAP</primary>
11034 <secondary>returned data formats</secondary>
11035 </indexterm>
11036 The <command>ldapdn</command> lookup type returns the Distinguished Name from a single entry
11037 as a sequence of values, for example
11038 </para>
11039 <literallayout class="monospaced">
11040 cn=manager, o=University of Cambridge, c=UK
11041 </literallayout>
11042 <para>
11043 The <command>ldap</command> lookup type generates an error if more than one entry matches the
11044 search filter, whereas <command>ldapm</command> permits this case, and inserts a newline in
11045 the result between the data from different entries. It is possible for multiple
11046 values to be returned for both <command>ldap</command> and <command>ldapm</command>, but in the former case
11047 you know that whatever values are returned all came from a single entry in the
11048 directory.
11049 </para>
11050 <para>
11051 In the common case where you specify a single attribute in your LDAP query, the
11052 result is not quoted, and does not contain the attribute name. If the attribute
11053 has multiple values, they are separated by commas.
11054 </para>
11055 <para>
11056 If you specify multiple attributes, the result contains space-separated, quoted
11057 strings, each preceded by the attribute name and an equals sign. Within the
11058 quotes, the quote character, backslash, and newline are escaped with
11059 backslashes, and commas are used to separate multiple values for the attribute.
11060 Apart from the escaping, the string within quotes takes the same form as the
11061 output when a single attribute is requested. Specifying no attributes is the
11062 same as specifying all of an entry&#x2019;s attributes.
11063 </para>
11064 <para>
11065 Here are some examples of the output format. The first line of each pair is an
11066 LDAP query, and the second is the data that is returned. The attribute called
11067 <option>attr1</option> has two values, whereas <option>attr2</option> has only one value:
11068 </para>
11069 <literallayout class="monospaced">
11070 ldap:///o=base?attr1?sub?(uid=fred)
11071 value1.1, value1.2
11072
11073 ldap:///o=base?attr2?sub?(uid=fred)
11074 value two
11075
11076 ldap:///o=base?attr1,attr2?sub?(uid=fred)
11077 attr1="value1.1, value1.2" attr2="value two"
11078
11079 ldap:///o=base??sub?(uid=fred)
11080 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
11081 </literallayout>
11082 <para>
11083 The <option>extract</option> operator in string expansions can be used to pick out
11084 individual fields from data that consists of <emphasis>key</emphasis>=<emphasis>value</emphasis> pairs. You can
11085 make use of Exim&#x2019;s <option>-be</option> option to run expansion tests and thereby check the
11086 results of LDAP lookups.
11087 </para>
11088 </section>
11089 <section id="SECTnisplus">
11090 <title>More about NIS+</title>
11091 <para>
11092 <indexterm role="concept">
11093 <primary>NIS+ lookup type</primary>
11094 </indexterm>
11095 <indexterm role="concept">
11096 <primary>lookup</primary>
11097 <secondary>NIS+</secondary>
11098 </indexterm>
11099 NIS+ queries consist of a NIS+ <emphasis>indexed name</emphasis> followed by an optional colon
11100 and field name. If this is given, the result of a successful query is the
11101 contents of the named field; otherwise the result consists of a concatenation
11102 of <emphasis>field-name=field-value</emphasis> pairs, separated by spaces. Empty values and
11103 values containing spaces are quoted. For example, the query
11104 </para>
11105 <literallayout class="monospaced">
11106 [name=mg1456],passwd.org_dir
11107 </literallayout>
11108 <para>
11109 might return the string
11110 </para>
11111 <literallayout class="monospaced">
11112 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
11113 home=/home/mg1456 shell=/bin/bash shadow=""
11114 </literallayout>
11115 <para>
11116 (split over two lines here to fit on the page), whereas
11117 </para>
11118 <literallayout class="monospaced">
11119 [name=mg1456],passwd.org_dir:gcos
11120 </literallayout>
11121 <para>
11122 would just return
11123 </para>
11124 <literallayout class="monospaced">
11125 Martin Guerre
11126 </literallayout>
11127 <para>
11128 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
11129 for the given indexed key. The effect of the <option>quote_nisplus</option> expansion
11130 operator is to double any quote characters within the text.
11131 </para>
11132 </section>
11133 <section id="SECTsql">
11134 <title>SQL lookups</title>
11135 <para>
11136 <indexterm role="concept">
11137 <primary>SQL lookup types</primary>
11138 </indexterm>
11139 <indexterm role="concept">
11140 <primary>MySQL</primary>
11141 <secondary>lookup type</secondary>
11142 </indexterm>
11143 <indexterm role="concept">
11144 <primary>PostgreSQL lookup type</primary>
11145 </indexterm>
11146 <indexterm role="concept">
11147 <primary>lookup</primary>
11148 <secondary>MySQL</secondary>
11149 </indexterm>
11150 <indexterm role="concept">
11151 <primary>lookup</primary>
11152 <secondary>PostgreSQL</secondary>
11153 </indexterm>
11154 <indexterm role="concept">
11155 <primary>Oracle</primary>
11156 <secondary>lookup type</secondary>
11157 </indexterm>
11158 <indexterm role="concept">
11159 <primary>lookup</primary>
11160 <secondary>Oracle</secondary>
11161 </indexterm>
11162 <indexterm role="concept">
11163 <primary>InterBase lookup type</primary>
11164 </indexterm>
11165 <indexterm role="concept">
11166 <primary>lookup</primary>
11167 <secondary>InterBase</secondary>
11168 </indexterm>
11169 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
11170 databases. Queries for these databases contain SQL statements, so an example
11171 might be
11172 </para>
11173 <literallayout class="monospaced">
11174 ${lookup mysql{select mailbox from users where id='userx'}\
11175   {$value}fail}
11176 </literallayout>
11177 <para>
11178 If the result of the query contains more than one field, the data for each
11179 field in the row is returned, preceded by its name, so the result of
11180 </para>
11181 <literallayout class="monospaced">
11182 ${lookup pgsql{select home,name from users where id='userx'}\
11183   {$value}}
11184 </literallayout>
11185 <para>
11186 might be
11187 </para>
11188 <literallayout class="monospaced">
11189 home=/home/userx name="Mister X"
11190 </literallayout>
11191 <para>
11192 Empty values and values containing spaces are double quoted, with embedded
11193 quotes escaped by a backslash. If the result of the query contains just one
11194 field, the value is passed back verbatim, without a field name, for example:
11195 </para>
11196 <literallayout class="monospaced">
11197 Mister X
11198 </literallayout>
11199 <para>
11200 If the result of the query yields more than one row, it is all concatenated,
11201 with a newline between the data for each row.
11202 </para>
11203 </section>
11204 <section id="SECID72">
11205 <title>More about MySQL, PostgreSQL, Oracle, and InterBase</title>
11206 <para>
11207 <indexterm role="concept">
11208 <primary>MySQL</primary>
11209 <secondary>lookup type</secondary>
11210 </indexterm>
11211 <indexterm role="concept">
11212 <primary>PostgreSQL lookup type</primary>
11213 </indexterm>
11214 <indexterm role="concept">
11215 <primary>lookup</primary>
11216 <secondary>MySQL</secondary>
11217 </indexterm>
11218 <indexterm role="concept">
11219 <primary>lookup</primary>
11220 <secondary>PostgreSQL</secondary>
11221 </indexterm>
11222 <indexterm role="concept">
11223 <primary>Oracle</primary>
11224 <secondary>lookup type</secondary>
11225 </indexterm>
11226 <indexterm role="concept">
11227 <primary>lookup</primary>
11228 <secondary>Oracle</secondary>
11229 </indexterm>
11230 <indexterm role="concept">
11231 <primary>InterBase lookup type</primary>
11232 </indexterm>
11233 <indexterm role="concept">
11234 <primary>lookup</primary>
11235 <secondary>InterBase</secondary>
11236 </indexterm>
11237 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
11238 <option>mysql_servers</option>, <option>pgsql_servers</option>, <option>oracle_servers</option>, or <option>ibase_servers</option>
11239 option (as appropriate) must be set to a colon-separated list of server
11240 information.
11241 (For MySQL and PostgreSQL only, the global option need not be set if all
11242 queries contain their own server information &ndash; see section
11243 <xref linkend="SECTspeserque"/>.) Each item in the list is a slash-separated list of four
11244 items: host name, database name, user name, and password. In the case of
11245 Oracle, the host name field is used for the <quote>service name</quote>, and the database
11246 name field is not used and should be empty. For example:
11247 </para>
11248 <literallayout class="monospaced">
11249 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
11250 </literallayout>
11251 <para>
11252 Because password data is sensitive, you should always precede the setting with
11253 <quote>hide</quote>, to prevent non-admin users from obtaining the setting via the <option>-bP</option>
11254 option. Here is an example where two MySQL servers are listed:
11255 </para>
11256 <literallayout class="monospaced">
11257 hide mysql_servers = localhost/users/root/secret:\
11258                      otherhost/users/root/othersecret
11259 </literallayout>
11260 <para>
11261 For MySQL and PostgreSQL, a host may be specified as &lt;<emphasis>name</emphasis>&gt;:&lt;<emphasis>port</emphasis>&gt; but
11262 because this is a colon-separated list, the colon has to be doubled. For each
11263 query, these parameter groups are tried in order until a connection is made and
11264 a query is successfully processed. The result of a query may be that no data is
11265 found, but that is still a successful query. In other words, the list of
11266 servers provides a backup facility, not a list of different places to look.
11267 </para>
11268 <para>
11269 The <option>quote_mysql</option>, <option>quote_pgsql</option>, and <option>quote_oracle</option> expansion operators
11270 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
11271 respectively, and the characters single-quote, double-quote, and backslash
11272 itself are escaped with backslashes. The <option>quote_pgsql</option> expansion operator, in
11273 addition, escapes the percent and underscore characters. This cannot be done
11274 for MySQL because these escapes are not recognized in contexts where these
11275 characters are not special.
11276 </para>
11277 </section>
11278 <section id="SECTspeserque">
11279 <title>Specifying the server in the query</title>
11280 <para>
11281 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
11282 it is possible to specify a list of servers with an individual query. This is
11283 done by starting the query with
11284 </para>
11285 <literallayout>
11286 <literal>servers=</literal><emphasis>server1:server2:server3:...</emphasis><literal>;</literal>
11287 </literallayout>
11288 <para>
11289 Each item in the list may take one of two forms:
11290 </para>
11291 <orderedlist numeration="arabic">
11292 <listitem>
11293 <para>
11294 If it contains no slashes it is assumed to be just a host name. The appropriate
11295 global option (<option>mysql_servers</option> or <option>pgsql_servers</option>) is searched for a host
11296 of the same name, and the remaining parameters (database, user, password) are
11297 taken from there.
11298 </para>
11299 </listitem>
11300 <listitem>
11301 <para>
11302 If it contains any slashes, it is taken as a complete parameter set.
11303 </para>
11304 </listitem>
11305 </orderedlist>
11306 <para>
11307 The list of servers is used in exactly the same way as the global list.
11308 Once a connection to a server has happened and a query has been
11309 successfully executed, processing of the lookup ceases.
11310 </para>
11311 <para>
11312 This feature is intended for use in master/slave situations where updates
11313 are occurring and you want to update the master rather than a slave. If the
11314 master is in the list as a backup for reading, you might have a global setting
11315 like this:
11316 </para>
11317 <literallayout class="monospaced">
11318 mysql_servers = slave1/db/name/pw:\
11319                 slave2/db/name/pw:\
11320                 master/db/name/pw
11321 </literallayout>
11322 <para>
11323 In an updating lookup, you could then write:
11324 </para>
11325 <literallayout class="monospaced">
11326 ${lookup mysql{servers=master; UPDATE ...} }
11327 </literallayout>
11328 <para>
11329 That query would then be sent only to the master server. If, on the other hand,
11330 the master is not to be used for reading, and so is not present in the global
11331 option, you can still update it by a query of this form:
11332 </para>
11333 <literallayout class="monospaced">
11334 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
11335 </literallayout>
11336 </section>
11337 <section id="SECID73">
11338 <title>Special MySQL features</title>
11339 <para>
11340 For MySQL, an empty host name or the use of <quote>localhost</quote> in <option>mysql_servers</option>
11341 causes a connection to the server on the local host by means of a Unix domain
11342 socket. An alternate socket can be specified in parentheses. The full syntax of
11343 each item in <option>mysql_servers</option> is:
11344 </para>
11345 <literallayout>
11346 &lt;<emphasis>hostname</emphasis>&gt;::&lt;<emphasis>port</emphasis>&gt;(&lt;<emphasis>socket name</emphasis>&gt;)/&lt;<emphasis>database</emphasis>&gt;/&lt;<emphasis>user</emphasis>&gt;/&lt;<emphasis>password</emphasis>&gt;
11347 </literallayout>
11348 <para>
11349 Any of the three sub-parts of the first field can be omitted. For normal use on
11350 the local host it can be left blank or set to just <quote>localhost</quote>.
11351 </para>
11352 <para>
11353 No database need be supplied &ndash; but if it is absent here, it must be given in
11354 the queries.
11355 </para>
11356 <para>
11357 If a MySQL query is issued that does not request any data (an insert, update,
11358 or delete command), the result of the lookup is the number of rows affected.
11359 </para>
11360 <para>
11361 <emphasis role="bold">Warning</emphasis>: This can be misleading. If an update does not actually change
11362 anything (for example, setting a field to the value it already has), the result
11363 is zero because no rows are affected.
11364 </para>
11365 </section>
11366 <section id="SECID74">
11367 <title>Special PostgreSQL features</title>
11368 <para>
11369 PostgreSQL lookups can also use Unix domain socket connections to the database.
11370 This is usually faster and costs less CPU time than a TCP/IP connection.
11371 However it can be used only if the mail server runs on the same machine as the
11372 database server. A configuration line for PostgreSQL via Unix domain sockets
11373 looks like this:
11374 </para>
11375 <literallayout class="monospaced">
11376 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
11377 </literallayout>
11378 <para>
11379 In other words, instead of supplying a host name, a path to the socket is
11380 given. The path name is enclosed in parentheses so that its slashes aren&#x2019;t
11381 visually confused with the delimiters for the other server parameters.
11382 </para>
11383 <para>
11384 If a PostgreSQL query is issued that does not request any data (an insert,
11385 update, or delete command), the result of the lookup is the number of rows
11386 affected.
11387 </para>
11388 </section>
11389 <section id="SECTsqlite">
11390 <title>More about SQLite</title>
11391 <para>
11392 <indexterm role="concept">
11393 <primary>lookup</primary>
11394 <secondary>SQLite</secondary>
11395 </indexterm>
11396 <indexterm role="concept">
11397 <primary>sqlite lookup type</primary>
11398 </indexterm>
11399 SQLite is different to the other SQL lookups because a file name is required in
11400 addition to the SQL query. An SQLite database is a single file, and there is no
11401 daemon as in the other SQL databases. The interface to Exim requires the name
11402 of the file, as an absolute path, to be given at the start of the query. It is
11403 separated from the query by white space. This means that the path name cannot
11404 contain white space. Here is a lookup expansion example:
11405 </para>
11406 <literallayout class="monospaced">
11407 ${lookup sqlite {/some/thing/sqlitedb \
11408   select name from aliases where id='userx';}}
11409 </literallayout>
11410 <para>
11411 In a list, the syntax is similar. For example:
11412 </para>
11413 <literallayout class="monospaced">
11414 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
11415    select * from relays where ip='$sender_host_address';
11416 </literallayout>
11417 <para>
11418 The only character affected by the <option>quote_sqlite</option> operator is a single
11419 quote, which it doubles.
11420 </para>
11421 <para>
11422 The SQLite library handles multiple simultaneous accesses to the database
11423 internally. Multiple readers are permitted, but only one process can
11424 update at once. Attempts to access the database while it is being updated
11425 are rejected after a timeout period, during which the SQLite library
11426 waits for the lock to be released. In Exim, the default timeout is set
11427 to 5 seconds, but it can be changed by means of the <option>sqlite_lock_timeout</option>
11428 option.
11429 <indexterm role="concept" startref="IIDfidalo1" class="endofrange"/>
11430 <indexterm role="concept" startref="IIDfidalo2" class="endofrange"/>
11431 </para>
11432 </section>
11433 </chapter>
11434
11435 <chapter id="CHAPdomhosaddlists">
11436 <title>Domain, host, address, and local part lists</title>
11437 <titleabbrev>Domain, host, and address lists</titleabbrev>
11438 <para>
11439 <indexterm role="concept" id="IIDdohoadli" class="startofrange">
11440 <primary>lists of domains; hosts; etc.</primary>
11441 </indexterm>
11442 A number of Exim configuration options contain lists of domains, hosts,
11443 email addresses, or local parts. For example, the <option>hold_domains</option> option
11444 contains a list of domains whose delivery is currently suspended. These lists
11445 are also used as data in ACL statements (see chapter <xref linkend="CHAPACL"/>), and as
11446 arguments to expansion conditions such as <option>match_domain</option>.
11447 </para>
11448 <para>
11449 Each item in one of these lists is a pattern to be matched against a domain,
11450 host, email address, or local part, respectively. In the sections below, the
11451 different types of pattern for each case are described, but first we cover some
11452 general facilities that apply to all four kinds of list.
11453 </para>
11454 <section id="SECID75">
11455 <title>Expansion of lists</title>
11456 <para>
11457 <indexterm role="concept">
11458 <primary>expansion</primary>
11459 <secondary>of lists</secondary>
11460 </indexterm>
11461 Each list is expanded as a single string before it is used. The result of
11462 expansion must be a list, possibly containing empty items, which is split up
11463 into separate items for matching. By default, colon is the separator character,
11464 but this can be varied if necessary. See sections <xref linkend="SECTlistconstruct"/> and
11465 <xref linkend="SECTempitelis"/> for details of the list syntax; the second of these
11466 discusses the way to specify empty list items.
11467 </para>
11468 <para>
11469 If the string expansion is forced to fail, Exim behaves as if the item it is
11470 testing (domain, host, address, or local part) is not in the list. Other
11471 expansion failures cause temporary errors.
11472 </para>
11473 <para>
11474 If an item in a list is a regular expression, backslashes, dollars and possibly
11475 other special characters in the expression must be protected against
11476 misinterpretation by the string expander. The easiest way to do this is to use
11477 the <literal>\N</literal> expansion feature to indicate that the contents of the regular
11478 expression should not be expanded. For example, in an ACL you might have:
11479 </para>
11480 <literallayout class="monospaced">
11481 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
11482                ${lookup{$domain}lsearch{/badsenders/bydomain}}
11483 </literallayout>
11484 <para>
11485 The first item is a regular expression that is protected from expansion by
11486 <literal>\N</literal>, whereas the second uses the expansion to obtain a list of unwanted
11487 senders based on the receiving domain.
11488 </para>
11489 </section>
11490 <section id="SECID76">
11491 <title>Negated items in lists</title>
11492 <para>
11493 <indexterm role="concept">
11494 <primary>list</primary>
11495 <secondary>negation</secondary>
11496 </indexterm>
11497 <indexterm role="concept">
11498 <primary>negation</primary>
11499 <secondary>in lists</secondary>
11500 </indexterm>
11501 Items in a list may be positive or negative. Negative items are indicated by a
11502 leading exclamation mark, which may be followed by optional white space. A list
11503 defines a set of items (domains, etc). When Exim processes one of these lists,
11504 it is trying to find out whether a domain, host, address, or local part
11505 (respectively) is in the set that is defined by the list. It works like this:
11506 </para>
11507 <para>
11508 The list is scanned from left to right. If a positive item is matched, the
11509 subject that is being checked is in the set; if a negative item is matched, the
11510 subject is not in the set. If the end of the list is reached without the
11511 subject having matched any of the patterns, it is in the set if the last item
11512 was a negative one, but not if it was a positive one. For example, the list in
11513 </para>
11514 <literallayout class="monospaced">
11515 domainlist relay_to_domains = !a.b.c : *.b.c
11516 </literallayout>
11517 <para>
11518 matches any domain ending in <emphasis>.b.c</emphasis> except for <emphasis>a.b.c</emphasis>. Domains that match
11519 neither <emphasis>a.b.c</emphasis> nor <emphasis>*.b.c</emphasis> do not match, because the last item in the
11520 list is positive. However, if the setting were
11521 </para>
11522 <literallayout class="monospaced">
11523 domainlist relay_to_domains = !a.b.c
11524 </literallayout>
11525 <para>
11526 then all domains other than <emphasis>a.b.c</emphasis> would match because the last item in the
11527 list is negative. In other words, a list that ends with a negative item behaves
11528 as if it had an extra item <literal>:*</literal> on the end.
11529 </para>
11530 <para>
11531 Another way of thinking about positive and negative items in lists is to read
11532 the connector as <quote>or</quote> after a positive item and as <quote>and</quote> after a negative
11533 item.
11534 </para>
11535 </section>
11536 <section id="SECTfilnamlis">
11537 <title>File names in lists</title>
11538 <para>
11539 <indexterm role="concept">
11540 <primary>list</primary>
11541 <secondary>file name in</secondary>
11542 </indexterm>
11543 If an item in a domain, host, address, or local part list is an absolute file
11544 name (beginning with a slash character), each line of the file is read and
11545 processed as if it were an independent item in the list, except that further
11546 file names are not allowed,
11547 and no expansion of the data from the file takes place.
11548 Empty lines in the file are ignored, and the file may also contain comment
11549 lines:
11550 </para>
11551 <itemizedlist>
11552 <listitem>
11553 <para>
11554 For domain and host lists, if a # character appears anywhere in a line of the
11555 file, it and all following characters are ignored.
11556 </para>
11557 </listitem>
11558 <listitem>
11559 <para>
11560 Because local parts may legitimately contain # characters, a comment in an
11561 address list or local part list file is recognized only if # is preceded by
11562 white space or the start of the line. For example:
11563 </para>
11564 <literallayout class="monospaced">
11565 not#comment@x.y.z   # but this is a comment
11566 </literallayout>
11567 </listitem>
11568 </itemizedlist>
11569 <para>
11570 Putting a file name in a list has the same effect as inserting each line of the
11571 file as an item in the list (blank lines and comments excepted). However, there
11572 is one important difference: the file is read each time the list is processed,
11573 so if its contents vary over time, Exim&#x2019;s behaviour changes.
11574 </para>
11575 <para>
11576 If a file name is preceded by an exclamation mark, the sense of any match
11577 within the file is inverted. For example, if
11578 </para>
11579 <literallayout class="monospaced">
11580 hold_domains = !/etc/nohold-domains
11581 </literallayout>
11582 <para>
11583 and the file contains the lines
11584 </para>
11585 <literallayout class="monospaced">
11586 !a.b.c
11587 *.b.c
11588 </literallayout>
11589 <para>
11590 then <emphasis>a.b.c</emphasis> is in the set of domains defined by <option>hold_domains</option>, whereas
11591 any domain matching <literal>*.b.c</literal> is not.
11592 </para>
11593 </section>
11594 <section id="SECID77">
11595 <title>An lsearch file is not an out-of-line list</title>
11596 <para>
11597 As will be described in the sections that follow, lookups can be used in lists
11598 to provide indexed methods of checking list membership. There has been some
11599 confusion about the way <command>lsearch</command> lookups work in lists. Because
11600 an <command>lsearch</command> file contains plain text and is scanned sequentially, it is
11601 sometimes thought that it is allowed to contain wild cards and other kinds of
11602 non-constant pattern. This is not the case. The keys in an <command>lsearch</command> file are
11603 always fixed strings, just as for any other single-key lookup type.
11604 </para>
11605 <para>
11606 If you want to use a file to contain wild-card patterns that form part of a
11607 list, just give the file name on its own, without a search type, as described
11608 in the previous section. You could also use the <command>wildlsearch</command> or
11609 <command>nwildlsearch</command>, but there is no advantage in doing this.
11610 </para>
11611 </section>
11612 <section id="SECTnamedlists">
11613 <title>Named lists</title>
11614 <para>
11615 <indexterm role="concept">
11616 <primary>named lists</primary>
11617 </indexterm>
11618 <indexterm role="concept">
11619 <primary>list</primary>
11620 <secondary>named</secondary>
11621 </indexterm>
11622 A list of domains, hosts, email addresses, or local parts can be given a name
11623 which is then used to refer to the list elsewhere in the configuration. This is
11624 particularly convenient if the same list is required in several different
11625 places. It also allows lists to be given meaningful names, which can improve
11626 the readability of the configuration. For example, it is conventional to define
11627 a domain list called <emphasis>local_domains</emphasis> for all the domains that are handled
11628 locally on a host, using a configuration line such as
11629 </para>
11630 <literallayout class="monospaced">
11631 domainlist local_domains = localhost:my.dom.example
11632 </literallayout>
11633 <para>
11634 Named lists are referenced by giving their name preceded by a plus sign, so,
11635 for example, a router that is intended to handle local domains would be
11636 configured with the line
11637 </para>
11638 <literallayout class="monospaced">
11639 domains = +local_domains
11640 </literallayout>
11641 <para>
11642 The first router in a configuration is often one that handles all domains
11643 except the local ones, using a configuration with a negated item like this:
11644 </para>
11645 <literallayout class="monospaced">
11646 dnslookup:
11647   driver = dnslookup
11648   domains = ! +local_domains
11649   transport = remote_smtp
11650   no_more
11651 </literallayout>
11652 <para>
11653 The four kinds of named list are created by configuration lines starting with
11654 the words <option>domainlist</option>, <option>hostlist</option>, <option>addresslist</option>, or <option>localpartlist</option>,
11655 respectively. Then there follows the name that you are defining, followed by an
11656 equals sign and the list itself. For example:
11657 </para>
11658 <literallayout class="monospaced">
11659 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
11660 addresslist bad_senders = cdb;/etc/badsenders
11661 </literallayout>
11662 <para>
11663 A named list may refer to other named lists:
11664 </para>
11665 <literallayout class="monospaced">
11666 domainlist  dom1 = first.example : second.example
11667 domainlist  dom2 = +dom1 : third.example
11668 domainlist  dom3 = fourth.example : +dom2 : fifth.example
11669 </literallayout>
11670 <para>
11671 <emphasis role="bold">Warning</emphasis>: If the last item in a referenced list is a negative one, the
11672 effect may not be what you intended, because the negation does not propagate
11673 out to the higher level. For example, consider:
11674 </para>
11675 <literallayout class="monospaced">
11676 domainlist  dom1 = !a.b
11677 domainlist  dom2 = +dom1 : *.b
11678 </literallayout>
11679 <para>
11680 The second list specifies <quote>either in the <option>dom1</option> list or <emphasis>*.b</emphasis></quote>. The first
11681 list specifies just <quote>not <emphasis>a.b</emphasis></quote>, so the domain <emphasis>x.y</emphasis> matches it. That
11682 means it matches the second list as well. The effect is not the same as
11683 </para>
11684 <literallayout class="monospaced">
11685 domainlist  dom2 = !a.b : *.b
11686 </literallayout>
11687 <para>
11688 where <emphasis>x.y</emphasis> does not match. It&#x2019;s best to avoid negation altogether in
11689 referenced lists if you can.
11690 </para>
11691 <para>
11692 Named lists may have a performance advantage. When Exim is routing an
11693 address or checking an incoming message, it caches the result of tests on named
11694 lists. So, if you have a setting such as
11695 </para>
11696 <literallayout class="monospaced">
11697 domains = +local_domains
11698 </literallayout>
11699 <para>
11700 on several of your routers
11701 or in several ACL statements,
11702 the actual test is done only for the first one. However, the caching works only
11703 if there are no expansions within the list itself or any sublists that it
11704 references. In other words, caching happens only for lists that are known to be
11705 the same each time they are referenced.
11706 </para>
11707 <para>
11708 By default, there may be up to 16 named lists of each type. This limit can be
11709 extended by changing a compile-time variable. The use of domain and host lists
11710 is recommended for concepts such as local domains, relay domains, and relay
11711 hosts. The default configuration is set up like this.
11712 </para>
11713 </section>
11714 <section id="SECID78">
11715 <title>Named lists compared with macros</title>
11716 <para>
11717 <indexterm role="concept">
11718 <primary>list</primary>
11719 <secondary>named compared with macro</secondary>
11720 </indexterm>
11721 <indexterm role="concept">
11722 <primary>macro</primary>
11723 <secondary>compared with named list</secondary>
11724 </indexterm>
11725 At first sight, named lists might seem to be no different from macros in the
11726 configuration file. However, macros are just textual substitutions. If you
11727 write
11728 </para>
11729 <literallayout class="monospaced">
11730 ALIST = host1 : host2
11731 auth_advertise_hosts = !ALIST
11732 </literallayout>
11733 <para>
11734 it probably won&#x2019;t do what you want, because that is exactly the same as
11735 </para>
11736 <literallayout class="monospaced">
11737 auth_advertise_hosts = !host1 : host2
11738 </literallayout>
11739 <para>
11740 Notice that the second host name is not negated. However, if you use a host
11741 list, and write
11742 </para>
11743 <literallayout class="monospaced">
11744 hostlist alist = host1 : host2
11745 auth_advertise_hosts = ! +alist
11746 </literallayout>
11747 <para>
11748 the negation applies to the whole list, and so that is equivalent to
11749 </para>
11750 <literallayout class="monospaced">
11751 auth_advertise_hosts = !host1 : !host2
11752 </literallayout>
11753 </section>
11754 <section id="SECID79">
11755 <title>Named list caching</title>
11756 <para>
11757 <indexterm role="concept">
11758 <primary>list</primary>
11759 <secondary>caching of named</secondary>
11760 </indexterm>
11761 <indexterm role="concept">
11762 <primary>caching</primary>
11763 <secondary>named lists</secondary>
11764 </indexterm>
11765 While processing a message, Exim caches the result of checking a named list if
11766 it is sure that the list is the same each time. In practice, this means that
11767 the cache operates only if the list contains no $ characters, which guarantees
11768 that it will not change when it is expanded. Sometimes, however, you may have
11769 an expanded list that you know will be the same each time within a given
11770 message. For example:
11771 </para>
11772 <literallayout class="monospaced">
11773 domainlist special_domains = \
11774            ${lookup{$sender_host_address}cdb{/some/file}}
11775 </literallayout>
11776 <para>
11777 This provides a list of domains that depends only on the sending host&#x2019;s IP
11778 address. If this domain list is referenced a number of times (for example,
11779 in several ACL lines, or in several routers) the result of the check is not
11780 cached by default, because Exim does not know that it is going to be the
11781 same list each time.
11782 </para>
11783 <para>
11784 By appending <literal>_cache</literal> to <literal>domainlist</literal> you can tell Exim to go ahead and
11785 cache the result anyway. For example:
11786 </para>
11787 <literallayout class="monospaced">
11788 domainlist_cache special_domains = ${lookup{...
11789 </literallayout>
11790 <para>
11791 If you do this, you should be absolutely sure that caching is going to do
11792 the right thing in all cases. When in doubt, leave it out.
11793 </para>
11794 </section>
11795 <section id="SECTdomainlist">
11796 <title>Domain lists</title>
11797 <para>
11798 <indexterm role="concept">
11799 <primary>domain list</primary>
11800 <secondary>patterns for</secondary>
11801 </indexterm>
11802 <indexterm role="concept">
11803 <primary>list</primary>
11804 <secondary>domain list</secondary>
11805 </indexterm>
11806 Domain lists contain patterns that are to be matched against a mail domain.
11807 The following types of item may appear in domain lists:
11808 </para>
11809 <itemizedlist>
11810 <listitem>
11811 <para>
11812 <indexterm role="concept">
11813 <primary>primary host name</primary>
11814 </indexterm>
11815 <indexterm role="concept">
11816 <primary>host name</primary>
11817 <secondary>matched in domain list</secondary>
11818 </indexterm>
11819 <indexterm role="option">
11820 <primary><option>primary_hostname</option></primary>
11821 </indexterm>
11822 <indexterm role="concept">
11823 <primary>domain list</primary>
11824 <secondary>matching primary host name</secondary>
11825 </indexterm>
11826 <indexterm role="concept">
11827 <primary>@ in a domain list</primary>
11828 </indexterm>
11829 If a pattern consists of a single @ character, it matches the local host name,
11830 as set by the <option>primary_hostname</option> option (or defaulted). This makes it
11831 possible to use the same configuration file on several different hosts that
11832 differ only in their names.
11833 </para>
11834 </listitem>
11835 <listitem>
11836 <para>
11837 <indexterm role="concept">
11838 <primary>@[] in a domain list</primary>
11839 </indexterm>
11840 <indexterm role="concept">
11841 <primary>domain list</primary>
11842 <secondary>matching local IP interfaces</secondary>
11843 </indexterm>
11844 <indexterm role="concept">
11845 <primary>domain literal</primary>
11846 </indexterm>
11847 If a pattern consists of the string <literal>@[]</literal> it matches an IP address enclosed
11848 in square brackets (as in an email address that contains a domain literal), but
11849 only if that IP address is recognized as local for email routing purposes. The
11850 <option>local_interfaces</option> and <option>extra_local_interfaces</option> options can be used to
11851 control which of a host&#x2019;s several IP addresses are treated as local.
11852 In today&#x2019;s Internet, the use of domain literals is controversial.
11853 </para>
11854 </listitem>
11855 <listitem>
11856 <para>
11857 <indexterm role="concept">
11858 <primary>@mx_any</primary>
11859 </indexterm>
11860 <indexterm role="concept">
11861 <primary>@mx_primary</primary>
11862 </indexterm>
11863 <indexterm role="concept">
11864 <primary>@mx_secondary</primary>
11865 </indexterm>
11866 <indexterm role="concept">
11867 <primary>domain list</primary>
11868 <secondary>matching MX pointers to local host</secondary>
11869 </indexterm>
11870 If a pattern consists of the string <literal>@mx_any</literal> it matches any domain that
11871 has an MX record pointing to the local host or to any host that is listed in
11872 <indexterm role="option">
11873 <primary><option>hosts_treat_as_local</option></primary>
11874 </indexterm>
11875 <option>hosts_treat_as_local</option>. The items <literal>@mx_primary</literal> and <literal>@mx_secondary</literal>
11876 are similar, except that the first matches only when a primary MX target is the
11877 local host, and the second only when no primary MX target is the local host,
11878 but a secondary MX target is. <quote>Primary</quote> means an MX record with the lowest
11879 preference value &ndash; there may of course be more than one of them.
11880 </para>
11881 <para>
11882 The MX lookup that takes place when matching a pattern of this type is
11883 performed with the resolver options for widening names turned off. Thus, for
11884 example, a single-component domain will <emphasis>not</emphasis> be expanded by adding the
11885 resolver&#x2019;s default domain. See the <option>qualify_single</option> and <option>search_parents</option>
11886 options of the <command>dnslookup</command> router for a discussion of domain widening.
11887 </para>
11888 <para>
11889 Sometimes you may want to ignore certain IP addresses when using one of these
11890 patterns. You can specify this by following the pattern with <literal>/ignore=</literal>&lt;<emphasis>ip
11891 list</emphasis>&gt;, where &lt;<emphasis>ip list</emphasis>&gt; is a list of IP addresses. These addresses are
11892 ignored when processing the pattern (compare the <option>ignore_target_hosts</option> option
11893 on a router). For example:
11894 </para>
11895 <literallayout class="monospaced">
11896 domains = @mx_any/ignore=127.0.0.1
11897 </literallayout>
11898 <para>
11899 This example matches any domain that has an MX record pointing to one of
11900 the local host&#x2019;s IP addresses other than 127.0.0.1.
11901 </para>
11902 <para>
11903 The list of IP addresses is in fact processed by the same code that processes
11904 host lists, so it may contain CIDR-coded network specifications and it may also
11905 contain negative items.
11906 </para>
11907 <para>
11908 Because the list of IP addresses is a sublist within a domain list, you have to
11909 be careful about delimiters if there is more than one address. Like any other
11910 list, the default delimiter can be changed. Thus, you might have:
11911 </para>
11912 <literallayout class="monospaced">
11913 domains = @mx_any/ignore=&lt;;127.0.0.1;0.0.0.0 : \
11914           an.other.domain : ...
11915 </literallayout>
11916 <para>
11917 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
11918 involved, it is easiest to change the delimiter for the main list as well:
11919 </para>
11920 <literallayout class="monospaced">
11921 domains = &lt;? @mx_any/ignore=&lt;;127.0.0.1;::1 ? \
11922           an.other.domain ? ...
11923 </literallayout>
11924 </listitem>
11925 <listitem>
11926 <para>
11927 <indexterm role="concept">
11928 <primary>asterisk</primary>
11929 <secondary>in domain list</secondary>
11930 </indexterm>
11931 <indexterm role="concept">
11932 <primary>domain list</primary>
11933 <secondary>asterisk in</secondary>
11934 </indexterm>
11935 <indexterm role="concept">
11936 <primary>domain list</primary>
11937 <secondary>matching <quote>ends with</quote></secondary>
11938 </indexterm>
11939 If a pattern starts with an asterisk, the remaining characters of the pattern
11940 are compared with the terminating characters of the domain. The use of <quote>*</quote> in
11941 domain lists differs from its use in partial matching lookups. In a domain
11942 list, the character following the asterisk need not be a dot, whereas partial
11943 matching works only in terms of dot-separated components. For example, a domain
11944 list item such as <literal>*key.ex</literal> matches <emphasis>donkey.ex</emphasis> as well as
11945 <emphasis>cipher.key.ex</emphasis>.
11946 </para>
11947 </listitem>
11948 <listitem>
11949 <para>
11950 <indexterm role="concept">
11951 <primary>regular expressions</primary>
11952 <secondary>in domain list</secondary>
11953 </indexterm>
11954 <indexterm role="concept">
11955 <primary>domain list</primary>
11956 <secondary>matching regular expression</secondary>
11957 </indexterm>
11958 If a pattern starts with a circumflex character, it is treated as a regular
11959 expression, and matched against the domain using a regular expression matching
11960 function. The circumflex is treated as part of the regular expression.
11961 Email domains are case-independent, so this regular expression match is by
11962 default case-independent, but you can make it case-dependent by starting it
11963 with <literal>(?-i)</literal>. References to descriptions of the syntax of regular expressions
11964 are given in chapter <xref linkend="CHAPregexp"/>.
11965 </para>
11966 <para>
11967 <emphasis role="bold">Warning</emphasis>: Because domain lists are expanded before being processed, you
11968 must escape any backslash and dollar characters in the regular expression, or
11969 use the special <literal>\N</literal> sequence (see chapter <xref linkend="CHAPexpand"/>) to specify that
11970 it is not to be expanded (unless you really do want to build a regular
11971 expression by expansion, of course).
11972 </para>
11973 </listitem>
11974 <listitem>
11975 <para>
11976 <indexterm role="concept">
11977 <primary>lookup</primary>
11978 <secondary>in domain list</secondary>
11979 </indexterm>
11980 <indexterm role="concept">
11981 <primary>domain list</primary>
11982 <secondary>matching by lookup</secondary>
11983 </indexterm>
11984 If a pattern starts with the name of a single-key lookup type followed by a
11985 semicolon (for example, <quote>dbm;</quote> or <quote>lsearch;</quote>), the remainder of the pattern
11986 must be a file name in a suitable format for the lookup type. For example, for
11987 <quote>cdb;</quote> it must be an absolute path:
11988 </para>
11989 <literallayout class="monospaced">
11990 domains = cdb;/etc/mail/local_domains.cdb
11991 </literallayout>
11992 <para>
11993 The appropriate type of lookup is done on the file using the domain name as the
11994 key. In most cases, the data that is looked up is not used; Exim is interested
11995 only in whether or not the key is present in the file. However, when a lookup
11996 is used for the <option>domains</option> option on a router
11997 or a <option>domains</option> condition in an ACL statement, the data is preserved in the
11998 <varname>$domain_data</varname> variable and can be referred to in other router options or
11999 other statements in the same ACL.
12000 </para>
12001 </listitem>
12002 <listitem>
12003 <para>
12004 Any of the single-key lookup type names may be preceded by
12005 <literal>partial</literal>&lt;<emphasis>n</emphasis>&gt;<literal>-</literal>, where the &lt;<emphasis>n</emphasis>&gt; is optional, for example,
12006 </para>
12007 <literallayout class="monospaced">
12008 domains = partial-dbm;/partial/domains
12009 </literallayout>
12010 <para>
12011 This causes partial matching logic to be invoked; a description of how this
12012 works is given in section <xref linkend="SECTpartiallookup"/>.
12013 </para>
12014 </listitem>
12015 <listitem>
12016 <para>
12017 <indexterm role="concept">
12018 <primary>asterisk</primary>
12019 <secondary>in lookup type</secondary>
12020 </indexterm>
12021 Any of the single-key lookup types may be followed by an asterisk. This causes
12022 a default lookup for a key consisting of a single asterisk to be done if the
12023 original lookup fails. This is not a useful feature when using a domain list to
12024 select particular domains (because any domain would match), but it might have
12025 value if the result of the lookup is being used via the <varname>$domain_data</varname>
12026 expansion variable.
12027 </para>
12028 </listitem>
12029 <listitem>
12030 <para>
12031 If the pattern starts with the name of a query-style lookup type followed by a
12032 semicolon (for example, <quote>nisplus;</quote> or <quote>ldap;</quote>), the remainder of the
12033 pattern must be an appropriate query for the lookup type, as described in
12034 chapter <xref linkend="CHAPfdlookup"/>. For example:
12035 </para>
12036 <literallayout class="monospaced">
12037 hold_domains = mysql;select domain from holdlist \
12038   where domain = '${quote_mysql:$domain}';
12039 </literallayout>
12040 <para>
12041 In most cases, the data that is looked up is not used (so for an SQL query, for
12042 example, it doesn&#x2019;t matter what field you select). Exim is interested only in
12043 whether or not the query succeeds. However, when a lookup is used for the
12044 <option>domains</option> option on a router, the data is preserved in the <varname>$domain_data</varname>
12045 variable and can be referred to in other options.
12046 </para>
12047 </listitem>
12048 <listitem>
12049 <para>
12050 <indexterm role="concept">
12051 <primary>domain list</primary>
12052 <secondary>matching literal domain name</secondary>
12053 </indexterm>
12054 If none of the above cases apply, a caseless textual comparison is made
12055 between the pattern and the domain.
12056 </para>
12057 </listitem>
12058 </itemizedlist>
12059 <para>
12060 Here is an example that uses several different kinds of pattern:
12061 </para>
12062 <literallayout class="monospaced">
12063 domainlist funny_domains = \
12064   @ : \
12065   lib.unseen.edu : \
12066   *.foundation.fict.example : \
12067   \N^[1-2]\d{3}\.fict\.example$\N : \
12068   partial-dbm;/opt/data/penguin/book : \
12069   nis;domains.byname : \
12070   nisplus;[name=$domain,status=local],domains.org_dir
12071 </literallayout>
12072 <para>
12073 There are obvious processing trade-offs among the various matching modes. Using
12074 an asterisk is faster than a regular expression, and listing a few names
12075 explicitly probably is too. The use of a file or database lookup is expensive,
12076 but may be the only option if hundreds of names are required. Because the
12077 patterns are tested in order, it makes sense to put the most commonly matched
12078 patterns earlier.
12079 </para>
12080 </section>
12081 <section id="SECThostlist">
12082 <title>Host lists</title>
12083 <para>
12084 <indexterm role="concept">
12085 <primary>host list</primary>
12086 <secondary>patterns in</secondary>
12087 </indexterm>
12088 <indexterm role="concept">
12089 <primary>list</primary>
12090 <secondary>host list</secondary>
12091 </indexterm>
12092 Host lists are used to control what remote hosts are allowed to do. For
12093 example, some hosts may be allowed to use the local host as a relay, and some
12094 may be permitted to use the SMTP ETRN command. Hosts can be identified in
12095 two different ways, by name or by IP address. In a host list, some types of
12096 pattern are matched to a host name, and some are matched to an IP address.
12097 You need to be particularly careful with this when single-key lookups are
12098 involved, to ensure that the right value is being used as the key.
12099 </para>
12100 </section>
12101 <section id="SECID80">
12102 <title>Special host list patterns</title>
12103 <para>
12104 <indexterm role="concept">
12105 <primary>empty item in hosts list</primary>
12106 </indexterm>
12107 <indexterm role="concept">
12108 <primary>host list</primary>
12109 <secondary>empty string in</secondary>
12110 </indexterm>
12111 If a host list item is the empty string, it matches only when no remote host is
12112 involved. This is the case when a message is being received from a local
12113 process using SMTP on the standard input, that is, when a TCP/IP connection is
12114 not used.
12115 </para>
12116 <para>
12117 <indexterm role="concept">
12118 <primary>asterisk</primary>
12119 <secondary>in host list</secondary>
12120 </indexterm>
12121 The special pattern <quote>*</quote> in a host list matches any host or no host. Neither
12122 the IP address nor the name is actually inspected.
12123 </para>
12124 </section>
12125 <section id="SECThoslispatip">
12126 <title>Host list patterns that match by IP address</title>
12127 <para>
12128 <indexterm role="concept">
12129 <primary>host list</primary>
12130 <secondary>matching IP addresses</secondary>
12131 </indexterm>
12132 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
12133 the incoming address actually appears in the IPv6 host as
12134 <literal>::ffff:</literal>&lt;<emphasis>v4address</emphasis>&gt;. When such an address is tested against a host
12135 list, it is converted into a traditional IPv4 address first. (Not all operating
12136 systems accept IPv4 calls on IPv6 sockets, as there have been some security
12137 concerns.)
12138 </para>
12139 <para>
12140 The following types of pattern in a host list check the remote host by
12141 inspecting its IP address:
12142 </para>
12143 <itemizedlist>
12144 <listitem>
12145 <para>
12146 If the pattern is a plain domain name (not a regular expression, not starting
12147 with *, not a lookup of any kind), Exim calls the operating system function
12148 to find the associated IP address(es). Exim uses the newer
12149 <function>getipnodebyname()</function> function when available, otherwise <function>gethostbyname()</function>.
12150 This typically causes a forward DNS lookup of the name. The result is compared
12151 with the IP address of the subject host.
12152 </para>
12153 <para>
12154 If there is a temporary problem (such as a DNS timeout) with the host name
12155 lookup, a temporary error occurs. For example, if the list is being used in an
12156 ACL condition, the ACL gives a <quote>defer</quote> response, usually leading to a
12157 temporary SMTP error code. If no IP address can be found for the host name,
12158 what happens is described in section <xref linkend="SECTbehipnot"/> below.
12159 </para>
12160 </listitem>
12161 <listitem>
12162 <para>
12163 <indexterm role="concept">
12164 <primary>@ in a host list</primary>
12165 </indexterm>
12166 If the pattern is <quote>@</quote>, the primary host name is substituted and used as a
12167 domain name, as just described.
12168 </para>
12169 </listitem>
12170 <listitem>
12171 <para>
12172 If the pattern is an IP address, it is matched against the IP address of the
12173 subject host. IPv4 addresses are given in the normal <quote>dotted-quad</quote> notation.
12174 IPv6 addresses can be given in colon-separated format, but the colons have to
12175 be doubled so as not to be taken as item separators when the default list
12176 separator is used. IPv6 addresses are recognized even when Exim is compiled
12177 without IPv6 support. This means that if they appear in a host list on an
12178 IPv4-only host, Exim will not treat them as host names. They are just addresses
12179 that can never match a client host.
12180 </para>
12181 </listitem>
12182 <listitem>
12183 <para>
12184 <indexterm role="concept">
12185 <primary>@[] in a host list</primary>
12186 </indexterm>
12187 If the pattern is <quote>@[]</quote>, it matches the IP address of any IP interface on
12188 the local host. For example, if the local host is an IPv4 host with one
12189 interface address 10.45.23.56, these two ACL statements have the same effect:
12190 </para>
12191 <literallayout class="monospaced">
12192 accept hosts = 127.0.0.1 : 10.45.23.56
12193 accept hosts = @[]
12194 </literallayout>
12195 </listitem>
12196 <listitem>
12197 <para>
12198 <indexterm role="concept">
12199 <primary>CIDR notation</primary>
12200 </indexterm>
12201 If the pattern is an IP address followed by a slash and a mask length (for
12202 example 10.11.42.0/24), it is matched against the IP address of the subject
12203 host under the given mask. This allows, an entire network of hosts to be
12204 included (or excluded) by a single item. The mask uses CIDR notation; it
12205 specifies the number of address bits that must match, starting from the most
12206 significant end of the address.
12207 </para>
12208 <para>
12209 <emphasis role="bold">Note</emphasis>: The mask is <emphasis>not</emphasis> a count of addresses, nor is it the high number
12210 of a range of addresses. It is the number of bits in the network portion of the
12211 address. The above example specifies a 24-bit netmask, so it matches all 256
12212 addresses in the 10.11.42.0 network. An item such as
12213 </para>
12214 <literallayout class="monospaced">
12215 192.168.23.236/31
12216 </literallayout>
12217 <para>
12218 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
12219 32 for an IPv4 address is the same as no mask at all; just a single address
12220 matches.
12221 </para>
12222 <para>
12223 Here is another example which shows an IPv4 and an IPv6 network:
12224 </para>
12225 <literallayout class="monospaced">
12226 recipient_unqualified_hosts = 192.168.0.0/16: \
12227                               3ffe::ffff::836f::::/48
12228 </literallayout>
12229 <para>
12230 The doubling of list separator characters applies only when these items
12231 appear inline in a host list. It is not required when indirecting via a file.
12232 For example:
12233 </para>
12234 <literallayout class="monospaced">
12235 recipient_unqualified_hosts = /opt/exim/unqualnets
12236 </literallayout>
12237 <para>
12238 could make use of a file containing
12239 </para>
12240 <literallayout class="monospaced">
12241 172.16.0.0/12
12242 3ffe:ffff:836f::/48
12243 </literallayout>
12244 <para>
12245 to have exactly the same effect as the previous example. When listing IPv6
12246 addresses inline, it is usually more convenient to use the facility for
12247 changing separator characters. This list contains the same two networks:
12248 </para>
12249 <literallayout class="monospaced">
12250 recipient_unqualified_hosts = &lt;; 172.16.0.0/12; \
12251                                  3ffe:ffff:836f::/48
12252 </literallayout>
12253 <para>
12254 The separator is changed to semicolon by the leading <quote>&lt;;</quote> at the start of the
12255 list.
12256 </para>
12257 </listitem>
12258 </itemizedlist>
12259 </section>
12260 <section id="SECThoslispatsikey">
12261 <title>Host list patterns for single-key lookups by host address</title>
12262 <para>
12263 <indexterm role="concept">
12264 <primary>host list</primary>
12265 <secondary>lookup of IP address</secondary>
12266 </indexterm>
12267 When a host is to be identified by a single-key lookup of its complete IP
12268 address, the pattern takes this form:
12269 </para>
12270 <literallayout>
12271 <literal>net-&lt;</literal><emphasis>single-key-search-type</emphasis><literal>&gt;;&lt;</literal><emphasis>search-data</emphasis><literal>&gt;</literal>
12272 </literallayout>
12273 <para>
12274 For example:
12275 </para>
12276 <literallayout class="monospaced">
12277 hosts_lookup = net-cdb;/hosts-by-ip.db
12278 </literallayout>
12279 <para>
12280 The text form of the IP address of the subject host is used as the lookup key.
12281 IPv6 addresses are converted to an unabbreviated form, using lower case
12282 letters, with dots as separators because colon is the key terminator in
12283 <command>lsearch</command> files. [Colons can in fact be used in keys in <command>lsearch</command> files by
12284 quoting the keys, but this is a facility that was added later.] The data
12285 returned by the lookup is not used.
12286 </para>
12287 <para>
12288 <indexterm role="concept">
12289 <primary>IP address</primary>
12290 <secondary>masking</secondary>
12291 </indexterm>
12292 <indexterm role="concept">
12293 <primary>host list</primary>
12294 <secondary>masked IP address</secondary>
12295 </indexterm>
12296 Single-key lookups can also be performed using masked IP addresses, using
12297 patterns of this form:
12298 </para>
12299 <literallayout>
12300 <literal>net&lt;</literal><emphasis>number</emphasis><literal>&gt;-&lt;</literal><emphasis>single-key-search-type</emphasis><literal>&gt;;&lt;</literal><emphasis>search-data</emphasis><literal>&gt;</literal>
12301 </literallayout>
12302 <para>
12303 For example:
12304 </para>
12305 <literallayout class="monospaced">
12306 net24-dbm;/networks.db
12307 </literallayout>
12308 <para>
12309 The IP address of the subject host is masked using &lt;<emphasis>number</emphasis>&gt; as the mask
12310 length. A textual string is constructed from the masked value, followed by the
12311 mask, and this is used as the lookup key. For example, if the host&#x2019;s IP address
12312 is 192.168.34.6, the key that is looked up for the above example is
12313 <quote>192.168.34.0/24</quote>.
12314 </para>
12315 <para>
12316 When an IPv6 address is converted to a string, dots are normally used instead
12317 of colons, so that keys in <command>lsearch</command> files need not contain colons (which
12318 terminate <command>lsearch</command> keys). This was implemented some time before the ability
12319 to quote keys was made available in <command>lsearch</command> files. However, the more
12320 recently implemented <command>iplsearch</command> files do require colons in IPv6 keys
12321 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
12322 For this reason, when the lookup type is <command>iplsearch</command>, IPv6 addresses are
12323 converted using colons and not dots. In all cases, full, unabbreviated IPv6
12324 addresses are always used.
12325 </para>
12326 <para>
12327 Ideally, it would be nice to tidy up this anomalous situation by changing to
12328 colons in all cases, given that quoting is now available for <command>lsearch</command>.
12329 However, this would be an incompatible change that might break some existing
12330 configurations.
12331 </para>
12332 <para>
12333 <emphasis role="bold">Warning</emphasis>: Specifying <option>net32-</option> (for an IPv4 address) or <option>net128-</option> (for an
12334 IPv6 address) is not the same as specifying just <option>net-</option> without a number. In
12335 the former case the key strings include the mask value, whereas in the latter
12336 case the IP address is used on its own.
12337 </para>
12338 </section>
12339 <section id="SECThoslispatnam">
12340 <title>Host list patterns that match by host name</title>
12341 <para>
12342 <indexterm role="concept">
12343 <primary>host</primary>
12344 <secondary>lookup failures</secondary>
12345 </indexterm>
12346 <indexterm role="concept">
12347 <primary>unknown host name</primary>
12348 </indexterm>
12349 <indexterm role="concept">
12350 <primary>host list</primary>
12351 <secondary>matching host name</secondary>
12352 </indexterm>
12353 There are several types of pattern that require Exim to know the name of the
12354 remote host. These are either wildcard patterns or lookups by name. (If a
12355 complete hostname is given without any wildcarding, it is used to find an IP
12356 address to match against, as described in section <xref linkend="SECThoslispatip"/>
12357 above.)
12358 </para>
12359 <para>
12360 If the remote host name is not already known when Exim encounters one of these
12361 patterns, it has to be found from the IP address.
12362 Although many sites on the Internet are conscientious about maintaining reverse
12363 DNS data for their hosts, there are also many that do not do this.
12364 Consequently, a name cannot always be found, and this may lead to unwanted
12365 effects. Take care when configuring host lists with wildcarded name patterns.
12366 Consider what will happen if a name cannot be found.
12367 </para>
12368 <para>
12369 Because of the problems of determining host names from IP addresses, matching
12370 against host names is not as common as matching against IP addresses.
12371 </para>
12372 <para>
12373 By default, in order to find a host name, Exim first does a reverse DNS lookup;
12374 if no name is found in the DNS, the system function (<function>gethostbyaddr()</function> or
12375 <function>getipnodebyaddr()</function> if available) is tried. The order in which these lookups
12376 are done can be changed by setting the <option>host_lookup_order</option> option. For
12377 security, once Exim has found one or more names, it looks up the IP addresses
12378 for these names and compares them with the IP address that it started with.
12379 Only those names whose IP addresses match are accepted. Any other names are
12380 discarded. If no names are left, Exim behaves as if the host name cannot be
12381 found. In the most common case there is only one name and one IP address.
12382 </para>
12383 <para>
12384 There are some options that control what happens if a host name cannot be
12385 found. These are described in section <xref linkend="SECTbehipnot"/> below.
12386 </para>
12387 <para>
12388 <indexterm role="concept">
12389 <primary>host</primary>
12390 <secondary>alias for</secondary>
12391 </indexterm>
12392 <indexterm role="concept">
12393 <primary>alias for host</primary>
12394 </indexterm>
12395 As a result of aliasing, hosts may have more than one name. When processing any
12396 of the following types of pattern, all the host&#x2019;s names are checked:
12397 </para>
12398 <itemizedlist>
12399 <listitem>
12400 <para>
12401 <indexterm role="concept">
12402 <primary>asterisk</primary>
12403 <secondary>in host list</secondary>
12404 </indexterm>
12405 If a pattern starts with <quote>*</quote> the remainder of the item must match the end of
12406 the host name. For example, <literal>*.b.c</literal> matches all hosts whose names end in
12407 <emphasis>.b.c</emphasis>. This special simple form is provided because this is a very common
12408 requirement. Other kinds of wildcarding require the use of a regular
12409 expression.
12410 </para>
12411 </listitem>
12412 <listitem>
12413 <para>
12414 <indexterm role="concept">
12415 <primary>regular expressions</primary>
12416 <secondary>in host list</secondary>
12417 </indexterm>
12418 <indexterm role="concept">
12419 <primary>host list</primary>
12420 <secondary>regular expression in</secondary>
12421 </indexterm>
12422 If the item starts with <quote>^</quote> it is taken to be a regular expression which is
12423 matched against the host name. Host names are case-independent, so this regular
12424 expression match is by default case-independent, but you can make it
12425 case-dependent by starting it with <literal>(?-i)</literal>. References to descriptions of the
12426 syntax of regular expressions are given in chapter <xref linkend="CHAPregexp"/>. For
12427 example,
12428 </para>
12429 <literallayout class="monospaced">
12430 ^(a|b)\.c\.d$
12431 </literallayout>
12432 <para>
12433 is a regular expression that matches either of the two hosts <emphasis>a.c.d</emphasis> or
12434 <emphasis>b.c.d</emphasis>. When a regular expression is used in a host list, you must take care
12435 that backslash and dollar characters are not misinterpreted as part of the
12436 string expansion. The simplest way to do this is to use <literal>\N</literal> to mark that
12437 part of the string as non-expandable. For example:
12438 </para>
12439 <literallayout class="monospaced">
12440 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
12441 </literallayout>
12442 <para>
12443 <emphasis role="bold">Warning</emphasis>: If you want to match a complete host name, you must include the
12444 <literal>$</literal> terminating metacharacter in the regular expression, as in the above
12445 example. Without it, a match at the start of the host name is all that is
12446 required.
12447 </para>
12448 </listitem>
12449 </itemizedlist>
12450 </section>
12451 <section id="SECTbehipnot">
12452 <title>Behaviour when an IP address or name cannot be found</title>
12453 <para>
12454 <indexterm role="concept">
12455 <primary>host</primary>
12456 <secondary>lookup failures, permanent</secondary>
12457 </indexterm>
12458 While processing a host list, Exim may need to look up an IP address from a
12459 name (see section <xref linkend="SECThoslispatip"/>), or it may need to look up a host name
12460 from an IP address (see section <xref linkend="SECThoslispatnam"/>). In either case, the
12461 behaviour when it fails to find the information it is seeking is the same.
12462 </para>
12463 <para>
12464 <emphasis role="bold">Note</emphasis>: This section applies to permanent lookup failures. It does <emphasis>not</emphasis>
12465 apply to temporary DNS errors, whose handling is described in the next section.
12466 </para>
12467 <para>
12468 <indexterm role="concept">
12469 <primary><literal>+include_unknown</literal></primary>
12470 </indexterm>
12471 <indexterm role="concept">
12472 <primary><literal>+ignore_unknown</literal></primary>
12473 </indexterm>
12474 Exim parses a host list from left to right. If it encounters a permanent
12475 lookup failure in any item in the host list before it has found a match,
12476 Exim treats it as a failure and the default behavior is as if the host
12477 does not match the list. This may not always be what you want to happen.
12478 To change Exim&#x2019;s behaviour, the special items <literal>+include_unknown</literal> or
12479 <literal>+ignore_unknown</literal> may appear in the list (at top level &ndash; they are
12480 not recognized in an indirected file).
12481 </para>
12482 <itemizedlist>
12483 <listitem>
12484 <para>
12485 If any item that follows <literal>+include_unknown</literal> requires information that
12486 cannot found, Exim behaves as if the host does match the list. For example,
12487 </para>
12488 <literallayout class="monospaced">
12489 host_reject_connection = +include_unknown:*.enemy.ex
12490 </literallayout>
12491 <para>
12492 rejects connections from any host whose name matches <literal>*.enemy.ex</literal>, and also
12493 any hosts whose name it cannot find.
12494 </para>
12495 </listitem>
12496 <listitem>
12497 <para>
12498 If any item that follows <literal>+ignore_unknown</literal> requires information that cannot
12499 be found, Exim ignores that item and proceeds to the rest of the list. For
12500 example:
12501 </para>
12502 <literallayout class="monospaced">
12503 accept hosts = +ignore_unknown : friend.example : \
12504                192.168.4.5
12505 </literallayout>
12506 <para>
12507 accepts from any host whose name is <emphasis>friend.example</emphasis> and from 192.168.4.5,
12508 whether or not its host name can be found. Without <literal>+ignore_unknown</literal>, if no
12509 name can be found for 192.168.4.5, it is rejected.
12510 </para>
12511 </listitem>
12512 </itemizedlist>
12513 <para>
12514 Both <literal>+include_unknown</literal> and <literal>+ignore_unknown</literal> may appear in the same
12515 list. The effect of each one lasts until the next, or until the end of the
12516 list.
12517 </para>
12518 </section>
12519 <section id="SECTmixwilhos" revisionflag="changed">
12520 <title>Mixing wildcarded host names and addresses in host lists</title>
12521 <para revisionflag="changed">
12522 <indexterm role="concept">
12523 <primary>host list</primary>
12524 <secondary>mixing names and addresses in</secondary>
12525 </indexterm>
12526 </para>
12527 <para revisionflag="changed">
12528 This section explains the host/ip processing logic with the same concepts
12529 as the previous section, but specifically addresses what happens when a
12530 wildcarded hostname is one of the items in the hostlist.
12531 </para>
12532 <itemizedlist revisionflag="changed">
12533 <listitem>
12534 <para revisionflag="changed">
12535 If you have name lookups or wildcarded host names and
12536 IP addresses in the same host list, you should normally put the IP
12537 addresses first. For example, in an ACL you could have:
12538 </para>
12539 <literallayout class="monospaced" revisionflag="changed">
12540 accept hosts = 10.9.8.7 : *.friend.example
12541 </literallayout>
12542 <para revisionflag="changed">
12543 The reason you normally would order it this way lies in the
12544 left-to-right way that Exim processes lists.  It can test IP addresses
12545 without doing any DNS lookups, but when it reaches an item that requires
12546 a host name, it fails if it cannot find a host name to compare with the
12547 pattern. If the above list is given in the opposite order, the
12548 <option>accept</option> statement fails for a host whose name cannot be found, even
12549 if its IP address is 10.9.8.7.
12550 </para>
12551 </listitem>
12552 <listitem>
12553 <para revisionflag="changed">
12554 If you really do want to do the name check first, and still recognize the IP
12555 address, you can rewrite the ACL like this:
12556 </para>
12557 <literallayout class="monospaced" revisionflag="changed">
12558 accept hosts = *.friend.example
12559 accept hosts = 10.9.8.7
12560 </literallayout>
12561 <para revisionflag="changed">
12562 If the first <option>accept</option> fails, Exim goes on to try the second one. See chapter
12563 <xref linkend="CHAPACL"/> for details of ACLs. Alternatively, you can use
12564 <literal>+ignore_unknown</literal>, which was discussed in depth in the first example in
12565 this section.
12566 </para>
12567 </listitem>
12568 </itemizedlist>
12569 </section>
12570 <section id="SECTtemdnserr">
12571 <title>Temporary DNS errors when looking up host information</title>
12572 <para>
12573 <indexterm role="concept">
12574 <primary>host</primary>
12575 <secondary>lookup failures, temporary</secondary>
12576 </indexterm>
12577 <indexterm role="concept">
12578 <primary><literal>+include_defer</literal></primary>
12579 </indexterm>
12580 <indexterm role="concept">
12581 <primary><literal>+ignore_defer</literal></primary>
12582 </indexterm>
12583 A temporary DNS lookup failure normally causes a defer action (except when
12584 <option>dns_again_means_nonexist</option> converts it into a permanent error). However,
12585 host lists can include <literal>+ignore_defer</literal> and <literal>+include_defer</literal>, analagous to
12586 <literal>+ignore_unknown</literal> and <literal>+include_unknown</literal>, as described in the previous
12587 section. These options should be used with care, probably only in non-critical
12588 host lists such as whitelists.
12589 </para>
12590 </section>
12591 <section id="SECThoslispatnamsk">
12592 <title>Host list patterns for single-key lookups by host name</title>
12593 <para>
12594 <indexterm role="concept">
12595 <primary>unknown host name</primary>
12596 </indexterm>
12597 <indexterm role="concept">
12598 <primary>host list</primary>
12599 <secondary>matching host name</secondary>
12600 </indexterm>
12601 If a pattern is of the form
12602 </para>
12603 <literallayout>
12604 &lt;<emphasis>single-key-search-type</emphasis>&gt;;&lt;<emphasis>search-data</emphasis>&gt;
12605 </literallayout>
12606 <para>
12607 for example
12608 </para>
12609 <literallayout class="monospaced">
12610 dbm;/host/accept/list
12611 </literallayout>
12612 <para>
12613 a single-key lookup is performed, using the host name as its key. If the
12614 lookup succeeds, the host matches the item. The actual data that is looked up
12615 is not used.
12616 </para>
12617 <para>
12618 <emphasis role="bold">Reminder</emphasis>: With this kind of pattern, you must have host <emphasis>names</emphasis> as
12619 keys in the file, not IP addresses. If you want to do lookups based on IP
12620 addresses, you must precede the search type with <quote>net-</quote> (see section
12621 <xref linkend="SECThoslispatsikey"/>). There is, however, no reason why you could not use
12622 two items in the same list, one doing an address lookup and one doing a name
12623 lookup, both using the same file.
12624 </para>
12625 </section>
12626 <section id="SECID81">
12627 <title>Host list patterns for query-style lookups</title>
12628 <para>
12629 If a pattern is of the form
12630 </para>
12631 <literallayout>
12632 &lt;<emphasis>query-style-search-type</emphasis>&gt;;&lt;<emphasis>query</emphasis>&gt;
12633 </literallayout>
12634 <para>
12635 the query is obeyed, and if it succeeds, the host matches the item. The actual
12636 data that is looked up is not used. The variables <varname>$sender_host_address</varname> and
12637 <varname>$sender_host_name</varname> can be used in the query. For example:
12638 </para>
12639 <literallayout class="monospaced">
12640 hosts_lookup = pgsql;\
12641   select ip from hostlist where ip='$sender_host_address'
12642 </literallayout>
12643 <para>
12644 The value of <varname>$sender_host_address</varname> for an IPv6 address contains colons. You
12645 can use the <option>sg</option> expansion item to change this if you need to. If you want to
12646 use masked IP addresses in database queries, you can use the <option>mask</option> expansion
12647 operator.
12648 </para>
12649 <para>
12650 If the query contains a reference to <varname>$sender_host_name</varname>, Exim automatically
12651 looks up the host name if it has not already done so. (See section
12652 <xref linkend="SECThoslispatnam"/> for comments on finding host names.)
12653 </para>
12654 <para>
12655 Historical note: prior to release 4.30, Exim would always attempt to find a
12656 host name before running the query, unless the search type was preceded by
12657 <literal>net-</literal>. This is no longer the case. For backwards compatibility, <literal>net-</literal> is
12658 still recognized for query-style lookups, but its presence or absence has no
12659 effect. (Of course, for single-key lookups, <literal>net-</literal> <emphasis>is</emphasis> important.
12660 See section <xref linkend="SECThoslispatsikey"/>.)
12661 </para>
12662 </section>
12663 <section id="SECTaddresslist">
12664 <title>Address lists</title>
12665 <para>
12666 <indexterm role="concept">
12667 <primary>list</primary>
12668 <secondary>address list</secondary>
12669 </indexterm>
12670 <indexterm role="concept">
12671 <primary>address list</primary>
12672 <secondary>empty item</secondary>
12673 </indexterm>
12674 <indexterm role="concept">
12675 <primary>address list</primary>
12676 <secondary>patterns</secondary>
12677 </indexterm>
12678 Address lists contain patterns that are matched against mail addresses. There
12679 is one special case to be considered: the sender address of a bounce message is
12680 always empty. You can test for this by providing an empty item in an address
12681 list. For example, you can set up a router to process bounce messages by
12682 using this option setting:
12683 </para>
12684 <literallayout class="monospaced">
12685 senders = :
12686 </literallayout>
12687 <para>
12688 The presence of the colon creates an empty item. If you do not provide any
12689 data, the list is empty and matches nothing. The empty sender can also be
12690 detected by a regular expression that matches an empty string,
12691 and by a query-style lookup that succeeds when <varname>$sender_address</varname> is empty.
12692 </para>
12693 <para>
12694 Non-empty items in an address list can be straightforward email addresses. For
12695 example:
12696 </para>
12697 <literallayout class="monospaced">
12698 senders = jbc@askone.example : hs@anacreon.example
12699 </literallayout>
12700 <para>
12701 A certain amount of wildcarding is permitted. If a pattern contains an @
12702 character, but is not a regular expression and does not begin with a
12703 semicolon-terminated lookup type (described below), the local part of the
12704 subject address is compared with the local part of the pattern, which may start
12705 with an asterisk. If the local parts match, the domain is checked in exactly
12706 the same way as for a pattern in a domain list. For example, the domain can be
12707 wildcarded, refer to a named list, or be a lookup:
12708 </para>
12709 <literallayout class="monospaced">
12710 deny senders = *@*.spamming.site:\
12711                *@+hostile_domains:\
12712                bozo@partial-lsearch;/list/of/dodgy/sites:\
12713                *@dbm;/bad/domains.db
12714 </literallayout>
12715 <para>
12716 <indexterm role="concept">
12717 <primary>local part</primary>
12718 <secondary>starting with !</secondary>
12719 </indexterm>
12720 <indexterm role="concept">
12721 <primary>address list</primary>
12722 <secondary>local part starting with !</secondary>
12723 </indexterm>
12724 If a local part that begins with an exclamation mark is required, it has to be
12725 specified using a regular expression, because otherwise the exclamation mark is
12726 treated as a sign of negation, as is standard in lists.
12727 </para>
12728 <para>
12729 If a non-empty pattern that is not a regular expression or a lookup does not
12730 contain an @ character, it is matched against the domain part of the subject
12731 address. The only two formats that are recognized this way are a literal
12732 domain, or a domain pattern that starts with *. In both these cases, the effect
12733 is the same as if <literal>*@</literal> preceded the pattern. For example:
12734 </para>
12735 <literallayout class="monospaced">
12736 deny senders = enemy.domain : *.enemy.domain
12737 </literallayout>
12738 <para>
12739 The following kinds of more complicated address list pattern can match any
12740 address, including the empty address that is characteristic of bounce message
12741 senders:
12742 </para>
12743 <itemizedlist>
12744 <listitem>
12745 <para>
12746 <indexterm role="concept">
12747 <primary>regular expressions</primary>
12748 <secondary>in address list</secondary>
12749 </indexterm>
12750 <indexterm role="concept">
12751 <primary>address list</primary>
12752 <secondary>regular expression in</secondary>
12753 </indexterm>
12754 If (after expansion) a pattern starts with <quote>^</quote>, a regular expression match is
12755 done against the complete address, with the pattern as the regular expression.
12756 You must take care that backslash and dollar characters are not misinterpreted
12757 as part of the string expansion. The simplest way to do this is to use <literal>\N</literal>
12758 to mark that part of the string as non-expandable. For example:
12759 </para>
12760 <literallayout class="monospaced">
12761 deny senders = \N^.*this.*@example\.com$\N : \
12762                \N^\d{8}.+@spamhaus.example$\N : ...
12763 </literallayout>
12764 <para>
12765 The <literal>\N</literal> sequences are removed by the expansion, so these items do indeed
12766 start with <quote>^</quote> by the time they are being interpreted as address patterns.
12767 </para>
12768 </listitem>
12769 <listitem>
12770 <para>
12771 <indexterm role="concept">
12772 <primary>address list</primary>
12773 <secondary>lookup for complete address</secondary>
12774 </indexterm>
12775 Complete addresses can be looked up by using a pattern that starts with a
12776 lookup type terminated by a semicolon, followed by the data for the lookup. For
12777 example:
12778 </para>
12779 <literallayout class="monospaced">
12780 deny senders = cdb;/etc/blocked.senders : \
12781   mysql;select address from blocked where \
12782   address='${quote_mysql:$sender_address}'
12783 </literallayout>
12784 <para>
12785 Both query-style and single-key lookup types can be used. For a single-key
12786 lookup type, Exim uses the complete address as the key. However, empty keys are
12787 not supported for single-key lookups, so a match against the empty address
12788 always fails. This restriction does not apply to query-style lookups.
12789 </para>
12790 <para>
12791 Partial matching for single-key lookups (section <xref linkend="SECTpartiallookup"/>)
12792 cannot be used, and is ignored if specified, with an entry being written to the
12793 panic log.
12794 <indexterm role="concept">
12795 <primary>*@ with single-key lookup</primary>
12796 </indexterm>
12797 However, you can configure lookup defaults, as described in section
12798 <xref linkend="SECTdefaultvaluelookups"/>, but this is useful only for the <quote>*@</quote> type of
12799 default. For example, with this lookup:
12800 </para>
12801 <literallayout class="monospaced">
12802 accept senders = lsearch*@;/some/file
12803 </literallayout>
12804 <para>
12805 the file could contains lines like this:
12806 </para>
12807 <literallayout class="monospaced">
12808 user1@domain1.example
12809 *@domain2.example
12810 </literallayout>
12811 <para>
12812 and for the sender address <emphasis>nimrod@jaeger.example</emphasis>, the sequence of keys
12813 that are tried is:
12814 </para>
12815 <literallayout class="monospaced">
12816 nimrod@jaeger.example
12817 *@jaeger.example
12818 *
12819 </literallayout>
12820 <para>
12821 <emphasis role="bold">Warning 1</emphasis>: Do not include a line keyed by <quote>*</quote> in the file, because that
12822 would mean that every address matches, thus rendering the test useless.
12823 </para>
12824 <para>
12825 <emphasis role="bold">Warning 2</emphasis>: Do not confuse these two kinds of item:
12826 </para>
12827 <literallayout class="monospaced">
12828 deny recipients = dbm*@;/some/file
12829 deny recipients = *@dbm;/some/file
12830 </literallayout>
12831 <para>
12832 The first does a whole address lookup, with defaulting, as just described,
12833 because it starts with a lookup type. The second matches the local part and
12834 domain independently, as described in a bullet point below.
12835 </para>
12836 </listitem>
12837 </itemizedlist>
12838 <para>
12839 The following kinds of address list pattern can match only non-empty addresses.
12840 If the subject address is empty, a match against any of these pattern types
12841 always fails.
12842 </para>
12843 <itemizedlist>
12844 <listitem>
12845 <para>
12846 <indexterm role="concept">
12847 <primary>@@ with single-key lookup</primary>
12848 </indexterm>
12849 <indexterm role="concept">
12850 <primary>address list</primary>
12851 <secondary>@@ lookup type</secondary>
12852 </indexterm>
12853 <indexterm role="concept">
12854 <primary>address list</primary>
12855 <secondary>split local part and domain</secondary>
12856 </indexterm>
12857 If a pattern starts with <quote>@@</quote> followed by a single-key lookup item
12858 (for example, <literal>@@lsearch;/some/file</literal>), the address that is being checked is
12859 split into a local part and a domain. The domain is looked up in the file. If
12860 it is not found, there is no match. If it is found, the data that is looked up
12861 from the file is treated as a colon-separated list of local part patterns, each
12862 of which is matched against the subject local part in turn.
12863 </para>
12864 <para>
12865 <indexterm role="concept">
12866 <primary>asterisk</primary>
12867 <secondary>in address list</secondary>
12868 </indexterm>
12869 The lookup may be a partial one, and/or one involving a search for a default
12870 keyed by <quote>*</quote> (see section <xref linkend="SECTdefaultvaluelookups"/>). The local part
12871 patterns that are looked up can be regular expressions or begin with <quote>*</quote>, or
12872 even be further lookups. They may also be independently negated. For example,
12873 with
12874 </para>
12875 <literallayout class="monospaced">
12876 deny senders = @@dbm;/etc/reject-by-domain
12877 </literallayout>
12878 <para>
12879 the data from which the DBM file is built could contain lines like
12880 </para>
12881 <literallayout class="monospaced">
12882 baddomain.com:  !postmaster : *
12883 </literallayout>
12884 <para>
12885 to reject all senders except <option>postmaster</option> from that domain.
12886 </para>
12887 <para>
12888 <indexterm role="concept">
12889 <primary>local part</primary>
12890 <secondary>starting with !</secondary>
12891 </indexterm>
12892 If a local part that actually begins with an exclamation mark is required, it
12893 has to be specified using a regular expression. In <command>lsearch</command> files, an entry
12894 may be split over several lines by indenting the second and subsequent lines,
12895 but the separating colon must still be included at line breaks. White space
12896 surrounding the colons is ignored. For example:
12897 </para>
12898 <literallayout class="monospaced">
12899 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
12900   spammer3 : spammer4
12901 </literallayout>
12902 <para>
12903 As in all colon-separated lists in Exim, a colon can be included in an item by
12904 doubling.
12905 </para>
12906 <para>
12907 If the last item in the list starts with a right angle-bracket, the remainder
12908 of the item is taken as a new key to look up in order to obtain a continuation
12909 list of local parts. The new key can be any sequence of characters. Thus one
12910 might have entries like
12911 </para>
12912 <literallayout class="monospaced">
12913 aol.com: spammer1 : spammer 2 : &gt;*
12914 xyz.com: spammer3 : &gt;*
12915 *:       ^\d{8}$
12916 </literallayout>
12917 <para>
12918 in a file that was searched with <option>@@dbm*</option>, to specify a match for 8-digit
12919 local parts for all domains, in addition to the specific local parts listed for
12920 each domain. Of course, using this feature costs another lookup each time a
12921 chain is followed, but the effort needed to maintain the data is reduced.
12922 </para>
12923 <para>
12924 <indexterm role="concept">
12925 <primary>loop</primary>
12926 <secondary>in lookups</secondary>
12927 </indexterm>
12928 It is possible to construct loops using this facility, and in order to catch
12929 them, the chains may be no more than fifty items long.
12930 </para>
12931 </listitem>
12932 <listitem>
12933 <para>
12934 The @@&lt;<emphasis>lookup</emphasis>&gt; style of item can also be used with a query-style
12935 lookup, but in this case, the chaining facility is not available. The lookup
12936 can only return a single list of local parts.
12937 </para>
12938 </listitem>
12939 </itemizedlist>
12940 <para>
12941 <emphasis role="bold">Warning</emphasis>: There is an important difference between the address list items
12942 in these two examples:
12943 </para>
12944 <literallayout class="monospaced">
12945 senders = +my_list
12946 senders = *@+my_list
12947 </literallayout>
12948 <para>
12949 In the first one, <literal>my_list</literal> is a named address list, whereas in the second
12950 example it is a named domain list.
12951 </para>
12952 </section>
12953 <section id="SECTcasletadd">
12954 <title>Case of letters in address lists</title>
12955 <para>
12956 <indexterm role="concept">
12957 <primary>case of local parts</primary>
12958 </indexterm>
12959 <indexterm role="concept">
12960 <primary>address list</primary>
12961 <secondary>case forcing</secondary>
12962 </indexterm>
12963 <indexterm role="concept">
12964 <primary>case forcing in address lists</primary>
12965 </indexterm>
12966 Domains in email addresses are always handled caselessly, but for local parts
12967 case may be significant on some systems (see <option>caseful_local_part</option> for how
12968 Exim deals with this when routing addresses). However, RFC 2505 (<emphasis>Anti-Spam
12969 Recommendations for SMTP MTAs</emphasis>) suggests that matching of addresses to
12970 blocking lists should be done in a case-independent manner. Since most address
12971 lists in Exim are used for this kind of control, Exim attempts to do this by
12972 default.
12973 </para>
12974 <para>
12975 The domain portion of an address is always lowercased before matching it to an
12976 address list. The local part is lowercased by default, and any string
12977 comparisons that take place are done caselessly. This means that the data in
12978 the address list itself, in files included as plain file names, and in any file
12979 that is looked up using the <quote>@@</quote> mechanism, can be in any case. However, the
12980 keys in files that are looked up by a search type other than <command>lsearch</command> (which
12981 works caselessly) must be in lower case, because these lookups are not
12982 case-independent.
12983 </para>
12984 <para>
12985 <indexterm role="concept">
12986 <primary><literal>+caseful</literal></primary>
12987 </indexterm>
12988 To allow for the possibility of caseful address list matching, if an item in
12989 an address list is the string <quote>+caseful</quote>, the original case of the local
12990 part is restored for any comparisons that follow, and string comparisons are no
12991 longer case-independent. This does not affect the domain, which remains in
12992 lower case. However, although independent matches on the domain alone are still
12993 performed caselessly, regular expressions that match against an entire address
12994 become case-sensitive after <quote>+caseful</quote> has been seen.
12995 </para>
12996 </section>
12997 <section id="SECTlocparlis">
12998 <title>Local part lists</title>
12999 <para>
13000 <indexterm role="concept">
13001 <primary>list</primary>
13002 <secondary>local part list</secondary>
13003 </indexterm>
13004 <indexterm role="concept">
13005 <primary>local part</primary>
13006 <secondary>list</secondary>
13007 </indexterm>
13008 Case-sensitivity in local part lists is handled in the same way as for address
13009 lists, as just described. The <quote>+caseful</quote> item can be used if required. In a
13010 setting of the <option>local_parts</option> option in a router with <option>caseful_local_part</option>
13011 set false, the subject is lowercased and the matching is initially
13012 case-insensitive. In this case, <quote>+caseful</quote> will restore case-sensitive
13013 matching in the local part list, but not elsewhere in the router. If
13014 <option>caseful_local_part</option> is set true in a router, matching in the <option>local_parts</option>
13015 option is case-sensitive from the start.
13016 </para>
13017 <para>
13018 If a local part list is indirected to a file (see section <xref linkend="SECTfilnamlis"/>),
13019 comments are handled in the same way as address lists &ndash; they are recognized
13020 only if the # is preceded by white space or the start of the line.
13021 Otherwise, local part lists are matched in the same way as domain lists, except
13022 that the special items that refer to the local host (<literal>@</literal>, <literal>@[]</literal>,
13023 <literal>@mx_any</literal>, <literal>@mx_primary</literal>, and <literal>@mx_secondary</literal>) are not recognized.
13024 Refer to section <xref linkend="SECTdomainlist"/> for details of the other available item
13025 types.
13026 <indexterm role="concept" startref="IIDdohoadli" class="endofrange"/>
13027 </para>
13028 </section>
13029 </chapter>
13030
13031 <chapter id="CHAPexpand">
13032 <title>String expansions</title>
13033 <para>
13034 <indexterm role="concept" id="IIDstrexp" class="startofrange">
13035 <primary>expansion</primary>
13036 <secondary>of strings</secondary>
13037 </indexterm>
13038 Many strings in Exim&#x2019;s run time configuration are expanded before use. Some of
13039 them are expanded every time they are used; others are expanded only once.
13040 </para>
13041 <para>
13042 When a string is being expanded it is copied verbatim from left to right except
13043 when a dollar or backslash character is encountered. A dollar specifies the
13044 start of a portion of the string that is interpreted and replaced as described
13045 below in section <xref linkend="SECTexpansionitems"/> onwards. Backslash is used as an
13046 escape character, as described in the following section.
13047 </para>
13048 <para>
13049 Whether a string is expanded depends upon the context.  Usually this is solely
13050 dependent upon the option for which a value is sought; in this documentation,
13051 options for which string expansion is performed are marked with &dagger; after
13052 the data type.  ACL rules always expand strings.  A couple of expansion
13053 conditions do not expand some of the brace-delimited branches, for security
13054 reasons.
13055 </para>
13056 <section id="SECTlittext">
13057 <title>Literal text in expanded strings</title>
13058 <para>
13059 <indexterm role="concept">
13060 <primary>expansion</primary>
13061 <secondary>including literal text</secondary>
13062 </indexterm>
13063 An uninterpreted dollar can be included in an expanded string by putting a
13064 backslash in front of it. A backslash can be used to prevent any special
13065 character being treated specially in an expansion, including backslash itself.
13066 If the string appears in quotes in the configuration file, two backslashes are
13067 required because the quotes themselves cause interpretation of backslashes when
13068 the string is read in (see section <xref linkend="SECTstrings"/>).
13069 </para>
13070 <para>
13071 <indexterm role="concept">
13072 <primary>expansion</primary>
13073 <secondary>non-expandable substrings</secondary>
13074 </indexterm>
13075 A portion of the string can specified as non-expandable by placing it between
13076 two occurrences of <literal>\N</literal>. This is particularly useful for protecting regular
13077 expressions, which often contain backslashes and dollar signs. For example:
13078 </para>
13079 <literallayout class="monospaced">
13080 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
13081 </literallayout>
13082 <para>
13083 On encountering the first <literal>\N</literal>, the expander copies subsequent characters
13084 without interpretation until it reaches the next <literal>\N</literal> or the end of the
13085 string.
13086 </para>
13087 </section>
13088 <section id="SECID82">
13089 <title>Character escape sequences in expanded strings</title>
13090 <para>
13091 <indexterm role="concept">
13092 <primary>expansion</primary>
13093 <secondary>escape sequences</secondary>
13094 </indexterm>
13095 A backslash followed by one of the letters <quote>n</quote>, <quote>r</quote>, or <quote>t</quote> in an
13096 expanded string is recognized as an escape sequence for the character newline,
13097 carriage return, or tab, respectively. A backslash followed by up to three
13098 octal digits is recognized as an octal encoding for a single character, and a
13099 backslash followed by <quote>x</quote> and up to two hexadecimal digits is a hexadecimal
13100 encoding.
13101 </para>
13102 <para>
13103 These escape sequences are also recognized in quoted strings when they are read
13104 in. Their interpretation in expansions as well is useful for unquoted strings,
13105 and for other cases such as looked-up strings that are then expanded.
13106 </para>
13107 </section>
13108 <section id="SECID83">
13109 <title>Testing string expansions</title>
13110 <para>
13111 <indexterm role="concept">
13112 <primary>expansion</primary>
13113 <secondary>testing</secondary>
13114 </indexterm>
13115 <indexterm role="concept">
13116 <primary>testing</primary>
13117 <secondary>string expansion</secondary>
13118 </indexterm>
13119 <indexterm role="option">
13120 <primary><option>-be</option></primary>
13121 </indexterm>
13122 Many expansions can be tested by calling Exim with the <option>-be</option> option. This
13123 takes the command arguments, or lines from the standard input if there are no
13124 arguments, runs them through the string expansion code, and writes the results
13125 to the standard output. Variables based on configuration values are set up, but
13126 since no message is being processed, variables such as <varname>$local_part</varname> have no
13127 value. Nevertheless the <option>-be</option> option can be useful for checking out file and
13128 database lookups, and the use of expansion operators such as <option>sg</option>, <option>substr</option>
13129 and <option>nhash</option>.
13130 </para>
13131 <para>
13132 Exim gives up its root privilege when it is called with the <option>-be</option> option, and
13133 instead runs under the uid and gid it was called with, to prevent users from
13134 using <option>-be</option> for reading files to which they do not have access.
13135 </para>
13136 <para>
13137 <indexterm role="option">
13138 <primary><option>-bem</option></primary>
13139 </indexterm>
13140 If you want to test expansions that include variables whose values are taken
13141 from a message, there are two other options that can be used. The <option>-bem</option>
13142 option is like <option>-be</option> except that it is followed by a file name. The file is
13143 read as a message before doing the test expansions. For example:
13144 </para>
13145 <literallayout class="monospaced">
13146 exim -bem /tmp/test.message '$h_subject:'
13147 </literallayout>
13148 <para>
13149 The <option>-Mset</option> option is used in conjunction with <option>-be</option> and is followed by an
13150 Exim message identifier. For example:
13151 </para>
13152 <literallayout class="monospaced">
13153 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
13154 </literallayout>
13155 <para>
13156 This loads the message from Exim&#x2019;s spool before doing the test expansions, and
13157 is therefore restricted to admin users.
13158 </para>
13159 </section>
13160 <section id="SECTforexpfai">
13161 <title>Forced expansion failure</title>
13162 <para>
13163 <indexterm role="concept">
13164 <primary>expansion</primary>
13165 <secondary>forced failure</secondary>
13166 </indexterm>
13167 A number of expansions that are described in the following section have
13168 alternative <quote>true</quote> and <quote>false</quote> substrings, enclosed in brace characters
13169 (which are sometimes called <quote>curly brackets</quote>). Which of the two strings is
13170 used depends on some condition that is evaluated as part of the expansion. If,
13171 instead of a <quote>false</quote> substring, the word <quote>fail</quote> is used (not in braces),
13172 the entire string expansion fails in a way that can be detected by the code
13173 that requested the expansion. This is called <quote>forced expansion failure</quote>, and
13174 its consequences depend on the circumstances. In some cases it is no different
13175 from any other expansion failure, but in others a different action may be
13176 taken. Such variations are mentioned in the documentation of the option that is
13177 being expanded.
13178 </para>
13179 </section>
13180 <section id="SECTexpansionitems">
13181 <title>Expansion items</title>
13182 <para>
13183 The following items are recognized in expanded strings. White space may be used
13184 between sub-items that are keywords or substrings enclosed in braces inside an
13185 outer set of braces, to improve readability. <emphasis role="bold">Warning</emphasis>: Within braces,
13186 white space is significant.
13187 </para>
13188 <variablelist>
13189 <varlistentry>
13190 <term><emphasis role="bold">$</emphasis>&lt;<emphasis>variable&nbsp;name</emphasis>&gt;&nbsp;or&nbsp;<emphasis role="bold">${</emphasis>&lt;<emphasis>variable&nbsp;name</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
13191 <listitem>
13192 <para>
13193 <indexterm role="concept">
13194 <primary>expansion</primary>
13195 <secondary>variables</secondary>
13196 </indexterm>
13197 Substitute the contents of the named variable, for example:
13198 </para>
13199 <literallayout class="monospaced">
13200 $local_part
13201 ${domain}
13202 </literallayout>
13203 <para>
13204 The second form can be used to separate the name from subsequent alphanumeric
13205 characters. This form (using braces) is available only for variables; it does
13206 <emphasis>not</emphasis> apply to message headers. The names of the variables are given in
13207 section <xref linkend="SECTexpvar"/> below. If the name of a non-existent variable is
13208 given, the expansion fails.
13209 </para>
13210 </listitem></varlistentry>
13211 <varlistentry>
13212 <term><emphasis role="bold">${</emphasis>&lt;<emphasis>op</emphasis>&gt;<emphasis role="bold">:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
13213 <listitem>
13214 <para>
13215 <indexterm role="concept">
13216 <primary>expansion</primary>
13217 <secondary>operators</secondary>
13218 </indexterm>
13219 The string is first itself expanded, and then the operation specified by
13220 &lt;<emphasis>op</emphasis>&gt; is applied to it. For example:
13221 </para>
13222 <literallayout class="monospaced">
13223 ${lc:$local_part}
13224 </literallayout>
13225 <para>
13226 The string starts with the first character after the colon, which may be
13227 leading white space. A list of operators is given in section <xref linkend="SECTexpop"/>
13228 below. The operator notation is used for simple expansion items that have just
13229 one argument, because it reduces the number of braces and therefore makes the
13230 string easier to understand.
13231 </para>
13232 </listitem></varlistentry>
13233 <varlistentry>
13234 <term><emphasis role="bold">$bheader_</emphasis>&lt;<emphasis>header&nbsp;name</emphasis>&gt;<emphasis role="bold">:</emphasis>&nbsp;or&nbsp;<emphasis role="bold">$bh_</emphasis>&lt;<emphasis>header&nbsp;name</emphasis>&gt;<emphasis role="bold">:</emphasis></term>
13235 <listitem>
13236 <para>
13237 This item inserts <quote>basic</quote> header lines. It is described with the <option>header</option>
13238 expansion item below.
13239 </para>
13240 </listitem></varlistentry>
13241 <varlistentry>
13242 <term><emphasis role="bold">${acl{</emphasis>&lt;<emphasis>name</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>arg</emphasis>&gt;<emphasis role="bold">}...}</emphasis></term>
13243 <listitem>
13244 <para>
13245 <indexterm role="concept">
13246 <primary>expansion</primary>
13247 <secondary>calling an acl</secondary>
13248 </indexterm>
13249 <indexterm role="concept">
13250 <primary><option>acl</option></primary>
13251 <secondary>call from expansion</secondary>
13252 </indexterm>
13253 The name and zero to nine argument strings are first expanded separately.  The expanded
13254 arguments are assigned to the variables <varname>$acl_arg1</varname> to <varname>$acl_arg9</varname> in order.
13255 Any unused are made empty.  The variable <varname>$acl_narg</varname> is set to the number of
13256 arguments.  The named ACL (see chapter <xref linkend="CHAPACL"/>) is called
13257 and may use the variables; if another acl expansion is used the values
13258 are restored after it returns.  If the ACL sets
13259 a value using a "message =" modifier and returns accept or deny, the value becomes
13260 the result of the expansion.
13261 If no message is set and the ACL returns accept or deny
13262 the expansion result is an empty string.
13263 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
13264 </para>
13265 </listitem></varlistentry>
13266 <varlistentry revisionflag="changed">
13267 <term><emphasis role="bold">${certextract{</emphasis>&lt;<emphasis>field</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>certificate</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string3</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
13268 <listitem>
13269 <para revisionflag="changed">
13270 <indexterm role="concept">
13271 <primary>expansion</primary>
13272 <secondary>extracting cerificate fields</secondary>
13273 </indexterm>
13274 <indexterm role="concept">
13275 <primary><option>certextract</option></primary>
13276 <secondary>certificate fields</secondary>
13277 </indexterm>
13278 <indexterm role="concept">
13279 <primary>certificate</primary>
13280 <secondary>extracting fields</secondary>
13281 </indexterm>
13282 The &lt;<emphasis>certificate</emphasis>&gt; must be a variable of type certificate.
13283 The field name is expanded and used to retrive the relevant field from
13284 the certificate.  Supported fields are:
13285 </para>
13286 <literallayout revisionflag="changed">
13287 <literal>version        </literal>
13288 <literal>serial_number  </literal>
13289 <literal>subject        </literal> RFC4514 DN
13290 <literal>issuer         </literal> RFC4514 DN
13291 <literal>notbefore      </literal> time
13292 <literal>notafter       </literal> time
13293 <literal>sig_algorithm  </literal>
13294 <literal>signature      </literal>
13295 <literal>subj_altname   </literal> tagged list
13296 <literal>ocsp_uri       </literal> list
13297 <literal>crl_uri        </literal> list
13298 </literallayout>
13299 <para revisionflag="changed">
13300 If the field is found,
13301 &lt;<emphasis>string2</emphasis>&gt; is expanded, and replaces the whole item;
13302 otherwise &lt;<emphasis>string3</emphasis>&gt; is used. During the expansion of &lt;<emphasis>string2</emphasis>&gt; the
13303 variable <varname>$value</varname> contains the value that has been extracted. Afterwards, it
13304 is restored to any previous value it might have had.
13305 </para>
13306 <para revisionflag="changed">
13307 If {&lt;<emphasis>string3</emphasis>&gt;} is omitted, the item is replaced by an empty string if the
13308 key is not found. If {&lt;<emphasis>string2</emphasis>&gt;} is also omitted, the value that was
13309 extracted is used.
13310 </para>
13311 <para revisionflag="changed">
13312 Some field names take optional modifiers, appended and separated by commas.
13313 </para>
13314 <para revisionflag="changed">
13315 The field selectors marked as "RFC4514" above
13316 output a Distinguished Name string which is
13317 not quite
13318 parseable by Exim as a comma-separated tagged list
13319 (the exceptions being elements containin commas).
13320 RDN elements of a single type may be selected by
13321 a modifier of the type label; if so the expansion
13322 result is a list (newline-separated by default).
13323 The separator may be changed by another modifer of
13324 a right angle-bracket followed immediately by the new separator.
13325 Recognised RDN type labels include "CN", "O", "OU" and "DC".
13326 </para>
13327 <para revisionflag="changed">
13328 The field selectors marked as "time" above
13329 may output a number of seconds since epoch
13330 if the modifier "int" is used.
13331 </para>
13332 <para revisionflag="changed">
13333 The field selectors marked as "list" above return a list,
13334 newline-separated by default,
13335 (embedded separator characters in elements are doubled).
13336 The separator may be changed by a modifier of
13337 a right angle-bracket followed immediately by the new separator.
13338 </para>
13339 <para revisionflag="changed">
13340 The field selectors marked as "tagged" above
13341 prefix each list element with a type string and an equals sign.
13342 Elements of only one type may be selected by a modifier
13343 which is one of "dns", "uri" or "mail";
13344 if so the elenment tags are omitted.
13345 </para>
13346 <para revisionflag="changed">
13347 If not otherwise noted field values are presented in human-readable form.
13348 </para>
13349 </listitem></varlistentry>
13350 <varlistentry>
13351 <term><emphasis role="bold">${dlfunc{</emphasis>&lt;<emphasis>file</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>function</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>arg</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>arg</emphasis>&gt;<emphasis role="bold">}...}</emphasis></term>
13352 <listitem>
13353 <para>
13354 <indexterm role="concept">
13355 <primary><option>dlfunc</option></primary>
13356 </indexterm>
13357 This expansion dynamically loads and then calls a locally-written C function.
13358 This functionality is available only if Exim is compiled with
13359 </para>
13360 <literallayout class="monospaced">
13361 EXPAND_DLFUNC=yes
13362 </literallayout>
13363 <para>
13364 set in <filename>Local/Makefile</filename>. Once loaded, Exim remembers the dynamically loaded
13365 object so that it doesn&#x2019;t reload the same object file in the same Exim process
13366 (but of course Exim does start new processes frequently).
13367 </para>
13368 <para>
13369 There may be from zero to eight arguments to the function. When compiling
13370 a local function that is to be called in this way, <filename>local_scan.h</filename> should be
13371 included. The Exim variables and functions that are defined by that API
13372 are also available for dynamically loaded functions. The function itself
13373 must have the following type:
13374 </para>
13375 <literallayout class="monospaced">
13376 int dlfunction(uschar **yield, int argc, uschar *argv[])
13377 </literallayout>
13378 <para>
13379 Where <literal>uschar</literal> is a typedef for <literal>unsigned char</literal> in <filename>local_scan.h</filename>. The
13380 function should return one of the following values:
13381 </para>
13382 <para>
13383 <literal>OK</literal>: Success. The string that is placed in the variable <emphasis>yield</emphasis> is put
13384 into the expanded string that is being built.
13385 </para>
13386 <para>
13387 <literal>FAIL</literal>: A non-forced expansion failure occurs, with the error message taken
13388 from <emphasis>yield</emphasis>, if it is set.
13389 </para>
13390 <para>
13391 <literal>FAIL_FORCED</literal>: A forced expansion failure occurs, with the error message
13392 taken from <emphasis>yield</emphasis> if it is set.
13393 </para>
13394 <para>
13395 <literal>ERROR</literal>: Same as <literal>FAIL</literal>, except that a panic log entry is written.
13396 </para>
13397 <para>
13398 When compiling a function that is to be used in this way with gcc,
13399 you need to add <option>-shared</option> to the gcc command. Also, in the Exim build-time
13400 configuration, you must add <option>-export-dynamic</option> to EXTRALIBS.
13401 </para>
13402 </listitem></varlistentry>
13403 <varlistentry>
13404 <term><emphasis role="bold">${extract{</emphasis>&lt;<emphasis>key</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string3</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
13405 <listitem>
13406 <para>
13407 <indexterm role="concept">
13408 <primary>expansion</primary>
13409 <secondary>extracting substrings by key</secondary>
13410 </indexterm>
13411 <indexterm role="concept">
13412 <primary><option>extract</option></primary>
13413 <secondary>substrings by key</secondary>
13414 </indexterm>
13415 The key and &lt;<emphasis>string1</emphasis>&gt; are first expanded separately. Leading and trailing
13416 white space is removed from the key (but not from any of the strings). The key
13417 must not consist entirely of digits. The expanded &lt;<emphasis>string1</emphasis>&gt; must be of the
13418 form:
13419 </para>
13420 <literallayout>
13421 &lt;<emphasis>key1</emphasis>&gt; = &lt;<emphasis>value1</emphasis>&gt;  &lt;<emphasis>key2</emphasis>&gt; = &lt;<emphasis>value2</emphasis>&gt; ...
13422 </literallayout>
13423 <para>
13424 <indexterm role="variable">
13425 <primary><varname>$value</varname></primary>
13426 </indexterm>
13427 where the equals signs and spaces (but not both) are optional. If any of the
13428 values contain white space, they must be enclosed in double quotes, and any
13429 values that are enclosed in double quotes are subject to escape processing as
13430 described in section <xref linkend="SECTstrings"/>. The expanded &lt;<emphasis>string1</emphasis>&gt; is searched
13431 for the value that corresponds to the key. The search is case-insensitive. If
13432 the key is found, &lt;<emphasis>string2</emphasis>&gt; is expanded, and replaces the whole item;
13433 otherwise &lt;<emphasis>string3</emphasis>&gt; is used. During the expansion of &lt;<emphasis>string2</emphasis>&gt; the
13434 variable <varname>$value</varname> contains the value that has been extracted. Afterwards, it
13435 is restored to any previous value it might have had.
13436 </para>
13437 <para>
13438 If {&lt;<emphasis>string3</emphasis>&gt;} is omitted, the item is replaced by an empty string if the
13439 key is not found. If {&lt;<emphasis>string2</emphasis>&gt;} is also omitted, the value that was
13440 extracted is used. Thus, for example, these two expansions are identical, and
13441 yield <quote>2001</quote>:
13442 </para>
13443 <literallayout class="monospaced">
13444 ${extract{gid}{uid=1984 gid=2001}}
13445 ${extract{gid}{uid=1984 gid=2001}{$value}}
13446 </literallayout>
13447 <para>
13448 Instead of {&lt;<emphasis>string3</emphasis>&gt;} the word <quote>fail</quote> (not in curly brackets) can
13449 appear, for example:
13450 </para>
13451 <literallayout class="monospaced">
13452 ${extract{Z}{A=... B=...}{$value} fail }
13453 </literallayout>
13454 <para>
13455 This forces an expansion failure (see section <xref linkend="SECTforexpfai"/>);
13456 {&lt;<emphasis>string2</emphasis>&gt;} must be present for <quote>fail</quote> to be recognized.
13457 </para>
13458 </listitem></varlistentry>
13459 <varlistentry>
13460 <term><emphasis role="bold">${extract{</emphasis>&lt;<emphasis>number</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>separators</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string3</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
13461 <listitem>
13462 <para>
13463 <indexterm role="concept">
13464 <primary>expansion</primary>
13465 <secondary>extracting substrings by number</secondary>
13466 </indexterm>
13467 <indexterm role="concept">
13468 <primary><option>extract</option></primary>
13469 <secondary>substrings by number</secondary>
13470 </indexterm>
13471 The &lt;<emphasis>number</emphasis>&gt; argument must consist entirely of decimal digits,
13472 apart from leading and trailing white space, which is ignored.
13473 This is what distinguishes this form of <option>extract</option> from the previous kind. It
13474 behaves in the same way, except that, instead of extracting a named field, it
13475 extracts from &lt;<emphasis>string1</emphasis>&gt; the field whose number is given as the first
13476 argument. You can use <varname>$value</varname> in &lt;<emphasis>string2</emphasis>&gt; or <literal>fail</literal> instead of
13477 &lt;<emphasis>string3</emphasis>&gt; as before.
13478 </para>
13479 <para>
13480 The fields in the string are separated by any one of the characters in the
13481 separator string. These may include space or tab characters.
13482 The first field is numbered one. If the number is negative, the fields are
13483 counted from the end of the string, with the rightmost one numbered -1. If the
13484 number given is zero, the entire string is returned. If the modulus of the
13485 number is greater than the number of fields in the string, the result is the
13486 expansion of &lt;<emphasis>string3</emphasis>&gt;, or the empty string if &lt;<emphasis>string3</emphasis>&gt; is not
13487 provided. For example:
13488 </para>
13489 <literallayout class="monospaced">
13490 ${extract{2}{:}{x:42:99:&amp; Mailer::/bin/bash}}
13491 </literallayout>
13492 <para>
13493 yields <quote>42</quote>, and
13494 </para>
13495 <literallayout class="monospaced">
13496 ${extract{-4}{:}{x:42:99:&amp; Mailer::/bin/bash}}
13497 </literallayout>
13498 <para>
13499 yields <quote>99</quote>. Two successive separators mean that the field between them is
13500 empty (for example, the fifth field above).
13501 </para>
13502 </listitem></varlistentry>
13503 <varlistentry>
13504 <term><emphasis role="bold">${filter{</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>condition</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
13505 <listitem>
13506 <para>
13507 <indexterm role="concept">
13508 <primary>list</primary>
13509 <secondary>selecting by condition</secondary>
13510 </indexterm>
13511 <indexterm role="concept">
13512 <primary>expansion</primary>
13513 <secondary>selecting from list by condition</secondary>
13514 </indexterm>
13515 <indexterm role="variable">
13516 <primary><varname>$item</varname></primary>
13517 </indexterm>
13518 After expansion, &lt;<emphasis>string</emphasis>&gt; is interpreted as a list, colon-separated by
13519 default, but the separator can be changed in the usual way. For each item
13520 in this list, its value is place in <varname>$item</varname>, and then the condition is
13521 evaluated. If the condition is true, <varname>$item</varname> is added to the output as an
13522 item in a new list; if the condition is false, the item is discarded. The
13523 separator used for the output list is the same as the one used for the
13524 input, but a separator setting is not included in the output. For example:
13525 </para>
13526 <literallayout class="monospaced">
13527 ${filter{a:b:c}{!eq{$item}{b}}
13528 </literallayout>
13529 <para>
13530 yields <literal>a:c</literal>. At the end of the expansion, the value of <varname>$item</varname> is restored
13531 to what it was before. See also the <emphasis role="bold">map</emphasis> and <emphasis role="bold">reduce</emphasis> expansion items.
13532 </para>
13533 </listitem></varlistentry>
13534 <varlistentry>
13535 <term><emphasis role="bold">${hash{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string3</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
13536 <listitem>
13537 <para>
13538 <indexterm role="concept">
13539 <primary>hash function</primary>
13540 <secondary>textual</secondary>
13541 </indexterm>
13542 <indexterm role="concept">
13543 <primary>expansion</primary>
13544 <secondary>textual hash</secondary>
13545 </indexterm>
13546 This is a textual hashing function, and was the first to be implemented in
13547 early versions of Exim. In current releases, there are other hashing functions
13548 (numeric, MD5, and SHA-1), which are described below.
13549 </para>
13550 <para>
13551 The first two strings, after expansion, must be numbers. Call them &lt;<emphasis>m</emphasis>&gt; and
13552 &lt;<emphasis>n</emphasis>&gt;. If you are using fixed values for these numbers, that is, if
13553 &lt;<emphasis>string1</emphasis>&gt; and &lt;<emphasis>string2</emphasis>&gt; do not change when they are expanded, you can
13554 use the simpler operator notation that avoids some of the braces:
13555 </para>
13556 <literallayout class="monospaced">
13557 ${hash_&lt;n&gt;_&lt;m&gt;:&lt;string&gt;}
13558 </literallayout>
13559 <para>
13560 The second number is optional (in both notations). If &lt;<emphasis>n</emphasis>&gt; is greater than
13561 or equal to the length of the string, the expansion item returns the string.
13562 Otherwise it computes a new string of length &lt;<emphasis>n</emphasis>&gt; by applying a hashing
13563 function to the string. The new string consists of characters taken from the
13564 first &lt;<emphasis>m</emphasis>&gt; characters of the string
13565 </para>
13566 <literallayout class="monospaced">
13567 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
13568 </literallayout>
13569 <para>
13570 If &lt;<emphasis>m</emphasis>&gt; is not present the value 26 is used, so that only lower case
13571 letters appear. For example:
13572 </para>
13573 <literallayout>
13574 <literal>$hash{3}{monty}}           </literal>   yields  <literal>jmg</literal>
13575 <literal>$hash{5}{monty}}           </literal>   yields  <literal>monty</literal>
13576 <literal>$hash{4}{62}{monty python}}</literal>   yields  <literal>fbWx</literal>
13577 </literallayout>
13578 </listitem></varlistentry>
13579 <varlistentry>
13580 <term><emphasis role="bold">$header_</emphasis>&lt;<emphasis>header&nbsp;name</emphasis>&gt;<emphasis role="bold">:</emphasis>&nbsp;or&nbsp;<emphasis role="bold">$h_</emphasis>&lt;<emphasis>header&nbsp;name</emphasis>&gt;<emphasis role="bold">:</emphasis></term>
13581 <term><emphasis role="bold">$bheader_</emphasis>&lt;<emphasis>header&nbsp;name</emphasis>&gt;<emphasis role="bold">:</emphasis>&nbsp;or&nbsp;<emphasis role="bold">$bh_</emphasis>&lt;<emphasis>header&nbsp;name</emphasis>&gt;<emphasis role="bold">:</emphasis></term>
13582 <term><emphasis role="bold">$rheader_</emphasis>&lt;<emphasis>header&nbsp;name</emphasis>&gt;<emphasis role="bold">:</emphasis>&nbsp;or&nbsp;<emphasis role="bold">$rh_</emphasis>&lt;<emphasis>header&nbsp;name</emphasis>&gt;<emphasis role="bold">:</emphasis></term>
13583 <listitem>
13584 <para>
13585 <indexterm role="concept">
13586 <primary>expansion</primary>
13587 <secondary>header insertion</secondary>
13588 </indexterm>
13589 <indexterm role="variable">
13590 <primary><varname>$header_</varname></primary>
13591 </indexterm>
13592 <indexterm role="variable">
13593 <primary><varname>$bheader_</varname></primary>
13594 </indexterm>
13595 <indexterm role="variable">
13596 <primary><varname>$rheader_</varname></primary>
13597 </indexterm>
13598 <indexterm role="concept">
13599 <primary>header lines</primary>
13600 <secondary>in expansion strings</secondary>
13601 </indexterm>
13602 <indexterm role="concept">
13603 <primary>header lines</primary>
13604 <secondary>character sets</secondary>
13605 </indexterm>
13606 <indexterm role="concept">
13607 <primary>header lines</primary>
13608 <secondary>decoding</secondary>
13609 </indexterm>
13610 Substitute the contents of the named message header line, for example
13611 </para>
13612 <literallayout class="monospaced">
13613 $header_reply-to:
13614 </literallayout>
13615 <para>
13616 The newline that terminates a header line is not included in the expansion, but
13617 internal newlines (caused by splitting the header line over several physical
13618 lines) may be present.
13619 </para>
13620 <para>
13621 The difference between <option>rheader</option>, <option>bheader</option>, and <option>header</option> is in the way
13622 the data in the header line is interpreted.
13623 </para>
13624 <itemizedlist>
13625 <listitem>
13626 <para>
13627 <indexterm role="concept">
13628 <primary>white space</primary>
13629 <secondary>in header lines</secondary>
13630 </indexterm>
13631 <option>rheader</option> gives the original <quote>raw</quote> content of the header line, with no
13632 processing at all, and without the removal of leading and trailing white space.
13633 </para>
13634 </listitem>
13635 <listitem>
13636 <para>
13637 <indexterm role="concept">
13638 <primary>base64 encoding</primary>
13639 <secondary>in header lines</secondary>
13640 </indexterm>
13641 <option>bheader</option> removes leading and trailing white space, and then decodes base64
13642 or quoted-printable MIME <quote>words</quote> within the header text, but does no
13643 character set translation. If decoding of what looks superficially like a MIME
13644 <quote>word</quote> fails, the raw string is returned. If decoding
13645 <indexterm role="concept">
13646 <primary>binary zero</primary>
13647 <secondary>in header line</secondary>
13648 </indexterm>
13649 produces a binary zero character, it is replaced by a question mark &ndash; this is
13650 what Exim does for binary zeros that are actually received in header lines.
13651 </para>
13652 </listitem>
13653 <listitem>
13654 <para>
13655 <option>header</option> tries to translate the string as decoded by <option>bheader</option> to a
13656 standard character set. This is an attempt to produce the same string as would
13657 be displayed on a user&#x2019;s MUA. If translation fails, the <option>bheader</option> string is
13658 returned. Translation is attempted only on operating systems that support the
13659 <function>iconv()</function> function. This is indicated by the compile-time macro HAVE_ICONV in
13660 a system Makefile or in <filename>Local/Makefile</filename>.
13661 </para>
13662 </listitem>
13663 </itemizedlist>
13664 <para>
13665 In a filter file, the target character set for <option>header</option> can be specified by a
13666 command of the following form:
13667 </para>
13668 <literallayout class="monospaced">
13669 headers charset "UTF-8"
13670 </literallayout>
13671 <para>
13672 This command affects all references to <varname>$h_</varname> (or <varname>$header_</varname>) expansions in
13673 subsequently obeyed filter commands. In the absence of this command, the target
13674 character set in a filter is taken from the setting of the <option>headers_charset</option>
13675 option in the runtime configuration. The value of this option defaults to the
13676 value of HEADERS_CHARSET in <filename>Local/Makefile</filename>. The ultimate default is
13677 ISO-8859-1.
13678 </para>
13679 <para>
13680 Header names follow the syntax of RFC 2822, which states that they may contain
13681 any printing characters except space and colon. Consequently, curly brackets
13682 <emphasis>do not</emphasis> terminate header names, and should not be used to enclose them as
13683 if they were variables. Attempting to do so causes a syntax error.
13684 </para>
13685 <para>
13686 Only header lines that are common to all copies of a message are visible to
13687 this mechanism. These are the original header lines that are received with the
13688 message, and any that are added by an ACL statement or by a system
13689 filter. Header lines that are added to a particular copy of a message by a
13690 router or transport are not accessible.
13691 </para>
13692 <para>
13693 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
13694 before the DATA ACL, because the header structure is not set up until the
13695 message is received. Header lines that are added in a RCPT ACL (for example)
13696 are saved until the message&#x2019;s incoming header lines are available, at which
13697 point they are added. When a DATA ACL is running, however, header lines added
13698 by earlier ACLs are visible.
13699 </para>
13700 <para>
13701 Upper case and lower case letters are synonymous in header names. If the
13702 following character is white space, the terminating colon may be omitted, but
13703 this is not recommended, because you may then forget it when it is needed. When
13704 white space terminates the header name, it is included in the expanded string.
13705 If the message does not contain the given header, the expansion item is
13706 replaced by an empty string. (See the <option>def</option> condition in section
13707 <xref linkend="SECTexpcond"/> for a means of testing for the existence of a header.)
13708 </para>
13709 <para>
13710 If there is more than one header with the same name, they are all concatenated
13711 to form the substitution string, up to a maximum length of 64K. Unless
13712 <option>rheader</option> is being used, leading and trailing white space is removed from
13713 each header before concatenation, and a completely empty header is ignored. A
13714 newline character is then inserted between non-empty headers, but there is no
13715 newline at the very end. For the <option>header</option> and <option>bheader</option> expansion, for
13716 those headers that contain lists of addresses, a comma is also inserted at the
13717 junctions between headers. This does not happen for the <option>rheader</option> expansion.
13718 </para>
13719 </listitem></varlistentry>
13720 <varlistentry>
13721 <term><emphasis role="bold">${hmac{</emphasis>&lt;<emphasis>hashname</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>secret</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
13722 <listitem>
13723 <para>
13724 <indexterm role="concept">
13725 <primary>expansion</primary>
13726 <secondary>hmac hashing</secondary>
13727 </indexterm>
13728 <indexterm role="concept">
13729 <primary><option>hmac</option></primary>
13730 </indexterm>
13731 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
13732 shared secret and some text into a message authentication code, as specified in
13733 RFC 2104. This differs from <literal>${md5:secret_text...}</literal> or
13734 <literal>${sha1:secret_text...}</literal> in that the hmac step adds a signature to the
13735 cryptographic hash, allowing for authentication that is not possible with MD5
13736 or SHA-1 alone. The hash name must expand to either <literal>md5</literal> or <literal>sha1</literal> at
13737 present. For example:
13738 </para>
13739 <literallayout class="monospaced">
13740 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
13741 </literallayout>
13742 <para>
13743 For the hostname <emphasis>mail.example.com</emphasis> and time 2002-10-17 11:30:59, this
13744 produces:
13745 </para>
13746 <literallayout class="monospaced">
13747 dd97e3ba5d1a61b5006108f8c8252953
13748 </literallayout>
13749 <para>
13750 As an example of how this might be used, you might put in the main part of
13751 an Exim configuration:
13752 </para>
13753 <literallayout class="monospaced">
13754 SPAMSCAN_SECRET=cohgheeLei2thahw
13755 </literallayout>
13756 <para>
13757 In a router or a transport you could then have:
13758 </para>
13759 <literallayout class="monospaced">
13760 headers_add = \
13761   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
13762   ${hmac{md5}{SPAMSCAN_SECRET}\
13763   {${primary_hostname},${message_exim_id},$h_message-id:}}
13764 </literallayout>
13765 <para>
13766 Then given a message, you can check where it was scanned by looking at the
13767 <emphasis>X-Spam-Scanned:</emphasis> header line. If you know the secret, you can check that
13768 this header line is authentic by recomputing the authentication code from the
13769 host name, message ID and the <emphasis>Message-id:</emphasis> header line. This can be done
13770 using Exim&#x2019;s <option>-be</option> option, or by other means, for example by using the
13771 <emphasis>hmac_md5_hex()</emphasis> function in Perl.
13772 </para>
13773 </listitem></varlistentry>
13774 <varlistentry>
13775 <term><emphasis role="bold">${if&nbsp;</emphasis>&lt;<emphasis>condition</emphasis>&gt;<emphasis role="bold">&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
13776 <listitem>
13777 <para>
13778 <indexterm role="concept">
13779 <primary>expansion</primary>
13780 <secondary>conditional</secondary>
13781 </indexterm>
13782 <indexterm role="concept">
13783 <primary><option>if</option>, expansion item</primary>
13784 </indexterm>
13785 If &lt;<emphasis>condition</emphasis>&gt; is true, &lt;<emphasis>string1</emphasis>&gt; is expanded and replaces the whole
13786 item; otherwise &lt;<emphasis>string2</emphasis>&gt; is used. The available conditions are described
13787 in section <xref linkend="SECTexpcond"/> below. For example:
13788 </para>
13789 <literallayout class="monospaced">
13790 ${if eq {$local_part}{postmaster} {yes}{no} }
13791 </literallayout>
13792 <para>
13793 The second string need not be present; if it is not and the condition is not
13794 true, the item is replaced with nothing. Alternatively, the word <quote>fail</quote> may
13795 be present instead of the second string (without any curly brackets). In this
13796 case, the expansion is forced to fail if the condition is not true (see section
13797 <xref linkend="SECTforexpfai"/>).
13798 </para>
13799 <para>
13800 If both strings are omitted, the result is the string <literal>true</literal> if the condition
13801 is true, and the empty string if the condition is false. This makes it less
13802 cumbersome to write custom ACL and router conditions. For example, instead of
13803 </para>
13804 <literallayout class="monospaced">
13805 condition = ${if &gt;{$acl_m4}{3}{true}{false}}
13806 </literallayout>
13807 <para>
13808 you can use
13809 </para>
13810 <literallayout class="monospaced">
13811 condition = ${if &gt;{$acl_m4}{3}}
13812 </literallayout>
13813 </listitem></varlistentry>
13814 <varlistentry>
13815 <term><emphasis role="bold">${length{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
13816 <listitem>
13817 <para>
13818 <indexterm role="concept">
13819 <primary>expansion</primary>
13820 <secondary>string truncation</secondary>
13821 </indexterm>
13822 <indexterm role="concept">
13823 <primary><option>length</option> expansion item</primary>
13824 </indexterm>
13825 The <option>length</option> item is used to extract the initial portion of a string. Both
13826 strings are expanded, and the first one must yield a number, &lt;<emphasis>n</emphasis>&gt;, say. If
13827 you are using a fixed value for the number, that is, if &lt;<emphasis>string1</emphasis>&gt; does not
13828 change when expanded, you can use the simpler operator notation that avoids
13829 some of the braces:
13830 </para>
13831 <literallayout class="monospaced">
13832 ${length_&lt;n&gt;:&lt;string&gt;}
13833 </literallayout>
13834 <para>
13835 The result of this item is either the first &lt;<emphasis>n</emphasis>&gt; characters or the whole
13836 of &lt;<emphasis>string2</emphasis>&gt;, whichever is the shorter. Do not confuse <option>length</option> with
13837 <option>strlen</option>, which gives the length of a string.
13838 </para>
13839 </listitem></varlistentry>
13840 <varlistentry>
13841 <term><emphasis role="bold">${listextract{</emphasis>&lt;<emphasis>number</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string3</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
13842 <listitem>
13843 <para>
13844 <indexterm role="concept">
13845 <primary>expansion</primary>
13846 <secondary>extracting list elements by number</secondary>
13847 </indexterm>
13848 <indexterm role="concept">
13849 <primary><option>listextract</option></primary>
13850 <secondary>extract list elements by number</secondary>
13851 </indexterm>
13852 <indexterm role="concept">
13853 <primary>list</primary>
13854 <secondary>extracting elements by number</secondary>
13855 </indexterm>
13856 The &lt;<emphasis>number</emphasis>&gt; argument must consist entirely of decimal digits,
13857 apart from an optional leading minus,
13858 and leading and trailing white space (which is ignored).
13859 </para>
13860 <para>
13861 After expansion, &lt;<emphasis>string1</emphasis>&gt; is interpreted as a list, colon-separated by
13862 default, but the separator can be changed in the usual way.
13863 </para>
13864 <para>
13865 The first field of the list is numbered one.
13866 If the number is negative, the fields are
13867 counted from the end of the list, with the rightmost one numbered -1.
13868 The numbered element of the list is extracted and placed in <varname>$value</varname>,
13869 then &lt;<emphasis>string2</emphasis>&gt; is expanded as the result.
13870 </para>
13871 <para>
13872 If the modulus of the
13873 number is zero or greater than the number of fields in the string,
13874 the result is the expansion of &lt;<emphasis>string3</emphasis>&gt;.
13875 </para>
13876 <para>
13877 For example:
13878 </para>
13879 <literallayout class="monospaced">
13880 ${listextract{2}{x:42:99}}
13881 </literallayout>
13882 <para>
13883 yields <quote>42</quote>, and
13884 </para>
13885 <literallayout class="monospaced">
13886 ${listextract{-3}{&lt;, x,42,99,&amp; Mailer,,/bin/bash}{result: $value}}
13887 </literallayout>
13888 <para>
13889 yields <quote>result: 99</quote>.
13890 </para>
13891 <para>
13892 If {&lt;<emphasis>string3</emphasis>&gt;} is omitted, an empty string is used for string3.
13893 If {&lt;<emphasis>string2</emphasis>&gt;} is also omitted, the value that was
13894 extracted is used.
13895 You can use <literal>fail</literal> instead of {&lt;<emphasis>string3</emphasis>&gt;} as in a string extract.
13896 </para>
13897 </listitem></varlistentry>
13898 <varlistentry>
13899 <term><emphasis role="bold">${lookup{</emphasis>&lt;<emphasis>key</emphasis>&gt;<emphasis role="bold">}&nbsp;</emphasis>&lt;<emphasis>search&nbsp;type</emphasis>&gt;<emphasis role="bold">&nbsp;{</emphasis>&lt;<emphasis>file</emphasis>&gt;<emphasis role="bold">}&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}&nbsp;{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
13900 <listitem>
13901 <para>
13902 This is the first of one of two different types of lookup item, which are both
13903 described in the next item.
13904 </para>
13905 </listitem></varlistentry>
13906 <varlistentry>
13907 <term><emphasis role="bold">${lookup&nbsp;</emphasis>&lt;<emphasis>search&nbsp;type</emphasis>&gt;<emphasis role="bold">&nbsp;{</emphasis>&lt;<emphasis>query</emphasis>&gt;<emphasis role="bold">}&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}&nbsp;{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
13908 <listitem>
13909 <para>
13910 <indexterm role="concept">
13911 <primary>expansion</primary>
13912 <secondary>lookup in</secondary>
13913 </indexterm>
13914 <indexterm role="concept">
13915 <primary>file</primary>
13916 <secondary>lookups</secondary>
13917 </indexterm>
13918 <indexterm role="concept">
13919 <primary>lookup</primary>
13920 <secondary>in expanded string</secondary>
13921 </indexterm>
13922 The two forms of lookup item specify data lookups in files and databases, as
13923 discussed in chapter <xref linkend="CHAPfdlookup"/>. The first form is used for single-key
13924 lookups, and the second is used for query-style lookups. The &lt;<emphasis>key</emphasis>&gt;,
13925 &lt;<emphasis>file</emphasis>&gt;, and &lt;<emphasis>query</emphasis>&gt; strings are expanded before use.
13926 </para>
13927 <para>
13928 If there is any white space in a lookup item which is part of a filter command,
13929 a retry or rewrite rule, a routing rule for the <command>manualroute</command> router, or any
13930 other place where white space is significant, the lookup item must be enclosed
13931 in double quotes. The use of data lookups in users&#x2019; filter files may be locked
13932 out by the system administrator.
13933 </para>
13934 <para>
13935 <indexterm role="variable">
13936 <primary><varname>$value</varname></primary>
13937 </indexterm>
13938 If the lookup succeeds, &lt;<emphasis>string1</emphasis>&gt; is expanded and replaces the entire item.
13939 During its expansion, the variable <varname>$value</varname> contains the data returned by the
13940 lookup. Afterwards it reverts to the value it had previously (at the outer
13941 level it is empty). If the lookup fails, &lt;<emphasis>string2</emphasis>&gt; is expanded and replaces
13942 the entire item. If {&lt;<emphasis>string2</emphasis>&gt;} is omitted, the replacement is the empty
13943 string on failure. If &lt;<emphasis>string2</emphasis>&gt; is provided, it can itself be a nested
13944 lookup, thus providing a mechanism for looking up a default value when the
13945 original lookup fails.
13946 </para>
13947 <para>
13948 If a nested lookup is used as part of &lt;<emphasis>string1</emphasis>&gt;, <varname>$value</varname> contains the
13949 data for the outer lookup while the parameters of the second lookup are
13950 expanded, and also while &lt;<emphasis>string2</emphasis>&gt; of the second lookup is expanded, should
13951 the second lookup fail. Instead of {&lt;<emphasis>string2</emphasis>&gt;} the word <quote>fail</quote> can
13952 appear, and in this case, if the lookup fails, the entire expansion is forced
13953 to fail (see section <xref linkend="SECTforexpfai"/>). If both {&lt;<emphasis>string1</emphasis>&gt;} and
13954 {&lt;<emphasis>string2</emphasis>&gt;} are omitted, the result is the looked up value in the case of a
13955 successful lookup, and nothing in the case of failure.
13956 </para>
13957 <para>
13958 For single-key lookups, the string <quote>partial</quote> is permitted to precede the
13959 search type in order to do partial matching, and * or *@ may follow a search
13960 type to request default lookups if the key does not match (see sections
13961 <xref linkend="SECTdefaultvaluelookups"/> and <xref linkend="SECTpartiallookup"/> for details).
13962 </para>
13963 <para>
13964 <indexterm role="concept">
13965 <primary>numerical variables (<varname>$1</varname> <varname>$2</varname> etc)</primary>
13966 <secondary>in lookup expansion</secondary>
13967 </indexterm>
13968 If a partial search is used, the variables <varname>$1</varname> and <varname>$2</varname> contain the wild
13969 and non-wild parts of the key during the expansion of the replacement text.
13970 They return to their previous values at the end of the lookup item.
13971 </para>
13972 <para>
13973 This example looks up the postmaster alias in the conventional alias file:
13974 </para>
13975 <literallayout class="monospaced">
13976 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
13977 </literallayout>
13978 <para>
13979 This example uses NIS+ to look up the full name of the user corresponding to
13980 the local part of an address, forcing the expansion to fail if it is not found:
13981 </para>
13982 <literallayout class="monospaced">
13983 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
13984   {$value}fail}
13985 </literallayout>
13986 </listitem></varlistentry>
13987 <varlistentry>
13988 <term><emphasis role="bold">${map{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
13989 <listitem>
13990 <para>
13991 <indexterm role="concept">
13992 <primary>expansion</primary>
13993 <secondary>list creation</secondary>
13994 </indexterm>
13995 <indexterm role="variable">
13996 <primary><varname>$item</varname></primary>
13997 </indexterm>
13998 After expansion, &lt;<emphasis>string1</emphasis>&gt; is interpreted as a list, colon-separated by
13999 default, but the separator can be changed in the usual way. For each item
14000 in this list, its value is place in <varname>$item</varname>, and then &lt;<emphasis>string2</emphasis>&gt; is
14001 expanded and added to the output as an item in a new list. The separator used
14002 for the output list is the same as the one used for the input, but a separator
14003 setting is not included in the output. For example:
14004 </para>
14005 <literallayout class="monospaced">
14006 ${map{a:b:c}{[$item]}} ${map{&lt;- x-y-z}{($item)}}
14007 </literallayout>
14008 <para>
14009 expands to <literal>[a]:[b]:[c] (x)-(y)-(z)</literal>. At the end of the expansion, the
14010 value of <varname>$item</varname> is restored to what it was before. See also the <emphasis role="bold">filter</emphasis>
14011 and <emphasis role="bold">reduce</emphasis> expansion items.
14012 </para>
14013 </listitem></varlistentry>
14014 <varlistentry>
14015 <term><emphasis role="bold">${nhash{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string3</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
14016 <listitem>
14017 <para>
14018 <indexterm role="concept">
14019 <primary>expansion</primary>
14020 <secondary>numeric hash</secondary>
14021 </indexterm>
14022 <indexterm role="concept">
14023 <primary>hash function</primary>
14024 <secondary>numeric</secondary>
14025 </indexterm>
14026 The three strings are expanded; the first two must yield numbers. Call them
14027 &lt;<emphasis>n</emphasis>&gt; and &lt;<emphasis>m</emphasis>&gt;. If you are using fixed values for these numbers, that is,
14028 if &lt;<emphasis>string1</emphasis>&gt; and &lt;<emphasis>string2</emphasis>&gt; do not change when they are expanded, you
14029 can use the simpler operator notation that avoids some of the braces:
14030 </para>
14031 <literallayout class="monospaced">
14032 ${nhash_&lt;n&gt;_&lt;m&gt;:&lt;string&gt;}
14033 </literallayout>
14034 <para>
14035 The second number is optional (in both notations). If there is only one number,
14036 the result is a number in the range 0&ndash;&lt;<emphasis>n</emphasis>&gt;-1. Otherwise, the string is
14037 processed by a div/mod hash function that returns two numbers, separated by a
14038 slash, in the ranges 0 to &lt;<emphasis>n</emphasis>&gt;-1 and 0 to &lt;<emphasis>m</emphasis>&gt;-1, respectively. For
14039 example,
14040 </para>
14041 <literallayout class="monospaced">
14042 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
14043 </literallayout>
14044 <para>
14045 returns the string <quote>6/33</quote>.
14046 </para>
14047 </listitem></varlistentry>
14048 <varlistentry>
14049 <term><emphasis role="bold">${perl{</emphasis>&lt;<emphasis>subroutine</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>arg</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>arg</emphasis>&gt;<emphasis role="bold">}...}</emphasis></term>
14050 <listitem>
14051 <para>
14052 <indexterm role="concept">
14053 <primary>Perl</primary>
14054 <secondary>use in expanded string</secondary>
14055 </indexterm>
14056 <indexterm role="concept">
14057 <primary>expansion</primary>
14058 <secondary>calling Perl from</secondary>
14059 </indexterm>
14060 This item is available only if Exim has been built to include an embedded Perl
14061 interpreter. The subroutine name and the arguments are first separately
14062 expanded, and then the Perl subroutine is called with those arguments. No
14063 additional arguments need be given; the maximum number permitted, including the
14064 name of the subroutine, is nine.
14065 </para>
14066 <para>
14067 The return value of the subroutine is inserted into the expanded string, unless
14068 the return value is <option>undef</option>. In that case, the expansion fails in the same
14069 way as an explicit <quote>fail</quote> on a lookup item. The return value is a scalar.
14070 Whatever you return is evaluated in a scalar context. For example, if you
14071 return the name of a Perl vector, the return value is the size of the vector,
14072 not its contents.
14073 </para>
14074 <para>
14075 If the subroutine exits by calling Perl&#x2019;s <option>die</option> function, the expansion fails
14076 with the error message that was passed to <option>die</option>. More details of the embedded
14077 Perl facility are given in chapter <xref linkend="CHAPperl"/>.
14078 </para>
14079 <para>
14080 The <command>redirect</command> router has an option called <option>forbid_filter_perl</option> which locks
14081 out the use of this expansion item in filter files.
14082 </para>
14083 </listitem></varlistentry>
14084 <varlistentry>
14085 <term><emphasis role="bold">${prvs{</emphasis>&lt;<emphasis>address</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>secret</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>keynumber</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
14086 <listitem>
14087 <para>
14088 <indexterm role="concept">
14089 <primary><option>prvs</option> expansion item</primary>
14090 </indexterm>
14091 The first argument is a complete email address and the second is secret
14092 keystring. The third argument, specifying a key number, is optional. If absent,
14093 it defaults to 0. The result of the expansion is a prvs-signed email address,
14094 to be typically used with the <option>return_path</option> option on an <command>smtp</command> transport
14095 as part of a bounce address tag validation (BATV) scheme. For more discussion
14096 and an example, see section <xref linkend="SECTverifyPRVS"/>.
14097 </para>
14098 </listitem></varlistentry>
14099 <varlistentry>
14100 <term><emphasis role="bold">${prvscheck{</emphasis>&lt;<emphasis>address</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>secret</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
14101 <listitem>
14102 <para>
14103 <indexterm role="concept">
14104 <primary><option>prvscheck</option> expansion item</primary>
14105 </indexterm>
14106 This expansion item is the complement of the <option>prvs</option> item. It is used for
14107 checking prvs-signed addresses. If the expansion of the first argument does not
14108 yield a syntactically valid prvs-signed address, the whole item expands to the
14109 empty string. When the first argument does expand to a syntactically valid
14110 prvs-signed address, the second argument is expanded, with the prvs-decoded
14111 version of the address and the key number extracted from the address in the
14112 variables <varname>$prvscheck_address</varname> and <varname>$prvscheck_keynum</varname>, respectively.
14113 </para>
14114 <para>
14115 These two variables can be used in the expansion of the second argument to
14116 retrieve the secret. The validity of the prvs-signed address is then checked
14117 against the secret. The result is stored in the variable <varname>$prvscheck_result</varname>,
14118 which is empty for failure or <quote>1</quote> for success.
14119 </para>
14120 <para>
14121 The third argument is optional; if it is missing, it defaults to an empty
14122 string. This argument is now expanded. If the result is an empty string, the
14123 result of the expansion is the decoded version of the address. This is the case
14124 whether or not the signature was valid. Otherwise, the result of the expansion
14125 is the expansion of the third argument.
14126 </para>
14127 <para>
14128 All three variables can be used in the expansion of the third argument.
14129 However, once the expansion is complete, only <varname>$prvscheck_result</varname> remains set.
14130 For more discussion and an example, see section <xref linkend="SECTverifyPRVS"/>.
14131 </para>
14132 </listitem></varlistentry>
14133 <varlistentry>
14134 <term><emphasis role="bold">${readfile{</emphasis>&lt;<emphasis>file&nbsp;name</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>eol&nbsp;string</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
14135 <listitem>
14136 <para>
14137 <indexterm role="concept">
14138 <primary>expansion</primary>
14139 <secondary>inserting an entire file</secondary>
14140 </indexterm>
14141 <indexterm role="concept">
14142 <primary>file</primary>
14143 <secondary>inserting into expansion</secondary>
14144 </indexterm>
14145 <indexterm role="concept">
14146 <primary><option>readfile</option> expansion item</primary>
14147 </indexterm>
14148 The file name and end-of-line string are first expanded separately. The file is
14149 then read, and its contents replace the entire item. All newline characters in
14150 the file are replaced by the end-of-line string if it is present. Otherwise,
14151 newlines are left in the string.
14152 String expansion is not applied to the contents of the file. If you want this,
14153 you must wrap the item in an <option>expand</option> operator. If the file cannot be read,
14154 the string expansion fails.
14155 </para>
14156 <para>
14157 The <command>redirect</command> router has an option called <option>forbid_filter_readfile</option> which
14158 locks out the use of this expansion item in filter files.
14159 </para>
14160 </listitem></varlistentry>
14161 <varlistentry>
14162 <term><emphasis role="bold">${readsocket{</emphasis>&lt;<emphasis>name</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>request</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>timeout</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>eol&nbsp;string</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>fail&nbsp;string</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
14163 <listitem>
14164 <para>
14165 <indexterm role="concept">
14166 <primary>expansion</primary>
14167 <secondary>inserting from a socket</secondary>
14168 </indexterm>
14169 <indexterm role="concept">
14170 <primary>socket, use of in expansion</primary>
14171 </indexterm>
14172 <indexterm role="concept">
14173 <primary><option>readsocket</option> expansion item</primary>
14174 </indexterm>
14175 This item inserts data from a Unix domain or Internet socket into the expanded
14176 string. The minimal way of using it uses just two arguments, as in these
14177 examples:
14178 </para>
14179 <literallayout class="monospaced">
14180 ${readsocket{/socket/name}{request string}}
14181 ${readsocket{inet:some.host:1234}{request string}}
14182 </literallayout>
14183 <para>
14184 For a Unix domain socket, the first substring must be the path to the socket.
14185 For an Internet socket, the first substring must contain <literal>inet:</literal> followed by
14186 a host name or IP address, followed by a colon and a port, which can be a
14187 number or the name of a TCP port in <filename>/etc/services</filename>. An IP address may
14188 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
14189 example:
14190 </para>
14191 <literallayout class="monospaced">
14192 ${readsocket{inet:[::1]:1234}{request string}}
14193 </literallayout>
14194 <para>
14195 Only a single host name may be given, but if looking it up yields more than
14196 one IP address, they are each tried in turn until a connection is made. For
14197 both kinds of socket, Exim makes a connection, writes the request string
14198 (unless it is an empty string) and reads from the socket until an end-of-file
14199 is read. A timeout of 5 seconds is applied. Additional, optional arguments
14200 extend what can be done. Firstly, you can vary the timeout. For example:
14201 </para>
14202 <literallayout class="monospaced">
14203 ${readsocket{/socket/name}{request string}{3s}}
14204 </literallayout>
14205 <para>
14206 A fourth argument allows you to change any newlines that are in the data
14207 that is read, in the same way as for <option>readfile</option> (see above). This example
14208 turns them into spaces:
14209 </para>
14210 <literallayout class="monospaced">
14211 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
14212 </literallayout>
14213 <para>
14214 As with all expansions, the substrings are expanded before the processing
14215 happens. Errors in these sub-expansions cause the expansion to fail. In
14216 addition, the following errors can occur:
14217 </para>
14218 <itemizedlist>
14219 <listitem>
14220 <para>
14221 Failure to create a socket file descriptor;
14222 </para>
14223 </listitem>
14224 <listitem>
14225 <para>
14226 Failure to connect the socket;
14227 </para>
14228 </listitem>
14229 <listitem>
14230 <para>
14231 Failure to write the request string;
14232 </para>
14233 </listitem>
14234 <listitem>
14235 <para>
14236 Timeout on reading from the socket.
14237 </para>
14238 </listitem>
14239 </itemizedlist>
14240 <para>
14241 By default, any of these errors causes the expansion to fail. However, if
14242 you supply a fifth substring, it is expanded and used when any of the above
14243 errors occurs. For example:
14244 </para>
14245 <literallayout class="monospaced">
14246 ${readsocket{/socket/name}{request string}{3s}{\n}\
14247   {socket failure}}
14248 </literallayout>
14249 <para>
14250 You can test for the existence of a Unix domain socket by wrapping this
14251 expansion in <literal>${if exists</literal>, but there is a race condition between that test
14252 and the actual opening of the socket, so it is safer to use the fifth argument
14253 if you want to be absolutely sure of avoiding an expansion error for a
14254 non-existent Unix domain socket, or a failure to connect to an Internet socket.
14255 </para>
14256 <para>
14257 The <command>redirect</command> router has an option called <option>forbid_filter_readsocket</option> which
14258 locks out the use of this expansion item in filter files.
14259 </para>
14260 </listitem></varlistentry>
14261 <varlistentry>
14262 <term><emphasis role="bold">${reduce{</emphasis>&lt;<emphasis>string1</emphasis>&gt;}{&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string3</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
14263 <listitem>
14264 <para>
14265 <indexterm role="concept">
14266 <primary>expansion</primary>
14267 <secondary>reducing a list to a scalar</secondary>
14268 </indexterm>
14269 <indexterm role="concept">
14270 <primary>list</primary>
14271 <secondary>reducing to a scalar</secondary>
14272 </indexterm>
14273 <indexterm role="variable">
14274 <primary><varname>$value</varname></primary>
14275 </indexterm>
14276 <indexterm role="variable">
14277 <primary><varname>$item</varname></primary>
14278 </indexterm>
14279 This operation reduces a list to a single, scalar string. After expansion,
14280 &lt;<emphasis>string1</emphasis>&gt; is interpreted as a list, colon-separated by default, but the
14281 separator can be changed in the usual way. Then &lt;<emphasis>string2</emphasis>&gt; is expanded and
14282 assigned to the <varname>$value</varname> variable. After this, each item in the &lt;<emphasis>string1</emphasis>&gt;
14283 list is assigned to <varname>$item</varname> in turn, and &lt;<emphasis>string3</emphasis>&gt; is expanded for each of
14284 them. The result of that expansion is assigned to <varname>$value</varname> before the next
14285 iteration. When the end of the list is reached, the final value of <varname>$value</varname> is
14286 added to the expansion output. The <emphasis role="bold">reduce</emphasis> expansion item can be used in a
14287 number of ways. For example, to add up a list of numbers:
14288 </para>
14289 <literallayout class="monospaced">
14290 ${reduce {&lt;, 1,2,3}{0}{${eval:$value+$item}}}
14291 </literallayout>
14292 <para>
14293 The result of that expansion would be <literal>6</literal>. The maximum of a list of numbers
14294 can be found:
14295 </para>
14296 <literallayout class="monospaced">
14297 ${reduce {3:0:9:4:6}{0}{${if &gt;{$item}{$value}{$item}{$value}}}}
14298 </literallayout>
14299 <para>
14300 At the end of a <emphasis role="bold">reduce</emphasis> expansion, the values of <varname>$item</varname> and <varname>$value</varname> are
14301 restored to what they were before. See also the <emphasis role="bold">filter</emphasis> and <emphasis role="bold">map</emphasis>
14302 expansion items.
14303 </para>
14304 </listitem></varlistentry>
14305 <varlistentry>
14306 <term><emphasis role="bold">$rheader_</emphasis>&lt;<emphasis>header&nbsp;name</emphasis>&gt;<emphasis role="bold">:</emphasis>&nbsp;or&nbsp;<emphasis role="bold">$rh_</emphasis>&lt;<emphasis>header&nbsp;name</emphasis>&gt;<emphasis role="bold">:</emphasis></term>
14307 <listitem>
14308 <para>
14309 This item inserts <quote>raw</quote> header lines. It is described with the <option>header</option>
14310 expansion item above.
14311 </para>
14312 </listitem></varlistentry>
14313 <varlistentry>
14314 <term><emphasis role="bold">${run{</emphasis>&lt;<emphasis>command</emphasis>&gt;<emphasis role="bold">&nbsp;</emphasis>&lt;<emphasis>args</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
14315 <listitem>
14316 <para>
14317 <indexterm role="concept">
14318 <primary>expansion</primary>
14319 <secondary>running a command</secondary>
14320 </indexterm>
14321 <indexterm role="concept">
14322 <primary><option>run</option> expansion item</primary>
14323 </indexterm>
14324 </para>
14325 <para revisionflag="changed">
14326 The command and its arguments are first expanded as one string. The string is
14327 split apart into individual arguments by spaces, and then the command is run
14328 in a separate process, but under the same uid and gid.  As in other command
14329 executions from Exim, a shell is not used by default. If the command requires
14330 a shell, you must explicitly code it.
14331 </para>
14332 <para revisionflag="changed">
14333 Since the arguments are split by spaces, when there is a variable expansion
14334 which has an empty result, it will cause the situation that the argument will
14335 simply be omitted when the program is actually executed by Exim. If the
14336 script/program requires a specific number of arguments and the expanded
14337 variable could possibly result in this empty expansion, the variable must be
14338 quoted. This is more difficult if the expanded variable itself could result
14339 in a string containing quotes, because it would interfere with the quotes
14340 around the command arguments. A possible guard against this is to wrap the
14341 variable in the <option>sg</option> operator to change any quote marks to some other
14342 character.
14343 </para>
14344 <para>
14345 The standard input for the command exists, but is empty. The standard output
14346 and standard error are set to the same file descriptor.
14347 <indexterm role="concept">
14348 <primary>return code</primary>
14349 <secondary>from <option>run</option> expansion</secondary>
14350 </indexterm>
14351 <indexterm role="variable">
14352 <primary><varname>$value</varname></primary>
14353 </indexterm>
14354 If the command succeeds (gives a zero return code) &lt;<emphasis>string1</emphasis>&gt; is expanded
14355 and replaces the entire item; during this expansion, the standard output/error
14356 from the command is in the variable <varname>$value</varname>. If the command fails,
14357 &lt;<emphasis>string2</emphasis>&gt;, if present, is expanded and used. Once again, during the
14358 expansion, the standard output/error from the command is in the variable
14359 <varname>$value</varname>.
14360 </para>
14361 <para>
14362 If &lt;<emphasis>string2</emphasis>&gt; is absent, the result is empty. Alternatively, &lt;<emphasis>string2</emphasis>&gt;
14363 can be the word <quote>fail</quote> (not in braces) to force expansion failure if the
14364 command does not succeed. If both strings are omitted, the result is contents
14365 of the standard output/error on success, and nothing on failure.
14366 </para>
14367 <para>
14368 <indexterm role="variable">
14369 <primary><varname>$run_in_acl</varname></primary>
14370 </indexterm>
14371 The standard output/error of the command is put in the variable <varname>$value</varname>.
14372 In this ACL example, the output of a command is logged for the admin to
14373 troubleshoot:
14374 </para>
14375 <literallayout class="monospaced">
14376 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
14377       log_message  = Output of id: $value
14378 </literallayout>
14379 <para>
14380 If the command requires shell idioms, such as the &gt; redirect operator, the
14381 shell must be invoked directly, such as with:
14382 </para>
14383 <literallayout class="monospaced">
14384 ${run{/bin/bash -c "/usr/bin/id &gt;/tmp/id"}{yes}{yes}}
14385 </literallayout>
14386 <para>
14387 <indexterm role="variable">
14388 <primary><varname>$runrc</varname></primary>
14389 </indexterm>
14390 The return code from the command is put in the variable <varname>$runrc</varname>, and this
14391 remains set afterwards, so in a filter file you can do things like this:
14392 </para>
14393 <literallayout class="monospaced">
14394 if "${run{x y z}{}}$runrc" is 1 then ...
14395   elif $runrc is 2 then ...
14396   ...
14397 endif
14398 </literallayout>
14399 <para>
14400 If execution of the command fails (for example, the command does not exist),
14401 the return code is 127 &ndash; the same code that shells use for non-existent
14402 commands.
14403 </para>
14404 <para>
14405 <emphasis role="bold">Warning</emphasis>: In a router or transport, you cannot assume the order in which
14406 option values are expanded, except for those preconditions whose order of
14407 testing is documented. Therefore, you cannot reliably expect to set <varname>$runrc</varname>
14408 by the expansion of one option, and use it in another.
14409 </para>
14410 <para>
14411 The <command>redirect</command> router has an option called <option>forbid_filter_run</option> which locks
14412 out the use of this expansion item in filter files.
14413 </para>
14414 </listitem></varlistentry>
14415 <varlistentry>
14416 <term><emphasis role="bold">${sg{</emphasis>&lt;<emphasis>subject</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>regex</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>replacement</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
14417 <listitem>
14418 <para>
14419 <indexterm role="concept">
14420 <primary>expansion</primary>
14421 <secondary>string substitution</secondary>
14422 </indexterm>
14423 <indexterm role="concept">
14424 <primary><option>sg</option> expansion item</primary>
14425 </indexterm>
14426 This item works like Perl&#x2019;s substitution operator (s) with the global (/g)
14427 option; hence its name. However, unlike the Perl equivalent, Exim does not
14428 modify the subject string; instead it returns the modified string for insertion
14429 into the overall expansion. The item takes three arguments: the subject string,
14430 a regular expression, and a substitution string. For example:
14431 </para>
14432 <literallayout class="monospaced">
14433 ${sg{abcdefabcdef}{abc}{xyz}}
14434 </literallayout>
14435 <para>
14436 yields <quote>xyzdefxyzdef</quote>. Because all three arguments are expanded before use,
14437 if any $ or \ characters are required in the regular expression or in the
14438 substitution string, they have to be escaped. For example:
14439 </para>
14440 <literallayout class="monospaced">
14441 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
14442 </literallayout>
14443 <para>
14444 yields <quote>defabc</quote>, and
14445 </para>
14446 <literallayout class="monospaced">
14447 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
14448 </literallayout>
14449 <para>
14450 yields <quote>K1=A K4=D K3=C</quote>. Note the use of <literal>\N</literal> to protect the contents of
14451 the regular expression from string expansion.
14452 </para>
14453 </listitem></varlistentry>
14454 <varlistentry>
14455 <term><emphasis role="bold">${substr{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string3</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
14456 <listitem>
14457 <para>
14458 <indexterm role="concept">
14459 <primary><option>substr</option> expansion item</primary>
14460 </indexterm>
14461 <indexterm role="concept">
14462 <primary>substring extraction</primary>
14463 </indexterm>
14464 <indexterm role="concept">
14465 <primary>expansion</primary>
14466 <secondary>substring extraction</secondary>
14467 </indexterm>
14468 The three strings are expanded; the first two must yield numbers. Call them
14469 &lt;<emphasis>n</emphasis>&gt; and &lt;<emphasis>m</emphasis>&gt;. If you are using fixed values for these numbers, that is,
14470 if &lt;<emphasis>string1</emphasis>&gt; and &lt;<emphasis>string2</emphasis>&gt; do not change when they are expanded, you
14471 can use the simpler operator notation that avoids some of the braces:
14472 </para>
14473 <literallayout class="monospaced">
14474 ${substr_&lt;n&gt;_&lt;m&gt;:&lt;string&gt;}
14475 </literallayout>
14476 <para>
14477 The second number is optional (in both notations).
14478 If it is absent in the simpler format, the preceding underscore must also be
14479 omitted.
14480 </para>
14481 <para>
14482 The <option>substr</option> item can be used to extract more general substrings than
14483 <option>length</option>. The first number, &lt;<emphasis>n</emphasis>&gt;, is a starting offset, and &lt;<emphasis>m</emphasis>&gt; is the
14484 length required. For example
14485 </para>
14486 <literallayout class="monospaced">
14487 ${substr{3}{2}{$local_part}}
14488 </literallayout>
14489 <para>
14490 If the starting offset is greater than the string length the result is the
14491 null string; if the length plus starting offset is greater than the string
14492 length, the result is the right-hand part of the string, starting from the
14493 given offset. The first character in the string has offset zero.
14494 </para>
14495 <para>
14496 The <option>substr</option> expansion item can take negative offset values to count
14497 from the right-hand end of its operand. The last character is offset -1, the
14498 second-last is offset -2, and so on. Thus, for example,
14499 </para>
14500 <literallayout class="monospaced">
14501 ${substr{-5}{2}{1234567}}
14502 </literallayout>
14503 <para>
14504 yields <quote>34</quote>. If the absolute value of a negative offset is greater than the
14505 length of the string, the substring starts at the beginning of the string, and
14506 the length is reduced by the amount of overshoot. Thus, for example,
14507 </para>
14508 <literallayout class="monospaced">
14509 ${substr{-5}{2}{12}}
14510 </literallayout>
14511 <para>
14512 yields an empty string, but
14513 </para>
14514 <literallayout class="monospaced">
14515 ${substr{-3}{2}{12}}
14516 </literallayout>
14517 <para>
14518 yields <quote>1</quote>.
14519 </para>
14520 <para>
14521 When the second number is omitted from <option>substr</option>, the remainder of the string
14522 is taken if the offset is positive. If it is negative, all characters in the
14523 string preceding the offset point are taken. For example, an offset of -1 and
14524 no length, as in these semantically identical examples:
14525 </para>
14526 <literallayout class="monospaced">
14527 ${substr_-1:abcde}
14528 ${substr{-1}{abcde}}
14529 </literallayout>
14530 <para>
14531 yields all but the last character of the string, that is, <quote>abcd</quote>.
14532 </para>
14533 </listitem></varlistentry>
14534 <varlistentry>
14535 <term><emphasis role="bold">${tr{</emphasis>&lt;<emphasis>subject</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>characters</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>replacements</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
14536 <listitem>
14537 <para>
14538 <indexterm role="concept">
14539 <primary>expansion</primary>
14540 <secondary>character translation</secondary>
14541 </indexterm>
14542 <indexterm role="concept">
14543 <primary><option>tr</option> expansion item</primary>
14544 </indexterm>
14545 This item does single-character translation on its subject string. The second
14546 argument is a list of characters to be translated in the subject string. Each
14547 matching character is replaced by the corresponding character from the
14548 replacement list. For example
14549 </para>
14550 <literallayout class="monospaced">
14551 ${tr{abcdea}{ac}{13}}
14552 </literallayout>
14553 <para>
14554 yields <literal>1b3de1</literal>. If there are duplicates in the second character string, the
14555 last occurrence is used. If the third string is shorter than the second, its
14556 last character is replicated. However, if it is empty, no translation takes
14557 place.
14558 </para>
14559 </listitem></varlistentry>
14560 </variablelist>
14561 </section>
14562 <section id="SECTexpop">
14563 <title>Expansion operators</title>
14564 <para>
14565 <indexterm role="concept">
14566 <primary>expansion</primary>
14567 <secondary>operators</secondary>
14568 </indexterm>
14569 For expansion items that perform transformations on a single argument string,
14570 the <quote>operator</quote> notation is used because it is simpler and uses fewer braces.
14571 The substring is first expanded before the operation is applied to it. The
14572 following operations can be performed:
14573 </para>
14574 <variablelist>
14575 <varlistentry>
14576 <term><emphasis role="bold">${address:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
14577 <listitem>
14578 <para>
14579 <indexterm role="concept">
14580 <primary>expansion</primary>
14581 <secondary>RFC 2822 address handling</secondary>
14582 </indexterm>
14583 <indexterm role="concept">
14584 <primary><option>address</option> expansion item</primary>
14585 </indexterm>
14586 The string is interpreted as an RFC 2822 address, as it might appear in a
14587 header line, and the effective address is extracted from it. If the string does
14588 not parse successfully, the result is empty.
14589 </para>
14590 </listitem></varlistentry>
14591 <varlistentry>
14592 <term><emphasis role="bold">${addresses:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
14593 <listitem>
14594 <para>
14595 <indexterm role="concept">
14596 <primary>expansion</primary>
14597 <secondary>RFC 2822 address handling</secondary>
14598 </indexterm>
14599 <indexterm role="concept">
14600 <primary><option>addresses</option> expansion item</primary>
14601 </indexterm>
14602 The string (after expansion) is interpreted as a list of addresses in RFC
14603 2822 format, such as can be found in a <emphasis>To:</emphasis> or <emphasis>Cc:</emphasis> header line. The
14604 operative address (<emphasis>local-part@domain</emphasis>) is extracted from each item, and the
14605 result of the expansion is a colon-separated list, with appropriate
14606 doubling of colons should any happen to be present in the email addresses.
14607 Syntactically invalid RFC2822 address items are omitted from the output.
14608 </para>
14609 <para>
14610 It is possible to specify a character other than colon for the output
14611 separator by starting the string with &gt; followed by the new separator
14612 character. For example:
14613 </para>
14614 <literallayout class="monospaced">
14615 ${addresses:&gt;&amp; Chief &lt;ceo@up.stairs&gt;, sec@base.ment (dogsbody)}
14616 </literallayout>
14617 <para>
14618 expands to <literal>ceo@up.stairs&amp;sec@base.ment</literal>. Compare the <emphasis role="bold">address</emphasis> (singular)
14619 expansion item, which extracts the working address from a single RFC2822
14620 address. See the <emphasis role="bold">filter</emphasis>, <emphasis role="bold">map</emphasis>, and <emphasis role="bold">reduce</emphasis> items for ways of
14621 processing lists.
14622 </para>
14623 <para>
14624 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
14625 a strict interpretation of header line formatting.  Exim parses the bare,
14626 unquoted portion of an email address and if it finds a comma, treats it as an
14627 email address seperator. For the example header line:
14628 </para>
14629 <literallayout class="monospaced">
14630 From: =?iso-8859-2?Q?Last=2C_First?= &lt;user@example.com&gt;
14631 </literallayout>
14632 <para>
14633 The first example below demonstrates that Q-encoded email addresses are parsed
14634 properly if it is given the raw header (in this example, <literal>$rheader_from:</literal>).
14635 It does not see the comma because it&#x2019;s still encoded as "=2C".  The second
14636 example below is passed the contents of <literal>$header_from:</literal>, meaning it gets
14637 de-mimed. Exim sees the decoded "," so it treats it as <emphasis role="bold">two</emphasis> email addresses.
14638 The third example shows that the presence of a comma is skipped when it is
14639 quoted.
14640 </para>
14641 <literallayout class="monospaced">
14642 # exim -be '${addresses:From: \
14643 =?iso-8859-2?Q?Last=2C_First?= &lt;user@example.com&gt;}'
14644 user@example.com
14645 # exim -be '${addresses:From: Last, First &lt;user@example.com&gt;}'
14646 Last:user@example.com
14647 # exim -be '${addresses:From: "Last, First" &lt;user@example.com&gt;}'
14648 user@example.com
14649 </literallayout>
14650 </listitem></varlistentry>
14651 <varlistentry>
14652 <term><emphasis role="bold">${base62:</emphasis>&lt;<emphasis>digits</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
14653 <listitem>
14654 <para>
14655 <indexterm role="concept">
14656 <primary><option>base62</option> expansion item</primary>
14657 </indexterm>
14658 <indexterm role="concept">
14659 <primary>expansion</primary>
14660 <secondary>conversion to base 62</secondary>
14661 </indexterm>
14662 The string must consist entirely of decimal digits. The number is converted to
14663 base 62 and output as a string of six characters, including leading zeros. In
14664 the few operating environments where Exim uses base 36 instead of base 62 for
14665 its message identifiers (because those systems do not have case-sensitive file
14666 names), base 36 is used by this operator, despite its name. <emphasis role="bold">Note</emphasis>: Just to
14667 be absolutely clear: this is <emphasis>not</emphasis> base64 encoding.
14668 </para>
14669 </listitem></varlistentry>
14670 <varlistentry>
14671 <term><emphasis role="bold">${base62d:</emphasis>&lt;<emphasis>base-62&nbsp;digits</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
14672 <listitem>
14673 <para>
14674 <indexterm role="concept">
14675 <primary><option>base62d</option> expansion item</primary>
14676 </indexterm>
14677 <indexterm role="concept">
14678 <primary>expansion</primary>
14679 <secondary>conversion to base 62</secondary>
14680 </indexterm>
14681 The string must consist entirely of base-62 digits, or, in operating
14682 environments where Exim uses base 36 instead of base 62 for its message
14683 identifiers, base-36 digits. The number is converted to decimal and output as a
14684 string.
14685 </para>
14686 </listitem></varlistentry>
14687 <varlistentry>
14688 <term><emphasis role="bold">${domain:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
14689 <listitem>
14690 <para>
14691 <indexterm role="concept">
14692 <primary>domain</primary>
14693 <secondary>extraction</secondary>
14694 </indexterm>
14695 <indexterm role="concept">
14696 <primary>expansion</primary>
14697 <secondary>domain extraction</secondary>
14698 </indexterm>
14699 The string is interpreted as an RFC 2822 address and the domain is extracted
14700 from it. If the string does not parse successfully, the result is empty.
14701 </para>
14702 </listitem></varlistentry>
14703 <varlistentry>
14704 <term><emphasis role="bold">${escape:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
14705 <listitem>
14706 <para>
14707 <indexterm role="concept">
14708 <primary>expansion</primary>
14709 <secondary>escaping non-printing characters</secondary>
14710 </indexterm>
14711 <indexterm role="concept">
14712 <primary><option>escape</option> expansion item</primary>
14713 </indexterm>
14714 If the string contains any non-printing characters, they are converted to
14715 escape sequences starting with a backslash. Whether characters with the most
14716 significant bit set (so-called <quote>8-bit characters</quote>) count as printing or not
14717 is controlled by the <option>print_topbitchars</option> option.
14718 </para>
14719 </listitem></varlistentry>
14720 <varlistentry>
14721 <term><emphasis role="bold">${eval:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis>&nbsp;and&nbsp;<emphasis role="bold">${eval10:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
14722 <listitem>
14723 <para>
14724 <indexterm role="concept">
14725 <primary>expansion</primary>
14726 <secondary>expression evaluation</secondary>
14727 </indexterm>
14728 <indexterm role="concept">
14729 <primary>expansion</primary>
14730 <secondary>arithmetic expression</secondary>
14731 </indexterm>
14732 <indexterm role="concept">
14733 <primary><option>eval</option> expansion item</primary>
14734 </indexterm>
14735 These items supports simple arithmetic and bitwise logical operations in
14736 expansion strings. The string (after expansion) must be a conventional
14737 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
14738 logical operators, and parentheses. All operations are carried out using
14739 integer arithmetic. The operator priorities are as follows (the same as in the
14740 C programming language):
14741 </para>
14742 <informaltable frame="none">
14743 <tgroup cols="2" colsep="0" rowsep="0">
14744 <colspec colwidth="70pt" align="left"/>
14745 <colspec colwidth="300pt" align="left"/>
14746 <tbody>
14747 <row>
14748 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<emphasis>highest:</emphasis></entry>
14749 <entry>not (~), negate (-)</entry>
14750 </row>
14751 <row>
14752 <entry>&nbsp;&nbsp;&nbsp;&nbsp;</entry>
14753 <entry>multiply (*), divide (/), remainder (%)</entry>
14754 </row>
14755 <row>
14756 <entry>&nbsp;&nbsp;&nbsp;&nbsp;</entry>
14757 <entry>plus (+), minus (-)</entry>
14758 </row>
14759 <row>
14760 <entry>&nbsp;&nbsp;&nbsp;&nbsp;</entry>
14761 <entry>shift-left (&lt;&lt;), shift-right (&gt;&gt;)</entry>
14762 </row>
14763 <row>
14764 <entry>&nbsp;&nbsp;&nbsp;&nbsp;</entry>
14765 <entry>and (&amp;)</entry>
14766 </row>
14767 <row>
14768 <entry>&nbsp;&nbsp;&nbsp;&nbsp;</entry>
14769 <entry>xor (^)</entry>
14770 </row>
14771 <row>
14772 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<emphasis>lowest:</emphasis></entry>
14773 <entry>or (|)</entry>
14774 </row>
14775 </tbody>
14776 </tgroup>
14777 </informaltable>
14778 <para>
14779 Binary operators with the same priority are evaluated from left to right. White
14780 space is permitted before or after operators.
14781 </para>
14782 <para>
14783 For <option>eval</option>, numbers may be decimal, octal (starting with <quote>0</quote>) or
14784 hexadecimal (starting with <quote>0x</quote>). For <option>eval10</option>, all numbers are taken as
14785 decimal, even if they start with a leading zero; hexadecimal numbers are not
14786 permitted. This can be useful when processing numbers extracted from dates or
14787 times, which often do have leading zeros.
14788 </para>
14789 <para>
14790 A number may be followed by <quote>K</quote>, <quote>M</quote> or <quote>G</quote> to multiply it by 1024, 1024*1024
14791 or 1024*1024*1024,
14792 respectively. Negative numbers are supported. The result of the computation is
14793 a decimal representation of the answer (without <quote>K</quote>, <quote>M</quote> or <quote>G</quote>). For example:
14794 </para>
14795 <literallayout>
14796 <literal>${eval:1+1}            </literal>  yields 2
14797 <literal>${eval:1+2*3}          </literal>  yields 7
14798 <literal>${eval:(1+2)*3}        </literal>  yields 9
14799 <literal>${eval:2+42%5}         </literal>  yields 4
14800 <literal>${eval:0xc&amp;5}          </literal>  yields 4
14801 <literal>${eval:0xc|5}          </literal>  yields 13
14802 <literal>${eval:0xc^5}          </literal>  yields 9
14803 <literal>${eval:0xc&gt;&gt;1}         </literal>  yields 6
14804 <literal>${eval:0xc&lt;&lt;1}         </literal>  yields 24
14805 <literal>${eval:~255&amp;0x1234}    </literal>  yields 4608
14806 <literal>${eval:-(~255&amp;0x1234)} </literal>  yields -4608
14807 </literallayout>
14808 <para>
14809 As a more realistic example, in an ACL you might have
14810 </para>
14811 <literallayout class="monospaced">
14812 deny   message = Too many bad recipients
14813        condition =                    \
14814          ${if and {                   \
14815            {&gt;{$rcpt_count}{10}}       \
14816            {                          \
14817            &lt;                          \
14818              {$recipients_count}      \
14819              {${eval:$rcpt_count/2}}  \
14820            }                          \
14821          }{yes}{no}}
14822 </literallayout>
14823 <para>
14824 The condition is true if there have been more than 10 RCPT commands and
14825 fewer than half of them have resulted in a valid recipient.
14826 </para>
14827 </listitem></varlistentry>
14828 <varlistentry>
14829 <term><emphasis role="bold">${expand:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
14830 <listitem>
14831 <para>
14832 <indexterm role="concept">
14833 <primary>expansion</primary>
14834 <secondary>re-expansion of substring</secondary>
14835 </indexterm>
14836 The <option>expand</option> operator causes a string to be expanded for a second time. For
14837 example,
14838 </para>
14839 <literallayout class="monospaced">
14840 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
14841 </literallayout>
14842 <para>
14843 first looks up a string in a file while expanding the operand for <option>expand</option>,
14844 and then re-expands what it has found.
14845 </para>
14846 </listitem></varlistentry>
14847 <varlistentry>
14848 <term><emphasis role="bold">${from_utf8:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
14849 <listitem>
14850 <para>
14851 <indexterm role="concept">
14852 <primary>Unicode</primary>
14853 </indexterm>
14854 <indexterm role="concept">
14855 <primary>UTF-8</primary>
14856 <secondary>conversion from</secondary>
14857 </indexterm>
14858 <indexterm role="concept">
14859 <primary>expansion</primary>
14860 <secondary>UTF-8 conversion</secondary>
14861 </indexterm>
14862 <indexterm role="concept">
14863 <primary><option>from_utf8</option> expansion item</primary>
14864 </indexterm>
14865 The world is slowly moving towards Unicode, although there are no standards for
14866 email yet. However, other applications (including some databases) are starting
14867 to store data in Unicode, using UTF-8 encoding. This operator converts from a
14868 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
14869 converted to underscores. The input must be a valid UTF-8 string. If it is not,
14870 the result is an undefined sequence of bytes.
14871 </para>
14872 <para>
14873 Unicode code points with values less than 256 are compatible with ASCII and
14874 ISO-8859-1 (also known as Latin-1).
14875 For example, character 169 is the copyright symbol in both cases, though the
14876 way it is encoded is different. In UTF-8, more than one byte is needed for
14877 characters with code values greater than 127, whereas ISO-8859-1 is a
14878 single-byte encoding (but thereby limited to 256 characters). This makes
14879 translation from UTF-8 to ISO-8859-1 straightforward.
14880 </para>
14881 </listitem></varlistentry>
14882 <varlistentry>
14883 <term><emphasis role="bold">${hash_</emphasis>&lt;<emphasis>n</emphasis>&gt;<emphasis role="bold">_</emphasis>&lt;<emphasis>m</emphasis>&gt;<emphasis role="bold">:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
14884 <listitem>
14885 <para>
14886 <indexterm role="concept">
14887 <primary>hash function</primary>
14888 <secondary>textual</secondary>
14889 </indexterm>
14890 <indexterm role="concept">
14891 <primary>expansion</primary>
14892 <secondary>textual hash</secondary>
14893 </indexterm>
14894 The <option>hash</option> operator is a simpler interface to the hashing function that can
14895 be used when the two parameters are fixed numbers (as opposed to strings that
14896 change when expanded). The effect is the same as
14897 </para>
14898 <literallayout class="monospaced">
14899 ${hash{&lt;n&gt;}{&lt;m&gt;}{&lt;string&gt;}}
14900 </literallayout>
14901 <para>
14902 See the description of the general <option>hash</option> item above for details. The
14903 abbreviation <option>h</option> can be used when <option>hash</option> is used as an operator.
14904 </para>
14905 </listitem></varlistentry>
14906 <varlistentry>
14907 <term><emphasis role="bold">${hex2b64:</emphasis>&lt;<emphasis>hexstring</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
14908 <listitem>
14909 <para>
14910 <indexterm role="concept">
14911 <primary>base64 encoding</primary>
14912 <secondary>conversion from hex</secondary>
14913 </indexterm>
14914 <indexterm role="concept">
14915 <primary>expansion</primary>
14916 <secondary>hex to base64</secondary>
14917 </indexterm>
14918 <indexterm role="concept">
14919 <primary><option>hex2b64</option> expansion item</primary>
14920 </indexterm>
14921 This operator converts a hex string into one that is base64 encoded. This can
14922 be useful for processing the output of the MD5 and SHA-1 hashing functions.
14923 </para>
14924 </listitem></varlistentry>
14925 <varlistentry>
14926 <term><emphasis role="bold">${hexquote:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
14927 <listitem>
14928 <para>
14929 <indexterm role="concept">
14930 <primary>quoting</primary>
14931 <secondary>hex-encoded unprintable characters</secondary>
14932 </indexterm>
14933 <indexterm role="concept">
14934 <primary><option>hexquote</option> expansion item</primary>
14935 </indexterm>
14936 This operator converts non-printable characters in a string into a hex
14937 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
14938 as is, and other byte values are converted to <literal>\xNN</literal>, for example a
14939 byte value 127 is converted to <literal>\x7f</literal>.
14940 </para>
14941 </listitem></varlistentry>
14942 <varlistentry>
14943 <term><emphasis role="bold">${lc:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
14944 <listitem>
14945 <para>
14946 <indexterm role="concept">
14947 <primary>case forcing in strings</primary>
14948 </indexterm>
14949 <indexterm role="concept">
14950 <primary>string</primary>
14951 <secondary>case forcing</secondary>
14952 </indexterm>
14953 <indexterm role="concept">
14954 <primary>lower casing</primary>
14955 </indexterm>
14956 <indexterm role="concept">
14957 <primary>expansion</primary>
14958 <secondary>case forcing</secondary>
14959 </indexterm>
14960 <indexterm role="concept">
14961 <primary><option>lc</option> expansion item</primary>
14962 </indexterm>
14963 This forces the letters in the string into lower-case, for example:
14964 </para>
14965 <literallayout class="monospaced">
14966 ${lc:$local_part}
14967 </literallayout>
14968 </listitem></varlistentry>
14969 <varlistentry>
14970 <term><emphasis role="bold">${length_</emphasis>&lt;<emphasis>number</emphasis>&gt;<emphasis role="bold">:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
14971 <listitem>
14972 <para>
14973 <indexterm role="concept">
14974 <primary>expansion</primary>
14975 <secondary>string truncation</secondary>
14976 </indexterm>
14977 <indexterm role="concept">
14978 <primary><option>length</option> expansion item</primary>
14979 </indexterm>
14980 The <option>length</option> operator is a simpler interface to the <option>length</option> function that
14981 can be used when the parameter is a fixed number (as opposed to a string that
14982 changes when expanded). The effect is the same as
14983 </para>
14984 <literallayout class="monospaced">
14985 ${length{&lt;number&gt;}{&lt;string&gt;}}
14986 </literallayout>
14987 <para>
14988 See the description of the general <option>length</option> item above for details. Note that
14989 <option>length</option> is not the same as <option>strlen</option>. The abbreviation <option>l</option> can be used
14990 when <option>length</option> is used as an operator.
14991 </para>
14992 </listitem></varlistentry>
14993 <varlistentry>
14994 <term><emphasis role="bold">${listcount:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
14995 <listitem>
14996 <para>
14997 <indexterm role="concept">
14998 <primary>expansion</primary>
14999 <secondary>list item count</secondary>
15000 </indexterm>
15001 <indexterm role="concept">
15002 <primary>list</primary>
15003 <secondary>item count</secondary>
15004 </indexterm>
15005 <indexterm role="concept">
15006 <primary>list</primary>
15007 <secondary>count of items</secondary>
15008 </indexterm>
15009 <indexterm role="concept">
15010 <primary><option>listcount</option> expansion item</primary>
15011 </indexterm>
15012 The string is interpreted as a list and the number of items is returned.
15013 </para>
15014 </listitem></varlistentry>
15015 <varlistentry>
15016 <term><emphasis role="bold">${listnamed:</emphasis>&lt;<emphasis>name</emphasis>&gt;<emphasis role="bold">}</emphasis>&nbsp;and&nbsp;<emphasis role="bold">${listnamed_</emphasis>&lt;<emphasis>type</emphasis>&gt;<emphasis role="bold">:</emphasis>&lt;<emphasis>name</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15017 <listitem>
15018 <para>
15019 <indexterm role="concept">
15020 <primary>expansion</primary>
15021 <secondary>named list</secondary>
15022 </indexterm>
15023 <indexterm role="concept">
15024 <primary><option>listnamed</option> expansion item</primary>
15025 </indexterm>
15026 The name is interpreted as a named list and the content of the list is returned,
15027 expanding any referenced lists, re-quoting as needed for colon-separation.
15028 If the optional type is given it must be one of "a", "d", "h" or "l"
15029 and selects address-, domain-, host- or localpart- lists to search among respectively.
15030 Otherwise all types are searched in an undefined order and the first
15031 matching list is returned.
15032 </para>
15033 </listitem></varlistentry>
15034 <varlistentry>
15035 <term><emphasis role="bold">${local_part:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15036 <listitem>
15037 <para>
15038 <indexterm role="concept">
15039 <primary>expansion</primary>
15040 <secondary>local part extraction</secondary>
15041 </indexterm>
15042 <indexterm role="concept">
15043 <primary><option>local_part</option> expansion item</primary>
15044 </indexterm>
15045 The string is interpreted as an RFC 2822 address and the local part is
15046 extracted from it. If the string does not parse successfully, the result is
15047 empty.
15048 </para>
15049 </listitem></varlistentry>
15050 <varlistentry>
15051 <term><emphasis role="bold">${mask:</emphasis>&lt;<emphasis>IP&nbsp;address</emphasis>&gt;<emphasis role="bold">/</emphasis>&lt;<emphasis>bit&nbsp;count</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15052 <listitem>
15053 <para>
15054 <indexterm role="concept">
15055 <primary>masked IP address</primary>
15056 </indexterm>
15057 <indexterm role="concept">
15058 <primary>IP address</primary>
15059 <secondary>masking</secondary>
15060 </indexterm>
15061 <indexterm role="concept">
15062 <primary>CIDR notation</primary>
15063 </indexterm>
15064 <indexterm role="concept">
15065 <primary>expansion</primary>
15066 <secondary>IP address masking</secondary>
15067 </indexterm>
15068 <indexterm role="concept">
15069 <primary><option>mask</option> expansion item</primary>
15070 </indexterm>
15071 If the form of the string to be operated on is not an IP address followed by a
15072 slash and an integer (that is, a network address in CIDR notation), the
15073 expansion fails. Otherwise, this operator converts the IP address to binary,
15074 masks off the least significant bits according to the bit count, and converts
15075 the result back to text, with mask appended. For example,
15076 </para>
15077 <literallayout class="monospaced">
15078 ${mask:10.111.131.206/28}
15079 </literallayout>
15080 <para>
15081 returns the string <quote>10.111.131.192/28</quote>. Since this operation is expected to
15082 be mostly used for looking up masked addresses in files, the result for an IPv6
15083 address uses dots to separate components instead of colons, because colon
15084 terminates a key string in lsearch files. So, for example,
15085 </para>
15086 <literallayout class="monospaced">
15087 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
15088 </literallayout>
15089 <para>
15090 returns the string
15091 </para>
15092 <literallayout class="monospaced">
15093 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
15094 </literallayout>
15095 <para>
15096 Letters in IPv6 addresses are always output in lower case.
15097 </para>
15098 </listitem></varlistentry>
15099 <varlistentry>
15100 <term><emphasis role="bold">${md5:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15101 <listitem>
15102 <para>
15103 <indexterm role="concept">
15104 <primary>MD5 hash</primary>
15105 </indexterm>
15106 <indexterm role="concept">
15107 <primary>expansion</primary>
15108 <secondary>MD5 hash</secondary>
15109 </indexterm>
15110 <indexterm role="concept">
15111 <primary>certificate fingerprint</primary>
15112 </indexterm>
15113 <indexterm role="concept">
15114 <primary><option>md5</option> expansion item</primary>
15115 </indexterm>
15116 The <option>md5</option> operator computes the MD5 hash value of the string, and returns it
15117 as a 32-digit hexadecimal number, in which any letters are in lower case.
15118 </para>
15119 </listitem></varlistentry>
15120 <varlistentry>
15121 <term><emphasis role="bold">${nhash_</emphasis>&lt;<emphasis>n</emphasis>&gt;<emphasis role="bold">_</emphasis>&lt;<emphasis>m</emphasis>&gt;<emphasis role="bold">:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15122 <listitem>
15123 <para>
15124 <indexterm role="concept">
15125 <primary>expansion</primary>
15126 <secondary>numeric hash</secondary>
15127 </indexterm>
15128 <indexterm role="concept">
15129 <primary>hash function</primary>
15130 <secondary>numeric</secondary>
15131 </indexterm>
15132 The <option>nhash</option> operator is a simpler interface to the numeric hashing function
15133 that can be used when the two parameters are fixed numbers (as opposed to
15134 strings that change when expanded). The effect is the same as
15135 </para>
15136 <literallayout class="monospaced">
15137 ${nhash{&lt;n&gt;}{&lt;m&gt;}{&lt;string&gt;}}
15138 </literallayout>
15139 <para>
15140 See the description of the general <option>nhash</option> item above for details.
15141 </para>
15142 </listitem></varlistentry>
15143 <varlistentry>
15144 <term><emphasis role="bold">${quote:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15145 <listitem>
15146 <para>
15147 <indexterm role="concept">
15148 <primary>quoting</primary>
15149 <secondary>in string expansions</secondary>
15150 </indexterm>
15151 <indexterm role="concept">
15152 <primary>expansion</primary>
15153 <secondary>quoting</secondary>
15154 </indexterm>
15155 <indexterm role="concept">
15156 <primary><option>quote</option> expansion item</primary>
15157 </indexterm>
15158 The <option>quote</option> operator puts its argument into double quotes if it
15159 is an empty string or
15160 contains anything other than letters, digits, underscores, dots, and hyphens.
15161 Any occurrences of double quotes and backslashes are escaped with a backslash.
15162 Newlines and carriage returns are converted to <literal>\n</literal> and <literal>\r</literal>,
15163 respectively For example,
15164 </para>
15165 <literallayout class="monospaced">
15166 ${quote:ab"*"cd}
15167 </literallayout>
15168 <para>
15169 becomes
15170 </para>
15171 <literallayout class="monospaced">
15172 "ab\"*\"cd"
15173 </literallayout>
15174 <para>
15175 The place where this is useful is when the argument is a substitution from a
15176 variable or a message header.
15177 </para>
15178 </listitem></varlistentry>
15179 <varlistentry>
15180 <term><emphasis role="bold">${quote_local_part:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15181 <listitem>
15182 <para>
15183 <indexterm role="concept">
15184 <primary><option>quote_local_part</option> expansion item</primary>
15185 </indexterm>
15186 This operator is like <option>quote</option>, except that it quotes the string only if
15187 required to do so by the rules of RFC 2822 for quoting local parts. For
15188 example, a plus sign would not cause quoting (but it would for <option>quote</option>).
15189 If you are creating a new email address from the contents of <varname>$local_part</varname>
15190 (or any other unknown data), you should always use this operator.
15191 </para>
15192 </listitem></varlistentry>
15193 <varlistentry>
15194 <term><emphasis role="bold">${quote_</emphasis>&lt;<emphasis>lookup-type</emphasis>&gt;<emphasis role="bold">:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15195 <listitem>
15196 <para>
15197 <indexterm role="concept">
15198 <primary>quoting</primary>
15199 <secondary>lookup-specific</secondary>
15200 </indexterm>
15201 This operator applies lookup-specific quoting rules to the string. Each
15202 query-style lookup type has its own quoting rules which are described with
15203 the lookups in chapter <xref linkend="CHAPfdlookup"/>. For example,
15204 </para>
15205 <literallayout class="monospaced">
15206 ${quote_ldap:two * two}
15207 </literallayout>
15208 <para>
15209 returns
15210 </para>
15211 <literallayout class="monospaced">
15212 two%20%5C2A%20two
15213 </literallayout>
15214 <para>
15215 For single-key lookup types, no quoting is ever necessary and this operator
15216 yields an unchanged string.
15217 </para>
15218 </listitem></varlistentry>
15219 <varlistentry>
15220 <term><emphasis role="bold">${randint:</emphasis>&lt;<emphasis>n</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15221 <listitem>
15222 <para>
15223 <indexterm role="concept">
15224 <primary>random number</primary>
15225 </indexterm>
15226 This operator returns a somewhat random number which is less than the
15227 supplied number and is at least 0.  The quality of this randomness depends
15228 on how Exim was built; the values are not suitable for keying material.
15229 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
15230 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
15231 for versions of GnuTLS with that function.
15232 Otherwise, the implementation may be arc4random(), random() seeded by
15233 srandomdev() or srandom(), or a custom implementation even weaker than
15234 random().
15235 </para>
15236 </listitem></varlistentry>
15237 <varlistentry>
15238 <term><emphasis role="bold">${reverse_ip:</emphasis>&lt;<emphasis>ipaddr</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15239 <listitem>
15240 <para>
15241 <indexterm role="concept">
15242 <primary>expansion</primary>
15243 <secondary>IP address</secondary>
15244 </indexterm>
15245 This operator reverses an IP address; for IPv4 addresses, the result is in
15246 dotted-quad decimal form, while for IPv6 addreses the result is in
15247 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
15248 for DNS.  For example,
15249 </para>
15250 <literallayout class="monospaced">
15251 ${reverse_ip:192.0.2.4}
15252 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
15253 </literallayout>
15254 <para>
15255 returns
15256 </para>
15257 <literallayout class="monospaced">
15258 4.2.0.192
15259 f.7.2.0.0.0.0.c.d.c.b.a.1.0.0.0.9.0.0.0.2.4.c.0.8.b.d.0.1.0.0.2
15260 </literallayout>
15261 </listitem></varlistentry>
15262 <varlistentry>
15263 <term><emphasis role="bold">${rfc2047:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15264 <listitem>
15265 <para>
15266 <indexterm role="concept">
15267 <primary>expansion</primary>
15268 <secondary>RFC 2047</secondary>
15269 </indexterm>
15270 <indexterm role="concept">
15271 <primary>RFC 2047</primary>
15272 <secondary>expansion operator</secondary>
15273 </indexterm>
15274 <indexterm role="concept">
15275 <primary><option>rfc2047</option> expansion item</primary>
15276 </indexterm>
15277 This operator encodes text according to the rules of RFC 2047. This is an
15278 encoding that is used in header lines to encode non-ASCII characters. It is
15279 assumed that the input string is in the encoding specified by the
15280 <option>headers_charset</option> option, which defaults to ISO-8859-1. If the string
15281 contains only characters in the range 33&ndash;126, and no instances of the
15282 characters
15283 </para>
15284 <literallayout class="monospaced">
15285 ? = ( ) &lt; &gt; @ , ; : \ " . [ ] _
15286 </literallayout>
15287 <para>
15288 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
15289 string, using as many <quote>encoded words</quote> as necessary to encode all the
15290 characters.
15291 </para>
15292 </listitem></varlistentry>
15293 <varlistentry>
15294 <term><emphasis role="bold">${rfc2047d:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15295 <listitem>
15296 <para>
15297 <indexterm role="concept">
15298 <primary>expansion</primary>
15299 <secondary>RFC 2047</secondary>
15300 </indexterm>
15301 <indexterm role="concept">
15302 <primary>RFC 2047</primary>
15303 <secondary>decoding</secondary>
15304 </indexterm>
15305 <indexterm role="concept">
15306 <primary><option>rfc2047d</option> expansion item</primary>
15307 </indexterm>
15308 This operator decodes strings that are encoded as per RFC 2047. Binary zero
15309 bytes are replaced by question marks. Characters are converted into the
15310 character set defined by <option>headers_charset</option>. Overlong RFC 2047 <quote>words</quote> are
15311 not recognized unless <option>check_rfc2047_length</option> is set false.
15312 </para>
15313 <para>
15314 <emphasis role="bold">Note</emphasis>: If you use <option>$header</option>_<emphasis>xxx</emphasis><emphasis role="bold">:</emphasis> (or <option>$h</option>_<emphasis>xxx</emphasis><emphasis role="bold">:</emphasis>) to
15315 access a header line, RFC 2047 decoding is done automatically. You do not need
15316 to use this operator as well.
15317 </para>
15318 </listitem></varlistentry>
15319 <varlistentry>
15320 <term><emphasis role="bold">${rxquote:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15321 <listitem>
15322 <para>
15323 <indexterm role="concept">
15324 <primary>quoting</primary>
15325 <secondary>in regular expressions</secondary>
15326 </indexterm>
15327 <indexterm role="concept">
15328 <primary>regular expressions</primary>
15329 <secondary>quoting</secondary>
15330 </indexterm>
15331 <indexterm role="concept">
15332 <primary><option>rxquote</option> expansion item</primary>
15333 </indexterm>
15334 The <option>rxquote</option> operator inserts a backslash before any non-alphanumeric
15335 characters in its argument. This is useful when substituting the values of
15336 variables or headers inside regular expressions.
15337 </para>
15338 </listitem></varlistentry>
15339 <varlistentry>
15340 <term><emphasis role="bold">${sha1:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15341 <listitem>
15342 <para>
15343 <indexterm role="concept">
15344 <primary>SHA-1 hash</primary>
15345 </indexterm>
15346 <indexterm role="concept">
15347 <primary>expansion</primary>
15348 <secondary>SHA-1 hashing</secondary>
15349 </indexterm>
15350 <indexterm role="concept">
15351 <primary>certificate fingerprint</primary>
15352 </indexterm>
15353 <indexterm role="concept">
15354 <primary><option>sha2</option> expansion item</primary>
15355 </indexterm>
15356 The <option>sha1</option> operator computes the SHA-1 hash value of the string, and returns
15357 it as a 40-digit hexadecimal number, in which any letters are in upper case.
15358 </para>
15359 </listitem></varlistentry>
15360 <varlistentry>
15361 <term><emphasis role="bold">${sha256:</emphasis>&lt;<emphasis>certificate</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15362 <listitem>
15363 <para>
15364 <indexterm role="concept">
15365 <primary>SHA-256 hash</primary>
15366 </indexterm>
15367 <indexterm role="concept">
15368 <primary>certificate fingerprint</primary>
15369 </indexterm>
15370 <indexterm role="concept">
15371 <primary>expansion</primary>
15372 <secondary>SHA-256 hashing</secondary>
15373 </indexterm>
15374 <indexterm role="concept">
15375 <primary><option>sha256</option> expansion item</primary>
15376 </indexterm>
15377 The <option>sha256</option> operator computes the SHA-256 hash fingerprint of the
15378 certificate,
15379 and returns
15380 it as a 64-digit hexadecimal number, in which any letters are in upper case.
15381 Only arguments which are a single variable of certificate type are supported.
15382 </para>
15383 </listitem></varlistentry>
15384 <varlistentry>
15385 <term><emphasis role="bold">${stat:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15386 <listitem>
15387 <para>
15388 <indexterm role="concept">
15389 <primary>expansion</primary>
15390 <secondary>statting a file</secondary>
15391 </indexterm>
15392 <indexterm role="concept">
15393 <primary>file</primary>
15394 <secondary>extracting characteristics</secondary>
15395 </indexterm>
15396 <indexterm role="concept">
15397 <primary><option>stat</option> expansion item</primary>
15398 </indexterm>
15399 The string, after expansion, must be a file path. A call to the <function>stat()</function>
15400 function is made for this path. If <function>stat()</function> fails, an error occurs and the
15401 expansion fails. If it succeeds, the data from the stat replaces the item, as a
15402 series of &lt;<emphasis>name</emphasis>&gt;=&lt;<emphasis>value</emphasis>&gt; pairs, where the values are all numerical,
15403 except for the value of <quote>smode</quote>. The names are: <quote>mode</quote> (giving the mode as
15404 a 4-digit octal number), <quote>smode</quote> (giving the mode in symbolic format as a
15405 10-character string, as for the <emphasis>ls</emphasis> command), <quote>inode</quote>, <quote>device</quote>,
15406 <quote>links</quote>, <quote>uid</quote>, <quote>gid</quote>, <quote>size</quote>, <quote>atime</quote>, <quote>mtime</quote>, and <quote>ctime</quote>. You
15407 can extract individual fields using the <option>extract</option> expansion item.
15408 </para>
15409 <para>
15410 The use of the <option>stat</option> expansion in users&#x2019; filter files can be locked out by
15411 the system administrator. <emphasis role="bold">Warning</emphasis>: The file size may be incorrect on 32-bit
15412 systems for files larger than 2GB.
15413 </para>
15414 </listitem></varlistentry>
15415 <varlistentry>
15416 <term><emphasis role="bold">${str2b64:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15417 <listitem>
15418 <para>
15419 <indexterm role="concept">
15420 <primary>expansion</primary>
15421 <secondary>base64 encoding</secondary>
15422 </indexterm>
15423 <indexterm role="concept">
15424 <primary>base64 encoding</primary>
15425 <secondary>in string expansion</secondary>
15426 </indexterm>
15427 <indexterm role="concept">
15428 <primary><option>str2b64</option> expansion item</primary>
15429 </indexterm>
15430 This operator converts a string into one that is base64 encoded.
15431 </para>
15432 </listitem></varlistentry>
15433 <varlistentry>
15434 <term><emphasis role="bold">${strlen:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15435 <listitem>
15436 <para>
15437 <indexterm role="concept">
15438 <primary>expansion</primary>
15439 <secondary>string length</secondary>
15440 </indexterm>
15441 <indexterm role="concept">
15442 <primary>string</primary>
15443 <secondary>length in expansion</secondary>
15444 </indexterm>
15445 <indexterm role="concept">
15446 <primary><option>strlen</option> expansion item</primary>
15447 </indexterm>
15448 The item is replace by the length of the expanded string, expressed as a
15449 decimal number. <emphasis role="bold">Note</emphasis>: Do not confuse <option>strlen</option> with <option>length</option>.
15450 </para>
15451 </listitem></varlistentry>
15452 <varlistentry>
15453 <term><emphasis role="bold">${substr_</emphasis>&lt;<emphasis>start</emphasis>&gt;<emphasis role="bold">_</emphasis>&lt;<emphasis>length</emphasis>&gt;<emphasis role="bold">:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15454 <listitem>
15455 <para>
15456 <indexterm role="concept">
15457 <primary><option>substr</option> expansion item</primary>
15458 </indexterm>
15459 <indexterm role="concept">
15460 <primary>substring extraction</primary>
15461 </indexterm>
15462 <indexterm role="concept">
15463 <primary>expansion</primary>
15464 <secondary>substring expansion</secondary>
15465 </indexterm>
15466 The <option>substr</option> operator is a simpler interface to the <option>substr</option> function that
15467 can be used when the two parameters are fixed numbers (as opposed to strings
15468 that change when expanded). The effect is the same as
15469 </para>
15470 <literallayout class="monospaced">
15471 ${substr{&lt;start&gt;}{&lt;length&gt;}{&lt;string&gt;}}
15472 </literallayout>
15473 <para>
15474 See the description of the general <option>substr</option> item above for details. The
15475 abbreviation <option>s</option> can be used when <option>substr</option> is used as an operator.
15476 </para>
15477 </listitem></varlistentry>
15478 <varlistentry>
15479 <term><emphasis role="bold">${time_eval:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15480 <listitem>
15481 <para>
15482 <indexterm role="concept">
15483 <primary><option>time_eval</option> expansion item</primary>
15484 </indexterm>
15485 <indexterm role="concept">
15486 <primary>time interval</primary>
15487 <secondary>decoding</secondary>
15488 </indexterm>
15489 This item converts an Exim time interval such as <literal>2d4h5m</literal> into a number of
15490 seconds.
15491 </para>
15492 </listitem></varlistentry>
15493 <varlistentry>
15494 <term><emphasis role="bold">${time_interval:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15495 <listitem>
15496 <para>
15497 <indexterm role="concept">
15498 <primary><option>time_interval</option> expansion item</primary>
15499 </indexterm>
15500 <indexterm role="concept">
15501 <primary>time interval</primary>
15502 <secondary>formatting</secondary>
15503 </indexterm>
15504 The argument (after sub-expansion) must be a sequence of decimal digits that
15505 represents an interval of time as a number of seconds. It is converted into a
15506 number of larger units and output in Exim&#x2019;s normal time format, for example,
15507 <literal>1w3d4h2m6s</literal>.
15508 </para>
15509 </listitem></varlistentry>
15510 <varlistentry>
15511 <term><emphasis role="bold">${uc:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15512 <listitem>
15513 <para>
15514 <indexterm role="concept">
15515 <primary>case forcing in strings</primary>
15516 </indexterm>
15517 <indexterm role="concept">
15518 <primary>string</primary>
15519 <secondary>case forcing</secondary>
15520 </indexterm>
15521 <indexterm role="concept">
15522 <primary>upper casing</primary>
15523 </indexterm>
15524 <indexterm role="concept">
15525 <primary>expansion</primary>
15526 <secondary>case forcing</secondary>
15527 </indexterm>
15528 <indexterm role="concept">
15529 <primary><option>uc</option> expansion item</primary>
15530 </indexterm>
15531 This forces the letters in the string into upper-case.
15532 </para>
15533 </listitem></varlistentry>
15534 <varlistentry>
15535 <term><emphasis role="bold">${utf8clean:</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15536 <listitem>
15537 <para>
15538 <indexterm role="concept">
15539 <primary>correction of invalid utf-8 sequences in strings</primary>
15540 </indexterm>
15541 <indexterm role="concept">
15542 <primary>utf-8</primary>
15543 <secondary>utf-8 sequences</secondary>
15544 </indexterm>
15545 <indexterm role="concept">
15546 <primary>incorrect utf-8</primary>
15547 </indexterm>
15548 <indexterm role="concept">
15549 <primary>expansion</primary>
15550 <secondary>utf-8 forcing</secondary>
15551 </indexterm>
15552 <indexterm role="concept">
15553 <primary><option>utf8clean</option> expansion item</primary>
15554 </indexterm>
15555 This replaces any invalid utf-8 sequence in the string by the character <literal>?</literal>.
15556 </para>
15557 </listitem></varlistentry>
15558 </variablelist>
15559 </section>
15560 <section id="SECTexpcond">
15561 <title>Expansion conditions</title>
15562 <para>
15563 <indexterm role="concept" id="IIDexpcond" class="startofrange">
15564 <primary>expansion</primary>
15565 <secondary>conditions</secondary>
15566 </indexterm>
15567 The following conditions are available for testing by the <option>${if</option> construct
15568 while expanding strings:
15569 </para>
15570 <variablelist>
15571 <varlistentry>
15572 <term><emphasis role="bold">!</emphasis>&lt;<emphasis>condition</emphasis>&gt;</term>
15573 <listitem>
15574 <para>
15575 <indexterm role="concept">
15576 <primary>expansion</primary>
15577 <secondary>negating a condition</secondary>
15578 </indexterm>
15579 <indexterm role="concept">
15580 <primary>negation</primary>
15581 <secondary>in expansion condition</secondary>
15582 </indexterm>
15583 Preceding any condition with an exclamation mark negates the result of the
15584 condition.
15585 </para>
15586 </listitem></varlistentry>
15587 <varlistentry>
15588 <term>&lt;<emphasis>symbolic&nbsp;operator</emphasis>&gt;&nbsp;<emphasis role="bold">{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15589 <listitem>
15590 <para>
15591 <indexterm role="concept">
15592 <primary>numeric comparison</primary>
15593 </indexterm>
15594 <indexterm role="concept">
15595 <primary>expansion</primary>
15596 <secondary>numeric comparison</secondary>
15597 </indexterm>
15598 There are a number of symbolic operators for doing numeric comparisons. They
15599 are:
15600 </para>
15601 <literallayout>
15602 <literal>=   </literal>   equal
15603 <literal>==  </literal>   equal
15604 <literal>&gt;   </literal>   greater
15605 <literal>&gt;=  </literal>   greater or equal
15606 <literal>&lt;   </literal>   less
15607 <literal>&lt;=  </literal>   less or equal
15608 </literallayout>
15609 <para>
15610 For example:
15611 </para>
15612 <literallayout class="monospaced">
15613 ${if &gt;{$message_size}{10M} ...
15614 </literallayout>
15615 <para>
15616 Note that the general negation operator provides for inequality testing. The
15617 two strings must take the form of optionally signed decimal integers,
15618 optionally followed by one of the letters <quote>K</quote>, <quote>M</quote> or <quote>G</quote> (in either upper or
15619 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
15620 As a special case, the numerical value of an empty string is taken as
15621 zero.
15622 </para>
15623 <para>
15624 In all cases, a relative comparator OP is testing if &lt;<emphasis>string1</emphasis>&gt; OP
15625 &lt;<emphasis>string2</emphasis>&gt;; the above example is checking if <varname>$message_size</varname> is larger than
15626 10M, not if 10M is larger than <varname>$message_size</varname>.
15627 </para>
15628 </listitem></varlistentry>
15629 <varlistentry>
15630 <term><emphasis role="bold">acl&nbsp;{{</emphasis>&lt;<emphasis>name</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>arg1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>arg2</emphasis>&gt;<emphasis role="bold">}...}</emphasis></term>
15631 <listitem>
15632 <para>
15633 <indexterm role="concept">
15634 <primary>expansion</primary>
15635 <secondary>calling an acl</secondary>
15636 </indexterm>
15637 <indexterm role="concept">
15638 <primary><option>acl</option></primary>
15639 <secondary>expansion condition</secondary>
15640 </indexterm>
15641 The name and zero to nine argument strings are first expanded separately.  The expanded
15642 arguments are assigned to the variables <varname>$acl_arg1</varname> to <varname>$acl_arg9</varname> in order.
15643 Any unused are made empty.  The variable <varname>$acl_narg</varname> is set to the number of
15644 arguments.  The named ACL (see chapter <xref linkend="CHAPACL"/>) is called
15645 and may use the variables; if another acl expansion is used the values
15646 are restored after it returns.  If the ACL sets
15647 a value using a "message =" modifier the variable $value becomes
15648 the result of the expansion, otherwise it is empty.
15649 If the ACL returns accept the condition is true; if deny, false.
15650 If the ACL returns defer the result is a forced-fail.
15651 </para>
15652 </listitem></varlistentry>
15653 <varlistentry>
15654 <term><emphasis role="bold">bool&nbsp;{</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15655 <listitem>
15656 <para>
15657 <indexterm role="concept">
15658 <primary>expansion</primary>
15659 <secondary>boolean parsing</secondary>
15660 </indexterm>
15661 <indexterm role="concept">
15662 <primary><option>bool</option> expansion condition</primary>
15663 </indexterm>
15664 This condition turns a string holding a true or false representation into
15665 a boolean state.  It parses <quote>true</quote>, <quote>false</quote>, <quote>yes</quote> and <quote>no</quote>
15666 (case-insensitively); also integer numbers map to true if non-zero,
15667 false if zero.
15668 An empty string is treated as false.
15669 Leading and trailing whitespace is ignored;
15670 thus a string consisting only of whitespace is false.
15671 All other string values will result in expansion failure.
15672 </para>
15673 <para>
15674 When combined with ACL variables, this expansion condition will let you
15675 make decisions in one place and act on those decisions in another place.
15676 For example:
15677 </para>
15678 <literallayout class="monospaced">
15679 ${if bool{$acl_m_privileged_sender} ...
15680 </literallayout>
15681 </listitem></varlistentry>
15682 <varlistentry>
15683 <term><emphasis role="bold">bool_lax&nbsp;{</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15684 <listitem>
15685 <para>
15686 <indexterm role="concept">
15687 <primary>expansion</primary>
15688 <secondary>boolean parsing</secondary>
15689 </indexterm>
15690 <indexterm role="concept">
15691 <primary><option>bool_lax</option> expansion condition</primary>
15692 </indexterm>
15693 Like <option>bool</option>, this condition turns a string into a boolean state.  But
15694 where <option>bool</option> accepts a strict set of strings, <option>bool_lax</option> uses the same
15695 loose definition that the Router <option>condition</option> option uses.  The empty string
15696 and the values <quote>false</quote>, <quote>no</quote> and <quote>0</quote> map to false, all others map to
15697 true.  Leading and trailing whitespace is ignored.
15698 </para>
15699 <para>
15700 Note that where <quote>bool{00}</quote> is false, <quote>bool_lax{00}</quote> is true.
15701 </para>
15702 </listitem></varlistentry>
15703 <varlistentry>
15704 <term><emphasis role="bold">crypteq&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15705 <listitem>
15706 <para>
15707 <indexterm role="concept">
15708 <primary>expansion</primary>
15709 <secondary>encrypted comparison</secondary>
15710 </indexterm>
15711 <indexterm role="concept">
15712 <primary>encrypted strings, comparing</primary>
15713 </indexterm>
15714 <indexterm role="concept">
15715 <primary><option>crypteq</option> expansion condition</primary>
15716 </indexterm>
15717 This condition is included in the Exim binary if it is built to support any
15718 authentication mechanisms (see chapter <xref linkend="CHAPSMTPAUTH"/>). Otherwise, it is
15719 necessary to define SUPPORT_CRYPTEQ in <filename>Local/Makefile</filename> to get <option>crypteq</option>
15720 included in the binary.
15721 </para>
15722 <para>
15723 The <option>crypteq</option> condition has two arguments. The first is encrypted and
15724 compared against the second, which is already encrypted. The second string may
15725 be in the LDAP form for storing encrypted strings, which starts with the
15726 encryption type in curly brackets, followed by the data. If the second string
15727 does not begin with <quote>{</quote> it is assumed to be encrypted with <function>crypt()</function> or
15728 <function>crypt16()</function> (see below), since such strings cannot begin with <quote>{</quote>.
15729 Typically this will be a field from a password file. An example of an encrypted
15730 string in LDAP form is:
15731 </para>
15732 <literallayout class="monospaced">
15733 {md5}CY9rzUYh03PK3k6DJie09g==
15734 </literallayout>
15735 <para>
15736 If such a string appears directly in an expansion, the curly brackets have to
15737 be quoted, because they are part of the expansion syntax. For example:
15738 </para>
15739 <literallayout class="monospaced">
15740 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
15741 </literallayout>
15742 <para>
15743 The following encryption types (whose names are matched case-independently) are
15744 supported:
15745 </para>
15746 <itemizedlist>
15747 <listitem>
15748 <para>
15749 <indexterm role="concept">
15750 <primary>MD5 hash</primary>
15751 </indexterm>
15752 <indexterm role="concept">
15753 <primary>base64 encoding</primary>
15754 <secondary>in encrypted password</secondary>
15755 </indexterm>
15756 <option>{md5}</option> computes the MD5 digest of the first string, and expresses this as
15757 printable characters to compare with the remainder of the second string. If the
15758 length of the comparison string is 24, Exim assumes that it is base64 encoded
15759 (as in the above example). If the length is 32, Exim assumes that it is a
15760 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
15761 comparison fails.
15762 </para>
15763 </listitem>
15764 <listitem>
15765 <para>
15766 <indexterm role="concept">
15767 <primary>SHA-1 hash</primary>
15768 </indexterm>
15769 <option>{sha1}</option> computes the SHA-1 digest of the first string, and expresses this as
15770 printable characters to compare with the remainder of the second string. If the
15771 length of the comparison string is 28, Exim assumes that it is base64 encoded.
15772 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
15773 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
15774 </para>
15775 </listitem>
15776 <listitem>
15777 <para>
15778 <indexterm role="concept">
15779 <primary><function>crypt()</function></primary>
15780 </indexterm>
15781 <option>{crypt}</option> calls the <function>crypt()</function> function, which traditionally used to use
15782 only the first eight characters of the password. However, in modern operating
15783 systems this is no longer true, and in many cases the entire password is used,
15784 whatever its length.
15785 </para>
15786 </listitem>
15787 <listitem>
15788 <para>
15789 <indexterm role="concept">
15790 <primary><function>crypt16()</function></primary>
15791 </indexterm>
15792 <option>{crypt16}</option> calls the <function>crypt16()</function> function, which was originally created to
15793 use up to 16 characters of the password in some operating systems. Again, in
15794 modern operating systems, more characters may be used.
15795 </para>
15796 </listitem>
15797 </itemizedlist>
15798 <para>
15799 Exim has its own version of <function>crypt16()</function>, which is just a double call to
15800 <function>crypt()</function>. For operating systems that have their own version, setting
15801 HAVE_CRYPT16 in <filename>Local/Makefile</filename> when building Exim causes it to use the
15802 operating system version instead of its own. This option is set by default in
15803 the OS-dependent <filename>Makefile</filename> for those operating systems that are known to
15804 support <function>crypt16()</function>.
15805 </para>
15806 <para>
15807 Some years after Exim&#x2019;s <function>crypt16()</function> was implemented, a user discovered that
15808 it was not using the same algorithm as some operating systems&#x2019; versions. It
15809 turns out that as well as <function>crypt16()</function> there is a function called
15810 <function>bigcrypt()</function> in some operating systems. This may or may not use the same
15811 algorithm, and both of them may be different to Exim&#x2019;s built-in <function>crypt16()</function>.
15812 </para>
15813 <para>
15814 However, since there is now a move away from the traditional <function>crypt()</function>
15815 functions towards using SHA1 and other algorithms, tidying up this area of
15816 Exim is seen as very low priority.
15817 </para>
15818 <para>
15819 If you do not put a encryption type (in curly brackets) in a <option>crypteq</option>
15820 comparison, the default is usually either <literal>{crypt}</literal> or <literal>{crypt16}</literal>, as
15821 determined by the setting of DEFAULT_CRYPT in <filename>Local/Makefile</filename>. The default
15822 default is <literal>{crypt}</literal>. Whatever the default, you can always use either
15823 function by specifying it explicitly in curly brackets.
15824 </para>
15825 </listitem></varlistentry>
15826 <varlistentry>
15827 <term><emphasis role="bold">def:</emphasis>&lt;<emphasis>variable&nbsp;name</emphasis>&gt;</term>
15828 <listitem>
15829 <para>
15830 <indexterm role="concept">
15831 <primary>expansion</primary>
15832 <secondary>checking for empty variable</secondary>
15833 </indexterm>
15834 <indexterm role="concept">
15835 <primary><option>def</option> expansion condition</primary>
15836 </indexterm>
15837 The <option>def</option> condition must be followed by the name of one of the expansion
15838 variables defined in section <xref linkend="SECTexpvar"/>. The condition is true if the
15839 variable does not contain the empty string. For example:
15840 </para>
15841 <literallayout class="monospaced">
15842 ${if def:sender_ident {from $sender_ident}}
15843 </literallayout>
15844 <para>
15845 Note that the variable name is given without a leading <option>$</option> character. If the
15846 variable does not exist, the expansion fails.
15847 </para>
15848 </listitem></varlistentry>
15849 <varlistentry>
15850 <term><emphasis role="bold">def:header_</emphasis>&lt;<emphasis>header&nbsp;name</emphasis>&gt;<emphasis role="bold">:</emphasis>&nbsp;&nbsp;or&nbsp;&nbsp;<emphasis role="bold">def:h_</emphasis>&lt;<emphasis>header&nbsp;name</emphasis>&gt;<emphasis role="bold">:</emphasis></term>
15851 <listitem>
15852 <para>
15853 <indexterm role="concept">
15854 <primary>expansion</primary>
15855 <secondary>checking header line existence</secondary>
15856 </indexterm>
15857 This condition is true if a message is being processed and the named header
15858 exists in the message. For example,
15859 </para>
15860 <literallayout class="monospaced">
15861 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
15862 </literallayout>
15863 <para>
15864 <emphasis role="bold">Note</emphasis>: No <option>$</option> appears before <option>header_</option> or <option>h_</option> in the condition, and
15865 the header name must be terminated by a colon if white space does not follow.
15866 </para>
15867 </listitem></varlistentry>
15868 <varlistentry>
15869 <term><emphasis role="bold">eq&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15870 <term><emphasis role="bold">eqi&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15871 <listitem>
15872 <para>
15873 <indexterm role="concept">
15874 <primary>string</primary>
15875 <secondary>comparison</secondary>
15876 </indexterm>
15877 <indexterm role="concept">
15878 <primary>expansion</primary>
15879 <secondary>string comparison</secondary>
15880 </indexterm>
15881 <indexterm role="concept">
15882 <primary><option>eq</option> expansion condition</primary>
15883 </indexterm>
15884 <indexterm role="concept">
15885 <primary><option>eqi</option> expansion condition</primary>
15886 </indexterm>
15887 The two substrings are first expanded. The condition is true if the two
15888 resulting strings are identical. For <option>eq</option> the comparison includes the case of
15889 letters, whereas for <option>eqi</option> the comparison is case-independent.
15890 </para>
15891 </listitem></varlistentry>
15892 <varlistentry>
15893 <term><emphasis role="bold">exists&nbsp;{</emphasis>&lt;<emphasis>file&nbsp;name</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15894 <listitem>
15895 <para>
15896 <indexterm role="concept">
15897 <primary>expansion</primary>
15898 <secondary>file existence test</secondary>
15899 </indexterm>
15900 <indexterm role="concept">
15901 <primary>file</primary>
15902 <secondary>existence test</secondary>
15903 </indexterm>
15904 <indexterm role="concept">
15905 <primary><option>exists</option>, expansion condition</primary>
15906 </indexterm>
15907 The substring is first expanded and then interpreted as an absolute path. The
15908 condition is true if the named file (or directory) exists. The existence test
15909 is done by calling the <function>stat()</function> function. The use of the <option>exists</option> test in
15910 users&#x2019; filter files may be locked out by the system administrator.
15911 </para>
15912 </listitem></varlistentry>
15913 <varlistentry>
15914 <term><emphasis role="bold">first_delivery</emphasis></term>
15915 <listitem>
15916 <para>
15917 <indexterm role="concept">
15918 <primary>delivery</primary>
15919 <secondary>first</secondary>
15920 </indexterm>
15921 <indexterm role="concept">
15922 <primary>first delivery</primary>
15923 </indexterm>
15924 <indexterm role="concept">
15925 <primary>expansion</primary>
15926 <secondary>first delivery test</secondary>
15927 </indexterm>
15928 <indexterm role="concept">
15929 <primary><option>first_delivery</option> expansion condition</primary>
15930 </indexterm>
15931 This condition, which has no data, is true during a message&#x2019;s first delivery
15932 attempt. It is false during any subsequent delivery attempts.
15933 </para>
15934 </listitem></varlistentry>
15935 <varlistentry>
15936 <term><emphasis role="bold">forall{</emphasis>&lt;<emphasis>a list</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>a condition</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15937 <term><emphasis role="bold">forany{</emphasis>&lt;<emphasis>a list</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>a condition</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15938 <listitem>
15939 <para>
15940 <indexterm role="concept">
15941 <primary>list</primary>
15942 <secondary>iterative conditions</secondary>
15943 </indexterm>
15944 <indexterm role="concept">
15945 <primary>expansion</primary>
15946 <secondary><emphasis role="bold">forall</emphasis> condition</secondary>
15947 </indexterm>
15948 <indexterm role="concept">
15949 <primary>expansion</primary>
15950 <secondary><emphasis role="bold">forany</emphasis> condition</secondary>
15951 </indexterm>
15952 <indexterm role="variable">
15953 <primary><varname>$item</varname></primary>
15954 </indexterm>
15955 These conditions iterate over a list. The first argument is expanded to form
15956 the list. By default, the list separator is a colon, but it can be changed by
15957 the normal method. The second argument is interpreted as a condition that is to
15958 be applied to each item in the list in turn. During the interpretation of the
15959 condition, the current list item is placed in a variable called <varname>$item</varname>.
15960 </para>
15961 <itemizedlist>
15962 <listitem>
15963 <para>
15964 For <emphasis role="bold">forany</emphasis>, interpretation stops if the condition is true for any item, and
15965 the result of the whole condition is true. If the condition is false for all
15966 items in the list, the overall condition is false.
15967 </para>
15968 </listitem>
15969 <listitem>
15970 <para>
15971 For <emphasis role="bold">forall</emphasis>, interpretation stops if the condition is false for any item,
15972 and the result of the whole condition is false. If the condition is true for
15973 all items in the list, the overall condition is true.
15974 </para>
15975 </listitem>
15976 </itemizedlist>
15977 <para>
15978 Note that negation of <emphasis role="bold">forany</emphasis> means that the condition must be false for all
15979 items for the overall condition to succeed, and negation of <emphasis role="bold">forall</emphasis> means
15980 that the condition must be false for at least one item. In this example, the
15981 list separator is changed to a comma:
15982 </para>
15983 <literallayout class="monospaced">
15984 ${if forany{&lt;, $recipients}{match{$item}{^user3@}}{yes}{no}}
15985 </literallayout>
15986 <para>
15987 The value of <varname>$item</varname> is saved and restored while <emphasis role="bold">forany</emphasis> or <emphasis role="bold">forall</emphasis> is
15988 being processed, to enable these expansion items to be nested.
15989 </para>
15990 <para>
15991 To scan a named list, expand it with the <emphasis role="bold">listnamed</emphasis> operator.
15992 </para>
15993 </listitem></varlistentry>
15994 <varlistentry>
15995 <term><emphasis role="bold">ge&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15996 <term><emphasis role="bold">gei&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
15997 <listitem>
15998 <para>
15999 <indexterm role="concept">
16000 <primary>string</primary>
16001 <secondary>comparison</secondary>
16002 </indexterm>
16003 <indexterm role="concept">
16004 <primary>expansion</primary>
16005 <secondary>string comparison</secondary>
16006 </indexterm>
16007 <indexterm role="concept">
16008 <primary><option>ge</option> expansion condition</primary>
16009 </indexterm>
16010 <indexterm role="concept">
16011 <primary><option>gei</option> expansion condition</primary>
16012 </indexterm>
16013 The two substrings are first expanded. The condition is true if the first
16014 string is lexically greater than or equal to the second string. For <option>ge</option> the
16015 comparison includes the case of letters, whereas for <option>gei</option> the comparison is
16016 case-independent.
16017 </para>
16018 </listitem></varlistentry>
16019 <varlistentry>
16020 <term><emphasis role="bold">gt&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
16021 <term><emphasis role="bold">gti&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
16022 <listitem>
16023 <para>
16024 <indexterm role="concept">
16025 <primary>string</primary>
16026 <secondary>comparison</secondary>
16027 </indexterm>
16028 <indexterm role="concept">
16029 <primary>expansion</primary>
16030 <secondary>string comparison</secondary>
16031 </indexterm>
16032 <indexterm role="concept">
16033 <primary><option>gt</option> expansion condition</primary>
16034 </indexterm>
16035 <indexterm role="concept">
16036 <primary><option>gti</option> expansion condition</primary>
16037 </indexterm>
16038 The two substrings are first expanded. The condition is true if the first
16039 string is lexically greater than the second string. For <option>gt</option> the comparison
16040 includes the case of letters, whereas for <option>gti</option> the comparison is
16041 case-independent.
16042 </para>
16043 </listitem></varlistentry>
16044 <varlistentry>
16045 <term><emphasis role="bold">inlist&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
16046 <term><emphasis role="bold">inlisti&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
16047 <listitem>
16048 <para>
16049 <indexterm role="concept">
16050 <primary>string</primary>
16051 <secondary>comparison</secondary>
16052 </indexterm>
16053 <indexterm role="concept">
16054 <primary>list</primary>
16055 <secondary>iterative conditions</secondary>
16056 </indexterm>
16057 Both strings are expanded; the second string is treated as a list of simple
16058 strings; if the first string is a member of the second, then the condition
16059 is true.
16060 </para>
16061 <para>
16062 These are simpler to use versions of the more powerful <emphasis role="bold">forany</emphasis> condition.
16063 Examples, and the <emphasis role="bold">forany</emphasis> equivalents:
16064 </para>
16065 <literallayout class="monospaced">
16066 ${if inlist{needle}{foo:needle:bar}}
16067   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
16068 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
16069   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
16070 </literallayout>
16071 </listitem></varlistentry>
16072 <varlistentry>
16073 <term><emphasis role="bold">isip&nbsp;{</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
16074 <term><emphasis role="bold">isip4&nbsp;{</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
16075 <term><emphasis role="bold">isip6&nbsp;{</emphasis>&lt;<emphasis>string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
16076 <listitem>
16077 <para>
16078 <indexterm role="concept">
16079 <primary>IP address</primary>
16080 <secondary>testing string format</secondary>
16081 </indexterm>
16082 <indexterm role="concept">
16083 <primary>string</primary>
16084 <secondary>testing for IP address</secondary>
16085 </indexterm>
16086 <indexterm role="concept">
16087 <primary><option>isip</option> expansion condition</primary>
16088 </indexterm>
16089 <indexterm role="concept">
16090 <primary><option>isip4</option> expansion condition</primary>
16091 </indexterm>
16092 <indexterm role="concept">
16093 <primary><option>isip6</option> expansion condition</primary>
16094 </indexterm>
16095 The substring is first expanded, and then tested to see if it has the form of
16096 an IP address. Both IPv4 and IPv6 addresses are valid for <option>isip</option>, whereas
16097 <option>isip4</option> and <option>isip6</option> test specifically for IPv4 or IPv6 addresses.
16098 </para>
16099 <para>
16100 For an IPv4 address, the test is for four dot-separated components, each of
16101 which consists of from one to three digits. For an IPv6 address, up to eight
16102 colon-separated components are permitted, each containing from one to four
16103 hexadecimal digits. There may be fewer than eight components if an empty
16104 component (adjacent colons) is present. Only one empty component is permitted.
16105 </para>
16106 <para>
16107 <emphasis role="bold">Note</emphasis>: The checks are just on the form of the address; actual numerical
16108 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
16109 check. The main use of these tests is to distinguish between IP addresses and
16110 host names, or between IPv4 and IPv6 addresses. For example, you could use
16111 </para>
16112 <literallayout class="monospaced">
16113 ${if isip4{$sender_host_address}...
16114 </literallayout>
16115 <para>
16116 to test which IP version an incoming SMTP connection is using.
16117 </para>
16118 </listitem></varlistentry>
16119 <varlistentry>
16120 <term><emphasis role="bold">ldapauth&nbsp;{</emphasis>&lt;<emphasis>ldap&nbsp;query</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
16121 <listitem>
16122 <para>
16123 <indexterm role="concept">
16124 <primary>LDAP</primary>
16125 <secondary>use for authentication</secondary>
16126 </indexterm>
16127 <indexterm role="concept">
16128 <primary>expansion</primary>
16129 <secondary>LDAP authentication test</secondary>
16130 </indexterm>
16131 <indexterm role="concept">
16132 <primary><option>ldapauth</option> expansion condition</primary>
16133 </indexterm>
16134 This condition supports user authentication using LDAP. See section
16135 <xref linkend="SECTldap"/> for details of how to use LDAP in lookups and the syntax of
16136 queries. For this use, the query must contain a user name and password. The
16137 query itself is not used, and can be empty. The condition is true if the
16138 password is not empty, and the user name and password are accepted by the LDAP
16139 server. An empty password is rejected without calling LDAP because LDAP binds
16140 with an empty password are considered anonymous regardless of the username, and
16141 will succeed in most configurations. See chapter <xref linkend="CHAPSMTPAUTH"/> for details
16142 of SMTP authentication, and chapter <xref linkend="CHAPplaintext"/> for an example of how
16143 this can be used.
16144 </para>
16145 </listitem></varlistentry>
16146 <varlistentry>
16147 <term><emphasis role="bold">le&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
16148 <term><emphasis role="bold">lei&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
16149 <listitem>
16150 <para>
16151 <indexterm role="concept">
16152 <primary>string</primary>
16153 <secondary>comparison</secondary>
16154 </indexterm>
16155 <indexterm role="concept">
16156 <primary>expansion</primary>
16157 <secondary>string comparison</secondary>
16158 </indexterm>
16159 <indexterm role="concept">
16160 <primary><option>le</option> expansion condition</primary>
16161 </indexterm>
16162 <indexterm role="concept">
16163 <primary><option>lei</option> expansion condition</primary>
16164 </indexterm>
16165 The two substrings are first expanded. The condition is true if the first
16166 string is lexically less than or equal to the second string. For <option>le</option> the
16167 comparison includes the case of letters, whereas for <option>lei</option> the comparison is
16168 case-independent.
16169 </para>
16170 </listitem></varlistentry>
16171 <varlistentry>
16172 <term><emphasis role="bold">lt&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
16173 <term><emphasis role="bold">lti&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
16174 <listitem>
16175 <para>
16176 <indexterm role="concept">
16177 <primary>string</primary>
16178 <secondary>comparison</secondary>
16179 </indexterm>
16180 <indexterm role="concept">
16181 <primary>expansion</primary>
16182 <secondary>string comparison</secondary>
16183 </indexterm>
16184 <indexterm role="concept">
16185 <primary><option>lt</option> expansion condition</primary>
16186 </indexterm>
16187 <indexterm role="concept">
16188 <primary><option>lti</option> expansion condition</primary>
16189 </indexterm>
16190 The two substrings are first expanded. The condition is true if the first
16191 string is lexically less than the second string. For <option>lt</option> the comparison
16192 includes the case of letters, whereas for <option>lti</option> the comparison is
16193 case-independent.
16194 </para>
16195 </listitem></varlistentry>
16196 <varlistentry>
16197 <term><emphasis role="bold">match&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
16198 <listitem>
16199 <para>
16200 <indexterm role="concept">
16201 <primary>expansion</primary>
16202 <secondary>regular expression comparison</secondary>
16203 </indexterm>
16204 <indexterm role="concept">
16205 <primary>regular expressions</primary>
16206 <secondary>match in expanded string</secondary>
16207 </indexterm>
16208 <indexterm role="concept">
16209 <primary><option>match</option> expansion condition</primary>
16210 </indexterm>
16211 The two substrings are first expanded. The second is then treated as a regular
16212 expression and applied to the first. Because of the pre-expansion, if the
16213 regular expression contains dollar, or backslash characters, they must be
16214 escaped. Care must also be taken if the regular expression contains braces
16215 (curly brackets). A closing brace must be escaped so that it is not taken as a
16216 premature termination of &lt;<emphasis>string2</emphasis>&gt;. The easiest approach is to use the
16217 <literal>\N</literal> feature to disable expansion of the regular expression.
16218 For example,
16219 </para>
16220 <literallayout class="monospaced">
16221 ${if match {$local_part}{\N^\d{3}\N} ...
16222 </literallayout>
16223 <para>
16224 If the whole expansion string is in double quotes, further escaping of
16225 backslashes is also required.
16226 </para>
16227 <para>
16228 The condition is true if the regular expression match succeeds.
16229 The regular expression is not required to begin with a circumflex
16230 metacharacter, but if there is no circumflex, the expression is not anchored,
16231 and it may match anywhere in the subject, not just at the start. If you want
16232 the pattern to match at the end of the subject, you must include the <literal>$</literal>
16233 metacharacter at an appropriate point.
16234 </para>
16235 <para>
16236 <indexterm role="concept">
16237 <primary>numerical variables (<varname>$1</varname> <varname>$2</varname> etc)</primary>
16238 <secondary>in <option>if</option> expansion</secondary>
16239 </indexterm>
16240 At the start of an <option>if</option> expansion the values of the numeric variable
16241 substitutions <varname>$1</varname> etc. are remembered. Obeying a <option>match</option> condition that
16242 succeeds causes them to be reset to the substrings of that condition and they
16243 will have these values during the expansion of the success string. At the end
16244 of the <option>if</option> expansion, the previous values are restored. After testing a
16245 combination of conditions using <option>or</option>, the subsequent values of the numeric
16246 variables are those of the condition that succeeded.
16247 </para>
16248 </listitem></varlistentry>
16249 <varlistentry>
16250 <term><emphasis role="bold">match_address&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
16251 <listitem>
16252 <para>
16253 <indexterm role="concept">
16254 <primary><option>match_address</option> expansion condition</primary>
16255 </indexterm>
16256 See <emphasis role="bold">match_local_part</emphasis>.
16257 </para>
16258 </listitem></varlistentry>
16259 <varlistentry>
16260 <term><emphasis role="bold">match_domain&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
16261 <listitem>
16262 <para>
16263 <indexterm role="concept">
16264 <primary><option>match_domain</option> expansion condition</primary>
16265 </indexterm>
16266 See <emphasis role="bold">match_local_part</emphasis>.
16267 </para>
16268 </listitem></varlistentry>
16269 <varlistentry>
16270 <term><emphasis role="bold">match_ip&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
16271 <listitem>
16272 <para>
16273 <indexterm role="concept">
16274 <primary><option>match_ip</option> expansion condition</primary>
16275 </indexterm>
16276 This condition matches an IP address to a list of IP address patterns. It must
16277 be followed by two argument strings. The first (after expansion) must be an IP
16278 address or an empty string. The second (not expanded) is a restricted host
16279 list that can match only an IP address, not a host name. For example:
16280 </para>
16281 <literallayout class="monospaced">
16282 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
16283 </literallayout>
16284 <para>
16285 The specific types of host list item that are permitted in the list are:
16286 </para>
16287 <itemizedlist>
16288 <listitem>
16289 <para>
16290 An IP address, optionally with a CIDR mask.
16291 </para>
16292 </listitem>
16293 <listitem>
16294 <para>
16295 A single asterisk, which matches any IP address.
16296 </para>
16297 </listitem>
16298 <listitem>
16299 <para>
16300 An empty item, which matches only if the IP address is empty. This could be
16301 useful for testing for a locally submitted message or one from specific hosts
16302 in a single test such as
16303 </para>
16304 <literallayout class="monospaced">
16305   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
16306 </literallayout>
16307 <para>
16308 where the first item in the list is the empty string.
16309 </para>
16310 </listitem>
16311 <listitem>
16312 <para>
16313 The item @[] matches any of the local host&#x2019;s interface addresses.
16314 </para>
16315 </listitem>
16316 <listitem>
16317 <para>
16318 Single-key lookups are assumed to be like <quote>net-</quote> style lookups in host lists,
16319 even if <literal>net-</literal> is not specified. There is never any attempt to turn the IP
16320 address into a host name. The most common type of linear search for
16321 <emphasis role="bold">match_ip</emphasis> is likely to be <emphasis role="bold">iplsearch</emphasis>, in which the file can contain CIDR
16322 masks. For example:
16323 </para>
16324 <literallayout class="monospaced">
16325   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
16326 </literallayout>
16327 <para>
16328 It is of course possible to use other kinds of lookup, and in such a case, you
16329 do need to specify the <literal>net-</literal> prefix if you want to specify a specific
16330 address mask, for example:
16331 </para>
16332 <literallayout class="monospaced">
16333   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
16334 </literallayout>
16335 <para>
16336 However, unless you are combining a <option>match_ip</option> condition with others, it is
16337 just as easy to use the fact that a lookup is itself a condition, and write:
16338 </para>
16339 <literallayout class="monospaced">
16340   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
16341 </literallayout>
16342 </listitem>
16343 </itemizedlist>
16344 <para>
16345 Note that &lt;<emphasis>string2</emphasis>&gt; is not itself subject to string expansion, unless
16346 Exim was built with the EXPAND_LISTMATCH_RHS option.
16347 </para>
16348 <para>
16349 Consult section <xref linkend="SECThoslispatip"/> for further details of these patterns.
16350 </para>
16351 </listitem></varlistentry>
16352 <varlistentry>
16353 <term><emphasis role="bold">match_local_part&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
16354 <listitem>
16355 <para>
16356 <indexterm role="concept">
16357 <primary>domain list</primary>
16358 <secondary>in expansion condition</secondary>
16359 </indexterm>
16360 <indexterm role="concept">
16361 <primary>address list</primary>
16362 <secondary>in expansion condition</secondary>
16363 </indexterm>
16364 <indexterm role="concept">
16365 <primary>local part</primary>
16366 <secondary>list, in expansion condition</secondary>
16367 </indexterm>
16368 <indexterm role="concept">
16369 <primary><option>match_local_part</option> expansion condition</primary>
16370 </indexterm>
16371 This condition, together with <option>match_address</option> and <option>match_domain</option>, make it
16372 possible to test domain, address, and local part lists within expansions. Each
16373 condition requires two arguments: an item and a list to match. A trivial
16374 example is:
16375 </para>
16376 <literallayout class="monospaced">
16377 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
16378 </literallayout>
16379 <para>
16380 In each case, the second argument may contain any of the allowable items for a
16381 list of the appropriate type. Also, because the second argument (after
16382 expansion) is a standard form of list, it is possible to refer to a named list.
16383 Thus, you can use conditions like this:
16384 </para>
16385 <literallayout class="monospaced">
16386 ${if match_domain{$domain}{+local_domains}{...
16387 </literallayout>
16388 <para>
16389 <indexterm role="concept">
16390 <primary><literal>+caseful</literal></primary>
16391 </indexterm>
16392 For address lists, the matching starts off caselessly, but the <literal>+caseful</literal>
16393 item can be used, as in all address lists, to cause subsequent items to
16394 have their local parts matched casefully. Domains are always matched
16395 caselessly.
16396 </para>
16397 <para>
16398 Note that &lt;<emphasis>string2</emphasis>&gt; is not itself subject to string expansion, unless
16399 Exim was built with the EXPAND_LISTMATCH_RHS option.
16400 </para>
16401 <para>
16402 <emphasis role="bold">Note</emphasis>: Host lists are <emphasis>not</emphasis> supported in this way. This is because
16403 hosts have two identities: a name and an IP address, and it is not clear
16404 how to specify cleanly how such a test would work. However, IP addresses can be
16405 matched using <option>match_ip</option>.
16406 </para>
16407 </listitem></varlistentry>
16408 <varlistentry>
16409 <term><emphasis role="bold">pam&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">:</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">:...}</emphasis></term>
16410 <listitem>
16411 <para>
16412 <indexterm role="concept">
16413 <primary>PAM authentication</primary>
16414 </indexterm>
16415 <indexterm role="concept">
16416 <primary>AUTH</primary>
16417 <secondary>with PAM</secondary>
16418 </indexterm>
16419 <indexterm role="concept">
16420 <primary>Solaris</primary>
16421 <secondary>PAM support</secondary>
16422 </indexterm>
16423 <indexterm role="concept">
16424 <primary>expansion</primary>
16425 <secondary>PAM authentication test</secondary>
16426 </indexterm>
16427 <indexterm role="concept">
16428 <primary><option>pam</option> expansion condition</primary>
16429 </indexterm>
16430 <emphasis>Pluggable Authentication Modules</emphasis>
16431 (<emphasis role="bold"><ulink url="http://www.kernel.org/pub/linux/libs/pam/">http://www.kernel.org/pub/linux/libs/pam/</ulink></emphasis>) are a facility that is
16432 available in the latest releases of Solaris and in some GNU/Linux
16433 distributions. The Exim support, which is intended for use in conjunction with
16434 the SMTP AUTH command, is available only if Exim is compiled with
16435 </para>
16436 <literallayout class="monospaced">
16437 SUPPORT_PAM=yes
16438 </literallayout>
16439 <para>
16440 in <filename>Local/Makefile</filename>. You probably need to add <option>-lpam</option> to EXTRALIBS, and
16441 in some releases of GNU/Linux <option>-ldl</option> is also needed.
16442 </para>
16443 <para>
16444 The argument string is first expanded, and the result must be a
16445 colon-separated list of strings. Leading and trailing white space is ignored.
16446 The PAM module is initialized with the service name <quote>exim</quote> and the user name
16447 taken from the first item in the colon-separated data string (&lt;<emphasis>string1</emphasis>&gt;).
16448 The remaining items in the data string are passed over in response to requests
16449 from the authentication function. In the simple case there will only be one
16450 request, for a password, so the data consists of just two strings.
16451 </para>
16452 <para>
16453 There can be problems if any of the strings are permitted to contain colon
16454 characters. In the usual way, these have to be doubled to avoid being taken as
16455 separators. If the data is being inserted from a variable, the <option>sg</option> expansion
16456 item can be used to double any existing colons. For example, the configuration
16457 of a LOGIN authenticator might contain this setting:
16458 </para>
16459 <literallayout class="monospaced">
16460 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
16461 </literallayout>
16462 <para>
16463 For a PLAIN authenticator you could use:
16464 </para>
16465 <literallayout class="monospaced">
16466 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
16467 </literallayout>
16468 <para>
16469 In some operating systems, PAM authentication can be done only from a process
16470 running as root. Since Exim is running as the Exim user when receiving
16471 messages, this means that PAM cannot be used directly in those systems.
16472 A patched version of the <emphasis>pam_unix</emphasis> module that comes with the
16473 Linux PAM package is available from <emphasis role="bold"><ulink url="http://www.e-admin.de/pam_exim/">http://www.e-admin.de/pam_exim/</ulink></emphasis>.
16474 The patched module allows one special uid/gid combination, in addition to root,
16475 to authenticate. If you build the patched module to allow the Exim user and
16476 group, PAM can then be used from an Exim authenticator.
16477 </para>
16478 </listitem></varlistentry>
16479 <varlistentry>
16480 <term><emphasis role="bold">pwcheck&nbsp;{</emphasis>&lt;<emphasis>string1</emphasis>&gt;<emphasis role="bold">:</emphasis>&lt;<emphasis>string2</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
16481 <listitem>
16482 <para>
16483 <indexterm role="concept">
16484 <primary><emphasis>pwcheck</emphasis> daemon</primary>
16485 </indexterm>
16486 <indexterm role="concept">
16487 <primary>Cyrus</primary>
16488 </indexterm>
16489 <indexterm role="concept">
16490 <primary>expansion</primary>
16491 <secondary><emphasis>pwcheck</emphasis> authentication test</secondary>
16492 </indexterm>
16493 <indexterm role="concept">
16494 <primary><option>pwcheck</option> expansion condition</primary>
16495 </indexterm>
16496 This condition supports user authentication using the Cyrus <emphasis>pwcheck</emphasis> daemon.
16497 This is one way of making it possible for passwords to be checked by a process
16498 that is not running as root. <emphasis role="bold">Note</emphasis>: The use of <emphasis>pwcheck</emphasis> is now
16499 deprecated. Its replacement is <emphasis>saslauthd</emphasis> (see below).
16500 </para>
16501 <para>
16502 The pwcheck support is not included in Exim by default. You need to specify
16503 the location of the pwcheck daemon&#x2019;s socket in <filename>Local/Makefile</filename> before
16504 building Exim. For example:
16505 </para>
16506 <literallayout class="monospaced">
16507 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
16508 </literallayout>
16509 <para>
16510 You do not need to install the full Cyrus software suite in order to use
16511 the pwcheck daemon. You can compile and install just the daemon alone
16512 from the Cyrus SASL library. Ensure that <emphasis>exim</emphasis> is the only user that has
16513 access to the <filename>/var/pwcheck</filename> directory.
16514 </para>
16515 <para>
16516 The <option>pwcheck</option> condition takes one argument, which must be the user name and
16517 password, separated by a colon. For example, in a LOGIN authenticator
16518 configuration, you might have this:
16519 </para>
16520 <literallayout class="monospaced">
16521 server_condition = ${if pwcheck{$auth1:$auth2}}
16522 </literallayout>
16523 <para>
16524 Again, for a PLAIN authenticator configuration, this would be:
16525 </para>
16526 <literallayout class="monospaced">
16527 server_condition = ${if pwcheck{$auth2:$auth3}}
16528 </literallayout>
16529 </listitem></varlistentry>
16530 <varlistentry>
16531 <term><emphasis role="bold">queue_running</emphasis></term>
16532 <listitem>
16533 <para>
16534 <indexterm role="concept">
16535 <primary>queue runner</primary>
16536 <secondary>detecting when delivering from</secondary>
16537 </indexterm>
16538 <indexterm role="concept">
16539 <primary>expansion</primary>
16540 <secondary>queue runner test</secondary>
16541 </indexterm>
16542 <indexterm role="concept">
16543 <primary><option>queue_running</option> expansion condition</primary>
16544 </indexterm>
16545 This condition, which has no data, is true during delivery attempts that are
16546 initiated by queue runner processes, and false otherwise.
16547 </para>
16548 </listitem></varlistentry>
16549 <varlistentry>
16550 <term><emphasis role="bold">radius&nbsp;{</emphasis>&lt;<emphasis>authentication&nbsp;string</emphasis>&gt;<emphasis role="bold">}</emphasis></term>
16551 <listitem>
16552 <para>
16553 <indexterm role="concept">
16554 <primary>Radius</primary>
16555 </indexterm>
16556 <indexterm role="concept">
16557 <primary>expansion</primary>
16558 <secondary>Radius authentication</secondary>
16559 </indexterm>
16560 <indexterm role="concept">
16561 <primary><option>radius</option> expansion condition</primary>
16562 </indexterm>
16563 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
16564 set RADIUS_CONFIG_FILE in <filename>Local/Makefile</filename> to specify the location of
16565 the Radius client configuration file in order to build Exim with Radius
16566 support.
16567 </para>
16568 <para>
16569 With just that one setting, Exim expects to be linked with the <option>radiusclient</option>
16570 library, using the original API. If you are using release 0.4.0 or later of
16571 this library, you need to set
16572 </para>
16573 <literallayout class="monospaced">
16574 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
16575 </literallayout>
16576 <para>
16577 in <filename>Local/Makefile</filename> when building Exim. You can also link Exim with the
16578 <option>libradius</option> library that comes with FreeBSD. To do this, set
16579 </para>
16580 <literallayout class="monospaced">
16581 RADIUS_LIB_TYPE=RADLIB
16582 </literallayout>
16583 <para>
16584 in <filename>Local/Makefile</filename>, in addition to setting RADIUS_CONFIGURE_FILE.
16585 You may also have to supply a suitable setting in EXTRALIBS so that the
16586 Radius library can be found when Exim is linked.
16587 </para>
16588 <para>
16589 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
16590 Radius client library, which calls the Radius server. The condition is true if
16591 the authentication is successful. For example:
16592 </para>
16593 <literallayout class="monospaced">
16594 server_condition = ${if radius{&lt;arguments&gt;}}
16595 </literallayout>
16596 </listitem></varlistentry>
16597 <varlistentry>
16598 <term><emphasis role="bold">saslauthd&nbsp;{{</emphasis>&lt;<emphasis>user</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>password</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>service</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>realm</emphasis>&gt;<emphasis role="bold">}}</emphasis></term>
16599 <listitem>
16600 <para>
16601 <indexterm role="concept">
16602 <primary><emphasis>saslauthd</emphasis> daemon</primary>
16603 </indexterm>
16604 <indexterm role="concept">
16605 <primary>Cyrus</primary>
16606 </indexterm>
16607 <indexterm role="concept">
16608 <primary>expansion</primary>
16609 <secondary><emphasis>saslauthd</emphasis> authentication test</secondary>
16610 </indexterm>
16611 <indexterm role="concept">
16612 <primary><option>saslauthd</option> expansion condition</primary>
16613 </indexterm>
16614 This condition supports user authentication using the Cyrus <emphasis>saslauthd</emphasis>
16615 daemon. This replaces the older <emphasis>pwcheck</emphasis> daemon, which is now deprecated.
16616 Using this daemon is one way of making it possible for passwords to be checked
16617 by a process that is not running as root.
16618 </para>
16619 <para>
16620 The saslauthd support is not included in Exim by default. You need to specify
16621 the location of the saslauthd daemon&#x2019;s socket in <filename>Local/Makefile</filename> before
16622 building Exim. For example:
16623 </para>
16624 <literallayout class="monospaced">
16625 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
16626 </literallayout>
16627 <para>
16628 You do not need to install the full Cyrus software suite in order to use
16629 the saslauthd daemon. You can compile and install just the daemon alone
16630 from the Cyrus SASL library.
16631 </para>
16632 <para>
16633 Up to four arguments can be supplied to the <option>saslauthd</option> condition, but only
16634 two are mandatory. For example:
16635 </para>
16636 <literallayout class="monospaced">
16637 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
16638 </literallayout>
16639 <para>
16640 The service and the realm are optional (which is why the arguments are enclosed
16641 in their own set of braces). For details of the meaning of the service and
16642 realm, and how to run the daemon, consult the Cyrus documentation.
16643 </para>
16644 </listitem></varlistentry>
16645 </variablelist>
16646 </section>
16647 <section id="SECID84">
16648 <title>Combining expansion conditions</title>
16649 <para>
16650 <indexterm role="concept">
16651 <primary>expansion</primary>
16652 <secondary>combining conditions</secondary>
16653 </indexterm>
16654 Several conditions can be tested at once by combining them using the <option>and</option>
16655 and <option>or</option> combination conditions. Note that <option>and</option> and <option>or</option> are complete
16656 conditions on their own, and precede their lists of sub-conditions. Each
16657 sub-condition must be enclosed in braces within the overall braces that contain
16658 the list. No repetition of <option>if</option> is used.
16659 </para>
16660 <variablelist>
16661 <varlistentry>
16662 <term><emphasis role="bold">or&nbsp;{{</emphasis>&lt;<emphasis>cond1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>cond2</emphasis>&gt;<emphasis role="bold">}...}</emphasis></term>
16663 <listitem>
16664 <para>
16665 <indexterm role="concept">
16666 <primary><quote>or</quote> expansion condition</primary>
16667 </indexterm>
16668 <indexterm role="concept">
16669 <primary>expansion</primary>
16670 <secondary><quote>or</quote> of conditions</secondary>
16671 </indexterm>
16672 The sub-conditions are evaluated from left to right. The condition is true if
16673 any one of the sub-conditions is true.
16674 For example,
16675 </para>
16676 <literallayout class="monospaced">
16677 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
16678 </literallayout>
16679 <para>
16680 When a true sub-condition is found, the following ones are parsed but not
16681 evaluated. If there are several <quote>match</quote> sub-conditions the values of the
16682 numeric variables afterwards are taken from the first one that succeeds.
16683 </para>
16684 </listitem></varlistentry>
16685 <varlistentry>
16686 <term><emphasis role="bold">and&nbsp;{{</emphasis>&lt;<emphasis>cond1</emphasis>&gt;<emphasis role="bold">}{</emphasis>&lt;<emphasis>cond2</emphasis>&gt;<emphasis role="bold">}...}</emphasis></term>
16687 <listitem>
16688 <para>
16689 <indexterm role="concept">
16690 <primary><quote>and</quote> expansion condition</primary>
16691 </indexterm>
16692 <indexterm role="concept">
16693 <primary>expansion</primary>
16694 <secondary><quote>and</quote> of conditions</secondary>
16695 </indexterm>
16696 The sub-conditions are evaluated from left to right. The condition is true if
16697 all of the sub-conditions are true. If there are several <quote>match</quote>
16698 sub-conditions, the values of the numeric variables afterwards are taken from
16699 the last one. When a false sub-condition is found, the following ones are
16700 parsed but not evaluated.
16701 </para>
16702 </listitem></varlistentry>
16703 </variablelist>
16704 <para>
16705 <indexterm role="concept" startref="IIDexpcond" class="endofrange"/>
16706 </para>
16707 </section>
16708 <section id="SECTexpvar">
16709 <title>Expansion variables</title>
16710 <para>
16711 <indexterm role="concept">
16712 <primary>expansion</primary>
16713 <secondary>variables, list of</secondary>
16714 </indexterm>
16715 This section contains an alphabetical list of all the expansion variables. Some
16716 of them are available only when Exim is compiled with specific options such as
16717 support for TLS or the content scanning extension.
16718 </para>
16719 <variablelist>
16720 <varlistentry>
16721 <term><varname>$0</varname>, <varname>$1</varname>, etc</term>
16722 <listitem>
16723 <para>
16724 <indexterm role="concept">
16725 <primary>numerical variables (<varname>$1</varname> <varname>$2</varname> etc)</primary>
16726 </indexterm>
16727 When a <option>match</option> expansion condition succeeds, these variables contain the
16728 captured substrings identified by the regular expression during subsequent
16729 processing of the success string of the containing <option>if</option> expansion item.
16730 However, they do not retain their values afterwards; in fact, their previous
16731 values are restored at the end of processing an <option>if</option> item. The numerical
16732 variables may also be set externally by some other matching process which
16733 precedes the expansion of the string. For example, the commands available in
16734 Exim filter files include an <option>if</option> command with its own regular expression
16735 matching condition.
16736 </para>
16737 </listitem></varlistentry>
16738 <varlistentry>
16739 <term><varname>$acl_c...</varname></term>
16740 <listitem>
16741 <para>
16742 Values can be placed in these variables by the <option>set</option> modifier in an ACL. They
16743 can be given any name that starts with <varname>$acl_c</varname> and is at least six characters
16744 long, but the sixth character must be either a digit or an underscore. For
16745 example: <varname>$acl_c5</varname>, <varname>$acl_c_mycount</varname>. The values of the <varname>$acl_c...</varname>
16746 variables persist throughout the lifetime of an SMTP connection. They can be
16747 used to pass information between ACLs and between different invocations of the
16748 same ACL. When a message is received, the values of these variables are saved
16749 with the message, and can be accessed by filters, routers, and transports
16750 during subsequent delivery.
16751 </para>
16752 </listitem></varlistentry>
16753 <varlistentry>
16754 <term><varname>$acl_m...</varname></term>
16755 <listitem>
16756 <para>
16757 These variables are like the <varname>$acl_c...</varname> variables, except that their values
16758 are reset after a message has been received. Thus, if several messages are
16759 received in one SMTP connection, <varname>$acl_m...</varname> values are not passed on from one
16760 message to the next, as <varname>$acl_c...</varname> values are. The <varname>$acl_m...</varname> variables are
16761 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
16762 message is received, the values of these variables are saved with the message,
16763 and can be accessed by filters, routers, and transports during subsequent
16764 delivery.
16765 </para>
16766 </listitem></varlistentry>
16767 <varlistentry>
16768 <term><varname>$acl_verify_message</varname></term>
16769 <listitem>
16770 <para>
16771 <indexterm role="variable">
16772 <primary><varname>$acl_verify_message</varname></primary>
16773 </indexterm>
16774 After an address verification has failed, this variable contains the failure
16775 message. It retains its value for use in subsequent modifiers. The message can
16776 be preserved by coding like this:
16777 </para>
16778 <literallayout class="monospaced">
16779 warn !verify = sender
16780      set acl_m0 = $acl_verify_message
16781 </literallayout>
16782 <para>
16783 You can use <varname>$acl_verify_message</varname> during the expansion of the <option>message</option> or
16784 <option>log_message</option> modifiers, to include information about the verification
16785 failure.
16786 </para>
16787 </listitem></varlistentry>
16788 <varlistentry>
16789 <term><varname>$address_data</varname></term>
16790 <listitem>
16791 <para>
16792 <indexterm role="variable">
16793 <primary><varname>$address_data</varname></primary>
16794 </indexterm>
16795 This variable is set by means of the <option>address_data</option> option in routers. The
16796 value then remains with the address while it is processed by subsequent routers
16797 and eventually a transport. If the transport is handling multiple addresses,
16798 the value from the first address is used. See chapter <xref linkend="CHAProutergeneric"/>
16799 for more details. <emphasis role="bold">Note</emphasis>: The contents of <varname>$address_data</varname> are visible in
16800 user filter files.
16801 </para>
16802 <para>
16803 If <varname>$address_data</varname> is set when the routers are called from an ACL to verify
16804 a recipient address, the final value is still in the variable for subsequent
16805 conditions and modifiers of the ACL statement. If routing the address caused it
16806 to be redirected to just one address, the child address is also routed as part
16807 of the verification, and in this case the final value of <varname>$address_data</varname> is
16808 from the child&#x2019;s routing.
16809 </para>
16810 <para>
16811 If <varname>$address_data</varname> is set when the routers are called from an ACL to verify a
16812 sender address, the final value is also preserved, but this time in
16813 <varname>$sender_address_data</varname>, to distinguish it from data from a recipient
16814 address.
16815 </para>
16816 <para>
16817 In both cases (recipient and sender verification), the value does not persist
16818 after the end of the current ACL statement. If you want to preserve
16819 these values for longer, you can save them in ACL variables.
16820 </para>
16821 </listitem></varlistentry>
16822 <varlistentry>
16823 <term><varname>$address_file</varname></term>
16824 <listitem>
16825 <para>
16826 <indexterm role="variable">
16827 <primary><varname>$address_file</varname></primary>
16828 </indexterm>
16829 When, as a result of aliasing, forwarding, or filtering, a message is directed
16830 to a specific file, this variable holds the name of the file when the transport
16831 is running. At other times, the variable is empty. For example, using the
16832 default configuration, if user <option>r2d2</option> has a <filename>.forward</filename> file containing
16833 </para>
16834 <literallayout class="monospaced">
16835 /home/r2d2/savemail
16836 </literallayout>
16837 <para>
16838 then when the <command>address_file</command> transport is running, <varname>$address_file</varname>
16839 contains the text string <literal>/home/r2d2/savemail</literal>.
16840 <indexterm role="concept">
16841 <primary>Sieve filter</primary>
16842 <secondary>value of <varname>$address_file</varname></secondary>
16843 </indexterm>
16844 For Sieve filters, the value may be <quote>inbox</quote> or a relative folder name. It is
16845 then up to the transport configuration to generate an appropriate absolute path
16846 to the relevant file.
16847 </para>
16848 </listitem></varlistentry>
16849 <varlistentry>
16850 <term><varname>$address_pipe</varname></term>
16851 <listitem>
16852 <para>
16853 <indexterm role="variable">
16854 <primary><varname>$address_pipe</varname></primary>
16855 </indexterm>
16856 When, as a result of aliasing or forwarding, a message is directed to a pipe,
16857 this variable holds the pipe command when the transport is running.
16858 </para>
16859 </listitem></varlistentry>
16860 <varlistentry>
16861 <term><varname>$auth1</varname> &ndash; <varname>$auth3</varname></term>
16862 <listitem>
16863 <para>
16864 <indexterm role="variable">
16865 <primary><varname>$auth1</varname>, <varname>$auth2</varname>, etc</primary>
16866 </indexterm>
16867 These variables are used in SMTP authenticators (see chapters
16868 <xref linkend="CHAPplaintext"/>&ndash;<xref linkend="CHAPspa"/>). Elsewhere, they are empty.
16869 </para>
16870 </listitem></varlistentry>
16871 <varlistentry>
16872 <term><varname>$authenticated_id</varname></term>
16873 <listitem>
16874 <para>
16875 <indexterm role="concept">
16876 <primary>authentication</primary>
16877 <secondary>id</secondary>
16878 </indexterm>
16879 <indexterm role="variable">
16880 <primary><varname>$authenticated_id</varname></primary>
16881 </indexterm>
16882 When a server successfully authenticates a client it may be configured to
16883 preserve some of the authentication information in the variable
16884 <varname>$authenticated_id</varname> (see chapter <xref linkend="CHAPSMTPAUTH"/>). For example, a
16885 user/password authenticator configuration might preserve the user name for use
16886 in the routers. Note that this is not the same information that is saved in
16887 <varname>$sender_host_authenticated</varname>.
16888 When a message is submitted locally (that is, not over a TCP connection)
16889 the value of <varname>$authenticated_id</varname> is normally the login name of the calling
16890 process. However, a trusted user can override this by means of the <option>-oMai</option>
16891 command line option.
16892 </para>
16893 </listitem></varlistentry>
16894 <varlistentry>
16895 <term><varname>$authenticated_fail_id</varname></term>
16896 <listitem>
16897 <para>
16898 <indexterm role="concept">
16899 <primary>authentication</primary>
16900 <secondary>fail</secondary>
16901 </indexterm>
16902 <indexterm role="variable">
16903 <primary><varname>$authenticated_fail_id</varname></primary>
16904 </indexterm>
16905 When an authentication attempt fails, the variable <varname>$authenticated_fail_id</varname>
16906 will contain the failed authentication id. If more than one authentication
16907 id is attempted, it will contain only the last one. The variable is
16908 available for processing in the ACL&#x2019;s, generally the quit or notquit ACL.
16909 A message to a local recipient could still be accepted without requiring
16910 authentication, which means this variable could also be visible in all of
16911 the ACL&#x2019;s as well.
16912 </para>
16913 </listitem></varlistentry>
16914 <varlistentry>
16915 <term><varname>$authenticated_sender</varname></term>
16916 <listitem>
16917 <para>
16918 <indexterm role="concept">
16919 <primary>sender</primary>
16920 <secondary>authenticated</secondary>
16921 </indexterm>
16922 <indexterm role="concept">
16923 <primary>authentication</primary>
16924 <secondary>sender</secondary>
16925 </indexterm>
16926 <indexterm role="concept">
16927 <primary>AUTH</primary>
16928 <secondary>on MAIL command</secondary>
16929 </indexterm>
16930 <indexterm role="variable">
16931 <primary><varname>$authenticated_sender</varname></primary>
16932 </indexterm>
16933 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
16934 SMTP MAIL command if it believes the sender is sufficiently trusted, as
16935 described in section <xref linkend="SECTauthparamail"/>. Unless the data is the string
16936 <quote>&lt;&gt;</quote>, it is set as the authenticated sender of the message, and the value is
16937 available during delivery in the <varname>$authenticated_sender</varname> variable. If the
16938 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
16939 </para>
16940 <para>
16941 <indexterm role="variable">
16942 <primary><varname>$qualify_domain</varname></primary>
16943 </indexterm>
16944 When a message is submitted locally (that is, not over a TCP connection), the
16945 value of <varname>$authenticated_sender</varname> is an address constructed from the login
16946 name of the calling process and <varname>$qualify_domain</varname>, except that a trusted user
16947 can override this by means of the <option>-oMas</option> command line option.
16948 </para>
16949 </listitem></varlistentry>
16950 <varlistentry>
16951 <term><varname>$authentication_failed</varname></term>
16952 <listitem>
16953 <para>
16954 <indexterm role="concept">
16955 <primary>authentication</primary>
16956 <secondary>failure</secondary>
16957 </indexterm>
16958 <indexterm role="variable">
16959 <primary><varname>$authentication_failed</varname></primary>
16960 </indexterm>
16961 This variable is set to <quote>1</quote> in an Exim server if a client issues an AUTH
16962 command that does not succeed. Otherwise it is set to <quote>0</quote>. This makes it
16963 possible to distinguish between <quote>did not try to authenticate</quote>
16964 (<varname>$sender_host_authenticated</varname> is empty and <varname>$authentication_failed</varname> is set to
16965 <quote>0</quote>) and <quote>tried to authenticate but failed</quote> (<varname>$sender_host_authenticated</varname>
16966 is empty and <varname>$authentication_failed</varname> is set to <quote>1</quote>). Failure includes any
16967 negative response to an AUTH command, including (for example) an attempt to use
16968 an undefined mechanism.
16969 </para>
16970 </listitem></varlistentry>
16971 <varlistentry>
16972 <term><varname>$av_failed</varname></term>
16973 <listitem>
16974 <para>
16975 <indexterm role="concept">
16976 <primary>content scanning</primary>
16977 <secondary>AV scanner failure</secondary>
16978 </indexterm>
16979 This variable is available when Exim is compiled with the content-scanning
16980 extension. It is set to <quote>0</quote> by default, but will be set to <quote>1</quote> if any
16981 problem occurs with the virus scanner (specified by <option>av_scanner</option>) during
16982 the ACL malware condition.
16983 </para>
16984 </listitem></varlistentry>
16985 <varlistentry>
16986 <term><varname>$body_linecount</varname></term>
16987 <listitem>
16988 <para>
16989 <indexterm role="concept">
16990 <primary>message body</primary>
16991 <secondary>line count</secondary>
16992 </indexterm>
16993 <indexterm role="concept">
16994 <primary>body of message</primary>
16995 <secondary>line count</secondary>
16996 </indexterm>
16997 <indexterm role="variable">
16998 <primary><varname>$body_linecount</varname></primary>
16999 </indexterm>
17000 When a message is being received or delivered, this variable contains the
17001 number of lines in the message&#x2019;s body. See also <varname>$message_linecount</varname>.
17002 </para>
17003 </listitem></varlistentry>
17004 <varlistentry>
17005 <term><varname>$body_zerocount</varname></term>
17006 <listitem>
17007 <para>
17008 <indexterm role="concept">
17009 <primary>message body</primary>
17010 <secondary>binary zero count</secondary>
17011 </indexterm>
17012 <indexterm role="concept">
17013 <primary>body of message</primary>
17014 <secondary>binary zero count</secondary>
17015 </indexterm>
17016 <indexterm role="concept">
17017 <primary>binary zero</primary>
17018 <secondary>in message body</secondary>
17019 </indexterm>
17020 <indexterm role="variable">
17021 <primary><varname>$body_zerocount</varname></primary>
17022 </indexterm>
17023 When a message is being received or delivered, this variable contains the
17024 number of binary zero bytes (ASCII NULs) in the message&#x2019;s body.
17025 </para>
17026 </listitem></varlistentry>
17027 <varlistentry>
17028 <term><varname>$bounce_recipient</varname></term>
17029 <listitem>
17030 <para>
17031 <indexterm role="variable">
17032 <primary><varname>$bounce_recipient</varname></primary>
17033 </indexterm>
17034 This is set to the recipient address of a bounce message while Exim is creating
17035 it. It is useful if a customized bounce message text file is in use (see
17036 chapter <xref linkend="CHAPemsgcust"/>).
17037 </para>
17038 </listitem></varlistentry>
17039 <varlistentry>
17040 <term><varname>$bounce_return_size_limit</varname></term>
17041 <listitem>
17042 <para>
17043 <indexterm role="variable">
17044 <primary><varname>$bounce_return_size_limit</varname></primary>
17045 </indexterm>
17046 This contains the value set in the <option>bounce_return_size_limit</option> option, rounded
17047 up to a multiple of 1000. It is useful when a customized error message text
17048 file is in use (see chapter <xref linkend="CHAPemsgcust"/>).
17049 </para>
17050 </listitem></varlistentry>
17051 <varlistentry>
17052 <term><varname>$caller_gid</varname></term>
17053 <listitem>
17054 <para>
17055 <indexterm role="concept">
17056 <primary>gid (group id)</primary>
17057 <secondary>caller</secondary>
17058 </indexterm>
17059 <indexterm role="variable">
17060 <primary><varname>$caller_gid</varname></primary>
17061 </indexterm>
17062 The real group id under which the process that called Exim was running. This is
17063 not the same as the group id of the originator of a message (see
17064 <varname>$originator_gid</varname>). If Exim re-execs itself, this variable in the new
17065 incarnation normally contains the Exim gid.
17066 </para>
17067 </listitem></varlistentry>
17068 <varlistentry>
17069 <term><varname>$caller_uid</varname></term>
17070 <listitem>
17071 <para>
17072 <indexterm role="concept">
17073 <primary>uid (user id)</primary>
17074 <secondary>caller</secondary>
17075 </indexterm>
17076 <indexterm role="variable">
17077 <primary><varname>$caller_uid</varname></primary>
17078 </indexterm>
17079 The real user id under which the process that called Exim was running. This is
17080 not the same as the user id of the originator of a message (see
17081 <varname>$originator_uid</varname>). If Exim re-execs itself, this variable in the new
17082 incarnation normally contains the Exim uid.
17083 </para>
17084 </listitem></varlistentry>
17085 <varlistentry>
17086 <term><varname>$compile_date</varname></term>
17087 <listitem>
17088 <para>
17089 <indexterm role="variable">
17090 <primary><varname>$compile_date</varname></primary>
17091 </indexterm>
17092 The date on which the Exim binary was compiled.
17093 </para>
17094 </listitem></varlistentry>
17095 <varlistentry>
17096 <term><varname>$compile_number</varname></term>
17097 <listitem>
17098 <para>
17099 <indexterm role="variable">
17100 <primary><varname>$compile_number</varname></primary>
17101 </indexterm>
17102 The building process for Exim keeps a count of the number
17103 of times it has been compiled. This serves to distinguish different
17104 compilations of the same version of the program.
17105 </para>
17106 </listitem></varlistentry>
17107 <varlistentry>
17108 <term><varname>$demime_errorlevel</varname></term>
17109 <listitem>
17110 <para>
17111 <indexterm role="variable">
17112 <primary><varname>$demime_errorlevel</varname></primary>
17113 </indexterm>
17114 This variable is available when Exim is compiled with
17115 the content-scanning extension and the obsolete <option>demime</option> condition. For
17116 details, see section <xref linkend="SECTdemimecond"/>.
17117 </para>
17118 </listitem></varlistentry>
17119 <varlistentry>
17120 <term><varname>$demime_reason</varname></term>
17121 <listitem>
17122 <para>
17123 <indexterm role="variable">
17124 <primary><varname>$demime_reason</varname></primary>
17125 </indexterm>
17126 This variable is available when Exim is compiled with the
17127 content-scanning extension and the obsolete <option>demime</option> condition. For details,
17128 see section <xref linkend="SECTdemimecond"/>.
17129 </para>
17130 </listitem></varlistentry>
17131 <varlistentry>
17132 <term><varname>$dnslist_domain</varname></term>
17133 <term><varname>$dnslist_matched</varname></term>
17134 <term><varname>$dnslist_text</varname></term>
17135 <term><varname>$dnslist_value</varname></term>
17136 <listitem>
17137 <para>
17138 <indexterm role="variable">
17139 <primary><varname>$dnslist_domain</varname></primary>
17140 </indexterm>
17141 <indexterm role="variable">
17142 <primary><varname>$dnslist_matched</varname></primary>
17143 </indexterm>
17144 <indexterm role="variable">
17145 <primary><varname>$dnslist_text</varname></primary>
17146 </indexterm>
17147 <indexterm role="variable">
17148 <primary><varname>$dnslist_value</varname></primary>
17149 </indexterm>
17150 <indexterm role="concept">
17151 <primary>black list (DNS)</primary>
17152 </indexterm>
17153 When a DNS (black) list lookup succeeds, these variables are set to contain
17154 the following data from the lookup: the list&#x2019;s domain name, the key that was
17155 looked up, the contents of any associated TXT record, and the value from the
17156 main A record. See section <xref linkend="SECID204"/> for more details.
17157 </para>
17158 </listitem></varlistentry>
17159 <varlistentry>
17160 <term><varname>$domain</varname></term>
17161 <listitem>
17162 <para>
17163 <indexterm role="variable">
17164 <primary><varname>$domain</varname></primary>
17165 </indexterm>
17166 When an address is being routed, or delivered on its own, this variable
17167 contains the domain. Uppercase letters in the domain are converted into lower
17168 case for <varname>$domain</varname>.
17169 </para>
17170 <para>
17171 Global address rewriting happens when a message is received, so the value of
17172 <varname>$domain</varname> during routing and delivery is the value after rewriting. <varname>$domain</varname>
17173 is set during user filtering, but not during system filtering, because a
17174 message may have many recipients and the system filter is called just once.
17175 </para>
17176 <para>
17177 When more than one address is being delivered at once (for example, several
17178 RCPT commands in one SMTP delivery), <varname>$domain</varname> is set only if they all
17179 have the same domain. Transports can be restricted to handling only one domain
17180 at a time if the value of <varname>$domain</varname> is required at transport time &ndash; this is
17181 the default for local transports. For further details of the environment in
17182 which local transports are run, see chapter <xref linkend="CHAPenvironment"/>.
17183 </para>
17184 <para>
17185 <indexterm role="option">
17186 <primary><option>delay_warning_condition</option></primary>
17187 </indexterm>
17188 At the end of a delivery, if all deferred addresses have the same domain, it is
17189 set in <varname>$domain</varname> during the expansion of <option>delay_warning_condition</option>.
17190 </para>
17191 <para>
17192 The <varname>$domain</varname> variable is also used in some other circumstances:
17193 </para>
17194 <itemizedlist>
17195 <listitem>
17196 <para>
17197 When an ACL is running for a RCPT command, <varname>$domain</varname> contains the domain of
17198 the recipient address. The domain of the <emphasis>sender</emphasis> address is in
17199 <varname>$sender_address_domain</varname> at both MAIL time and at RCPT time. <varname>$domain</varname> is not
17200 normally set during the running of the MAIL ACL. However, if the sender address
17201 is verified with a callout during the MAIL ACL, the sender domain is placed in
17202 <varname>$domain</varname> during the expansions of <option>hosts</option>, <option>interface</option>, and <option>port</option> in
17203 the <command>smtp</command> transport.
17204 </para>
17205 </listitem>
17206 <listitem>
17207 <para>
17208 When a rewrite item is being processed (see chapter <xref linkend="CHAPrewrite"/>),
17209 <varname>$domain</varname> contains the domain portion of the address that is being rewritten;
17210 it can be used in the expansion of the replacement address, for example, to
17211 rewrite domains by file lookup.
17212 </para>
17213 </listitem>
17214 <listitem>
17215 <para>
17216 With one important exception, whenever a domain list is being scanned,
17217 <varname>$domain</varname> contains the subject domain. <emphasis role="bold">Exception</emphasis>: When a domain list in
17218 a <option>sender_domains</option> condition in an ACL is being processed, the subject domain
17219 is in <varname>$sender_address_domain</varname> and not in <varname>$domain</varname>. It works this way so
17220 that, in a RCPT ACL, the sender domain list can be dependent on the
17221 recipient domain (which is what is in <varname>$domain</varname> at this time).
17222 </para>
17223 </listitem>
17224 <listitem>
17225 <para>
17226 <indexterm role="concept">
17227 <primary>ETRN</primary>
17228 <secondary>value of <varname>$domain</varname></secondary>
17229 </indexterm>
17230 <indexterm role="option">
17231 <primary><option>smtp_etrn_command</option></primary>
17232 </indexterm>
17233 When the <option>smtp_etrn_command</option> option is being expanded, <varname>$domain</varname> contains
17234 the complete argument of the ETRN command (see section <xref linkend="SECTETRN"/>).
17235 </para>
17236 </listitem>
17237 </itemizedlist>
17238 </listitem></varlistentry>
17239 <varlistentry>
17240 <term><varname>$domain_data</varname></term>
17241 <listitem>
17242 <para>
17243 <indexterm role="variable">
17244 <primary><varname>$domain_data</varname></primary>
17245 </indexterm>
17246 When the <option>domains</option> option on a router matches a domain by
17247 means of a lookup, the data read by the lookup is available during the running
17248 of the router as <varname>$domain_data</varname>. In addition, if the driver routes the
17249 address to a transport, the value is available in that transport. If the
17250 transport is handling multiple addresses, the value from the first address is
17251 used.
17252 </para>
17253 <para>
17254 <varname>$domain_data</varname> is also set when the <option>domains</option> condition in an ACL matches a
17255 domain by means of a lookup. The data read by the lookup is available during
17256 the rest of the ACL statement. In all other situations, this variable expands
17257 to nothing.
17258 </para>
17259 </listitem></varlistentry>
17260 <varlistentry>
17261 <term><varname>$exim_gid</varname></term>
17262 <listitem>
17263 <para>
17264 <indexterm role="variable">
17265 <primary><varname>$exim_gid</varname></primary>
17266 </indexterm>
17267 This variable contains the numerical value of the Exim group id.
17268 </para>
17269 </listitem></varlistentry>
17270 <varlistentry>
17271 <term><varname>$exim_path</varname></term>
17272 <listitem>
17273 <para>
17274 <indexterm role="variable">
17275 <primary><varname>$exim_path</varname></primary>
17276 </indexterm>
17277 This variable contains the path to the Exim binary.
17278 </para>
17279 </listitem></varlistentry>
17280 <varlistentry>
17281 <term><varname>$exim_uid</varname></term>
17282 <listitem>
17283 <para>
17284 <indexterm role="variable">
17285 <primary><varname>$exim_uid</varname></primary>
17286 </indexterm>
17287 This variable contains the numerical value of the Exim user id.
17288 </para>
17289 </listitem></varlistentry>
17290 <varlistentry>
17291 <term><varname>$found_extension</varname></term>
17292 <listitem>
17293 <para>
17294 <indexterm role="variable">
17295 <primary><varname>$found_extension</varname></primary>
17296 </indexterm>
17297 This variable is available when Exim is compiled with the
17298 content-scanning extension and the obsolete <option>demime</option> condition. For details,
17299 see section <xref linkend="SECTdemimecond"/>.
17300 </para>
17301 </listitem></varlistentry>
17302 <varlistentry>
17303 <term><varname>$header_</varname>&lt;<emphasis>name</emphasis>&gt;</term>
17304 <listitem>
17305 <para>
17306 This is not strictly an expansion variable. It is expansion syntax for
17307 inserting the message header line with the given name. Note that the name must
17308 be terminated by colon or white space, because it may contain a wide variety of
17309 characters. Note also that braces must <emphasis>not</emphasis> be used.
17310 </para>
17311 </listitem></varlistentry>
17312 <varlistentry>
17313 <term><varname>$headers_added</varname></term>
17314 <listitem>
17315 <para>
17316 <indexterm role="variable">
17317 <primary><varname>$headers_added</varname></primary>
17318 </indexterm>
17319 Within an ACL this variable contains the headers added so far by
17320 the ACL modifier add_header (section <xref linkend="SECTaddheadacl"/>).
17321 The headers are a newline-separated list.
17322 </para>
17323 </listitem></varlistentry>
17324 <varlistentry>
17325 <term><varname>$home</varname></term>
17326 <listitem>
17327 <para>
17328 <indexterm role="variable">
17329 <primary><varname>$home</varname></primary>
17330 </indexterm>
17331 When the <option>check_local_user</option> option is set for a router, the user&#x2019;s home
17332 directory is placed in <varname>$home</varname> when the check succeeds. In particular, this
17333 means it is set during the running of users&#x2019; filter files. A router may also
17334 explicitly set a home directory for use by a transport; this can be overridden
17335 by a setting on the transport itself.
17336 </para>
17337 <para>
17338 When running a filter test via the <option>-bf</option> option, <varname>$home</varname> is set to the value
17339 of the environment variable HOME.
17340 </para>
17341 </listitem></varlistentry>
17342 <varlistentry>
17343 <term><varname>$host</varname></term>
17344 <listitem>
17345 <para>
17346 <indexterm role="variable">
17347 <primary><varname>$host</varname></primary>
17348 </indexterm>
17349 If a router assigns an address to a transport (any transport), and passes a
17350 list of hosts with the address, the value of <varname>$host</varname> when the transport starts
17351 to run is the name of the first host on the list. Note that this applies both
17352 to local and remote transports.
17353 </para>
17354 <para>
17355 <indexterm role="concept">
17356 <primary>transport</primary>
17357 <secondary>filter</secondary>
17358 </indexterm>
17359 <indexterm role="concept">
17360 <primary>filter</primary>
17361 <secondary>transport filter</secondary>
17362 </indexterm>
17363 For the <command>smtp</command> transport, if there is more than one host, the value of
17364 <varname>$host</varname> changes as the transport works its way through the list. In
17365 particular, when the <command>smtp</command> transport is expanding its options for encryption
17366 using TLS, or for specifying a transport filter (see chapter
17367 <xref linkend="CHAPtransportgeneric"/>), <varname>$host</varname> contains the name of the host to which it
17368 is connected.
17369 </para>
17370 <para>
17371 When used in the client part of an authenticator configuration (see chapter
17372 <xref linkend="CHAPSMTPAUTH"/>), <varname>$host</varname> contains the name of the server to which the
17373 client is connected.
17374 </para>
17375 </listitem></varlistentry>
17376 <varlistentry>
17377 <term><varname>$host_address</varname></term>
17378 <listitem>
17379 <para>
17380 <indexterm role="variable">
17381 <primary><varname>$host_address</varname></primary>
17382 </indexterm>
17383 This variable is set to the remote host&#x2019;s IP address whenever <varname>$host</varname> is set
17384 for a remote connection. It is also set to the IP address that is being checked
17385 when the <option>ignore_target_hosts</option> option is being processed.
17386 </para>
17387 </listitem></varlistentry>
17388 <varlistentry>
17389 <term><varname>$host_data</varname></term>
17390 <listitem>
17391 <para>
17392 <indexterm role="variable">
17393 <primary><varname>$host_data</varname></primary>
17394 </indexterm>
17395 If a <option>hosts</option> condition in an ACL is satisfied by means of a lookup, the
17396 result of the lookup is made available in the <varname>$host_data</varname> variable. This
17397 allows you, for example, to do things like this:
17398 </para>
17399 <literallayout class="monospaced">
17400 deny  hosts = net-lsearch;/some/file
17401 message = $host_data
17402 </literallayout>
17403 </listitem></varlistentry>
17404 <varlistentry>
17405 <term><varname>$host_lookup_deferred</varname></term>
17406 <listitem>
17407 <para>
17408 <indexterm role="concept">
17409 <primary>host name</primary>
17410 <secondary>lookup, failure of</secondary>
17411 </indexterm>
17412 <indexterm role="variable">
17413 <primary><varname>$host_lookup_deferred</varname></primary>
17414 </indexterm>
17415 This variable normally contains <quote>0</quote>, as does <varname>$host_lookup_failed</varname>. When a
17416 message comes from a remote host and there is an attempt to look up the host&#x2019;s
17417 name from its IP address, and the attempt is not successful, one of these
17418 variables is set to <quote>1</quote>.
17419 </para>
17420 <itemizedlist>
17421 <listitem>
17422 <para>
17423 If the lookup receives a definite negative response (for example, a DNS lookup
17424 succeeded, but no records were found), <varname>$host_lookup_failed</varname> is set to <quote>1</quote>.
17425 </para>
17426 </listitem>
17427 <listitem>
17428 <para>
17429 If there is any kind of problem during the lookup, such that Exim cannot
17430 tell whether or not the host name is defined (for example, a timeout for a DNS
17431 lookup), <varname>$host_lookup_deferred</varname> is set to <quote>1</quote>.
17432 </para>
17433 </listitem>
17434 </itemizedlist>
17435 <para>
17436 Looking up a host&#x2019;s name from its IP address consists of more than just a
17437 single reverse lookup. Exim checks that a forward lookup of at least one of the
17438 names it receives from a reverse lookup yields the original IP address. If this
17439 is not the case, Exim does not accept the looked up name(s), and
17440 <varname>$host_lookup_failed</varname> is set to <quote>1</quote>. Thus, being able to find a name from an
17441 IP address (for example, the existence of a PTR record in the DNS) is not
17442 sufficient on its own for the success of a host name lookup. If the reverse
17443 lookup succeeds, but there is a lookup problem such as a timeout when checking
17444 the result, the name is not accepted, and <varname>$host_lookup_deferred</varname> is set to
17445 <quote>1</quote>. See also <varname>$sender_host_name</varname>.
17446 </para>
17447 </listitem></varlistentry>
17448 <varlistentry>
17449 <term><varname>$host_lookup_failed</varname></term>
17450 <listitem>
17451 <para>
17452 <indexterm role="variable">
17453 <primary><varname>$host_lookup_failed</varname></primary>
17454 </indexterm>
17455 See <varname>$host_lookup_deferred</varname>.
17456 </para>
17457 </listitem></varlistentry>
17458 <varlistentry>
17459 <term><varname>$inode</varname></term>
17460 <listitem>
17461 <para>
17462 <indexterm role="variable">
17463 <primary><varname>$inode</varname></primary>
17464 </indexterm>
17465 The only time this variable is set is while expanding the <option>directory_file</option>
17466 option in the <command>appendfile</command> transport. The variable contains the inode number
17467 of the temporary file which is about to be renamed. It can be used to construct
17468 a unique name for the file.
17469 </para>
17470 </listitem></varlistentry>
17471 <varlistentry>
17472 <term><varname>$interface_address</varname></term>
17473 <listitem>
17474 <para>
17475 <indexterm role="variable">
17476 <primary><varname>$interface_address</varname></primary>
17477 </indexterm>
17478 This is an obsolete name for <varname>$received_ip_address</varname>.
17479 </para>
17480 </listitem></varlistentry>
17481 <varlistentry>
17482 <term><varname>$interface_port</varname></term>
17483 <listitem>
17484 <para>
17485 <indexterm role="variable">
17486 <primary><varname>$interface_port</varname></primary>
17487 </indexterm>
17488 This is an obsolete name for <varname>$received_port</varname>.
17489 </para>
17490 </listitem></varlistentry>
17491 <varlistentry>
17492 <term><varname>$item</varname></term>
17493 <listitem>
17494 <para>
17495 <indexterm role="variable">
17496 <primary><varname>$item</varname></primary>
17497 </indexterm>
17498 This variable is used during the expansion of <emphasis role="bold">forall</emphasis> and <emphasis role="bold">forany</emphasis>
17499 conditions (see section <xref linkend="SECTexpcond"/>), and <emphasis role="bold">filter</emphasis>, <emphasis role="bold">map</emphasis>, and
17500 <emphasis role="bold">reduce</emphasis> items (see section <xref linkend="SECTexpcond"/>). In other circumstances, it is
17501 empty.
17502 </para>
17503 </listitem></varlistentry>
17504 <varlistentry>
17505 <term><varname>$ldap_dn</varname></term>
17506 <listitem>
17507 <para>
17508 <indexterm role="variable">
17509 <primary><varname>$ldap_dn</varname></primary>
17510 </indexterm>
17511 This variable, which is available only when Exim is compiled with LDAP support,
17512 contains the DN from the last entry in the most recently successful LDAP
17513 lookup.
17514 </para>
17515 </listitem></varlistentry>
17516 <varlistentry>
17517 <term><varname>$load_average</varname></term>
17518 <listitem>
17519 <para>
17520 <indexterm role="variable">
17521 <primary><varname>$load_average</varname></primary>
17522 </indexterm>
17523 This variable contains the system load average, multiplied by 1000 so that it
17524 is an integer. For example, if the load average is 0.21, the value of the
17525 variable is 210. The value is recomputed every time the variable is referenced.
17526 </para>
17527 </listitem></varlistentry>
17528 <varlistentry>
17529 <term><varname>$local_part</varname></term>
17530 <listitem>
17531 <para>
17532 <indexterm role="variable">
17533 <primary><varname>$local_part</varname></primary>
17534 </indexterm>
17535 When an address is being routed, or delivered on its own, this
17536 variable contains the local part. When a number of addresses are being
17537 delivered together (for example, multiple RCPT commands in an SMTP
17538 session), <varname>$local_part</varname> is not set.
17539 </para>
17540 <para>
17541 Global address rewriting happens when a message is received, so the value of
17542 <varname>$local_part</varname> during routing and delivery is the value after rewriting.
17543 <varname>$local_part</varname> is set during user filtering, but not during system filtering,
17544 because a message may have many recipients and the system filter is called just
17545 once.
17546 </para>
17547 <para>
17548 <indexterm role="variable">
17549 <primary><varname>$local_part_prefix</varname></primary>
17550 </indexterm>
17551 <indexterm role="variable">
17552 <primary><varname>$local_part_suffix</varname></primary>
17553 </indexterm>
17554 If a local part prefix or suffix has been recognized, it is not included in the
17555 value of <varname>$local_part</varname> during routing and subsequent delivery. The values of
17556 any prefix or suffix are in <varname>$local_part_prefix</varname> and
17557 <varname>$local_part_suffix</varname>, respectively.
17558 </para>
17559 <para>
17560 When a message is being delivered to a file, pipe, or autoreply transport as a
17561 result of aliasing or forwarding, <varname>$local_part</varname> is set to the local part of
17562 the parent address, not to the file name or command (see <varname>$address_file</varname> and
17563 <varname>$address_pipe</varname>).
17564 </para>
17565 <para>
17566 When an ACL is running for a RCPT command, <varname>$local_part</varname> contains the
17567 local part of the recipient address.
17568 </para>
17569 <para>
17570 When a rewrite item is being processed (see chapter <xref linkend="CHAPrewrite"/>),
17571 <varname>$local_part</varname> contains the local part of the address that is being rewritten;
17572 it can be used in the expansion of the replacement address, for example.
17573 </para>
17574 <para>
17575 In all cases, all quoting is removed from the local part. For example, for both
17576 the addresses
17577 </para>
17578 <literallayout class="monospaced">
17579 "abc:xyz"@test.example
17580 abc\:xyz@test.example
17581 </literallayout>
17582 <para>
17583 the value of <varname>$local_part</varname> is
17584 </para>
17585 <literallayout class="monospaced">
17586 abc:xyz
17587 </literallayout>
17588 <para>
17589 If you use <varname>$local_part</varname> to create another address, you should always wrap it
17590 inside a quoting operator. For example, in a <command>redirect</command> router you could
17591 have:
17592 </para>
17593 <literallayout class="monospaced">
17594 data = ${quote_local_part:$local_part}@new.domain.example
17595 </literallayout>
17596 <para>
17597 <emphasis role="bold">Note</emphasis>: The value of <varname>$local_part</varname> is normally lower cased. If you want
17598 to process local parts in a case-dependent manner in a router, you can set the
17599 <option>caseful_local_part</option> option (see chapter <xref linkend="CHAProutergeneric"/>).
17600 </para>
17601 </listitem></varlistentry>
17602 <varlistentry>
17603 <term><varname>$local_part_data</varname></term>
17604 <listitem>
17605 <para>
17606 <indexterm role="variable">
17607 <primary><varname>$local_part_data</varname></primary>
17608 </indexterm>
17609 When the <option>local_parts</option> option on a router matches a local part by means of a
17610 lookup, the data read by the lookup is available during the running of the
17611 router as <varname>$local_part_data</varname>. In addition, if the driver routes the address
17612 to a transport, the value is available in that transport. If the transport is
17613 handling multiple addresses, the value from the first address is used.
17614 </para>
17615 <para>
17616 <varname>$local_part_data</varname> is also set when the <option>local_parts</option> condition in an ACL
17617 matches a local part by means of a lookup. The data read by the lookup is
17618 available during the rest of the ACL statement. In all other situations, this
17619 variable expands to nothing.
17620 </para>
17621 </listitem></varlistentry>
17622 <varlistentry>
17623 <term><varname>$local_part_prefix</varname></term>
17624 <listitem>
17625 <para>
17626 <indexterm role="variable">
17627 <primary><varname>$local_part_prefix</varname></primary>
17628 </indexterm>
17629 When an address is being routed or delivered, and a
17630 specific prefix for the local part was recognized, it is available in this
17631 variable, having been removed from <varname>$local_part</varname>.
17632 </para>
17633 </listitem></varlistentry>
17634 <varlistentry>
17635 <term><varname>$local_part_suffix</varname></term>
17636 <listitem>
17637 <para>
17638 <indexterm role="variable">
17639 <primary><varname>$local_part_suffix</varname></primary>
17640 </indexterm>
17641 When an address is being routed or delivered, and a
17642 specific suffix for the local part was recognized, it is available in this
17643 variable, having been removed from <varname>$local_part</varname>.
17644 </para>
17645 </listitem></varlistentry>
17646 <varlistentry>
17647 <term><varname>$local_scan_data</varname></term>
17648 <listitem>
17649 <para>
17650 <indexterm role="variable">
17651 <primary><varname>$local_scan_data</varname></primary>
17652 </indexterm>
17653 This variable contains the text returned by the <function>local_scan()</function> function when
17654 a message is received. See chapter <xref linkend="CHAPlocalscan"/> for more details.
17655 </para>
17656 </listitem></varlistentry>
17657 <varlistentry>
17658 <term><varname>$local_user_gid</varname></term>
17659 <listitem>
17660 <para>
17661 <indexterm role="variable">
17662 <primary><varname>$local_user_gid</varname></primary>
17663 </indexterm>
17664 See <varname>$local_user_uid</varname>.
17665 </para>
17666 </listitem></varlistentry>
17667 <varlistentry>
17668 <term><varname>$local_user_uid</varname></term>
17669 <listitem>
17670 <para>
17671 <indexterm role="variable">
17672 <primary><varname>$local_user_uid</varname></primary>
17673 </indexterm>
17674 This variable and <varname>$local_user_gid</varname> are set to the uid and gid after the
17675 <option>check_local_user</option> router precondition succeeds. This means that their values
17676 are available for the remaining preconditions (<option>senders</option>, <option>require_files</option>,
17677 and <option>condition</option>), for the <option>address_data</option> expansion, and for any
17678 router-specific expansions. At all other times, the values in these variables
17679 are <literal>(uid_t)(-1)</literal> and <literal>(gid_t)(-1)</literal>, respectively.
17680 </para>
17681 </listitem></varlistentry>
17682 <varlistentry>
17683 <term><varname>$localhost_number</varname></term>
17684 <listitem>
17685 <para>
17686 <indexterm role="variable">
17687 <primary><varname>$localhost_number</varname></primary>
17688 </indexterm>
17689 This contains the expanded value of the
17690 <option>localhost_number</option> option. The expansion happens after the main options have
17691 been read.
17692 </para>
17693 </listitem></varlistentry>
17694 <varlistentry>
17695 <term><varname>$log_inodes</varname></term>
17696 <listitem>
17697 <para>
17698 <indexterm role="variable">
17699 <primary><varname>$log_inodes</varname></primary>
17700 </indexterm>
17701 The number of free inodes in the disk partition where Exim&#x2019;s
17702 log files are being written. The value is recalculated whenever the variable is
17703 referenced. If the relevant file system does not have the concept of inodes,
17704 the value of is -1. See also the <option>check_log_inodes</option> option.
17705 </para>
17706 </listitem></varlistentry>
17707 <varlistentry>
17708 <term><varname>$log_space</varname></term>
17709 <listitem>
17710 <para>
17711 <indexterm role="variable">
17712 <primary><varname>$log_space</varname></primary>
17713 </indexterm>
17714 The amount of free space (as a number of kilobytes) in the disk
17715 partition where Exim&#x2019;s log files are being written. The value is recalculated
17716 whenever the variable is referenced. If the operating system does not have the
17717 ability to find the amount of free space (only true for experimental systems),
17718 the space value is -1. See also the <option>check_log_space</option> option.
17719 </para>
17720 </listitem></varlistentry>
17721 <varlistentry revisionflag="changed">
17722 <term><varname>$lookup_dnssec_authenticated</varname></term>
17723 <listitem>
17724 <para revisionflag="changed">
17725 <indexterm role="variable">
17726 <primary><varname>$lookup_dnssec_authenticated</varname></primary>
17727 </indexterm>
17728 This variable is set after a DNS lookup done by
17729 a dnsdb lookup expansion, dnslookup router or smtp transport.
17730 It will be empty if <command>DNSSEC</command> was not requested,
17731 <quote>no</quote> if the result was not labelled as authenticated data
17732 and <quote>yes</quote> if it was.
17733 </para>
17734 </listitem></varlistentry>
17735 <varlistentry>
17736 <term><varname>$mailstore_basename</varname></term>
17737 <listitem>
17738 <para>
17739 <indexterm role="variable">
17740 <primary><varname>$mailstore_basename</varname></primary>
17741 </indexterm>
17742 This variable is set only when doing deliveries in <quote>mailstore</quote> format in the
17743 <command>appendfile</command> transport. During the expansion of the <option>mailstore_prefix</option>,
17744 <option>mailstore_suffix</option>, <option>message_prefix</option>, and <option>message_suffix</option> options, it
17745 contains the basename of the files that are being written, that is, the name
17746 without the <quote>.tmp</quote>, <quote>.env</quote>, or <quote>.msg</quote> suffix. At all other times, this
17747 variable is empty.
17748 </para>
17749 </listitem></varlistentry>
17750 <varlistentry>
17751 <term><varname>$malware_name</varname></term>
17752 <listitem>
17753 <para>
17754 <indexterm role="variable">
17755 <primary><varname>$malware_name</varname></primary>
17756 </indexterm>
17757 This variable is available when Exim is compiled with the
17758 content-scanning extension. It is set to the name of the virus that was found
17759 when the ACL <option>malware</option> condition is true (see section <xref linkend="SECTscanvirus"/>).
17760 </para>
17761 </listitem></varlistentry>
17762 <varlistentry>
17763 <term><varname>$max_received_linelength</varname></term>
17764 <listitem>
17765 <para>
17766 <indexterm role="variable">
17767 <primary><varname>$max_received_linelength</varname></primary>
17768 </indexterm>
17769 <indexterm role="concept">
17770 <primary>maximum</primary>
17771 <secondary>line length</secondary>
17772 </indexterm>
17773 <indexterm role="concept">
17774 <primary>line length</primary>
17775 <secondary>maximum</secondary>
17776 </indexterm>
17777 This variable contains the number of bytes in the longest line that was
17778 received as part of the message, not counting the line termination
17779 character(s).
17780 </para>
17781 </listitem></varlistentry>
17782 <varlistentry>
17783 <term><varname>$message_age</varname></term>
17784 <listitem>
17785 <para>
17786 <indexterm role="concept">
17787 <primary>message</primary>
17788 <secondary>age of</secondary>
17789 </indexterm>
17790 <indexterm role="variable">
17791 <primary><varname>$message_age</varname></primary>
17792 </indexterm>
17793 This variable is set at the start of a delivery attempt to contain the number
17794 of seconds since the message was received. It does not change during a single
17795 delivery attempt.
17796 </para>
17797 </listitem></varlistentry>
17798 <varlistentry>
17799 <term><varname>$message_body</varname></term>
17800 <listitem>
17801 <para>
17802 <indexterm role="concept">
17803 <primary>body of message</primary>
17804 <secondary>expansion variable</secondary>
17805 </indexterm>
17806 <indexterm role="concept">
17807 <primary>message body</primary>
17808 <secondary>in expansion</secondary>
17809 </indexterm>
17810 <indexterm role="concept">
17811 <primary>binary zero</primary>
17812 <secondary>in message body</secondary>
17813 </indexterm>
17814 <indexterm role="variable">
17815 <primary><varname>$message_body</varname></primary>
17816 </indexterm>
17817 <indexterm role="option">
17818 <primary><option>message_body_visible</option></primary>
17819 </indexterm>
17820 This variable contains the initial portion of a message&#x2019;s body while it is
17821 being delivered, and is intended mainly for use in filter files. The maximum
17822 number of characters of the body that are put into the variable is set by the
17823 <option>message_body_visible</option> configuration option; the default is 500.
17824 </para>
17825 <para>
17826 <indexterm role="option">
17827 <primary><option>message_body_newlines</option></primary>
17828 </indexterm>
17829 By default, newlines are converted into spaces in <varname>$message_body</varname>, to make it
17830 easier to search for phrases that might be split over a line break. However,
17831 this can be disabled by setting <option>message_body_newlines</option> to be true. Binary
17832 zeros are always converted into spaces.
17833 </para>
17834 </listitem></varlistentry>
17835 <varlistentry>
17836 <term><varname>$message_body_end</varname></term>
17837 <listitem>
17838 <para>
17839 <indexterm role="concept">
17840 <primary>body of message</primary>
17841 <secondary>expansion variable</secondary>
17842 </indexterm>
17843 <indexterm role="concept">
17844 <primary>message body</primary>
17845 <secondary>in expansion</secondary>
17846 </indexterm>
17847 <indexterm role="variable">
17848 <primary><varname>$message_body_end</varname></primary>
17849 </indexterm>
17850 This variable contains the final portion of a message&#x2019;s
17851 body while it is being delivered. The format and maximum size are as for
17852 <varname>$message_body</varname>.
17853 </para>
17854 </listitem></varlistentry>
17855 <varlistentry>
17856 <term><varname>$message_body_size</varname></term>
17857 <listitem>
17858 <para>
17859 <indexterm role="concept">
17860 <primary>body of message</primary>
17861 <secondary>size</secondary>
17862 </indexterm>
17863 <indexterm role="concept">
17864 <primary>message body</primary>
17865 <secondary>size</secondary>
17866 </indexterm>
17867 <indexterm role="variable">
17868 <primary><varname>$message_body_size</varname></primary>
17869 </indexterm>
17870 When a message is being delivered, this variable contains the size of the body
17871 in bytes. The count starts from the character after the blank line that
17872 separates the body from the header. Newlines are included in the count. See
17873 also <varname>$message_size</varname>, <varname>$body_linecount</varname>, and <varname>$body_zerocount</varname>.
17874 </para>
17875 </listitem></varlistentry>
17876 <varlistentry>
17877 <term><varname>$message_exim_id</varname></term>
17878 <listitem>
17879 <para>
17880 <indexterm role="variable">
17881 <primary><varname>$message_exim_id</varname></primary>
17882 </indexterm>
17883 When a message is being received or delivered, this variable contains the
17884 unique message id that is generated and used by Exim to identify the message.
17885 An id is not created for a message until after its header has been successfully
17886 received. <emphasis role="bold">Note</emphasis>: This is <emphasis>not</emphasis> the contents of the <emphasis>Message-ID:</emphasis> header
17887 line; it is the local id that Exim assigns to the message, for example:
17888 <literal>1BXTIK-0001yO-VA</literal>.
17889 </para>
17890 </listitem></varlistentry>
17891 <varlistentry>
17892 <term><varname>$message_headers</varname></term>
17893 <listitem>
17894 <para>
17895 <indexterm role="variable">
17896 <primary><varname>$message_headers</varname></primary>
17897 </indexterm>
17898 This variable contains a concatenation of all the header lines when a message
17899 is being processed, except for lines added by routers or transports. The header
17900 lines are separated by newline characters. Their contents are decoded in the
17901 same way as a header line that is inserted by <option>bheader</option>.
17902 </para>
17903 </listitem></varlistentry>
17904 <varlistentry>
17905 <term><varname>$message_headers_raw</varname></term>
17906 <listitem>
17907 <para>
17908 <indexterm role="variable">
17909 <primary><varname>$message_headers_raw</varname></primary>
17910 </indexterm>
17911 This variable is like <varname>$message_headers</varname> except that no processing of the
17912 contents of header lines is done.
17913 </para>
17914 </listitem></varlistentry>
17915 <varlistentry>
17916 <term><varname>$message_id</varname></term>
17917 <listitem>
17918 <para>
17919 This is an old name for <varname>$message_exim_id</varname>, which is now deprecated.
17920 </para>
17921 </listitem></varlistentry>
17922 <varlistentry>
17923 <term><varname>$message_linecount</varname></term>
17924 <listitem>
17925 <para>
17926 <indexterm role="variable">
17927 <primary><varname>$message_linecount</varname></primary>
17928 </indexterm>
17929 This variable contains the total number of lines in the header and body of the
17930 message. Compare <varname>$body_linecount</varname>, which is the count for the body only.
17931 During the DATA and content-scanning ACLs, <varname>$message_linecount</varname> contains the
17932 number of lines received. Before delivery happens (that is, before filters,
17933 routers, and transports run) the count is increased to include the
17934 <emphasis>Received:</emphasis> header line that Exim standardly adds, and also any other header
17935 lines that are added by ACLs. The blank line that separates the message header
17936 from the body is not counted.
17937 </para>
17938 <para>
17939 As with the special case of <varname>$message_size</varname>, during the expansion of the
17940 appendfile transport&#x2019;s maildir_tag option in maildir format, the value of
17941 <varname>$message_linecount</varname> is the precise size of the number of newlines in the
17942 file that has been written (minus one for the blank line between the
17943 header and the body).
17944 </para>
17945 <para>
17946 Here is an example of the use of this variable in a DATA ACL:
17947 </para>
17948 <literallayout class="monospaced">
17949 deny message   = Too many lines in message header
17950      condition = \
17951       ${if &lt;{250}{${eval:$message_linecount - $body_linecount}}}
17952 </literallayout>
17953 <para>
17954 In the MAIL and RCPT ACLs, the value is zero because at that stage the
17955 message has not yet been received.
17956 </para>
17957 </listitem></varlistentry>
17958 <varlistentry>
17959 <term><varname>$message_size</varname></term>
17960 <listitem>
17961 <para>
17962 <indexterm role="concept">
17963 <primary>size</primary>
17964 <secondary>of message</secondary>
17965 </indexterm>
17966 <indexterm role="concept">
17967 <primary>message</primary>
17968 <secondary>size</secondary>
17969 </indexterm>
17970 <indexterm role="variable">
17971 <primary><varname>$message_size</varname></primary>
17972 </indexterm>
17973 When a message is being processed, this variable contains its size in bytes. In
17974 most cases, the size includes those headers that were received with the
17975 message, but not those (such as <emphasis>Envelope-to:</emphasis>) that are added to individual
17976 deliveries as they are written. However, there is one special case: during the
17977 expansion of the <option>maildir_tag</option> option in the <command>appendfile</command> transport while
17978 doing a delivery in maildir format, the value of <varname>$message_size</varname> is the
17979 precise size of the file that has been written. See also
17980 <varname>$message_body_size</varname>, <varname>$body_linecount</varname>, and <varname>$body_zerocount</varname>.
17981 </para>
17982 <para>
17983 <indexterm role="concept">
17984 <primary>RCPT</primary>
17985 <secondary>value of <varname>$message_size</varname></secondary>
17986 </indexterm>
17987 While running a per message ACL (mail/rcpt/predata), <varname>$message_size</varname>
17988 contains the size supplied on the MAIL command, or -1 if no size was given. The
17989 value may not, of course, be truthful.
17990 </para>
17991 </listitem></varlistentry>
17992 <varlistentry>
17993 <term><varname>$mime_</varname><emphasis>xxx</emphasis></term>
17994 <listitem>
17995 <para>
17996 A number of variables whose names start with <varname>$mime</varname> are
17997 available when Exim is compiled with the content-scanning extension. For
17998 details, see section <xref linkend="SECTscanmimepart"/>.
17999 </para>
18000 </listitem></varlistentry>
18001 <varlistentry>
18002 <term><varname>$n0</varname> &ndash; <varname>$n9</varname></term>
18003 <listitem>
18004 <para>
18005 These variables are counters that can be incremented by means
18006 of the <option>add</option> command in filter files.
18007 </para>
18008 </listitem></varlistentry>
18009 <varlistentry>
18010 <term><varname>$original_domain</varname></term>
18011 <listitem>
18012 <para>
18013 <indexterm role="variable">
18014 <primary><varname>$domain</varname></primary>
18015 </indexterm>
18016 <indexterm role="variable">
18017 <primary><varname>$original_domain</varname></primary>
18018 </indexterm>
18019 When a top-level address is being processed for delivery, this contains the
18020 same value as <varname>$domain</varname>. However, if a <quote>child</quote> address (for example,
18021 generated by an alias, forward, or filter file) is being processed, this
18022 variable contains the domain of the original address (lower cased). This
18023 differs from <varname>$parent_domain</varname> only when there is more than one level of
18024 aliasing or forwarding. When more than one address is being delivered in a
18025 single transport run, <varname>$original_domain</varname> is not set.
18026 </para>
18027 <para>
18028 If a new address is created by means of a <option>deliver</option> command in a system
18029 filter, it is set up with an artificial <quote>parent</quote> address. This has the local
18030 part <emphasis>system-filter</emphasis> and the default qualify domain.
18031 </para>
18032 </listitem></varlistentry>
18033 <varlistentry>
18034 <term><varname>$original_local_part</varname></term>
18035 <listitem>
18036 <para>
18037 <indexterm role="variable">
18038 <primary><varname>$local_part</varname></primary>
18039 </indexterm>
18040 <indexterm role="variable">
18041 <primary><varname>$original_local_part</varname></primary>
18042 </indexterm>
18043 When a top-level address is being processed for delivery, this contains the
18044 same value as <varname>$local_part</varname>, unless a prefix or suffix was removed from the
18045 local part, because <varname>$original_local_part</varname> always contains the full local
18046 part. When a <quote>child</quote> address (for example, generated by an alias, forward, or
18047 filter file) is being processed, this variable contains the full local part of
18048 the original address.
18049 </para>
18050 <para>
18051 If the router that did the redirection processed the local part
18052 case-insensitively, the value in <varname>$original_local_part</varname> is in lower case.
18053 This variable differs from <varname>$parent_local_part</varname> only when there is more than
18054 one level of aliasing or forwarding. When more than one address is being
18055 delivered in a single transport run, <varname>$original_local_part</varname> is not set.
18056 </para>
18057 <para>
18058 If a new address is created by means of a <option>deliver</option> command in a system
18059 filter, it is set up with an artificial <quote>parent</quote> address. This has the local
18060 part <emphasis>system-filter</emphasis> and the default qualify domain.
18061 </para>
18062 </listitem></varlistentry>
18063 <varlistentry>
18064 <term><varname>$originator_gid</varname></term>
18065 <listitem>
18066 <para>
18067 <indexterm role="concept">
18068 <primary>gid (group id)</primary>
18069 <secondary>of originating user</secondary>
18070 </indexterm>
18071 <indexterm role="concept">
18072 <primary>sender</primary>
18073 <secondary>gid</secondary>
18074 </indexterm>
18075 <indexterm role="variable">
18076 <primary><varname>$caller_gid</varname></primary>
18077 </indexterm>
18078 <indexterm role="variable">
18079 <primary><varname>$originator_gid</varname></primary>
18080 </indexterm>
18081 This variable contains the value of <varname>$caller_gid</varname> that was set when the
18082 message was received. For messages received via the command line, this is the
18083 gid of the sending user. For messages received by SMTP over TCP/IP, this is
18084 normally the gid of the Exim user.
18085 </para>
18086 </listitem></varlistentry>
18087 <varlistentry>
18088 <term><varname>$originator_uid</varname></term>
18089 <listitem>
18090 <para>
18091 <indexterm role="concept">
18092 <primary>uid (user id)</primary>
18093 <secondary>of originating user</secondary>
18094 </indexterm>
18095 <indexterm role="concept">
18096 <primary>sender</primary>
18097 <secondary>uid</secondary>
18098 </indexterm>
18099 <indexterm role="variable">
18100 <primary><varname>$caller_uid</varname></primary>
18101 </indexterm>
18102 <indexterm role="variable">
18103 <primary><varname>$originaltor_uid</varname></primary>
18104 </indexterm>
18105 The value of <varname>$caller_uid</varname> that was set when the message was received. For
18106 messages received via the command line, this is the uid of the sending user.
18107 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
18108 user.
18109 </para>
18110 </listitem></varlistentry>
18111 <varlistentry>
18112 <term><varname>$parent_domain</varname></term>
18113 <listitem>
18114 <para>
18115 <indexterm role="variable">
18116 <primary><varname>$parent_domain</varname></primary>
18117 </indexterm>
18118 This variable is similar to <varname>$original_domain</varname> (see
18119 above), except that it refers to the immediately preceding parent address.
18120 </para>
18121 </listitem></varlistentry>
18122 <varlistentry>
18123 <term><varname>$parent_local_part</varname></term>
18124 <listitem>
18125 <para>
18126 <indexterm role="variable">
18127 <primary><varname>$parent_local_part</varname></primary>
18128 </indexterm>
18129 This variable is similar to <varname>$original_local_part</varname>
18130 (see above), except that it refers to the immediately preceding parent address.
18131 </para>
18132 </listitem></varlistentry>
18133 <varlistentry>
18134 <term><varname>$pid</varname></term>
18135 <listitem>
18136 <para>
18137 <indexterm role="concept">
18138 <primary>pid (process id)</primary>
18139 <secondary>of current process</secondary>
18140 </indexterm>
18141 <indexterm role="variable">
18142 <primary><varname>$pid</varname></primary>
18143 </indexterm>
18144 This variable contains the current process id.
18145 </para>
18146 </listitem></varlistentry>
18147 <varlistentry>
18148 <term><varname>$pipe_addresses</varname></term>
18149 <listitem>
18150 <para>
18151 <indexterm role="concept">
18152 <primary>filter</primary>
18153 <secondary>transport filter</secondary>
18154 </indexterm>
18155 <indexterm role="concept">
18156 <primary>transport</primary>
18157 <secondary>filter</secondary>
18158 </indexterm>
18159 <indexterm role="variable">
18160 <primary><varname>$pipe_addresses</varname></primary>
18161 </indexterm>
18162 This is not an expansion variable, but is mentioned here because the string
18163 <literal>$pipe_addresses</literal> is handled specially in the command specification for the
18164 <command>pipe</command> transport (chapter <xref linkend="CHAPpipetransport"/>) and in transport filters
18165 (described under <option>transport_filter</option> in chapter <xref linkend="CHAPtransportgeneric"/>).
18166 It cannot be used in general expansion strings, and provokes an <quote>unknown
18167 variable</quote> error if encountered.
18168 </para>
18169 </listitem></varlistentry>
18170 <varlistentry>
18171 <term><varname>$primary_hostname</varname></term>
18172 <listitem>
18173 <para>
18174 <indexterm role="variable">
18175 <primary><varname>$primary_hostname</varname></primary>
18176 </indexterm>
18177 This variable contains the value set by <option>primary_hostname</option> in the
18178 configuration file, or read by the <function>uname()</function> function. If <function>uname()</function> returns
18179 a single-component name, Exim calls <function>gethostbyname()</function> (or
18180 <function>getipnodebyname()</function> where available) in an attempt to acquire a fully
18181 qualified host name. See also <varname>$smtp_active_hostname</varname>.
18182 </para>
18183 </listitem></varlistentry>
18184 <varlistentry>
18185 <term><varname>$prvscheck_address</varname></term>
18186 <listitem>
18187 <para>
18188 This variable is used in conjunction with the <option>prvscheck</option> expansion item,
18189 which is described in sections <xref linkend="SECTexpansionitems"/> and
18190 <xref linkend="SECTverifyPRVS"/>.
18191 </para>
18192 </listitem></varlistentry>
18193 <varlistentry>
18194 <term><varname>$prvscheck_keynum</varname></term>
18195 <listitem>
18196 <para>
18197 This variable is used in conjunction with the <option>prvscheck</option> expansion item,
18198 which is described in sections <xref linkend="SECTexpansionitems"/> and
18199 <xref linkend="SECTverifyPRVS"/>.
18200 </para>
18201 </listitem></varlistentry>
18202 <varlistentry>
18203 <term><varname>$prvscheck_result</varname></term>
18204 <listitem>
18205 <para>
18206 This variable is used in conjunction with the <option>prvscheck</option> expansion item,
18207 which is described in sections <xref linkend="SECTexpansionitems"/> and
18208 <xref linkend="SECTverifyPRVS"/>.
18209 </para>
18210 </listitem></varlistentry>
18211 <varlistentry>
18212 <term><varname>$qualify_domain</varname></term>
18213 <listitem>
18214 <para>
18215 <indexterm role="variable">
18216 <primary><varname>$qualify_domain</varname></primary>
18217 </indexterm>
18218 The value set for the <option>qualify_domain</option> option in the configuration file.
18219 </para>
18220 </listitem></varlistentry>
18221 <varlistentry>
18222 <term><varname>$qualify_recipient</varname></term>
18223 <listitem>
18224 <para>
18225 <indexterm role="variable">
18226 <primary><varname>$qualify_recipient</varname></primary>
18227 </indexterm>
18228 The value set for the <option>qualify_recipient</option> option in the configuration file,
18229 or if not set, the value of <varname>$qualify_domain</varname>.
18230 </para>
18231 </listitem></varlistentry>
18232 <varlistentry>
18233 <term><varname>$rcpt_count</varname></term>
18234 <listitem>
18235 <para>
18236 <indexterm role="variable">
18237 <primary><varname>$rcpt_count</varname></primary>
18238 </indexterm>
18239 When a message is being received by SMTP, this variable contains the number of
18240 RCPT commands received for the current message. If this variable is used in a
18241 RCPT ACL, its value includes the current command.
18242 </para>
18243 </listitem></varlistentry>
18244 <varlistentry>
18245 <term><varname>$rcpt_defer_count</varname></term>
18246 <listitem>
18247 <para>
18248 <indexterm role="variable">
18249 <primary><varname>$rcpt_defer_count</varname></primary>
18250 </indexterm>
18251 <indexterm role="concept">
18252 <primary>4<emphasis>xx</emphasis> responses</primary>
18253 <secondary>count of</secondary>
18254 </indexterm>
18255 When a message is being received by SMTP, this variable contains the number of
18256 RCPT commands in the current message that have previously been rejected with a
18257 temporary (4<emphasis>xx</emphasis>) response.
18258 </para>
18259 </listitem></varlistentry>
18260 <varlistentry>
18261 <term><varname>$rcpt_fail_count</varname></term>
18262 <listitem>
18263 <para>
18264 <indexterm role="variable">
18265 <primary><varname>$rcpt_fail_count</varname></primary>
18266 </indexterm>
18267 When a message is being received by SMTP, this variable contains the number of
18268 RCPT commands in the current message that have previously been rejected with a
18269 permanent (5<emphasis>xx</emphasis>) response.
18270 </para>
18271 </listitem></varlistentry>
18272 <varlistentry>
18273 <term><varname>$received_count</varname></term>
18274 <listitem>
18275 <para>
18276 <indexterm role="variable">
18277 <primary><varname>$received_count</varname></primary>
18278 </indexterm>
18279 This variable contains the number of <emphasis>Received:</emphasis> header lines in the message,
18280 including the one added by Exim (so its value is always greater than zero). It
18281 is available in the DATA ACL, the non-SMTP ACL, and while routing and
18282 delivering.
18283 </para>
18284 </listitem></varlistentry>
18285 <varlistentry>
18286 <term><varname>$received_for</varname></term>
18287 <listitem>
18288 <para>
18289 <indexterm role="variable">
18290 <primary><varname>$received_for</varname></primary>
18291 </indexterm>
18292 If there is only a single recipient address in an incoming message, this
18293 variable contains that address when the <emphasis>Received:</emphasis> header line is being
18294 built. The value is copied after recipient rewriting has happened, but before
18295 the <function>local_scan()</function> function is run.
18296 </para>
18297 </listitem></varlistentry>
18298 <varlistentry>
18299 <term><varname>$received_ip_address</varname></term>
18300 <listitem>
18301 <para>
18302 <indexterm role="variable">
18303 <primary><varname>$received_ip_address</varname></primary>
18304 </indexterm>
18305 As soon as an Exim server starts processing an incoming TCP/IP connection, this
18306 variable is set to the address of the local IP interface, and <varname>$received_port</varname>
18307 is set to the local port number. (The remote IP address and port are in
18308 <varname>$sender_host_address</varname> and <varname>$sender_host_port</varname>.) When testing with <option>-bh</option>,
18309 the port value is -1 unless it has been set using the <option>-oMi</option> command line
18310 option.
18311 </para>
18312 <para>
18313 As well as being useful in ACLs (including the <quote>connect</quote> ACL), these variable
18314 could be used, for example, to make the file name for a TLS certificate depend
18315 on which interface and/or port is being used for the incoming connection. The
18316 values of <varname>$received_ip_address</varname> and <varname>$received_port</varname> are saved with any
18317 messages that are received, thus making these variables available at delivery
18318 time.
18319 </para>
18320 <para>
18321 <emphasis role="bold">Note:</emphasis> There are no equivalent variables for outgoing connections, because
18322 the values are unknown (unless they are explicitly set by options of the
18323 <command>smtp</command> transport).
18324 </para>
18325 </listitem></varlistentry>
18326 <varlistentry>
18327 <term><varname>$received_port</varname></term>
18328 <listitem>
18329 <para>
18330 <indexterm role="variable">
18331 <primary><varname>$received_port</varname></primary>
18332 </indexterm>
18333 See <varname>$received_ip_address</varname>.
18334 </para>
18335 </listitem></varlistentry>
18336 <varlistentry>
18337 <term><varname>$received_protocol</varname></term>
18338 <listitem>
18339 <para>
18340 <indexterm role="variable">
18341 <primary><varname>$received_protocol</varname></primary>
18342 </indexterm>
18343 When a message is being processed, this variable contains the name of the
18344 protocol by which it was received. Most of the names used by Exim are defined
18345 by RFCs 821, 2821, and 3848. They start with <quote>smtp</quote> (the client used HELO) or
18346 <quote>esmtp</quote> (the client used EHLO). This can be followed by <quote>s</quote> for secure
18347 (encrypted) and/or <quote>a</quote> for authenticated. Thus, for example, if the protocol
18348 is set to <quote>esmtpsa</quote>, the message was received over an encrypted SMTP
18349 connection and the client was successfully authenticated.
18350 </para>
18351 <para>
18352 Exim uses the protocol name <quote>smtps</quote> for the case when encryption is
18353 automatically set up on connection without the use of STARTTLS (see
18354 <option>tls_on_connect_ports</option>), and the client uses HELO to initiate the
18355 encrypted SMTP session. The name <quote>smtps</quote> is also used for the rare situation
18356 where the client initially uses EHLO, sets up an encrypted connection using
18357 STARTTLS, and then uses HELO afterwards.
18358 </para>
18359 <para>
18360 The <option>-oMr</option> option provides a way of specifying a custom protocol name for
18361 messages that are injected locally by trusted callers. This is commonly used to
18362 identify messages that are being re-injected after some kind of scanning.
18363 </para>
18364 </listitem></varlistentry>
18365 <varlistentry>
18366 <term><varname>$received_time</varname></term>
18367 <listitem>
18368 <para>
18369 <indexterm role="variable">
18370 <primary><varname>$received_time</varname></primary>
18371 </indexterm>
18372 This variable contains the date and time when the current message was received,
18373 as a number of seconds since the start of the Unix epoch.
18374 </para>
18375 </listitem></varlistentry>
18376 <varlistentry>
18377 <term><varname>$recipient_data</varname></term>
18378 <listitem>
18379 <para>
18380 <indexterm role="variable">
18381 <primary><varname>$recipient_data</varname></primary>
18382 </indexterm>
18383 This variable is set after an indexing lookup success in an ACL <option>recipients</option>
18384 condition. It contains the data from the lookup, and the value remains set
18385 until the next <option>recipients</option> test. Thus, you can do things like this:
18386 </para>
18387 <literallayout>
18388 <literal>require recipients  = cdb*@;/some/file</literal>
18389 <literal>deny    </literal><emphasis>some further test involving</emphasis> <literal>$recipient_data</literal>
18390 </literallayout>
18391 <para>
18392 <emphasis role="bold">Warning</emphasis>: This variable is set only when a lookup is used as an indexing
18393 method in the address list, using the semicolon syntax as in the example above.
18394 The variable is not set for a lookup that is used as part of the string
18395 expansion that all such lists undergo before being interpreted.
18396 </para>
18397 </listitem></varlistentry>
18398 <varlistentry>
18399 <term><varname>$recipient_verify_failure</varname></term>
18400 <listitem>
18401 <para>
18402 <indexterm role="variable">
18403 <primary><varname>$recipient_verify_failure</varname></primary>
18404 </indexterm>
18405 In an ACL, when a recipient verification fails, this variable contains
18406 information about the failure. It is set to one of the following words:
18407 </para>
18408 <itemizedlist>
18409 <listitem>
18410 <para>
18411 <quote>qualify</quote>: The address was unqualified (no domain), and the message
18412 was neither local nor came from an exempted host.
18413 </para>
18414 </listitem>
18415 <listitem>
18416 <para>
18417 <quote>route</quote>: Routing failed.
18418 </para>
18419 </listitem>
18420 <listitem>
18421 <para>
18422 <quote>mail</quote>: Routing succeeded, and a callout was attempted; rejection occurred at
18423 or before the MAIL command (that is, on initial connection, HELO, or
18424 MAIL).
18425 </para>
18426 </listitem>
18427 <listitem>
18428 <para>
18429 <quote>recipient</quote>: The RCPT command in a callout was rejected.
18430 </para>
18431 </listitem>
18432 <listitem>
18433 <para>
18434 <quote>postmaster</quote>: The postmaster check in a callout was rejected.
18435 </para>
18436 </listitem>
18437 </itemizedlist>
18438 <para>
18439 The main use of this variable is expected to be to distinguish between
18440 rejections of MAIL and rejections of RCPT.
18441 </para>
18442 </listitem></varlistentry>
18443 <varlistentry>
18444 <term><varname>$recipients</varname></term>
18445 <listitem>
18446 <para>
18447 <indexterm role="variable">
18448 <primary><varname>$recipients</varname></primary>
18449 </indexterm>
18450 This variable contains a list of envelope recipients for a message. A comma and
18451 a space separate the addresses in the replacement text. However, the variable
18452 is not generally available, to prevent exposure of Bcc recipients in
18453 unprivileged users&#x2019; filter files. You can use <varname>$recipients</varname> only in these
18454 cases:
18455 </para>
18456 <orderedlist numeration="arabic">
18457 <listitem>
18458 <para>
18459 In a system filter file.
18460 </para>
18461 </listitem>
18462 <listitem>
18463 <para>
18464 In the ACLs associated with the DATA command and with non-SMTP messages, that
18465 is, the ACLs defined by <option>acl_smtp_predata</option>, <option>acl_smtp_data</option>,
18466 <option>acl_smtp_mime</option>, <option>acl_not_smtp_start</option>, <option>acl_not_smtp</option>, and
18467 <option>acl_not_smtp_mime</option>.
18468 </para>
18469 </listitem>
18470 <listitem>
18471 <para>
18472 From within a <function>local_scan()</function> function.
18473 </para>
18474 </listitem>
18475 </orderedlist>
18476 </listitem></varlistentry>
18477 <varlistentry>
18478 <term><varname>$recipients_count</varname></term>
18479 <listitem>
18480 <para>
18481 <indexterm role="variable">
18482 <primary><varname>$recipients_count</varname></primary>
18483 </indexterm>
18484 When a message is being processed, this variable contains the number of
18485 envelope recipients that came with the message. Duplicates are not excluded
18486 from the count. While a message is being received over SMTP, the number
18487 increases for each accepted recipient. It can be referenced in an ACL.
18488 </para>
18489 </listitem></varlistentry>
18490 <varlistentry>
18491 <term><varname>$regex_match_string</varname></term>
18492 <listitem>
18493 <para>
18494 <indexterm role="variable">
18495 <primary><varname>$regex_match_string</varname></primary>
18496 </indexterm>
18497 This variable is set to contain the matching regular expression after a
18498 <option>regex</option> ACL condition has matched (see section <xref linkend="SECTscanregex"/>).
18499 </para>
18500 </listitem></varlistentry>
18501 <varlistentry>
18502 <term><varname>$reply_address</varname></term>
18503 <listitem>
18504 <para>
18505 <indexterm role="variable">
18506 <primary><varname>$reply_address</varname></primary>
18507 </indexterm>
18508 When a message is being processed, this variable contains the contents of the
18509 <emphasis>Reply-To:</emphasis> header line if one exists and it is not empty, or otherwise the
18510 contents of the <emphasis>From:</emphasis> header line. Apart from the removal of leading
18511 white space, the value is not processed in any way. In particular, no RFC 2047
18512 decoding or character code translation takes place.
18513 </para>
18514 </listitem></varlistentry>
18515 <varlistentry>
18516 <term><varname>$return_path</varname></term>
18517 <listitem>
18518 <para>
18519 <indexterm role="variable">
18520 <primary><varname>$return_path</varname></primary>
18521 </indexterm>
18522 When a message is being delivered, this variable contains the return path &ndash;
18523 the sender field that will be sent as part of the envelope. It is not enclosed
18524 in &lt;&gt; characters. At the start of routing an address, <varname>$return_path</varname> has the
18525 same value as <varname>$sender_address</varname>, but if, for example, an incoming message to a
18526 mailing list has been expanded by a router which specifies a different address
18527 for bounce messages, <varname>$return_path</varname> subsequently contains the new bounce
18528 address, whereas <varname>$sender_address</varname> always contains the original sender address
18529 that was received with the message. In other words, <varname>$sender_address</varname> contains
18530 the incoming envelope sender, and <varname>$return_path</varname> contains the outgoing
18531 envelope sender.
18532 </para>
18533 </listitem></varlistentry>
18534 <varlistentry>
18535 <term><varname>$return_size_limit</varname></term>
18536 <listitem>
18537 <para>
18538 <indexterm role="variable">
18539 <primary><varname>$return_size_limit</varname></primary>
18540 </indexterm>
18541 This is an obsolete name for <varname>$bounce_return_size_limit</varname>.
18542 </para>
18543 </listitem></varlistentry>
18544 <varlistentry>
18545 <term><varname>$router_name</varname></term>
18546 <listitem>
18547 <para>
18548 <indexterm role="concept">
18549 <primary>router</primary>
18550 <secondary>name</secondary>
18551 </indexterm>
18552 <indexterm role="concept">
18553 <primary>name</primary>
18554 <secondary>of router</secondary>
18555 </indexterm>
18556 <indexterm role="variable">
18557 <primary><varname>$router_name</varname></primary>
18558 </indexterm>
18559 During the running of a router this variable contains its name.
18560 </para>
18561 </listitem></varlistentry>
18562 <varlistentry>
18563 <term><varname>$runrc</varname></term>
18564 <listitem>
18565 <para>
18566 <indexterm role="concept">
18567 <primary>return code</primary>
18568 <secondary>from <option>run</option> expansion</secondary>
18569 </indexterm>
18570 <indexterm role="variable">
18571 <primary><varname>$runrc</varname></primary>
18572 </indexterm>
18573 This variable contains the return code from a command that is run by the
18574 <option>${run...}</option> expansion item. <emphasis role="bold">Warning</emphasis>: In a router or transport, you cannot
18575 assume the order in which option values are expanded, except for those
18576 preconditions whose order of testing is documented. Therefore, you cannot
18577 reliably expect to set <varname>$runrc</varname> by the expansion of one option, and use it in
18578 another.
18579 </para>
18580 </listitem></varlistentry>
18581 <varlistentry>
18582 <term><varname>$self_hostname</varname></term>
18583 <listitem>
18584 <para>
18585 <indexterm role="option">
18586 <primary><option>self</option></primary>
18587 <secondary>value of host name</secondary>
18588 </indexterm>
18589 <indexterm role="variable">
18590 <primary><varname>$self_hostname</varname></primary>
18591 </indexterm>
18592 When an address is routed to a supposedly remote host that turns out to be the
18593 local host, what happens is controlled by the <option>self</option> generic router option.
18594 One of its values causes the address to be passed to another router. When this
18595 happens, <varname>$self_hostname</varname> is set to the name of the local host that the
18596 original router encountered. In other circumstances its contents are null.
18597 </para>
18598 </listitem></varlistentry>
18599 <varlistentry>
18600 <term><varname>$sender_address</varname></term>
18601 <listitem>
18602 <para>
18603 <indexterm role="variable">
18604 <primary><varname>$sender_address</varname></primary>
18605 </indexterm>
18606 When a message is being processed, this variable contains the sender&#x2019;s address
18607 that was received in the message&#x2019;s envelope. The case of letters in the address
18608 is retained, in both the local part and the domain. For bounce messages, the
18609 value of this variable is the empty string. See also <varname>$return_path</varname>.
18610 </para>
18611 </listitem></varlistentry>
18612 <varlistentry>
18613 <term><varname>$sender_address_data</varname></term>
18614 <listitem>
18615 <para>
18616 <indexterm role="variable">
18617 <primary><varname>$address_data</varname></primary>
18618 </indexterm>
18619 <indexterm role="variable">
18620 <primary><varname>$sender_address_data</varname></primary>
18621 </indexterm>
18622 If <varname>$address_data</varname> is set when the routers are called from an ACL to verify a
18623 sender address, the final value is preserved in <varname>$sender_address_data</varname>, to
18624 distinguish it from data from a recipient address. The value does not persist
18625 after the end of the current ACL statement. If you want to preserve it for
18626 longer, you can save it in an ACL variable.
18627 </para>
18628 </listitem></varlistentry>
18629 <varlistentry>
18630 <term><varname>$sender_address_domain</varname></term>
18631 <listitem>
18632 <para>
18633 <indexterm role="variable">
18634 <primary><varname>$sender_address_domain</varname></primary>
18635 </indexterm>
18636 The domain portion of <varname>$sender_address</varname>.
18637 </para>
18638 </listitem></varlistentry>
18639 <varlistentry>
18640 <term><varname>$sender_address_local_part</varname></term>
18641 <listitem>
18642 <para>
18643 <indexterm role="variable">
18644 <primary><varname>$sender_address_local_part</varname></primary>
18645 </indexterm>
18646 The local part portion of <varname>$sender_address</varname>.
18647 </para>
18648 </listitem></varlistentry>
18649 <varlistentry>
18650 <term><varname>$sender_data</varname></term>
18651 <listitem>
18652 <para>
18653 <indexterm role="variable">
18654 <primary><varname>$sender_data</varname></primary>
18655 </indexterm>
18656 This variable is set after a lookup success in an ACL <option>senders</option> condition or
18657 in a router <option>senders</option> option. It contains the data from the lookup, and the
18658 value remains set until the next <option>senders</option> test. Thus, you can do things like
18659 this:
18660 </para>
18661 <literallayout>
18662 <literal>require senders      = cdb*@;/some/file</literal>
18663 <literal>deny    </literal><emphasis>some further test involving</emphasis> <literal>$sender_data</literal>
18664 </literallayout>
18665 <para>
18666 <emphasis role="bold">Warning</emphasis>: This variable is set only when a lookup is used as an indexing
18667 method in the address list, using the semicolon syntax as in the example above.
18668 The variable is not set for a lookup that is used as part of the string
18669 expansion that all such lists undergo before being interpreted.
18670 </para>
18671 </listitem></varlistentry>
18672 <varlistentry>
18673 <term><varname>$sender_fullhost</varname></term>
18674 <listitem>
18675 <para>
18676 <indexterm role="variable">
18677 <primary><varname>$sender_fullhost</varname></primary>
18678 </indexterm>
18679 When a message is received from a remote host, this variable contains the host
18680 name and IP address in a single string. It ends with the IP address in square
18681 brackets, followed by a colon and a port number if the logging of ports is
18682 enabled. The format of the rest of the string depends on whether the host
18683 issued a HELO or EHLO SMTP command, and whether the host name was verified by
18684 looking up its IP address. (Looking up the IP address can be forced by the
18685 <option>host_lookup</option> option, independent of verification.) A plain host name at the
18686 start of the string is a verified host name; if this is not present,
18687 verification either failed or was not requested. A host name in parentheses is
18688 the argument of a HELO or EHLO command. This is omitted if it is identical to
18689 the verified host name or to the host&#x2019;s IP address in square brackets.
18690 </para>
18691 </listitem></varlistentry>
18692 <varlistentry>
18693 <term><varname>$sender_helo_name</varname></term>
18694 <listitem>
18695 <para>
18696 <indexterm role="variable">
18697 <primary><varname>$sender_helo_name</varname></primary>
18698 </indexterm>
18699 When a message is received from a remote host that has issued a HELO or EHLO
18700 command, the argument of that command is placed in this variable. It is also
18701 set if HELO or EHLO is used when a message is received using SMTP locally via
18702 the <option>-bs</option> or <option>-bS</option> options.
18703 </para>
18704 </listitem></varlistentry>
18705 <varlistentry>
18706 <term><varname>$sender_host_address</varname></term>
18707 <listitem>
18708 <para>
18709 <indexterm role="variable">
18710 <primary><varname>$sender_host_address</varname></primary>
18711 </indexterm>
18712 When a message is received from a remote host, this variable contains that
18713 host&#x2019;s IP address. For locally submitted messages, it is empty.
18714 </para>
18715 </listitem></varlistentry>
18716 <varlistentry>
18717 <term><varname>$sender_host_authenticated</varname></term>
18718 <listitem>
18719 <para>
18720 <indexterm role="variable">
18721 <primary><varname>$sender_host_authenticated</varname></primary>
18722 </indexterm>
18723 This variable contains the name (not the public name) of the authenticator
18724 driver that successfully authenticated the client from which the message was
18725 received. It is empty if there was no successful authentication. See also
18726 <varname>$authenticated_id</varname>.
18727 </para>
18728 </listitem></varlistentry>
18729 <varlistentry>
18730 <term><varname>$sender_host_dnssec</varname></term>
18731 <listitem>
18732 <para>
18733 <indexterm role="variable">
18734 <primary><varname>$sender_host_dnssec</varname></primary>
18735 </indexterm>
18736 If an attempt to populate <varname>$sender_host_name</varname> has been made
18737 (by reference, <option>hosts_lookup</option> or
18738 otherwise) then this boolean will have been set true if, and only if, the
18739 resolver library states that the reverse DNS was authenticated data.  At all
18740 other times, this variable is false.
18741 </para>
18742 <para>
18743 It is likely that you will need to coerce DNSSEC support on in the resolver
18744 library, by setting:
18745 </para>
18746 <literallayout class="monospaced">
18747 dns_dnssec_ok = 1
18748 </literallayout>
18749 <para>
18750 Exim does not perform DNSSEC validation itself, instead leaving that to a
18751 validating resolver (eg, unbound, or bind with suitable configuration).
18752 </para>
18753 <para>
18754 Exim does not (currently) check to see if the forward DNS was also secured
18755 with DNSSEC, only the reverse DNS.
18756 </para>
18757 <para>
18758 If you have changed <option>host_lookup_order</option> so that <literal>bydns</literal> is not the first
18759 mechanism in the list, then this variable will be false.
18760 </para>
18761 </listitem></varlistentry>
18762 <varlistentry>
18763 <term><varname>$sender_host_name</varname></term>
18764 <listitem>
18765 <para>
18766 <indexterm role="variable">
18767 <primary><varname>$sender_host_name</varname></primary>
18768 </indexterm>
18769 When a message is received from a remote host, this variable contains the
18770 host&#x2019;s name as obtained by looking up its IP address. For messages received by
18771 other means, this variable is empty.
18772 </para>
18773 <para>
18774 <indexterm role="variable">
18775 <primary><varname>$host_lookup_failed</varname></primary>
18776 </indexterm>
18777 If the host name has not previously been looked up, a reference to
18778 <varname>$sender_host_name</varname> triggers a lookup (for messages from remote hosts).
18779 A looked up name is accepted only if it leads back to the original IP address
18780 via a forward lookup. If either the reverse or the forward lookup fails to find
18781 any data, or if the forward lookup does not yield the original IP address,
18782 <varname>$sender_host_name</varname> remains empty, and <varname>$host_lookup_failed</varname> is set to <quote>1</quote>.
18783 </para>
18784 <para>
18785 <indexterm role="variable">
18786 <primary><varname>$host_lookup_deferred</varname></primary>
18787 </indexterm>
18788 However, if either of the lookups cannot be completed (for example, there is a
18789 DNS timeout), <varname>$host_lookup_deferred</varname> is set to <quote>1</quote>, and
18790 <varname>$host_lookup_failed</varname> remains set to <quote>0</quote>.
18791 </para>
18792 <para>
18793 Once <varname>$host_lookup_failed</varname> is set to <quote>1</quote>, Exim does not try to look up the
18794 host name again if there is a subsequent reference to <varname>$sender_host_name</varname>
18795 in the same Exim process, but it does try again if <varname>$host_lookup_deferred</varname>
18796 is set to <quote>1</quote>.
18797 </para>
18798 <para>
18799 Exim does not automatically look up every calling host&#x2019;s name. If you want
18800 maximum efficiency, you should arrange your configuration so that it avoids
18801 these lookups altogether. The lookup happens only if one or more of the
18802 following are true:
18803 </para>
18804 <itemizedlist>
18805 <listitem>
18806 <para>
18807 A string containing <varname>$sender_host_name</varname> is expanded.
18808 </para>
18809 </listitem>
18810 <listitem>
18811 <para>
18812 The calling host matches the list in <option>host_lookup</option>. In the default
18813 configuration, this option is set to *, so it must be changed if lookups are
18814 to be avoided. (In the code, the default for <option>host_lookup</option> is unset.)
18815 </para>
18816 </listitem>
18817 <listitem>
18818 <para>
18819 Exim needs the host name in order to test an item in a host list. The items
18820 that require this are described in sections <xref linkend="SECThoslispatnam"/> and
18821 <xref linkend="SECThoslispatnamsk"/>.
18822 </para>
18823 </listitem>
18824 <listitem>
18825 <para>
18826 The calling host matches <option>helo_try_verify_hosts</option> or <option>helo_verify_hosts</option>.
18827 In this case, the host name is required to compare with the name quoted in any
18828 EHLO or HELO commands that the client issues.
18829 </para>
18830 </listitem>
18831 <listitem>
18832 <para>
18833 The remote host issues a EHLO or HELO command that quotes one of the
18834 domains in <option>helo_lookup_domains</option>. The default value of this option is
18835 </para>
18836 <literallayout class="monospaced">
18837   helo_lookup_domains = @ : @[]
18838 </literallayout>
18839 <para>
18840 which causes a lookup if a remote host (incorrectly) gives the server&#x2019;s name or
18841 IP address in an EHLO or HELO command.
18842 </para>
18843 </listitem>
18844 </itemizedlist>
18845 </listitem></varlistentry>
18846 <varlistentry>
18847 <term><varname>$sender_host_port</varname></term>
18848 <listitem>
18849 <para>
18850 <indexterm role="variable">
18851 <primary><varname>$sender_host_port</varname></primary>
18852 </indexterm>
18853 When a message is received from a remote host, this variable contains the port
18854 number that was used on the remote host.
18855 </para>
18856 </listitem></varlistentry>
18857 <varlistentry>
18858 <term><varname>$sender_ident</varname></term>
18859 <listitem>
18860 <para>
18861 <indexterm role="variable">
18862 <primary><varname>$sender_ident</varname></primary>
18863 </indexterm>
18864 When a message is received from a remote host, this variable contains the
18865 identification received in response to an RFC 1413 request. When a message has
18866 been received locally, this variable contains the login name of the user that
18867 called Exim.
18868 </para>
18869 </listitem></varlistentry>
18870 <varlistentry>
18871 <term><varname>$sender_rate_</varname><emphasis>xxx</emphasis></term>
18872 <listitem>
18873 <para>
18874 A number of variables whose names begin <varname>$sender_rate_</varname> are set as part of the
18875 <option>ratelimit</option> ACL condition. Details are given in section
18876 <xref linkend="SECTratelimiting"/>.
18877 </para>
18878 </listitem></varlistentry>
18879 <varlistentry>
18880 <term><varname>$sender_rcvhost</varname></term>
18881 <listitem>
18882 <para>
18883 <indexterm role="concept">
18884 <primary>DNS</primary>
18885 <secondary>reverse lookup</secondary>
18886 </indexterm>
18887 <indexterm role="concept">
18888 <primary>reverse DNS lookup</primary>
18889 </indexterm>
18890 <indexterm role="variable">
18891 <primary><varname>$sender_rcvhost</varname></primary>
18892 </indexterm>
18893 This is provided specifically for use in <emphasis>Received:</emphasis> headers. It starts with
18894 either the verified host name (as obtained from a reverse DNS lookup) or, if
18895 there is no verified host name, the IP address in square brackets. After that
18896 there may be text in parentheses. When the first item is a verified host name,
18897 the first thing in the parentheses is the IP address in square brackets,
18898 followed by a colon and a port number if port logging is enabled. When the
18899 first item is an IP address, the port is recorded as <quote>port=<emphasis>xxxx</emphasis></quote> inside
18900 the parentheses.
18901 </para>
18902 <para>
18903 There may also be items of the form <quote>helo=<emphasis>xxxx</emphasis></quote> if HELO or EHLO
18904 was used and its argument was not identical to the real host name or IP
18905 address, and <quote>ident=<emphasis>xxxx</emphasis></quote> if an RFC 1413 ident string is available. If
18906 all three items are present in the parentheses, a newline and tab are inserted
18907 into the string, to improve the formatting of the <emphasis>Received:</emphasis> header.
18908 </para>
18909 </listitem></varlistentry>
18910 <varlistentry>
18911 <term><varname>$sender_verify_failure</varname></term>
18912 <listitem>
18913 <para>
18914 <indexterm role="variable">
18915 <primary><varname>$sender_verify_failure</varname></primary>
18916 </indexterm>
18917 In an ACL, when a sender verification fails, this variable contains information
18918 about the failure. The details are the same as for
18919 <varname>$recipient_verify_failure</varname>.
18920 </para>
18921 </listitem></varlistentry>
18922 <varlistentry>
18923 <term><varname>$sending_ip_address</varname></term>
18924 <listitem>
18925 <para>
18926 <indexterm role="variable">
18927 <primary><varname>$sending_ip_address</varname></primary>
18928 </indexterm>
18929 This variable is set whenever an outgoing SMTP connection to another host has
18930 been set up. It contains the IP address of the local interface that is being
18931 used. This is useful if a host that has more than one IP address wants to take
18932 on different personalities depending on which one is being used. For incoming
18933 connections, see <varname>$received_ip_address</varname>.
18934 </para>
18935 </listitem></varlistentry>
18936 <varlistentry>
18937 <term><varname>$sending_port</varname></term>
18938 <listitem>
18939 <para>
18940 <indexterm role="variable">
18941 <primary><varname>$sending_port</varname></primary>
18942 </indexterm>
18943 This variable is set whenever an outgoing SMTP connection to another host has
18944 been set up. It contains the local port that is being used. For incoming
18945 connections, see <varname>$received_port</varname>.
18946 </para>
18947 </listitem></varlistentry>
18948 <varlistentry>
18949 <term><varname>$smtp_active_hostname</varname></term>
18950 <listitem>
18951 <para>
18952 <indexterm role="variable">
18953 <primary><varname>$smtp_active_hostname</varname></primary>
18954 </indexterm>
18955 During an incoming SMTP session, this variable contains the value of the active
18956 host name, as specified by the <option>smtp_active_hostname</option> option. The value of
18957 <varname>$smtp_active_hostname</varname> is saved with any message that is received, so its
18958 value can be consulted during routing and delivery.
18959 </para>
18960 </listitem></varlistentry>
18961 <varlistentry>
18962 <term><varname>$smtp_command</varname></term>
18963 <listitem>
18964 <para>
18965 <indexterm role="variable">
18966 <primary><varname>$smtp_command</varname></primary>
18967 </indexterm>
18968 During the processing of an incoming SMTP command, this variable contains the
18969 entire command. This makes it possible to distinguish between HELO and EHLO in
18970 the HELO ACL, and also to distinguish between commands such as these:
18971 </para>
18972 <literallayout class="monospaced">
18973 MAIL FROM:&lt;&gt;
18974 MAIL FROM: &lt;&gt;
18975 </literallayout>
18976 <para>
18977 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
18978 command, the address in <varname>$smtp_command</varname> is the original address before any
18979 rewriting, whereas the values in <varname>$local_part</varname> and <varname>$domain</varname> are taken from
18980 the address after SMTP-time rewriting.
18981 </para>
18982 </listitem></varlistentry>
18983 <varlistentry>
18984 <term><varname>$smtp_command_argument</varname></term>
18985 <listitem>
18986 <para>
18987 <indexterm role="concept">
18988 <primary>SMTP</primary>
18989 <secondary>command, argument for</secondary>
18990 </indexterm>
18991 <indexterm role="variable">
18992 <primary><varname>$smtp_command_argument</varname></primary>
18993 </indexterm>
18994 While an ACL is running to check an SMTP command, this variable contains the
18995 argument, that is, the text that follows the command name, with leading white
18996 space removed. Following the introduction of <varname>$smtp_command</varname>, this variable is
18997 somewhat redundant, but is retained for backwards compatibility.
18998 </para>
18999 </listitem></varlistentry>
19000 <varlistentry>
19001 <term><varname>$smtp_count_at_connection_start</varname></term>
19002 <listitem>
19003 <para>
19004 <indexterm role="variable">
19005 <primary><varname>$smtp_count_at_connection_start</varname></primary>
19006 </indexterm>
19007 This variable is set greater than zero only in processes spawned by the Exim
19008 daemon for handling incoming SMTP connections. The name is deliberately long,
19009 in order to emphasize what the contents are. When the daemon accepts a new
19010 connection, it increments this variable. A copy of the variable is passed to
19011 the child process that handles the connection, but its value is fixed, and
19012 never changes. It is only an approximation of how many incoming connections
19013 there actually are, because many other connections may come and go while a
19014 single connection is being processed. When a child process terminates, the
19015 daemon decrements its copy of the variable.
19016 </para>
19017 </listitem></varlistentry>
19018 <varlistentry>
19019 <term><varname>$sn0</varname> &ndash; <varname>$sn9</varname></term>
19020 <listitem>
19021 <para>
19022 These variables are copies of the values of the <varname>$n0</varname> &ndash; <varname>$n9</varname> accumulators
19023 that were current at the end of the system filter file. This allows a system
19024 filter file to set values that can be tested in users&#x2019; filter files. For
19025 example, a system filter could set a value indicating how likely it is that a
19026 message is junk mail.
19027 </para>
19028 </listitem></varlistentry>
19029 <varlistentry>
19030 <term><varname>$spam_</varname><emphasis>xxx</emphasis></term>
19031 <listitem>
19032 <para>
19033 A number of variables whose names start with <varname>$spam</varname> are available when Exim
19034 is compiled with the content-scanning extension. For details, see section
19035 <xref linkend="SECTscanspamass"/>.
19036 </para>
19037 </listitem></varlistentry>
19038 <varlistentry>
19039 <term><varname>$spool_directory</varname></term>
19040 <listitem>
19041 <para>
19042 <indexterm role="variable">
19043 <primary><varname>$spool_directory</varname></primary>
19044 </indexterm>
19045 The name of Exim&#x2019;s spool directory.
19046 </para>
19047 </listitem></varlistentry>
19048 <varlistentry>
19049 <term><varname>$spool_inodes</varname></term>
19050 <listitem>
19051 <para>
19052 <indexterm role="variable">
19053 <primary><varname>$spool_inodes</varname></primary>
19054 </indexterm>
19055 The number of free inodes in the disk partition where Exim&#x2019;s spool files are
19056 being written. The value is recalculated whenever the variable is referenced.
19057 If the relevant file system does not have the concept of inodes, the value of
19058 is -1. See also the <option>check_spool_inodes</option> option.
19059 </para>
19060 </listitem></varlistentry>
19061 <varlistentry>
19062 <term><varname>$spool_space</varname></term>
19063 <listitem>
19064 <para>
19065 <indexterm role="variable">
19066 <primary><varname>$spool_space</varname></primary>
19067 </indexterm>
19068 The amount of free space (as a number of kilobytes) in the disk partition where
19069 Exim&#x2019;s spool files are being written. The value is recalculated whenever the
19070 variable is referenced. If the operating system does not have the ability to
19071 find the amount of free space (only true for experimental systems), the space
19072 value is -1. For example, to check in an ACL that there is at least 50
19073 megabytes free on the spool, you could write:
19074 </para>
19075 <literallayout class="monospaced">
19076 condition = ${if &gt; {$spool_space}{50000}}
19077 </literallayout>
19078 <para>
19079 See also the <option>check_spool_space</option> option.
19080 </para>
19081 </listitem></varlistentry>
19082 <varlistentry>
19083 <term><varname>$thisaddress</varname></term>
19084 <listitem>
19085 <para>
19086 <indexterm role="variable">
19087 <primary><varname>$thisaddress</varname></primary>
19088 </indexterm>
19089 This variable is set only during the processing of the <option>foranyaddress</option>
19090 command in a filter file. Its use is explained in the description of that
19091 command, which can be found in the separate document entitled <emphasis>Exim&#x2019;s
19092 interfaces to mail filtering</emphasis>.
19093 </para>
19094 </listitem></varlistentry>
19095 <varlistentry>
19096 <term><varname>$tls_in_bits</varname></term>
19097 <listitem>
19098 <para>
19099 <indexterm role="variable">
19100 <primary><varname>$tls_in_bits</varname></primary>
19101 </indexterm>
19102 Contains an approximation of the TLS cipher&#x2019;s bit-strength
19103 on the inbound connection; the meaning of
19104 this depends upon the TLS implementation used.
19105 If TLS has not been negotiated, the value will be 0.
19106 The value of this is automatically fed into the Cyrus SASL authenticator
19107 when acting as a server, to specify the "external SSF" (a SASL term).
19108 </para>
19109 <para>
19110 The deprecated <varname>$tls_bits</varname> variable refers to the inbound side
19111 except when used in the context of an outbound SMTP delivery, when it refers to
19112 the outbound.
19113 </para>
19114 </listitem></varlistentry>
19115 <varlistentry>
19116 <term><varname>$tls_out_bits</varname></term>
19117 <listitem>
19118 <para>
19119 <indexterm role="variable">
19120 <primary><varname>$tls_out_bits</varname></primary>
19121 </indexterm>
19122 Contains an approximation of the TLS cipher&#x2019;s bit-strength
19123 on an outbound SMTP connection; the meaning of
19124 this depends upon the TLS implementation used.
19125 If TLS has not been negotiated, the value will be 0.
19126 </para>
19127 </listitem></varlistentry>
19128 <varlistentry revisionflag="changed">
19129 <term><varname>$tls_in_ourcert</varname></term>
19130 <listitem>
19131 <para revisionflag="changed">
19132 <indexterm role="variable">
19133 <primary><varname>$tls_in_ourcert</varname></primary>
19134 </indexterm>
19135 This variable refers to the certificate presented to the peer of an
19136 inbound connection when the message was received.
19137 It is only useful as the argument of a
19138 <option>certextract</option> expansion item, <option>md5</option> or <option>sha1</option> operator,
19139 or a <option>def</option> condition.
19140 </para>
19141 </listitem></varlistentry>
19142 <varlistentry revisionflag="changed">
19143 <term><varname>$tls_in_peercert</varname></term>
19144 <listitem>
19145 <para revisionflag="changed">
19146 <indexterm role="variable">
19147 <primary><varname>$tls_in_peercert</varname></primary>
19148 </indexterm>
19149 This variable refers to the certificate presented by the peer of an
19150 inbound connection when the message was received.
19151 It is only useful as the argument of a
19152 <option>certextract</option> expansion item, <option>md5</option> or <option>sha1</option> operator,
19153 or a <option>def</option> condition.
19154 </para>
19155 </listitem></varlistentry>
19156 <varlistentry revisionflag="changed">
19157 <term><varname>$tls_out_ourcert</varname></term>
19158 <listitem>
19159 <para revisionflag="changed">
19160 <indexterm role="variable">
19161 <primary><varname>$tls_out_ourcert</varname></primary>
19162 </indexterm>
19163 This variable refers to the certificate presented to the peer of an
19164 outbound connection.  It is only useful as the argument of a
19165 <option>certextract</option> expansion item, <option>md5</option> or <option>sha1</option> operator,
19166 or a <option>def</option> condition.
19167 </para>
19168 </listitem></varlistentry>
19169 <varlistentry revisionflag="changed">
19170 <term><varname>$tls_out_peercert</varname></term>
19171 <listitem>
19172 <para revisionflag="changed">
19173 <indexterm role="variable">
19174 <primary><varname>$tls_out_peercert</varname></primary>
19175 </indexterm>
19176 This variable refers to the certificate presented by the peer of an
19177 outbound connection.  It is only useful as the argument of a
19178 <option>certextract</option> expansion item, <option>md5</option> or <option>sha1</option> operator,
19179 or a <option>def</option> condition.
19180 </para>
19181 </listitem></varlistentry>
19182 <varlistentry>
19183 <term><varname>$tls_in_certificate_verified</varname></term>
19184 <listitem>
19185 <para>
19186 <indexterm role="variable">
19187 <primary><varname>$tls_in_certificate_verified</varname></primary>
19188 </indexterm>
19189 This variable is set to <quote>1</quote> if a TLS certificate was verified when the
19190 message was received, and <quote>0</quote> otherwise.
19191 </para>
19192 <para>
19193 The deprecated <varname>$tls_certificate_verfied</varname> variable refers to the inbound side
19194 except when used in the context of an outbound SMTP delivery, when it refers to
19195 the outbound.
19196 </para>
19197 </listitem></varlistentry>
19198 <varlistentry>
19199 <term><varname>$tls_out_certificate_verified</varname></term>
19200 <listitem>
19201 <para>
19202 <indexterm role="variable">
19203 <primary><varname>$tls_out_certificate_verified</varname></primary>
19204 </indexterm>
19205 This variable is set to <quote>1</quote> if a TLS certificate was verified when an
19206 outbound SMTP connection was made,
19207 and <quote>0</quote> otherwise.
19208 </para>
19209 </listitem></varlistentry>
19210 <varlistentry>
19211 <term><varname>$tls_in_cipher</varname></term>
19212 <listitem>
19213 <para>
19214 <indexterm role="variable">
19215 <primary><varname>$tls_in_cipher</varname></primary>
19216 </indexterm>
19217 <indexterm role="variable">
19218 <primary><varname>$tls_cipher</varname></primary>
19219 </indexterm>
19220 When a message is received from a remote host over an encrypted SMTP
19221 connection, this variable is set to the cipher suite that was negotiated, for
19222 example DES-CBC3-SHA. In other circumstances, in particular, for message
19223 received over unencrypted connections, the variable is empty. Testing
19224 <varname>$tls_cipher</varname> for emptiness is one way of distinguishing between encrypted and
19225 non-encrypted connections during ACL processing.
19226 </para>
19227 <para>
19228 The deprecated <varname>$tls_cipher</varname> variable is the same as <varname>$tls_in_cipher</varname> during message reception,
19229 but in the context of an outward SMTP delivery taking place via the <command>smtp</command> transport
19230 becomes the same as <varname>$tls_out_cipher</varname>.
19231 </para>
19232 </listitem></varlistentry>
19233 <varlistentry>
19234 <term><varname>$tls_out_cipher</varname></term>
19235 <listitem>
19236 <para>
19237 <indexterm role="variable">
19238 <primary><varname>$tls_out_cipher</varname></primary>
19239 </indexterm>
19240 This variable is
19241 cleared before any outgoing SMTP connection is made,
19242 and then set to the outgoing cipher suite if one is negotiated. See chapter
19243 <xref linkend="CHAPTLS"/> for details of TLS support and chapter <xref linkend="CHAPsmtptrans"/> for
19244 details of the <command>smtp</command> transport.
19245 </para>
19246 </listitem></varlistentry>
19247 <varlistentry>
19248 <term><varname>$tls_in_peerdn</varname></term>
19249 <listitem>
19250 <para>
19251 <indexterm role="variable">
19252 <primary><varname>$tls_in_peerdn</varname></primary>
19253 </indexterm>
19254 <indexterm role="variable">
19255 <primary><varname>$tls_peerdn</varname></primary>
19256 </indexterm>
19257 When a message is received from a remote host over an encrypted SMTP
19258 connection, and Exim is configured to request a certificate from the client,
19259 the value of the Distinguished Name of the certificate is made available in the
19260 <varname>$tls_in_peerdn</varname> during subsequent processing.
19261 </para>
19262 <para>
19263 The deprecated <varname>$tls_peerdn</varname> variable refers to the inbound side
19264 except when used in the context of an outbound SMTP delivery, when it refers to
19265 the outbound.
19266 </para>
19267 </listitem></varlistentry>
19268 <varlistentry>
19269 <term><varname>$tls_out_peerdn</varname></term>
19270 <listitem>
19271 <para>
19272 <indexterm role="variable">
19273 <primary><varname>$tls_out_peerdn</varname></primary>
19274 </indexterm>
19275 When a message is being delivered to a remote host over an encrypted SMTP
19276 connection, and Exim is configured to request a certificate from the server,
19277 the value of the Distinguished Name of the certificate is made available in the
19278 <varname>$tls_out_peerdn</varname> during subsequent processing.
19279 </para>
19280 </listitem></varlistentry>
19281 <varlistentry>
19282 <term><varname>$tls_in_sni</varname></term>
19283 <listitem>
19284 <para>
19285 <indexterm role="variable">
19286 <primary><varname>$tls_in_sni</varname></primary>
19287 </indexterm>
19288 <indexterm role="variable">
19289 <primary><varname>$tls_sni</varname></primary>
19290 </indexterm>
19291 <indexterm role="concept">
19292 <primary>TLS</primary>
19293 <secondary>Server Name Indication</secondary>
19294 </indexterm>
19295 When a TLS session is being established, if the client sends the Server
19296 Name Indication extension, the value will be placed in this variable.
19297 If the variable appears in <option>tls_certificate</option> then this option and
19298 some others, described in <xref linkend="SECTtlssni"/>,
19299 will be re-expanded early in the TLS session, to permit
19300 a different certificate to be presented (and optionally a different key to be
19301 used) to the client, based upon the value of the SNI extension.
19302 </para>
19303 <para>
19304 The deprecated <varname>$tls_sni</varname> variable refers to the inbound side
19305 except when used in the context of an outbound SMTP delivery, when it refers to
19306 the outbound.
19307 </para>
19308 </listitem></varlistentry>
19309 <varlistentry>
19310 <term><varname>$tls_out_sni</varname></term>
19311 <listitem>
19312 <para>
19313 <indexterm role="variable">
19314 <primary><varname>$tls_out_sni</varname></primary>
19315 </indexterm>
19316 <indexterm role="concept">
19317 <primary>TLS</primary>
19318 <secondary>Server Name Indication</secondary>
19319 </indexterm>
19320 During outbound
19321 SMTP deliveries, this variable reflects the value of the <option>tls_sni</option> option on
19322 the transport.
19323 </para>
19324 </listitem></varlistentry>
19325 <varlistentry>
19326 <term><varname>$tod_bsdinbox</varname></term>
19327 <listitem>
19328 <para>
19329 <indexterm role="variable">
19330 <primary><varname>$tod_bsdinbox</varname></primary>
19331 </indexterm>
19332 The time of day and the date, in the format required for BSD-style mailbox
19333 files, for example: Thu Oct 17 17:14:09 1995.
19334 </para>
19335 </listitem></varlistentry>
19336 <varlistentry>
19337 <term><varname>$tod_epoch</varname></term>
19338 <listitem>
19339 <para>
19340 <indexterm role="variable">
19341 <primary><varname>$tod_epoch</varname></primary>
19342 </indexterm>
19343 The time and date as a number of seconds since the start of the Unix epoch.
19344 </para>
19345 </listitem></varlistentry>
19346 <varlistentry>
19347 <term><varname>$tod_epoch_l</varname></term>
19348 <listitem>
19349 <para>
19350 <indexterm role="variable">
19351 <primary><varname>$tod_epoch_l</varname></primary>
19352 </indexterm>
19353 The time and date as a number of microseconds since the start of the Unix epoch.
19354 </para>
19355 </listitem></varlistentry>
19356 <varlistentry>
19357 <term><varname>$tod_full</varname></term>
19358 <listitem>
19359 <para>
19360 <indexterm role="variable">
19361 <primary><varname>$tod_full</varname></primary>
19362 </indexterm>
19363 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
19364 +0100. The timezone is always given as a numerical offset from UTC, with
19365 positive values used for timezones that are ahead (east) of UTC, and negative
19366 values for those that are behind (west).
19367 </para>
19368 </listitem></varlistentry>
19369 <varlistentry>
19370 <term><varname>$tod_log</varname></term>
19371 <listitem>
19372 <para>
19373 <indexterm role="variable">
19374 <primary><varname>$tod_log</varname></primary>
19375 </indexterm>
19376 The time and date in the format used for writing Exim&#x2019;s log files, for example:
19377 1995-10-12 15:32:29, but without a timezone.
19378 </para>
19379 </listitem></varlistentry>
19380 <varlistentry>
19381 <term><varname>$tod_logfile</varname></term>
19382 <listitem>
19383 <para>
19384 <indexterm role="variable">
19385 <primary><varname>$tod_logfile</varname></primary>
19386 </indexterm>
19387 This variable contains the date in the format yyyymmdd. This is the format that
19388 is used for datestamping log files when <option>log_file_path</option> contains the <literal>%D</literal>
19389 flag.
19390 </para>
19391 </listitem></varlistentry>
19392 <varlistentry>
19393 <term><varname>$tod_zone</varname></term>
19394 <listitem>
19395 <para>
19396 <indexterm role="variable">
19397 <primary><varname>$tod_zone</varname></primary>
19398 </indexterm>
19399 This variable contains the numerical value of the local timezone, for example:
19400 -0500.
19401 </para>
19402 </listitem></varlistentry>
19403 <varlistentry>
19404 <term><varname>$tod_zulu</varname></term>
19405 <listitem>
19406 <para>
19407 <indexterm role="variable">
19408 <primary><varname>$tod_zulu</varname></primary>
19409 </indexterm>
19410 This variable contains the UTC date and time in <quote>Zulu</quote> format, as specified
19411 by ISO 8601, for example: 20030221154023Z.
19412 </para>
19413 </listitem></varlistentry>
19414 <varlistentry>
19415 <term><varname>$transport_name</varname></term>
19416 <listitem>
19417 <para>
19418 <indexterm role="concept">
19419 <primary>transport</primary>
19420 <secondary>name</secondary>
19421 </indexterm>
19422 <indexterm role="concept">
19423 <primary>name</primary>
19424 <secondary>of transport</secondary>
19425 </indexterm>
19426 <indexterm role="variable">
19427 <primary><varname>$transport_name</varname></primary>
19428 </indexterm>
19429 During the running of a transport, this variable contains its name.
19430 </para>
19431 </listitem></varlistentry>
19432 <varlistentry>
19433 <term><varname>$value</varname></term>
19434 <listitem>
19435 <para>
19436 <indexterm role="variable">
19437 <primary><varname>$value</varname></primary>
19438 </indexterm>
19439 This variable contains the result of an expansion lookup, extraction operation,
19440 or external command, as described above. It is also used during a
19441 <emphasis role="bold">reduce</emphasis> expansion.
19442 </para>
19443 </listitem></varlistentry>
19444 <varlistentry>
19445 <term><varname>$version_number</varname></term>
19446 <listitem>
19447 <para>
19448 <indexterm role="variable">
19449 <primary><varname>$version_number</varname></primary>
19450 </indexterm>
19451 The version number of Exim.
19452 </para>
19453 </listitem></varlistentry>
19454 <varlistentry>
19455 <term><varname>$warn_message_delay</varname></term>
19456 <listitem>
19457 <para>
19458 <indexterm role="variable">
19459 <primary><varname>$warn_message_delay</varname></primary>
19460 </indexterm>
19461 This variable is set only during the creation of a message warning about a
19462 delivery delay. Details of its use are explained in section <xref linkend="SECTcustwarn"/>.
19463 </para>
19464 </listitem></varlistentry>
19465 <varlistentry>
19466 <term><varname>$warn_message_recipients</varname></term>
19467 <listitem>
19468 <para>
19469 <indexterm role="variable">
19470 <primary><varname>$warn_message_recipients</varname></primary>
19471 </indexterm>
19472 This variable is set only during the creation of a message warning about a
19473 delivery delay. Details of its use are explained in section <xref linkend="SECTcustwarn"/>.
19474 </para>
19475 </listitem></varlistentry>
19476 </variablelist>
19477 <para>
19478 <indexterm role="concept" startref="IIDstrexp" class="endofrange"/>
19479 </para>
19480 </section>
19481 </chapter>
19482
19483 <chapter id="CHAPperl">
19484 <title>Embedded Perl</title>
19485 <para>
19486 <indexterm role="concept" id="IIDperl" class="startofrange">
19487 <primary>Perl</primary>
19488 <secondary>calling from Exim</secondary>
19489 </indexterm>
19490 Exim can be built to include an embedded Perl interpreter. When this is done,
19491 Perl subroutines can be called as part of the string expansion process. To make
19492 use of the Perl support, you need version 5.004 or later of Perl installed on
19493 your system. To include the embedded interpreter in the Exim binary, include
19494 the line
19495 </para>
19496 <literallayout class="monospaced">
19497 EXIM_PERL = perl.o
19498 </literallayout>
19499 <para>
19500 in your <filename>Local/Makefile</filename> and then build Exim in the normal way.
19501 </para>
19502 <section id="SECID85">
19503 <title>Setting up so Perl can be used</title>
19504 <para>
19505 <indexterm role="option">
19506 <primary><option>perl_startup</option></primary>
19507 </indexterm>
19508 Access to Perl subroutines is via a global configuration option called
19509 <option>perl_startup</option> and an expansion string operator <option>${perl ...}</option>. If there is
19510 no <option>perl_startup</option> option in the Exim configuration file then no Perl
19511 interpreter is started and there is almost no overhead for Exim (since none of
19512 the Perl library will be paged in unless used). If there is a <option>perl_startup</option>
19513 option then the associated value is taken to be Perl code which is executed in
19514 a newly created Perl interpreter.
19515 </para>
19516 <para>
19517 The value of <option>perl_startup</option> is not expanded in the Exim sense, so you do not
19518 need backslashes before any characters to escape special meanings. The option
19519 should usually be something like
19520 </para>
19521 <literallayout class="monospaced">
19522 perl_startup = do '/etc/exim.pl'
19523 </literallayout>
19524 <para>
19525 where <filename>/etc/exim.pl</filename> is Perl code which defines any subroutines you want to
19526 use from Exim. Exim can be configured either to start up a Perl interpreter as
19527 soon as it is entered, or to wait until the first time it is needed. Starting
19528 the interpreter at the beginning ensures that it is done while Exim still has
19529 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
19530 fact used in a particular run. Also, note that this does not mean that Exim is
19531 necessarily running as root when Perl is called at a later time. By default,
19532 the interpreter is started only when it is needed, but this can be changed in
19533 two ways:
19534 </para>
19535 <itemizedlist>
19536 <listitem>
19537 <para>
19538 <indexterm role="option">
19539 <primary><option>perl_at_start</option></primary>
19540 </indexterm>
19541 Setting <option>perl_at_start</option> (a boolean option) in the configuration requests
19542 a startup when Exim is entered.
19543 </para>
19544 </listitem>
19545 <listitem>
19546 <para>
19547 The command line option <option>-ps</option> also requests a startup when Exim is entered,
19548 overriding the setting of <option>perl_at_start</option>.
19549 </para>
19550 </listitem>
19551 </itemizedlist>
19552 <para>
19553 There is also a command line option <option>-pd</option> (for delay) which suppresses the
19554 initial startup, even if <option>perl_at_start</option> is set.
19555 </para>
19556 </section>
19557 <section id="SECID86">
19558 <title>Calling Perl subroutines</title>
19559 <para>
19560 When the configuration file includes a <option>perl_startup</option> option you can make use
19561 of the string expansion item to call the Perl subroutines that are defined
19562 by the <option>perl_startup</option> code. The operator is used in any of the following
19563 forms:
19564 </para>
19565 <literallayout class="monospaced">
19566 ${perl{foo}}
19567 ${perl{foo}{argument}}
19568 ${perl{foo}{argument1}{argument2} ... }
19569 </literallayout>
19570 <para>
19571 which calls the subroutine <option>foo</option> with the given arguments. A maximum of eight
19572 arguments may be passed. Passing more than this results in an expansion failure
19573 with an error message of the form
19574 </para>
19575 <literallayout class="monospaced">
19576 Too many arguments passed to Perl subroutine "foo" (max is 8)
19577 </literallayout>
19578 <para>
19579 The return value of the Perl subroutine is evaluated in a scalar context before
19580 it is passed back to Exim to be inserted into the expanded string. If the
19581 return value is <emphasis>undef</emphasis>, the expansion is forced to fail in the same way as
19582 an explicit <quote>fail</quote> on an <option>if</option> or <option>lookup</option> item. If the subroutine aborts
19583 by obeying Perl&#x2019;s <option>die</option> function, the expansion fails with the error message
19584 that was passed to <option>die</option>.
19585 </para>
19586 </section>
19587 <section id="SECID87">
19588 <title>Calling Exim functions from Perl</title>
19589 <para>
19590 Within any Perl code called from Exim, the function <emphasis>Exim::expand_string()</emphasis>
19591 is available to call back into Exim&#x2019;s string expansion function. For example,
19592 the Perl code
19593 </para>
19594 <literallayout class="monospaced">
19595 my $lp = Exim::expand_string('$local_part');
19596 </literallayout>
19597 <para>
19598 makes the current Exim <varname>$local_part</varname> available in the Perl variable <varname>$lp</varname>.
19599 Note those are single quotes and not double quotes to protect against
19600 <varname>$local_part</varname> being interpolated as a Perl variable.
19601 </para>
19602 <para>
19603 If the string expansion is forced to fail by a <quote>fail</quote> item, the result of
19604 <emphasis>Exim::expand_string()</emphasis> is <option>undef</option>. If there is a syntax error in the
19605 expansion string, the Perl call from the original expansion string fails with
19606 an appropriate error message, in the same way as if <option>die</option> were used.
19607 </para>
19608 <para>
19609 <indexterm role="concept">
19610 <primary>debugging</primary>
19611 <secondary>from embedded Perl</secondary>
19612 </indexterm>
19613 <indexterm role="concept">
19614 <primary>log</primary>
19615 <secondary>writing from embedded Perl</secondary>
19616 </indexterm>
19617 Two other Exim functions are available for use from within Perl code.
19618 <emphasis>Exim::debug_write()</emphasis> writes a string to the standard error stream if Exim&#x2019;s
19619 debugging is enabled. If you want a newline at the end, you must supply it.
19620 <emphasis>Exim::log_write()</emphasis> writes a string to Exim&#x2019;s main log, adding a leading
19621 timestamp. In this case, you should not supply a terminating newline.
19622 </para>
19623 </section>
19624 <section id="SECID88">
19625 <title>Use of standard output and error by Perl</title>
19626 <para>
19627 <indexterm role="concept">
19628 <primary>Perl</primary>
19629 <secondary>standard output and error</secondary>
19630 </indexterm>
19631 You should not write to the standard error or output streams from within your
19632 Perl code, as it is not defined how these are set up. In versions of Exim
19633 before 4.50, it is possible for the standard output or error to refer to the
19634 SMTP connection during message reception via the daemon. Writing to this stream
19635 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
19636 error streams are connected to <filename>/dev/null</filename> in the daemon. The chaos is
19637 avoided, but the output is lost.
19638 </para>
19639 <para>
19640 <indexterm role="concept">
19641 <primary>Perl</primary>
19642 <secondary>use of <option>warn</option></secondary>
19643 </indexterm>
19644 The Perl <option>warn</option> statement writes to the standard error stream by default.
19645 Calls to <option>warn</option> may be embedded in Perl modules that you use, but over which
19646 you have no control. When Exim starts up the Perl interpreter, it arranges for
19647 output from the <option>warn</option> statement to be written to the Exim main log. You can
19648 change this by including appropriate Perl magic somewhere in your Perl code.
19649 For example, to discard <option>warn</option> output completely, you need this:
19650 </para>
19651 <literallayout class="monospaced">
19652 $SIG{__WARN__} = sub { };
19653 </literallayout>
19654 <para>
19655 Whenever a <option>warn</option> is obeyed, the anonymous subroutine is called. In this
19656 example, the code for the subroutine is empty, so it does nothing, but you can
19657 include any Perl code that you like. The text of the <option>warn</option> message is passed
19658 as the first subroutine argument.
19659 <indexterm role="concept" startref="IIDperl" class="endofrange"/>
19660 </para>
19661 </section>
19662 </chapter>
19663
19664 <chapter id="CHAPinterfaces">
19665 <title>Starting the daemon and the use of network interfaces</title>
19666 <titleabbrev>Starting the daemon</titleabbrev>
19667 <para>
19668 <indexterm role="concept">
19669 <primary>daemon</primary>
19670 <secondary>starting</secondary>
19671 </indexterm>
19672 <indexterm role="concept">
19673 <primary>interface</primary>
19674 <secondary>listening</secondary>
19675 </indexterm>
19676 <indexterm role="concept">
19677 <primary>network interface</primary>
19678 </indexterm>
19679 <indexterm role="concept">
19680 <primary>interface</primary>
19681 <secondary>network</secondary>
19682 </indexterm>
19683 <indexterm role="concept">
19684 <primary>IP address</primary>
19685 <secondary>for listening</secondary>
19686 </indexterm>
19687 <indexterm role="concept">
19688 <primary>daemon</primary>
19689 <secondary>listening IP addresses</secondary>
19690 </indexterm>
19691 <indexterm role="concept">
19692 <primary>TCP/IP</primary>
19693 <secondary>setting listening interfaces</secondary>
19694 </indexterm>
19695 <indexterm role="concept">
19696 <primary>TCP/IP</primary>
19697 <secondary>setting listening ports</secondary>
19698 </indexterm>
19699 A host that is connected to a TCP/IP network may have one or more physical
19700 hardware network interfaces. Each of these interfaces may be configured as one
19701 or more <quote>logical</quote> interfaces, which are the entities that a program actually
19702 works with. Each of these logical interfaces is associated with an IP address.
19703 In addition, TCP/IP software supports <quote>loopback</quote> interfaces (127.0.0.1 in
19704 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
19705 knowledge about the host&#x2019;s interfaces for use in three different circumstances:
19706 </para>
19707 <orderedlist numeration="arabic">
19708 <listitem>
19709 <para>
19710 When a listening daemon is started, Exim needs to know which interfaces
19711 and ports to listen on.
19712 </para>
19713 </listitem>
19714 <listitem>
19715 <para>
19716 When Exim is routing an address, it needs to know which IP addresses
19717 are associated with local interfaces. This is required for the correct
19718 processing of MX lists by removing the local host and others with the
19719 same or higher priority values. Also, Exim needs to detect cases
19720 when an address is routed to an IP address that in fact belongs to the
19721 local host. Unless the <option>self</option> router option or the <option>allow_localhost</option>
19722 option of the smtp transport is set (as appropriate), this is treated
19723 as an error situation.
19724 </para>
19725 </listitem>
19726 <listitem>
19727 <para>
19728 When Exim connects to a remote host, it may need to know which interface to use
19729 for the outgoing connection.
19730 </para>
19731 </listitem>
19732 </orderedlist>
19733 <para>
19734 Exim&#x2019;s default behaviour is likely to be appropriate in the vast majority
19735 of cases. If your host has only one interface, and you want all its IP
19736 addresses to be treated in the same way, and you are using only the
19737 standard SMTP port, you should not need to take any special action. The
19738 rest of this chapter does not apply to you.
19739 </para>
19740 <para>
19741 In a more complicated situation you may want to listen only on certain
19742 interfaces, or on different ports, and for this reason there are a number of
19743 options that can be used to influence Exim&#x2019;s behaviour. The rest of this
19744 chapter describes how they operate.
19745 </para>
19746 <para>
19747 When a message is received over TCP/IP, the interface and port that were
19748 actually used are set in <varname>$received_ip_address</varname> and <varname>$received_port</varname>.
19749 </para>
19750 <section id="SECID89">
19751 <title>Starting a listening daemon</title>
19752 <para>
19753 When a listening daemon is started (by means of the <option>-bd</option> command line
19754 option), the interfaces and ports on which it listens are controlled by the
19755 following options:
19756 </para>
19757 <itemizedlist>
19758 <listitem>
19759 <para>
19760 <option>daemon_smtp_ports</option> contains a list of default ports
19761 or service names.
19762 (For backward compatibility, this option can also be specified in the singular.)
19763 </para>
19764 </listitem>
19765 <listitem>
19766 <para>
19767 <option>local_interfaces</option> contains list of interface IP addresses on which to
19768 listen. Each item may optionally also specify a port.
19769 </para>
19770 </listitem>
19771 </itemizedlist>
19772 <para>
19773 The default list separator in both cases is a colon, but this can be changed as
19774 described in section <xref linkend="SECTlistconstruct"/>. When IPv6 addresses are involved,
19775 it is usually best to change the separator to avoid having to double all the
19776 colons. For example:
19777 </para>
19778 <literallayout class="monospaced">
19779 local_interfaces = &lt;; 127.0.0.1 ; \
19780                       192.168.23.65 ; \
19781                       ::1 ; \
19782                       3ffe:ffff:836f::fe86:a061
19783 </literallayout>
19784 <para>
19785 There are two different formats for specifying a port along with an IP address
19786 in <option>local_interfaces</option>:
19787 </para>
19788 <orderedlist numeration="arabic">
19789 <listitem>
19790 <para>
19791 The port is added onto the address with a dot separator. For example, to listen
19792 on port 1234 on two different IP addresses:
19793 </para>
19794 <literallayout class="monospaced">
19795 local_interfaces = &lt;; 192.168.23.65.1234 ; \
19796                       3ffe:ffff:836f::fe86:a061.1234
19797 </literallayout>
19798 </listitem>
19799 <listitem>
19800 <para>
19801 The IP address is enclosed in square brackets, and the port is added
19802 with a colon separator, for example:
19803 </para>
19804 <literallayout class="monospaced">
19805 local_interfaces = &lt;; [192.168.23.65]:1234 ; \
19806                       [3ffe:ffff:836f::fe86:a061]:1234
19807 </literallayout>
19808 </listitem>
19809 </orderedlist>
19810 <para>
19811 When a port is not specified, the value of <option>daemon_smtp_ports</option> is used. The
19812 default setting contains just one port:
19813 </para>
19814 <literallayout class="monospaced">
19815 daemon_smtp_ports = smtp
19816 </literallayout>
19817 <para>
19818 If more than one port is listed, each interface that does not have its own port
19819 specified listens on all of them. Ports that are listed in
19820 <option>daemon_smtp_ports</option> can be identified either by name (defined in
19821 <filename>/etc/services</filename>) or by number. However, when ports are given with individual
19822 IP addresses in <option>local_interfaces</option>, only numbers (not names) can be used.
19823 </para>
19824 </section>
19825 <section id="SECID90">
19826 <title>Special IP listening addresses</title>
19827 <para>
19828 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
19829 as <quote>all IPv4 interfaces</quote> and <quote>all IPv6 interfaces</quote>, respectively. In each
19830 case, Exim tells the TCP/IP stack to <quote>listen on all IPv<emphasis>x</emphasis> interfaces</quote>
19831 instead of setting up separate listening sockets for each interface. The
19832 default value of <option>local_interfaces</option> is
19833 </para>
19834 <literallayout class="monospaced">
19835 local_interfaces = 0.0.0.0
19836 </literallayout>
19837 <para>
19838 when Exim is built without IPv6 support; otherwise it is:
19839 </para>
19840 <literallayout class="monospaced">
19841 local_interfaces = &lt;; ::0 ; 0.0.0.0
19842 </literallayout>
19843 <para>
19844 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
19845 </para>
19846 </section>
19847 <section id="SECID91">
19848 <title>Overriding local_interfaces and daemon_smtp_ports</title>
19849 <para>
19850 The <option>-oX</option> command line option can be used to override the values of
19851 <option>daemon_smtp_ports</option> and/or <option>local_interfaces</option> for a particular daemon
19852 instance. Another way of doing this would be to use macros and the <option>-D</option>
19853 option. However, <option>-oX</option> can be used by any admin user, whereas modification of
19854 the runtime configuration by <option>-D</option> is allowed only when the caller is root or
19855 exim.
19856 </para>
19857 <para>
19858 The value of <option>-oX</option> is a list of items. The default colon separator can be
19859 changed in the usual way if required. If there are any items that do not
19860 contain dots or colons (that is, are not IP addresses), the value of
19861 <option>daemon_smtp_ports</option> is replaced by the list of those items. If there are any
19862 items that do contain dots or colons, the value of <option>local_interfaces</option> is
19863 replaced by those items. Thus, for example,
19864 </para>
19865 <literallayout class="monospaced">
19866 -oX 1225
19867 </literallayout>
19868 <para>
19869 overrides <option>daemon_smtp_ports</option>, but leaves <option>local_interfaces</option> unchanged,
19870 whereas
19871 </para>
19872 <literallayout class="monospaced">
19873 -oX 192.168.34.5.1125
19874 </literallayout>
19875 <para>
19876 overrides <option>local_interfaces</option>, leaving <option>daemon_smtp_ports</option> unchanged.
19877 (However, since <option>local_interfaces</option> now contains no items without ports, the
19878 value of <option>daemon_smtp_ports</option> is no longer relevant in this example.)
19879 </para>
19880 </section>
19881 <section id="SECTsupobssmt">
19882 <title>Support for the obsolete SSMTP (or SMTPS) protocol</title>
19883 <para>
19884 <indexterm role="concept">
19885 <primary>ssmtp protocol</primary>
19886 </indexterm>
19887 <indexterm role="concept">
19888 <primary>smtps protocol</primary>
19889 </indexterm>
19890 <indexterm role="concept">
19891 <primary>SMTP</primary>
19892 <secondary>ssmtp protocol</secondary>
19893 </indexterm>
19894 <indexterm role="concept">
19895 <primary>SMTP</primary>
19896 <secondary>smtps protocol</secondary>
19897 </indexterm>
19898 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
19899 before the STARTTLS command was standardized for SMTP. Some legacy clients
19900 still use this protocol. If the <option>tls_on_connect_ports</option> option is set to a
19901 list of port numbers or service names,
19902 connections to those ports must use SSMTP. The most
19903 common use of this option is expected to be
19904 </para>
19905 <literallayout class="monospaced">
19906 tls_on_connect_ports = 465
19907 </literallayout>
19908 <para>
19909 because 465 is the usual port number used by the legacy clients. There is also
19910 a command line option <option>-tls-on-connect</option>, which forces all ports to behave in
19911 this way when a daemon is started.
19912 </para>
19913 <para>
19914 <emphasis role="bold">Warning</emphasis>: Setting <option>tls_on_connect_ports</option> does not of itself cause the
19915 daemon to listen on those ports. You must still specify them in
19916 <option>daemon_smtp_ports</option>, <option>local_interfaces</option>, or the <option>-oX</option> option. (This is
19917 because <option>tls_on_connect_ports</option> applies to <option>inetd</option> connections as well as to
19918 connections via the daemon.)
19919 </para>
19920 </section>
19921 <section id="SECID92">
19922 <title>IPv6 address scopes</title>
19923 <para>
19924 <indexterm role="concept">
19925 <primary>IPv6</primary>
19926 <secondary>address scopes</secondary>
19927 </indexterm>
19928 IPv6 addresses have <quote>scopes</quote>, and a host with multiple hardware interfaces
19929 can, in principle, have the same link-local IPv6 address on different
19930 interfaces. Thus, additional information is needed, over and above the IP
19931 address, to distinguish individual interfaces. A convention of using a
19932 percent sign followed by something (often the interface name) has been
19933 adopted in some cases, leading to addresses like this:
19934 </para>
19935 <literallayout class="monospaced">
19936 fe80::202:b3ff:fe03:45c1%eth0
19937 </literallayout>
19938 <para>
19939 To accommodate this usage, a percent sign followed by an arbitrary string is
19940 allowed at the end of an IPv6 address. By default, Exim calls <function>getaddrinfo()</function>
19941 to convert a textual IPv6 address for actual use. This function recognizes the
19942 percent convention in operating systems that support it, and it processes the
19943 address appropriately. Unfortunately, some older libraries have problems with
19944 <function>getaddrinfo()</function>. If
19945 </para>
19946 <literallayout class="monospaced">
19947 IPV6_USE_INET_PTON=yes
19948 </literallayout>
19949 <para>
19950 is set in <filename>Local/Makefile</filename> (or an OS-dependent Makefile) when Exim is built,
19951 Exim uses <emphasis>inet_pton()</emphasis> to convert a textual IPv6 address for actual use,
19952 instead of <function>getaddrinfo()</function>. (Before version 4.14, it always used this
19953 function.) Of course, this means that the additional functionality of
19954 <function>getaddrinfo()</function> &ndash; recognizing scoped addresses &ndash; is lost.
19955 </para>
19956 </section>
19957 <section id="SECID93">
19958 <title>Disabling IPv6</title>
19959 <para>
19960 <indexterm role="concept">
19961 <primary>IPv6</primary>
19962 <secondary>disabling</secondary>
19963 </indexterm>
19964 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
19965 run on a host whose kernel does not support IPv6. The binary will fall back to
19966 using IPv4, but it may waste resources looking up AAAA records, and trying to
19967 connect to IPv6 addresses, causing delays to mail delivery. If you set the
19968 <indexterm role="option">
19969 <primary><option>disable_ipv6</option></primary>
19970 </indexterm>
19971 <option>disable_ipv6</option> option true, even if the Exim binary has IPv6 support, no IPv6
19972 activities take place. AAAA records are never looked up, and any IPv6 addresses
19973 that are listed in <option>local_interfaces</option>, data for the <command>manualroute</command> router,
19974 etc. are ignored. If IP literals are enabled, the <command>ipliteral</command> router declines
19975 to handle IPv6 literal addresses.
19976 </para>
19977 <para>
19978 On the other hand, when IPv6 is in use, there may be times when you want to
19979 disable it for certain hosts or domains. You can use the <option>dns_ipv4_lookup</option>
19980 option to globally suppress the lookup of AAAA records for specified domains,
19981 and you can use the <option>ignore_target_hosts</option> generic router option to ignore
19982 IPv6 addresses in an individual router.
19983 </para>
19984 </section>
19985 <section id="SECID94">
19986 <title>Examples of starting a listening daemon</title>
19987 <para>
19988 The default case in an IPv6 environment is
19989 </para>
19990 <literallayout class="monospaced">
19991 daemon_smtp_ports = smtp
19992 local_interfaces = &lt;; ::0 ; 0.0.0.0
19993 </literallayout>
19994 <para>
19995 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
19996 Either one or two sockets may be used, depending on the characteristics of
19997 the TCP/IP stack. (This is complicated and messy; for more information,
19998 read the comments in the <filename>daemon.c</filename> source file.)
19999 </para>
20000 <para>
20001 To specify listening on ports 25 and 26 on all interfaces:
20002 </para>
20003 <literallayout class="monospaced">
20004 daemon_smtp_ports = 25 : 26
20005 </literallayout>
20006 <para>
20007 (leaving <option>local_interfaces</option> at the default setting) or, more explicitly:
20008 </para>
20009 <literallayout class="monospaced">
20010 local_interfaces = &lt;; ::0.25     ; ::0.26 \
20011                       0.0.0.0.25 ; 0.0.0.0.26
20012 </literallayout>
20013 <para>
20014 To listen on the default port on all IPv4 interfaces, and on port 26 on the
20015 IPv4 loopback address only:
20016 </para>
20017 <literallayout class="monospaced">
20018 local_interfaces = 0.0.0.0 : 127.0.0.1.26
20019 </literallayout>
20020 <para>
20021 To specify listening on the default port on specific interfaces only:
20022 </para>
20023 <literallayout class="monospaced">
20024 local_interfaces = 10.0.0.67 : 192.168.34.67
20025 </literallayout>
20026 <para>
20027 <emphasis role="bold">Warning</emphasis>: Such a setting excludes listening on the loopback interfaces.
20028 </para>
20029 </section>
20030 <section id="SECTreclocipadd">
20031 <title>Recognizing the local host</title>
20032 <para>
20033 The <option>local_interfaces</option> option is also used when Exim needs to determine
20034 whether or not an IP address refers to the local host. That is, the IP
20035 addresses of all the interfaces on which a daemon is listening are always
20036 treated as local.
20037 </para>
20038 <para>
20039 For this usage, port numbers in <option>local_interfaces</option> are ignored. If either of
20040 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
20041 available interfaces from the operating system, and extracts the relevant
20042 (that is, IPv4 or IPv6) addresses to use for checking.
20043 </para>
20044 <para>
20045 Some systems set up large numbers of virtual interfaces in order to provide
20046 many virtual web servers. In this situation, you may want to listen for
20047 email on only a few of the available interfaces, but nevertheless treat all
20048 interfaces as local when routing. You can do this by setting
20049 <option>extra_local_interfaces</option> to a list of IP addresses, possibly including the
20050 <quote>all</quote> wildcard values. These addresses are recognized as local, but are not
20051 used for listening. Consider this example:
20052 </para>
20053 <literallayout class="monospaced">
20054 local_interfaces = &lt;; 127.0.0.1 ; ::1 ; \
20055                       192.168.53.235 ; \
20056                       3ffe:2101:12:1:a00:20ff:fe86:a061
20057
20058 extra_local_interfaces = &lt;; ::0 ; 0.0.0.0
20059 </literallayout>
20060 <para>
20061 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
20062 address, but all available interface addresses are treated as local when
20063 Exim is routing.
20064 </para>
20065 <para>
20066 In some environments the local host name may be in an MX list, but with an IP
20067 address that is not assigned to any local interface. In other cases it may be
20068 desirable to treat other host names as if they referred to the local host. Both
20069 these cases can be handled by setting the <option>hosts_treat_as_local</option> option.
20070 This contains host names rather than IP addresses. When a host is referenced
20071 during routing, either via an MX record or directly, it is treated as the local
20072 host if its name matches <option>hosts_treat_as_local</option>, or if any of its IP
20073 addresses match <option>local_interfaces</option> or <option>extra_local_interfaces</option>.
20074 </para>
20075 </section>
20076 <section id="SECID95">
20077 <title>Delivering to a remote host</title>
20078 <para>
20079 Delivery to a remote host is handled by the smtp transport. By default, it
20080 allows the system&#x2019;s TCP/IP functions to choose which interface to use (if
20081 there is more than one) when connecting to a remote host. However, the
20082 <option>interface</option> option can be set to specify which interface is used. See the
20083 description of the smtp transport in chapter <xref linkend="CHAPsmtptrans"/> for more
20084 details.
20085 </para>
20086 </section>
20087 </chapter>
20088
20089 <chapter id="CHAPmainconfig">
20090 <title>Main configuration</title>
20091 <para>
20092 <indexterm role="concept" id="IIDconfima" class="startofrange">
20093 <primary>configuration file</primary>
20094 <secondary>main section</secondary>
20095 </indexterm>
20096 <indexterm role="concept" id="IIDmaiconf" class="startofrange">
20097 <primary>main configuration</primary>
20098 </indexterm>
20099 The first part of the run time configuration file contains three types of item:
20100 </para>
20101 <itemizedlist>
20102 <listitem>
20103 <para>
20104 Macro definitions: These lines start with an upper case letter. See section
20105 <xref linkend="SECTmacrodefs"/> for details of macro processing.
20106 </para>
20107 </listitem>
20108 <listitem>
20109 <para>
20110 Named list definitions: These lines start with one of the words <quote>domainlist</quote>,
20111 <quote>hostlist</quote>, <quote>addresslist</quote>, or <quote>localpartlist</quote>. Their use is described in
20112 section <xref linkend="SECTnamedlists"/>.
20113 </para>
20114 </listitem>
20115 <listitem>
20116 <para>
20117 Main configuration settings: Each setting occupies one line of the file
20118 (with possible continuations). If any setting is preceded by the word
20119 <quote>hide</quote>, the <option>-bP</option> command line option displays its value to admin users
20120 only. See section <xref linkend="SECTcos"/> for a description of the syntax of these option
20121 settings.
20122 </para>
20123 </listitem>
20124 </itemizedlist>
20125 <para>
20126 This chapter specifies all the main configuration options, along with their
20127 types and default values. For ease of finding a particular option, they appear
20128 in alphabetical order in section <xref linkend="SECTalomo"/> below. However, because there
20129 are now so many options, they are first listed briefly in functional groups, as
20130 an aid to finding the name of the option you are looking for. Some options are
20131 listed in more than one group.
20132 </para>
20133 <section id="SECID96">
20134 <title>Miscellaneous</title>
20135 <informaltable frame="none">
20136 <tgroup cols="2" colsep="0" rowsep="0">
20137 <colspec colwidth="196pt" align="left"/>
20138 <colspec colwidth="254pt" align="left"/>
20139 <tbody>
20140 <row>
20141 <entry><option>bi_command</option></entry>
20142 <entry>to run for <option>-bi</option> command line option</entry>
20143 </row>
20144 <row>
20145 <entry><option>disable_ipv6</option></entry>
20146 <entry>do no IPv6 processing</entry>
20147 </row>
20148 <row>
20149 <entry><option>keep_malformed</option></entry>
20150 <entry>for broken files &ndash; should not happen</entry>
20151 </row>
20152 <row>
20153 <entry><option>localhost_number</option></entry>
20154 <entry>for unique message ids in clusters</entry>
20155 </row>
20156 <row>
20157 <entry><option>message_body_newlines</option></entry>
20158 <entry>retain newlines in <varname>$message_body</varname></entry>
20159 </row>
20160 <row>
20161 <entry><option>message_body_visible</option></entry>
20162 <entry>how much to show in <varname>$message_body</varname></entry>
20163 </row>
20164 <row>
20165 <entry><option>mua_wrapper</option></entry>
20166 <entry>run in <quote>MUA wrapper</quote> mode</entry>
20167 </row>
20168 <row>
20169 <entry><option>print_topbitchars</option></entry>
20170 <entry>top-bit characters are printing</entry>
20171 </row>
20172 <row>
20173 <entry><option>timezone</option></entry>
20174 <entry>force time zone</entry>
20175 </row>
20176 </tbody>
20177 </tgroup>
20178 </informaltable>
20179 </section>
20180 <section id="SECID97">
20181 <title>Exim parameters</title>
20182 <informaltable frame="none">
20183 <tgroup cols="2" colsep="0" rowsep="0">
20184 <colspec colwidth="196pt" align="left"/>
20185 <colspec colwidth="254pt" align="left"/>
20186 <tbody>
20187 <row>
20188 <entry><option>exim_group</option></entry>
20189 <entry>override compiled-in value</entry>
20190 </row>
20191 <row>
20192 <entry><option>exim_path</option></entry>
20193 <entry>override compiled-in value</entry>
20194 </row>
20195 <row>
20196 <entry><option>exim_user</option></entry>
20197 <entry>override compiled-in value</entry>
20198 </row>
20199 <row>
20200 <entry><option>primary_hostname</option></entry>
20201 <entry>default from <function>uname()</function></entry>
20202 </row>
20203 <row>
20204 <entry><option>split_spool_directory</option></entry>
20205 <entry>use multiple directories</entry>
20206 </row>
20207 <row>
20208 <entry><option>spool_directory</option></entry>
20209 <entry>override compiled-in value</entry>
20210 </row>
20211 </tbody>
20212 </tgroup>
20213 </informaltable>
20214 </section>
20215 <section id="SECID98">
20216 <title>Privilege controls</title>
20217 <informaltable frame="none">
20218 <tgroup cols="2" colsep="0" rowsep="0">
20219 <colspec colwidth="196pt" align="left"/>
20220 <colspec colwidth="254pt" align="left"/>
20221 <tbody>
20222 <row>
20223 <entry><option>admin_groups</option></entry>
20224 <entry>groups that are Exim admin users</entry>
20225 </row>
20226 <row>
20227 <entry><option>deliver_drop_privilege</option></entry>
20228 <entry>drop root for delivery processes</entry>
20229 </row>
20230 <row>
20231 <entry><option>local_from_check</option></entry>
20232 <entry>insert <emphasis>Sender:</emphasis> if necessary</entry>
20233 </row>
20234 <row>
20235 <entry><option>local_from_prefix</option></entry>
20236 <entry>for testing <emphasis>From:</emphasis> for local sender</entry>
20237 </row>
20238 <row>
20239 <entry><option>local_from_suffix</option></entry>
20240 <entry>for testing <emphasis>From:</emphasis> for local sender</entry>
20241 </row>
20242 <row>
20243 <entry><option>local_sender_retain</option></entry>
20244 <entry>keep <emphasis>Sender:</emphasis> from untrusted user</entry>
20245 </row>
20246 <row>
20247 <entry><option>never_users</option></entry>
20248 <entry>do not run deliveries as these</entry>
20249 </row>
20250 <row>
20251 <entry><option>prod_requires_admin</option></entry>
20252 <entry>forced delivery requires admin user</entry>
20253 </row>
20254 <row>
20255 <entry><option>queue_list_requires_admin</option></entry>
20256 <entry>queue listing requires admin user</entry>
20257 </row>
20258 <row>
20259 <entry><option>trusted_groups</option></entry>
20260 <entry>groups that are trusted</entry>
20261 </row>
20262 <row>
20263 <entry><option>trusted_users</option></entry>
20264 <entry>users that are trusted</entry>
20265 </row>
20266 </tbody>
20267 </tgroup>
20268 </informaltable>
20269 </section>
20270 <section id="SECID99">
20271 <title>Logging</title>
20272 <informaltable frame="none">
20273 <tgroup cols="2" colsep="0" rowsep="0">
20274 <colspec colwidth="196pt" align="left"/>
20275 <colspec colwidth="254pt" align="left"/>
20276 <tbody>
20277 <row>
20278 <entry><option>hosts_connection_nolog</option></entry>
20279 <entry>exemption from connect logging</entry>
20280 </row>
20281 <row>
20282 <entry><option>log_file_path</option></entry>
20283 <entry>override compiled-in value</entry>
20284 </row>
20285 <row>
20286 <entry><option>log_selector</option></entry>
20287 <entry>set/unset optional logging</entry>
20288 </row>
20289 <row>
20290 <entry><option>log_timezone</option></entry>
20291 <entry>add timezone to log lines</entry>
20292 </row>
20293 <row>
20294 <entry><option>message_logs</option></entry>
20295 <entry>create per-message logs</entry>
20296 </row>
20297 <row>
20298 <entry><option>preserve_message_logs</option></entry>
20299 <entry>after message completion</entry>
20300 </row>
20301 <row>
20302 <entry><option>process_log_path</option></entry>
20303 <entry>for SIGUSR1 and <emphasis>exiwhat</emphasis></entry>
20304 </row>
20305 <row>
20306 <entry><option>syslog_duplication</option></entry>
20307 <entry>controls duplicate log lines on syslog</entry>
20308 </row>
20309 <row>
20310 <entry><option>syslog_facility</option></entry>
20311 <entry>set syslog <quote>facility</quote> field</entry>
20312 </row>
20313 <row>
20314 <entry><option>syslog_processname</option></entry>
20315 <entry>set syslog <quote>ident</quote> field</entry>
20316 </row>
20317 <row>
20318 <entry><option>syslog_timestamp</option></entry>
20319 <entry>timestamp syslog lines</entry>
20320 </row>
20321 <row>
20322 <entry><option>write_rejectlog</option></entry>
20323 <entry>control use of message log</entry>
20324 </row>
20325 </tbody>
20326 </tgroup>
20327 </informaltable>
20328 </section>
20329 <section id="SECID100">
20330 <title>Frozen messages</title>
20331 <informaltable frame="none">
20332 <tgroup cols="2" colsep="0" rowsep="0">
20333 <colspec colwidth="196pt" align="left"/>
20334 <colspec colwidth="254pt" align="left"/>
20335 <tbody>
20336 <row>
20337 <entry><option>auto_thaw</option></entry>
20338 <entry>sets time for retrying frozen messages</entry>
20339 </row>
20340 <row>
20341 <entry><option>freeze_tell</option></entry>
20342 <entry>send message when freezing</entry>
20343 </row>
20344 <row>
20345 <entry><option>move_frozen_messages</option></entry>
20346 <entry>to another directory</entry>
20347 </row>
20348 <row>
20349 <entry><option>timeout_frozen_after</option></entry>
20350 <entry>keep frozen messages only so long</entry>
20351 </row>
20352 </tbody>
20353 </tgroup>
20354 </informaltable>
20355 </section>
20356 <section id="SECID101">
20357 <title>Data lookups</title>
20358 <informaltable frame="none">
20359 <tgroup cols="2" colsep="0" rowsep="0">
20360 <colspec colwidth="196pt" align="left"/>
20361 <colspec colwidth="254pt" align="left"/>
20362 <tbody>
20363 <row>
20364 <entry><option>ibase_servers</option></entry>
20365 <entry>InterBase servers</entry>
20366 </row>
20367 <row>
20368 <entry><option>ldap_ca_cert_dir</option></entry>
20369 <entry>dir of CA certs to verify LDAP server&#x2019;s</entry>
20370 </row>
20371 <row>
20372 <entry><option>ldap_ca_cert_file</option></entry>
20373 <entry>file of CA certs to verify LDAP server&#x2019;s</entry>
20374 </row>
20375 <row>
20376 <entry><option>ldap_cert_file</option></entry>
20377 <entry>client cert file for LDAP</entry>
20378 </row>
20379 <row>
20380 <entry><option>ldap_cert_key</option></entry>
20381 <entry>client key file for LDAP</entry>
20382 </row>
20383 <row>
20384 <entry><option>ldap_cipher_suite</option></entry>
20385 <entry>TLS negotiation preference control</entry>
20386 </row>
20387 <row>
20388 <entry><option>ldap_default_servers</option></entry>
20389 <entry>used if no server in query</entry>
20390 </row>
20391 <row>
20392 <entry><option>ldap_require_cert</option></entry>
20393 <entry>action to take without LDAP server cert</entry>
20394 </row>
20395 <row>
20396 <entry><option>ldap_start_tls</option></entry>
20397 <entry>require TLS within LDAP</entry>
20398 </row>
20399 <row>
20400 <entry><option>ldap_version</option></entry>
20401 <entry>set protocol version</entry>
20402 </row>
20403 <row>
20404 <entry><option>lookup_open_max</option></entry>
20405 <entry>lookup files held open</entry>
20406 </row>
20407 <row>
20408 <entry><option>mysql_servers</option></entry>
20409 <entry>default MySQL servers</entry>
20410 </row>
20411 <row>
20412 <entry><option>oracle_servers</option></entry>
20413 <entry>Oracle servers</entry>
20414 </row>
20415 <row>
20416 <entry><option>pgsql_servers</option></entry>
20417 <entry>default PostgreSQL servers</entry>
20418 </row>
20419 <row>
20420 <entry><option>sqlite_lock_timeout</option></entry>
20421 <entry>as it says</entry>
20422 </row>
20423 </tbody>
20424 </tgroup>
20425 </informaltable>
20426 </section>
20427 <section id="SECID102">
20428 <title>Message ids</title>
20429 <informaltable frame="none">
20430 <tgroup cols="2" colsep="0" rowsep="0">
20431 <colspec colwidth="196pt" align="left"/>
20432 <colspec colwidth="254pt" align="left"/>
20433 <tbody>
20434 <row>
20435 <entry><option>message_id_header_domain</option></entry>
20436 <entry>used to build <emphasis>Message-ID:</emphasis> header</entry>
20437 </row>
20438 <row>
20439 <entry><option>message_id_header_text</option></entry>
20440 <entry>ditto</entry>
20441 </row>
20442 </tbody>
20443 </tgroup>
20444 </informaltable>
20445 </section>
20446 <section id="SECID103">
20447 <title>Embedded Perl Startup</title>
20448 <informaltable frame="none">
20449 <tgroup cols="2" colsep="0" rowsep="0">
20450 <colspec colwidth="196pt" align="left"/>
20451 <colspec colwidth="254pt" align="left"/>
20452 <tbody>
20453 <row>
20454 <entry><option>perl_at_start</option></entry>
20455 <entry>always start the interpreter</entry>
20456 </row>
20457 <row>
20458 <entry><option>perl_startup</option></entry>
20459 <entry>code to obey when starting Perl</entry>
20460 </row>
20461 </tbody>
20462 </tgroup>
20463 </informaltable>
20464 </section>
20465 <section id="SECID104">
20466 <title>Daemon</title>
20467 <informaltable frame="none">
20468 <tgroup cols="2" colsep="0" rowsep="0">
20469 <colspec colwidth="196pt" align="left"/>
20470 <colspec colwidth="254pt" align="left"/>
20471 <tbody>
20472 <row>
20473 <entry><option>daemon_smtp_ports</option></entry>
20474 <entry>default ports</entry>
20475 </row>
20476 <row>
20477 <entry><option>daemon_startup_retries</option></entry>
20478 <entry>number of times to retry</entry>
20479 </row>
20480 <row>
20481 <entry><option>daemon_startup_sleep</option></entry>
20482 <entry>time to sleep between tries</entry>
20483 </row>
20484 <row>
20485 <entry><option>extra_local_interfaces</option></entry>
20486 <entry>not necessarily listened on</entry>
20487 </row>
20488 <row>
20489 <entry><option>local_interfaces</option></entry>
20490 <entry>on which to listen, with optional ports</entry>
20491 </row>
20492 <row>
20493 <entry><option>pid_file_path</option></entry>
20494 <entry>override compiled-in value</entry>
20495 </row>
20496 <row>
20497 <entry><option>queue_run_max</option></entry>
20498 <entry>maximum simultaneous queue runners</entry>
20499 </row>
20500 </tbody>
20501 </tgroup>
20502 </informaltable>
20503 </section>
20504 <section id="SECID105">
20505 <title>Resource control</title>
20506 <informaltable frame="none">
20507 <tgroup cols="2" colsep="0" rowsep="0">
20508 <colspec colwidth="196pt" align="left"/>
20509 <colspec colwidth="254pt" align="left"/>
20510 <tbody>
20511 <row>
20512 <entry><option>check_log_inodes</option></entry>
20513 <entry>before accepting a message</entry>
20514 </row>
20515 <row>
20516 <entry><option>check_log_space</option></entry>
20517 <entry>before accepting a message</entry>
20518 </row>
20519 <row>
20520 <entry><option>check_spool_inodes</option></entry>
20521 <entry>before accepting a message</entry>
20522 </row>
20523 <row>
20524 <entry><option>check_spool_space</option></entry>
20525 <entry>before accepting a message</entry>
20526 </row>
20527 <row>
20528 <entry><option>deliver_queue_load_max</option></entry>
20529 <entry>no queue deliveries if load high</entry>
20530 </row>
20531 <row>
20532 <entry><option>queue_only_load</option></entry>
20533 <entry>queue incoming if load high</entry>
20534 </row>
20535 <row>
20536 <entry><option>queue_only_load_latch</option></entry>
20537 <entry>don&#x2019;t re-evaluate load for each message</entry>
20538 </row>
20539 <row>
20540 <entry><option>queue_run_max</option></entry>
20541 <entry>maximum simultaneous queue runners</entry>
20542 </row>
20543 <row>
20544 <entry><option>remote_max_parallel</option></entry>
20545 <entry>parallel SMTP delivery per message</entry>
20546 </row>
20547 <row>
20548 <entry><option>smtp_accept_max</option></entry>
20549 <entry>simultaneous incoming connections</entry>
20550 </row>
20551 <row>
20552 <entry><option>smtp_accept_max_nonmail</option></entry>
20553 <entry>non-mail commands</entry>
20554 </row>
20555 <row>
20556 <entry><option>smtp_accept_max_nonmail_hosts</option></entry>
20557 <entry>hosts to which the limit applies</entry>
20558 </row>
20559 <row>
20560 <entry><option>smtp_accept_max_per_connection</option></entry>
20561 <entry>messages per connection</entry>
20562 </row>
20563 <row>
20564 <entry><option>smtp_accept_max_per_host</option></entry>
20565 <entry>connections from one host</entry>
20566 </row>
20567 <row>
20568 <entry><option>smtp_accept_queue</option></entry>
20569 <entry>queue mail if more connections</entry>
20570 </row>
20571 <row>
20572 <entry><option>smtp_accept_queue_per_connection</option></entry>
20573 <entry>queue if more messages per connection</entry>
20574 </row>
20575 <row>
20576 <entry><option>smtp_accept_reserve</option></entry>
20577 <entry>only reserve hosts if more connections</entry>
20578 </row>
20579 <row>
20580 <entry><option>smtp_check_spool_space</option></entry>
20581 <entry>from SIZE on MAIL command</entry>
20582 </row>
20583 <row>
20584 <entry><option>smtp_connect_backlog</option></entry>
20585 <entry>passed to TCP/IP stack</entry>
20586 </row>
20587 <row>
20588 <entry><option>smtp_load_reserve</option></entry>
20589 <entry>SMTP from reserved hosts if load high</entry>
20590 </row>
20591 <row>
20592 <entry><option>smtp_reserve_hosts</option></entry>
20593 <entry>these are the reserve hosts</entry>
20594 </row>
20595 </tbody>
20596 </tgroup>
20597 </informaltable>
20598 </section>
20599 <section id="SECID106">
20600 <title>Policy controls</title>
20601 <informaltable frame="none">
20602 <tgroup cols="2" colsep="0" rowsep="0">
20603 <colspec colwidth="196pt" align="left"/>
20604 <colspec colwidth="254pt" align="left"/>
20605 <tbody>
20606 <row>
20607 <entry><option>acl_not_smtp</option></entry>
20608 <entry>ACL for non-SMTP messages</entry>
20609 </row>
20610 <row>
20611 <entry><option>acl_not_smtp_mime</option></entry>
20612 <entry>ACL for non-SMTP MIME parts</entry>
20613 </row>
20614 <row>
20615 <entry><option>acl_not_smtp_start</option></entry>
20616 <entry>ACL for start of non-SMTP message</entry>
20617 </row>
20618 <row>
20619 <entry><option>acl_smtp_auth</option></entry>
20620 <entry>ACL for AUTH</entry>
20621 </row>
20622 <row>
20623 <entry><option>acl_smtp_connect</option></entry>
20624 <entry>ACL for connection</entry>
20625 </row>
20626 <row>
20627 <entry><option>acl_smtp_data</option></entry>
20628 <entry>ACL for DATA</entry>
20629 </row>
20630 <row>
20631 <entry><option>acl_smtp_data_prdr</option></entry>
20632 <entry>ACL for DATA, per-recipient</entry>
20633 </row>
20634 <row>
20635 <entry><option>acl_smtp_dkim</option></entry>
20636 <entry>ACL for DKIM verification</entry>
20637 </row>
20638 <row>
20639 <entry><option>acl_smtp_etrn</option></entry>
20640 <entry>ACL for ETRN</entry>
20641 </row>
20642 <row>
20643 <entry><option>acl_smtp_expn</option></entry>
20644 <entry>ACL for EXPN</entry>
20645 </row>
20646 <row>
20647 <entry><option>acl_smtp_helo</option></entry>
20648 <entry>ACL for EHLO or HELO</entry>
20649 </row>
20650 <row>
20651 <entry><option>acl_smtp_mail</option></entry>
20652 <entry>ACL for MAIL</entry>
20653 </row>
20654 <row>
20655 <entry><option>acl_smtp_mailauth</option></entry>
20656 <entry>ACL for AUTH on MAIL command</entry>
20657 </row>
20658 <row>
20659 <entry><option>acl_smtp_mime</option></entry>
20660 <entry>ACL for MIME parts</entry>
20661 </row>
20662 <row>
20663 <entry><option>acl_smtp_predata</option></entry>
20664 <entry>ACL for start of data</entry>
20665 </row>
20666 <row>
20667 <entry><option>acl_smtp_quit</option></entry>
20668 <entry>ACL for QUIT</entry>
20669 </row>
20670 <row>
20671 <entry><option>acl_smtp_rcpt</option></entry>
20672 <entry>ACL for RCPT</entry>
20673 </row>
20674 <row>
20675 <entry><option>acl_smtp_starttls</option></entry>
20676 <entry>ACL for STARTTLS</entry>
20677 </row>
20678 <row>
20679 <entry><option>acl_smtp_vrfy</option></entry>
20680 <entry>ACL for VRFY</entry>
20681 </row>
20682 <row>
20683 <entry><option>av_scanner</option></entry>
20684 <entry>specify virus scanner</entry>
20685 </row>
20686 <row>
20687 <entry><option>check_rfc2047_length</option></entry>
20688 <entry>check length of RFC 2047 <quote>encoded words</quote></entry>
20689 </row>
20690 <row>
20691 <entry><option>dns_csa_search_limit</option></entry>
20692 <entry>control CSA parent search depth</entry>
20693 </row>
20694 <row>
20695 <entry><option>dns_csa_use_reverse</option></entry>
20696 <entry>en/disable CSA IP reverse search</entry>
20697 </row>
20698 <row>
20699 <entry><option>header_maxsize</option></entry>
20700 <entry>total size of message header</entry>
20701 </row>
20702 <row>
20703 <entry><option>header_line_maxsize</option></entry>
20704 <entry>individual header line limit</entry>
20705 </row>
20706 <row>
20707 <entry><option>helo_accept_junk_hosts</option></entry>
20708 <entry>allow syntactic junk from these hosts</entry>
20709 </row>
20710 <row>
20711 <entry><option>helo_allow_chars</option></entry>
20712 <entry>allow illegal chars in HELO names</entry>
20713 </row>
20714 <row>
20715 <entry><option>helo_lookup_domains</option></entry>
20716 <entry>lookup hostname for these HELO names</entry>
20717 </row>
20718 <row>
20719 <entry><option>helo_try_verify_hosts</option></entry>
20720 <entry>HELO soft-checked for these hosts</entry>
20721 </row>
20722 <row>
20723 <entry><option>helo_verify_hosts</option></entry>
20724 <entry>HELO hard-checked for these hosts</entry>
20725 </row>
20726 <row>
20727 <entry><option>host_lookup</option></entry>
20728 <entry>host name looked up for these hosts</entry>
20729 </row>
20730 <row>
20731 <entry><option>host_lookup_order</option></entry>
20732 <entry>order of DNS and local name lookups</entry>
20733 </row>
20734 <row>
20735 <entry><option>host_reject_connection</option></entry>
20736 <entry>reject connection from these hosts</entry>
20737 </row>
20738 <row>
20739 <entry><option>hosts_treat_as_local</option></entry>
20740 <entry>useful in some cluster configurations</entry>
20741 </row>
20742 <row>
20743 <entry><option>local_scan_timeout</option></entry>
20744 <entry>timeout for <function>local_scan()</function></entry>
20745 </row>
20746 <row>
20747 <entry><option>message_size_limit</option></entry>
20748 <entry>for all messages</entry>
20749 </row>
20750 <row>
20751 <entry><option>percent_hack_domains</option></entry>
20752 <entry>recognize %-hack for these domains</entry>
20753 </row>
20754 <row>
20755 <entry><option>spamd_address</option></entry>
20756 <entry>set interface to SpamAssassin</entry>
20757 </row>
20758 <row>
20759 <entry><option>strict_acl_vars</option></entry>
20760 <entry>object to unset ACL variables</entry>
20761 </row>
20762 </tbody>
20763 </tgroup>
20764 </informaltable>
20765 </section>
20766 <section id="SECID107">
20767 <title>Callout cache</title>
20768 <informaltable frame="none">
20769 <tgroup cols="2" colsep="0" rowsep="0">
20770 <colspec colwidth="196pt" align="left"/>
20771 <colspec colwidth="254pt" align="left"/>
20772 <tbody>
20773 <row>
20774 <entry><option>callout_domain_negative_expire</option></entry>
20775 <entry>timeout for negative domain cache item</entry>
20776 </row>
20777 <row>
20778 <entry><option>callout_domain_positive_expire</option></entry>
20779 <entry>timeout for positive domain cache item</entry>
20780 </row>
20781 <row>
20782 <entry><option>callout_negative_expire</option></entry>
20783 <entry>timeout for negative address cache item</entry>
20784 </row>
20785 <row>
20786 <entry><option>callout_positive_expire</option></entry>
20787 <entry>timeout for positive address cache item</entry>
20788 </row>
20789 <row>
20790 <entry><option>callout_random_local_part</option></entry>
20791 <entry>string to use for <quote>random</quote> testing</entry>
20792 </row>
20793 </tbody>
20794 </tgroup>
20795 </informaltable>
20796 </section>
20797 <section id="SECID108">
20798 <title>TLS</title>
20799 <informaltable frame="none">
20800 <tgroup cols="2" colsep="0" rowsep="0">
20801 <colspec colwidth="196pt" align="left"/>
20802 <colspec colwidth="254pt" align="left"/>
20803 <tbody>
20804 <row>
20805 <entry><option>gnutls_compat_mode</option></entry>
20806 <entry>use GnuTLS compatibility mode</entry>
20807 </row>
20808 <row>
20809 <entry><option>gnutls_allow_auto_pkcs11</option></entry>
20810 <entry>allow GnuTLS to autoload PKCS11 modules</entry>
20811 </row>
20812 <row>
20813 <entry><option>openssl_options</option></entry>
20814 <entry>adjust OpenSSL compatibility options</entry>
20815 </row>
20816 <row>
20817 <entry><option>tls_advertise_hosts</option></entry>
20818 <entry>advertise TLS to these hosts</entry>
20819 </row>
20820 <row>
20821 <entry><option>tls_certificate</option></entry>
20822 <entry>location of server certificate</entry>
20823 </row>
20824 <row>
20825 <entry><option>tls_crl</option></entry>
20826 <entry>certificate revocation list</entry>
20827 </row>
20828 <row>
20829 <entry><option>tls_dh_max_bits</option></entry>
20830 <entry>clamp D-H bit count suggestion</entry>
20831 </row>
20832 <row>
20833 <entry><option>tls_dhparam</option></entry>
20834 <entry>DH parameters for server</entry>
20835 </row>
20836 <row>
20837 <entry><option>tls_ocsp_file</option></entry>
20838 <entry>location of server certificate status proof</entry>
20839 </row>
20840 <row>
20841 <entry><option>tls_on_connect_ports</option></entry>
20842 <entry>specify SSMTP (SMTPS) ports</entry>
20843 </row>
20844 <row>
20845 <entry><option>tls_privatekey</option></entry>
20846 <entry>location of server private key</entry>
20847 </row>
20848 <row>
20849 <entry><option>tls_remember_esmtp</option></entry>
20850 <entry>don&#x2019;t reset after starting TLS</entry>
20851 </row>
20852 <row>
20853 <entry><option>tls_require_ciphers</option></entry>
20854 <entry>specify acceptable ciphers</entry>
20855 </row>
20856 <row>
20857 <entry><option>tls_try_verify_hosts</option></entry>
20858 <entry>try to verify client certificate</entry>
20859 </row>
20860 <row>
20861 <entry><option>tls_verify_certificates</option></entry>
20862 <entry>expected client certificates</entry>
20863 </row>
20864 <row>
20865 <entry><option>tls_verify_hosts</option></entry>
20866 <entry>insist on client certificate verify</entry>
20867 </row>
20868 </tbody>
20869 </tgroup>
20870 </informaltable>
20871 </section>
20872 <section id="SECID109">
20873 <title>Local user handling</title>
20874 <informaltable frame="none">
20875 <tgroup cols="2" colsep="0" rowsep="0">
20876 <colspec colwidth="196pt" align="left"/>
20877 <colspec colwidth="254pt" align="left"/>
20878 <tbody>
20879 <row>
20880 <entry><option>finduser_retries</option></entry>
20881 <entry>useful in NIS environments</entry>
20882 </row>
20883 <row>
20884 <entry><option>gecos_name</option></entry>
20885 <entry>used when creating <emphasis>Sender:</emphasis></entry>
20886 </row>
20887 <row>
20888 <entry><option>gecos_pattern</option></entry>
20889 <entry>ditto</entry>
20890 </row>
20891 <row>
20892 <entry><option>max_username_length</option></entry>
20893 <entry>for systems that truncate</entry>
20894 </row>
20895 <row>
20896 <entry><option>unknown_login</option></entry>
20897 <entry>used when no login name found</entry>
20898 </row>
20899 <row>
20900 <entry><option>unknown_username</option></entry>
20901 <entry>ditto</entry>
20902 </row>
20903 <row>
20904 <entry><option>uucp_from_pattern</option></entry>
20905 <entry>for recognizing <quote>From </quote> lines</entry>
20906 </row>
20907 <row>
20908 <entry><option>uucp_from_sender</option></entry>
20909 <entry>ditto</entry>
20910 </row>
20911 </tbody>
20912 </tgroup>
20913 </informaltable>
20914 </section>
20915 <section id="SECID110">
20916 <title>All incoming messages (SMTP and non-SMTP)</title>
20917 <informaltable frame="none">
20918 <tgroup cols="2" colsep="0" rowsep="0">
20919 <colspec colwidth="196pt" align="left"/>
20920 <colspec colwidth="254pt" align="left"/>
20921 <tbody>
20922 <row>
20923 <entry><option>header_maxsize</option></entry>
20924 <entry>total size of message header</entry>
20925 </row>
20926 <row>
20927 <entry><option>header_line_maxsize</option></entry>
20928 <entry>individual header line limit</entry>
20929 </row>
20930 <row>
20931 <entry><option>message_size_limit</option></entry>
20932 <entry>applies to all messages</entry>
20933 </row>
20934 <row>
20935 <entry><option>percent_hack_domains</option></entry>
20936 <entry>recognize %-hack for these domains</entry>
20937 </row>
20938 <row>
20939 <entry><option>received_header_text</option></entry>
20940 <entry>expanded to make <emphasis>Received:</emphasis></entry>
20941 </row>
20942 <row>
20943 <entry><option>received_headers_max</option></entry>
20944 <entry>for mail loop detection</entry>
20945 </row>
20946 <row>
20947 <entry><option>recipients_max</option></entry>
20948 <entry>limit per message</entry>
20949 </row>
20950 <row>
20951 <entry><option>recipients_max_reject</option></entry>
20952 <entry>permanently reject excess recipients</entry>
20953 </row>
20954 </tbody>
20955 </tgroup>
20956 </informaltable>
20957 </section>
20958 <section id="SECID111">
20959 <title>Non-SMTP incoming messages</title>
20960 <informaltable frame="none">
20961 <tgroup cols="2" colsep="0" rowsep="0">
20962 <colspec colwidth="196pt" align="left"/>
20963 <colspec colwidth="254pt" align="left"/>
20964 <tbody>
20965 <row>
20966 <entry><option>receive_timeout</option></entry>
20967 <entry>for non-SMTP messages</entry>
20968 </row>
20969 </tbody>
20970 </tgroup>
20971 </informaltable>
20972 </section>
20973 <section id="SECID112">
20974 <title>Incoming SMTP messages</title>
20975 <para>
20976 See also the <emphasis>Policy controls</emphasis> section above.
20977 </para>
20978 <informaltable frame="none">
20979 <tgroup cols="2" colsep="0" rowsep="0">
20980 <colspec colwidth="196pt" align="left"/>
20981 <colspec colwidth="254pt" align="left"/>
20982 <tbody>
20983 <row>
20984 <entry><option>host_lookup</option></entry>
20985 <entry>host name looked up for these hosts</entry>
20986 </row>
20987 <row>
20988 <entry><option>host_lookup_order</option></entry>
20989 <entry>order of DNS and local name lookups</entry>
20990 </row>
20991 <row>
20992 <entry><option>recipient_unqualified_hosts</option></entry>
20993 <entry>may send unqualified recipients</entry>
20994 </row>
20995 <row>
20996 <entry><option>rfc1413_hosts</option></entry>
20997 <entry>make ident calls to these hosts</entry>
20998 </row>
20999 <row>
21000 <entry><option>rfc1413_query_timeout</option></entry>
21001 <entry>zero disables ident calls</entry>
21002 </row>
21003 <row>
21004 <entry><option>sender_unqualified_hosts</option></entry>
21005 <entry>may send unqualified senders</entry>
21006 </row>
21007 <row>
21008 <entry><option>smtp_accept_keepalive</option></entry>
21009 <entry>some TCP/IP magic</entry>
21010 </row>
21011 <row>
21012 <entry><option>smtp_accept_max</option></entry>
21013 <entry>simultaneous incoming connections</entry>
21014 </row>
21015 <row>
21016 <entry><option>smtp_accept_max_nonmail</option></entry>
21017 <entry>non-mail commands</entry>
21018 </row>
21019 <row>
21020 <entry><option>smtp_accept_max_nonmail_hosts</option></entry>
21021 <entry>hosts to which the limit applies</entry>
21022 </row>
21023 <row>
21024 <entry><option>smtp_accept_max_per_connection</option></entry>
21025 <entry>messages per connection</entry>
21026 </row>
21027 <row>
21028 <entry><option>smtp_accept_max_per_host</option></entry>
21029 <entry>connections from one host</entry>
21030 </row>
21031 <row>
21032 <entry><option>smtp_accept_queue</option></entry>
21033 <entry>queue mail if more connections</entry>
21034 </row>
21035 <row>
21036 <entry><option>smtp_accept_queue_per_connection</option></entry>
21037 <entry>queue if more messages per connection</entry>
21038 </row>
21039 <row>
21040 <entry><option>smtp_accept_reserve</option></entry>
21041 <entry>only reserve hosts if more connections</entry>
21042 </row>
21043 <row>
21044 <entry><option>smtp_active_hostname</option></entry>
21045 <entry>host name to use in messages</entry>
21046 </row>
21047 <row>
21048 <entry><option>smtp_banner</option></entry>
21049 <entry>text for welcome banner</entry>
21050 </row>
21051 <row>
21052 <entry><option>smtp_check_spool_space</option></entry>
21053 <entry>from SIZE on MAIL command</entry>
21054 </row>
21055 <row>
21056 <entry><option>smtp_connect_backlog</option></entry>
21057 <entry>passed to TCP/IP stack</entry>
21058 </row>
21059 <row>
21060 <entry><option>smtp_enforce_sync</option></entry>
21061 <entry>of SMTP command/responses</entry>
21062 </row>
21063 <row>
21064 <entry><option>smtp_etrn_command</option></entry>
21065 <entry>what to run for ETRN</entry>
21066 </row>
21067 <row>
21068 <entry><option>smtp_etrn_serialize</option></entry>
21069 <entry>only one at once</entry>
21070 </row>
21071 <row>
21072 <entry><option>smtp_load_reserve</option></entry>
21073 <entry>only reserve hosts if this load</entry>
21074 </row>
21075 <row>
21076 <entry><option>smtp_max_unknown_commands</option></entry>
21077 <entry>before dropping connection</entry>
21078 </row>
21079 <row>
21080 <entry><option>smtp_ratelimit_hosts</option></entry>
21081 <entry>apply ratelimiting to these hosts</entry>
21082 </row>
21083 <row>
21084 <entry><option>smtp_ratelimit_mail</option></entry>
21085 <entry>ratelimit for MAIL commands</entry>
21086 </row>
21087 <row>
21088 <entry><option>smtp_ratelimit_rcpt</option></entry>
21089 <entry>ratelimit for RCPT commands</entry>
21090 </row>
21091 <row>
21092 <entry><option>smtp_receive_timeout</option></entry>
21093 <entry>per command or data line</entry>
21094 </row>
21095 <row>
21096 <entry><option>smtp_reserve_hosts</option></entry>
21097 <entry>these are the reserve hosts</entry>
21098 </row>
21099 <row>
21100 <entry><option>smtp_return_error_details</option></entry>
21101 <entry>give detail on rejections</entry>
21102 </row>
21103 </tbody>
21104 </tgroup>
21105 </informaltable>
21106 </section>
21107 <section id="SECID113">
21108 <title>SMTP extensions</title>
21109 <informaltable frame="none">
21110 <tgroup cols="2" colsep="0" rowsep="0">
21111 <colspec colwidth="196pt" align="left"/>
21112 <colspec colwidth="254pt" align="left"/>
21113 <tbody>
21114 <row>
21115 <entry><option>accept_8bitmime</option></entry>
21116 <entry>advertise 8BITMIME</entry>
21117 </row>
21118 <row>
21119 <entry><option>auth_advertise_hosts</option></entry>
21120 <entry>advertise AUTH to these hosts</entry>
21121 </row>
21122 <row>
21123 <entry><option>ignore_fromline_hosts</option></entry>
21124 <entry>allow <quote>From </quote> from these hosts</entry>
21125 </row>
21126 <row>
21127 <entry><option>ignore_fromline_local</option></entry>
21128 <entry>allow <quote>From </quote> from local SMTP</entry>
21129 </row>
21130 <row>
21131 <entry><option>pipelining_advertise_hosts</option></entry>
21132 <entry>advertise pipelining to these hosts</entry>
21133 </row>
21134 <row>
21135 <entry><option>prdr_enable</option></entry>
21136 <entry>advertise PRDR to all hosts</entry>
21137 </row>
21138 <row>
21139 <entry><option>tls_advertise_hosts</option></entry>
21140 <entry>advertise TLS to these hosts</entry>
21141 </row>
21142 </tbody>
21143 </tgroup>
21144 </informaltable>
21145 </section>
21146 <section id="SECID114">
21147 <title>Processing messages</title>
21148 <informaltable frame="none">
21149 <tgroup cols="2" colsep="0" rowsep="0">
21150 <colspec colwidth="196pt" align="left"/>
21151 <colspec colwidth="254pt" align="left"/>
21152 <tbody>
21153 <row>
21154 <entry><option>allow_domain_literals</option></entry>
21155 <entry>recognize domain literal syntax</entry>
21156 </row>
21157 <row>
21158 <entry><option>allow_mx_to_ip</option></entry>
21159 <entry>allow MX to point to IP address</entry>
21160 </row>
21161 <row>
21162 <entry><option>allow_utf8_domains</option></entry>
21163 <entry>in addresses</entry>
21164 </row>
21165 <row>
21166 <entry><option>check_rfc2047_length</option></entry>
21167 <entry>check length of RFC 2047 <quote>encoded words</quote></entry>
21168 </row>
21169 <row>
21170 <entry><option>delivery_date_remove</option></entry>
21171 <entry>from incoming messages</entry>
21172 </row>
21173 <row>
21174 <entry><option>envelope_to_remove</option></entry>
21175 <entry>from incoming messages</entry>
21176 </row>
21177 <row>
21178 <entry><option>extract_addresses_remove_arguments</option></entry>
21179 <entry>affects <option>-t</option> processing</entry>
21180 </row>
21181 <row>
21182 <entry><option>headers_charset</option></entry>
21183 <entry>default for translations</entry>
21184 </row>
21185 <row>
21186 <entry><option>qualify_domain</option></entry>
21187 <entry>default for senders</entry>
21188 </row>
21189 <row>
21190 <entry><option>qualify_recipient</option></entry>
21191 <entry>default for recipients</entry>
21192 </row>
21193 <row>
21194 <entry><option>return_path_remove</option></entry>
21195 <entry>from incoming messages</entry>
21196 </row>
21197 <row>
21198 <entry><option>strip_excess_angle_brackets</option></entry>
21199 <entry>in addresses</entry>
21200 </row>
21201 <row>
21202 <entry><option>strip_trailing_dot</option></entry>
21203 <entry>at end of addresses</entry>
21204 </row>
21205 <row>
21206 <entry><option>untrusted_set_sender</option></entry>
21207 <entry>untrusted can set envelope sender</entry>
21208 </row>
21209 </tbody>
21210 </tgroup>
21211 </informaltable>
21212 </section>
21213 <section id="SECID115">
21214 <title>System filter</title>
21215 <informaltable frame="none">
21216 <tgroup cols="2" colsep="0" rowsep="0">
21217 <colspec colwidth="196pt" align="left"/>
21218 <colspec colwidth="254pt" align="left"/>
21219 <tbody>
21220 <row>
21221 <entry><option>system_filter</option></entry>
21222 <entry>locate system filter</entry>
21223 </row>
21224 <row>
21225 <entry><option>system_filter_directory_transport</option></entry>
21226 <entry>transport for delivery to a directory</entry>
21227 </row>
21228 <row>
21229 <entry><option>system_filter_file_transport</option></entry>
21230 <entry>transport for delivery to a file</entry>
21231 </row>
21232 <row>
21233 <entry><option>system_filter_group</option></entry>
21234 <entry>group for filter running</entry>
21235 </row>
21236 <row>
21237 <entry><option>system_filter_pipe_transport</option></entry>
21238 <entry>transport for delivery to a pipe</entry>
21239 </row>
21240 <row>
21241 <entry><option>system_filter_reply_transport</option></entry>
21242 <entry>transport for autoreply delivery</entry>
21243 </row>
21244 <row>
21245 <entry><option>system_filter_user</option></entry>
21246 <entry>user for filter running</entry>
21247 </row>
21248 </tbody>
21249 </tgroup>
21250 </informaltable>
21251 </section>
21252 <section id="SECID116">
21253 <title>Routing and delivery</title>
21254 <informaltable frame="none">
21255 <tgroup cols="2" colsep="0" rowsep="0">
21256 <colspec colwidth="196pt" align="left"/>
21257 <colspec colwidth="254pt" align="left"/>
21258 <tbody>
21259 <row>
21260 <entry><option>disable_ipv6</option></entry>
21261 <entry>do no IPv6 processing</entry>
21262 </row>
21263 <row>
21264 <entry><option>dns_again_means_nonexist</option></entry>
21265 <entry>for broken domains</entry>
21266 </row>
21267 <row>
21268 <entry><option>dns_check_names_pattern</option></entry>
21269 <entry>pre-DNS syntax check</entry>
21270 </row>
21271 <row>
21272 <entry><option>dns_dnssec_ok</option></entry>
21273 <entry>parameter for resolver</entry>
21274 </row>
21275 <row>
21276 <entry><option>dns_ipv4_lookup</option></entry>
21277 <entry>only v4 lookup for these domains</entry>
21278 </row>
21279 <row>
21280 <entry><option>dns_retrans</option></entry>
21281 <entry>parameter for resolver</entry>
21282 </row>
21283 <row>
21284 <entry><option>dns_retry</option></entry>
21285 <entry>parameter for resolver</entry>
21286 </row>
21287 <row>
21288 <entry><option>dns_use_edns0</option></entry>
21289 <entry>parameter for resolver</entry>
21290 </row>
21291 <row>
21292 <entry><option>hold_domains</option></entry>
21293 <entry>hold delivery for these domains</entry>
21294 </row>
21295 <row>
21296 <entry><option>local_interfaces</option></entry>
21297 <entry>for routing checks</entry>
21298 </row>
21299 <row>
21300 <entry><option>queue_domains</option></entry>
21301 <entry>no immediate delivery for these</entry>
21302 </row>
21303 <row>
21304 <entry><option>queue_only</option></entry>
21305 <entry>no immediate delivery at all</entry>
21306 </row>
21307 <row>
21308 <entry><option>queue_only_file</option></entry>
21309 <entry>no immediate delivery if file exists</entry>
21310 </row>
21311 <row>
21312 <entry><option>queue_only_load</option></entry>
21313 <entry>no immediate delivery if load is high</entry>
21314 </row>
21315 <row>
21316 <entry><option>queue_only_load_latch</option></entry>
21317 <entry>don&#x2019;t re-evaluate load for each message</entry>
21318 </row>
21319 <row>
21320 <entry><option>queue_only_override</option></entry>
21321 <entry>allow command line to override</entry>
21322 </row>
21323 <row>
21324 <entry><option>queue_run_in_order</option></entry>
21325 <entry>order of arrival</entry>
21326 </row>
21327 <row>
21328 <entry><option>queue_run_max</option></entry>
21329 <entry>of simultaneous queue runners</entry>
21330 </row>
21331 <row>
21332 <entry><option>queue_smtp_domains</option></entry>
21333 <entry>no immediate SMTP delivery for these</entry>
21334 </row>
21335 <row>
21336 <entry><option>remote_max_parallel</option></entry>
21337 <entry>parallel SMTP delivery per message</entry>
21338 </row>
21339 <row>
21340 <entry><option>remote_sort_domains</option></entry>
21341 <entry>order of remote deliveries</entry>
21342 </row>
21343 <row>
21344 <entry><option>retry_data_expire</option></entry>
21345 <entry>timeout for retry data</entry>
21346 </row>
21347 <row>
21348 <entry><option>retry_interval_max</option></entry>
21349 <entry>safety net for retry rules</entry>
21350 </row>
21351 </tbody>
21352 </tgroup>
21353 </informaltable>
21354 </section>
21355 <section id="SECID117">
21356 <title>Bounce and warning messages</title>
21357 <informaltable frame="none">
21358 <tgroup cols="2" colsep="0" rowsep="0">
21359 <colspec colwidth="196pt" align="left"/>
21360 <colspec colwidth="254pt" align="left"/>
21361 <tbody>
21362 <row>
21363 <entry><option>bounce_message_file</option></entry>
21364 <entry>content of bounce</entry>
21365 </row>
21366 <row>
21367 <entry><option>bounce_message_text</option></entry>
21368 <entry>content of bounce</entry>
21369 </row>
21370 <row>
21371 <entry><option>bounce_return_body</option></entry>
21372 <entry>include body if returning message</entry>
21373 </row>
21374 <row>
21375 <entry><option>bounce_return_message</option></entry>
21376 <entry>include original message in bounce</entry>
21377 </row>
21378 <row>
21379 <entry><option>bounce_return_size_limit</option></entry>
21380 <entry>limit on returned message</entry>
21381 </row>
21382 <row>
21383 <entry><option>bounce_sender_authentication</option></entry>
21384 <entry>send authenticated sender with bounce</entry>
21385 </row>
21386 <row>
21387 <entry><option>dsn_from</option></entry>
21388 <entry>set <emphasis>From:</emphasis> contents in bounces</entry>
21389 </row>
21390 <row>
21391 <entry><option>errors_copy</option></entry>
21392 <entry>copy bounce messages</entry>
21393 </row>
21394 <row>
21395 <entry><option>errors_reply_to</option></entry>
21396 <entry><emphasis>Reply-to:</emphasis> in bounces</entry>
21397 </row>
21398 <row>
21399 <entry><option>delay_warning</option></entry>
21400 <entry>time schedule</entry>
21401 </row>
21402 <row>
21403 <entry><option>delay_warning_condition</option></entry>
21404 <entry>condition for warning messages</entry>
21405 </row>
21406 <row>
21407 <entry><option>ignore_bounce_errors_after</option></entry>
21408 <entry>discard undeliverable bounces</entry>
21409 </row>
21410 <row>
21411 <entry><option>smtp_return_error_details</option></entry>
21412 <entry>give detail on rejections</entry>
21413 </row>
21414 <row>
21415 <entry><option>warn_message_file</option></entry>
21416 <entry>content of warning message</entry>
21417 </row>
21418 </tbody>
21419 </tgroup>
21420 </informaltable>
21421 </section>
21422 <section id="SECTalomo">
21423 <title>Alphabetical list of main options</title>
21424 <para>
21425 Those options that undergo string expansion before use are marked with
21426 &dagger;.
21427 </para>
21428 <para>
21429 <indexterm role="option">
21430 <primary><option>accept_8bitmime</option></primary>
21431 </indexterm>
21432 </para>
21433 <informaltable frame="all">
21434 <tgroup cols="4" colsep="0" rowsep="0">
21435 <colspec colwidth="8*" align="left"/>
21436 <colspec colwidth="6*" align="center"/>
21437 <colspec colwidth="6*" align="center"/>
21438 <colspec colwidth="6*" align="right"/>
21439 <tbody>
21440 <row>
21441 <entry><option>accept_8bitmime</option></entry>
21442 <entry>Use: <emphasis>main</emphasis></entry>
21443 <entry>Type: <emphasis>boolean</emphasis></entry>
21444 <entry>Default: <emphasis>true</emphasis></entry>
21445 </row>
21446 </tbody>
21447 </tgroup>
21448 </informaltable>
21449 <para>
21450 <indexterm role="concept">
21451 <primary>8BITMIME</primary>
21452 </indexterm>
21453 <indexterm role="concept">
21454 <primary>8-bit characters</primary>
21455 </indexterm>
21456 <indexterm role="concept">
21457 <primary>log</primary>
21458 <secondary>selectors</secondary>
21459 </indexterm>
21460 <indexterm role="concept">
21461 <primary>log</primary>
21462 <secondary>8BITMIME</secondary>
21463 </indexterm>
21464 This option causes Exim to send 8BITMIME in its response to an SMTP
21465 EHLO command, and to accept the BODY= parameter on MAIL commands.
21466 However, though Exim is 8-bit clean, it is not a protocol converter, and it
21467 takes no steps to do anything special with messages received by this route.
21468 </para>
21469 <para>
21470 Historically Exim kept this option off by default, but the maintainers
21471 feel that in today&#x2019;s Internet, this causes more problems than it solves.
21472 It now defaults to true.
21473 A more detailed analysis of the issues is provided by Dan Bernstein:
21474 </para>
21475 <literallayout>
21476 <emphasis role="bold"><ulink url="http://cr.yp.to/smtp/8bitmime.html">http://cr.yp.to/smtp/8bitmime.html</ulink></emphasis>
21477 </literallayout>
21478 <para>
21479 To log received 8BITMIME status use
21480 </para>
21481 <literallayout class="monospaced">
21482 log_selector = +8bitmime
21483 </literallayout>
21484 <para>
21485 <indexterm role="option">
21486 <primary><option>acl_not_smtp</option></primary>
21487 </indexterm>
21488 </para>
21489 <informaltable frame="all">
21490 <tgroup cols="4" colsep="0" rowsep="0">
21491 <colspec colwidth="8*" align="left"/>
21492 <colspec colwidth="6*" align="center"/>
21493 <colspec colwidth="6*" align="center"/>
21494 <colspec colwidth="6*" align="right"/>
21495 <tbody>
21496 <row>
21497 <entry><option>acl_not_smtp</option></entry>
21498 <entry>Use: <emphasis>main</emphasis></entry>
21499 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
21500 <entry>Default: <emphasis>unset</emphasis></entry>
21501 </row>
21502 </tbody>
21503 </tgroup>
21504 </informaltable>
21505 <para>
21506 <indexterm role="concept">
21507 <primary>access control lists (ACLs)</primary>
21508 <secondary>for non-SMTP messages</secondary>
21509 </indexterm>
21510 <indexterm role="concept">
21511 <primary>non-SMTP messages</primary>
21512 <secondary>ACLs for</secondary>
21513 </indexterm>
21514 This option defines the ACL that is run when a non-SMTP message has been
21515 read and is on the point of being accepted. See chapter <xref linkend="CHAPACL"/> for
21516 further details.
21517 </para>
21518 <para>
21519 <indexterm role="option">
21520 <primary><option>acl_not_smtp_mime</option></primary>
21521 </indexterm>
21522 </para>
21523 <informaltable frame="all">
21524 <tgroup cols="4" colsep="0" rowsep="0">
21525 <colspec colwidth="8*" align="left"/>
21526 <colspec colwidth="6*" align="center"/>
21527 <colspec colwidth="6*" align="center"/>
21528 <colspec colwidth="6*" align="right"/>
21529 <tbody>
21530 <row>
21531 <entry><option>acl_not_smtp_mime</option></entry>
21532 <entry>Use: <emphasis>main</emphasis></entry>
21533 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
21534 <entry>Default: <emphasis>unset</emphasis></entry>
21535 </row>
21536 </tbody>
21537 </tgroup>
21538 </informaltable>
21539 <para>
21540 This option defines the ACL that is run for individual MIME parts of non-SMTP
21541 messages. It operates in exactly the same way as <option>acl_smtp_mime</option> operates for
21542 SMTP messages.
21543 </para>
21544 <para>
21545 <indexterm role="option">
21546 <primary><option>acl_not_smtp_start</option></primary>
21547 </indexterm>
21548 </para>
21549 <informaltable frame="all">
21550 <tgroup cols="4" colsep="0" rowsep="0">
21551 <colspec colwidth="8*" align="left"/>
21552 <colspec colwidth="6*" align="center"/>
21553 <colspec colwidth="6*" align="center"/>
21554 <colspec colwidth="6*" align="right"/>
21555 <tbody>
21556 <row>
21557 <entry><option>acl_not_smtp_start</option></entry>
21558 <entry>Use: <emphasis>main</emphasis></entry>
21559 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
21560 <entry>Default: <emphasis>unset</emphasis></entry>
21561 </row>
21562 </tbody>
21563 </tgroup>
21564 </informaltable>
21565 <para>
21566 <indexterm role="concept">
21567 <primary>access control lists (ACLs)</primary>
21568 <secondary>at start of non-SMTP message</secondary>
21569 </indexterm>
21570 <indexterm role="concept">
21571 <primary>non-SMTP messages</primary>
21572 <secondary>ACLs for</secondary>
21573 </indexterm>
21574 This option defines the ACL that is run before Exim starts reading a
21575 non-SMTP message. See chapter <xref linkend="CHAPACL"/> for further details.
21576 </para>
21577 <para>
21578 <indexterm role="option">
21579 <primary><option>acl_smtp_auth</option></primary>
21580 </indexterm>
21581 </para>
21582 <informaltable frame="all">
21583 <tgroup cols="4" colsep="0" rowsep="0">
21584 <colspec colwidth="8*" align="left"/>
21585 <colspec colwidth="6*" align="center"/>
21586 <colspec colwidth="6*" align="center"/>
21587 <colspec colwidth="6*" align="right"/>
21588 <tbody>
21589 <row>
21590 <entry><option>acl_smtp_auth</option></entry>
21591 <entry>Use: <emphasis>main</emphasis></entry>
21592 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
21593 <entry>Default: <emphasis>unset</emphasis></entry>
21594 </row>
21595 </tbody>
21596 </tgroup>
21597 </informaltable>
21598 <para>
21599 <indexterm role="concept">
21600 <primary>access control lists (ACLs)</primary>
21601 <secondary>setting up for SMTP commands</secondary>
21602 </indexterm>
21603 <indexterm role="concept">
21604 <primary>AUTH</primary>
21605 <secondary>ACL for</secondary>
21606 </indexterm>
21607 This option defines the ACL that is run when an SMTP AUTH command is
21608 received. See chapter <xref linkend="CHAPACL"/> for further details.
21609 </para>
21610 <para>
21611 <indexterm role="option">
21612 <primary><option>acl_smtp_connect</option></primary>
21613 </indexterm>
21614 </para>
21615 <informaltable frame="all">
21616 <tgroup cols="4" colsep="0" rowsep="0">
21617 <colspec colwidth="8*" align="left"/>
21618 <colspec colwidth="6*" align="center"/>
21619 <colspec colwidth="6*" align="center"/>
21620 <colspec colwidth="6*" align="right"/>
21621 <tbody>
21622 <row>
21623 <entry><option>acl_smtp_connect</option></entry>
21624 <entry>Use: <emphasis>main</emphasis></entry>
21625 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
21626 <entry>Default: <emphasis>unset</emphasis></entry>
21627 </row>
21628 </tbody>
21629 </tgroup>
21630 </informaltable>
21631 <para>
21632 <indexterm role="concept">
21633 <primary>access control lists (ACLs)</primary>
21634 <secondary>on SMTP connection</secondary>
21635 </indexterm>
21636 This option defines the ACL that is run when an SMTP connection is received.
21637 See chapter <xref linkend="CHAPACL"/> for further details.
21638 </para>
21639 <para>
21640 <indexterm role="option">
21641 <primary><option>acl_smtp_data</option></primary>
21642 </indexterm>
21643 </para>
21644 <informaltable frame="all">
21645 <tgroup cols="4" colsep="0" rowsep="0">
21646 <colspec colwidth="8*" align="left"/>
21647 <colspec colwidth="6*" align="center"/>
21648 <colspec colwidth="6*" align="center"/>
21649 <colspec colwidth="6*" align="right"/>
21650 <tbody>
21651 <row>
21652 <entry><option>acl_smtp_data</option></entry>
21653 <entry>Use: <emphasis>main</emphasis></entry>
21654 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
21655 <entry>Default: <emphasis>unset</emphasis></entry>
21656 </row>
21657 </tbody>
21658 </tgroup>
21659 </informaltable>
21660 <para>
21661 <indexterm role="concept">
21662 <primary>DATA</primary>
21663 <secondary>ACL for</secondary>
21664 </indexterm>
21665 This option defines the ACL that is run after an SMTP DATA command has been
21666 processed and the message itself has been received, but before the final
21667 acknowledgment is sent. See chapter <xref linkend="CHAPACL"/> for further details.
21668 </para>
21669 <para>
21670 <indexterm role="option">
21671 <primary><option>acl_smtp_data_prdr</option></primary>
21672 </indexterm>
21673 </para>
21674 <informaltable frame="all">
21675 <tgroup cols="4" colsep="0" rowsep="0">
21676 <colspec colwidth="8*" align="left"/>
21677 <colspec colwidth="6*" align="center"/>
21678 <colspec colwidth="6*" align="center"/>
21679 <colspec colwidth="6*" align="right"/>
21680 <tbody>
21681 <row>
21682 <entry><option>acl_smtp_data_prdr</option></entry>
21683 <entry>Use: <emphasis>main</emphasis></entry>
21684 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
21685 <entry>Default: <emphasis>unset</emphasis></entry>
21686 </row>
21687 </tbody>
21688 </tgroup>
21689 </informaltable>
21690 <para>
21691 <indexterm role="concept">
21692 <primary>DATA</primary>
21693 <secondary>ACL for</secondary>
21694 </indexterm>
21695 <indexterm role="concept">
21696 <primary>access control lists (ACLs)</primary>
21697 <secondary>PRDR-related</secondary>
21698 </indexterm>
21699 <indexterm role="concept">
21700 <primary>access control lists (ACLs)</primary>
21701 <secondary>per-user data processing</secondary>
21702 </indexterm>
21703 This option defines the ACL that,
21704 if the PRDR feature has been negotiated,
21705 is run for each recipient after an SMTP DATA command has been
21706 processed and the message itself has been received, but before the
21707 acknowledgment is sent. See chapter <xref linkend="CHAPACL"/> for further details.
21708 </para>
21709 <para>
21710 <indexterm role="option">
21711 <primary><option>acl_smtp_etrn</option></primary>
21712 </indexterm>
21713 </para>
21714 <informaltable frame="all">
21715 <tgroup cols="4" colsep="0" rowsep="0">
21716 <colspec colwidth="8*" align="left"/>
21717 <colspec colwidth="6*" align="center"/>
21718 <colspec colwidth="6*" align="center"/>
21719 <colspec colwidth="6*" align="right"/>
21720 <tbody>
21721 <row>
21722 <entry><option>acl_smtp_etrn</option></entry>
21723 <entry>Use: <emphasis>main</emphasis></entry>
21724 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
21725 <entry>Default: <emphasis>unset</emphasis></entry>
21726 </row>
21727 </tbody>
21728 </tgroup>
21729 </informaltable>
21730 <para>
21731 <indexterm role="concept">
21732 <primary>ETRN</primary>
21733 <secondary>ACL for</secondary>
21734 </indexterm>
21735 This option defines the ACL that is run when an SMTP ETRN command is
21736 received. See chapter <xref linkend="CHAPACL"/> for further details.
21737 </para>
21738 <para>
21739 <indexterm role="option">
21740 <primary><option>acl_smtp_expn</option></primary>
21741 </indexterm>
21742 </para>
21743 <informaltable frame="all">
21744 <tgroup cols="4" colsep="0" rowsep="0">
21745 <colspec colwidth="8*" align="left"/>
21746 <colspec colwidth="6*" align="center"/>
21747 <colspec colwidth="6*" align="center"/>
21748 <colspec colwidth="6*" align="right"/>
21749 <tbody>
21750 <row>
21751 <entry><option>acl_smtp_expn</option></entry>
21752 <entry>Use: <emphasis>main</emphasis></entry>
21753 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
21754 <entry>Default: <emphasis>unset</emphasis></entry>
21755 </row>
21756 </tbody>
21757 </tgroup>
21758 </informaltable>
21759 <para>
21760 <indexterm role="concept">
21761 <primary>EXPN</primary>
21762 <secondary>ACL for</secondary>
21763 </indexterm>
21764 This option defines the ACL that is run when an SMTP EXPN command is
21765 received. See chapter <xref linkend="CHAPACL"/> for further details.
21766 </para>
21767 <para>
21768 <indexterm role="option">
21769 <primary><option>acl_smtp_helo</option></primary>
21770 </indexterm>
21771 </para>
21772 <informaltable frame="all">
21773 <tgroup cols="4" colsep="0" rowsep="0">
21774 <colspec colwidth="8*" align="left"/>
21775 <colspec colwidth="6*" align="center"/>
21776 <colspec colwidth="6*" align="center"/>
21777 <colspec colwidth="6*" align="right"/>
21778 <tbody>
21779 <row>
21780 <entry><option>acl_smtp_helo</option></entry>
21781 <entry>Use: <emphasis>main</emphasis></entry>
21782 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
21783 <entry>Default: <emphasis>unset</emphasis></entry>
21784 </row>
21785 </tbody>
21786 </tgroup>
21787 </informaltable>
21788 <para>
21789 <indexterm role="concept">
21790 <primary>EHLO</primary>
21791 <secondary>ACL for</secondary>
21792 </indexterm>
21793 <indexterm role="concept">
21794 <primary>HELO</primary>
21795 <secondary>ACL for</secondary>
21796 </indexterm>
21797 This option defines the ACL that is run when an SMTP EHLO or HELO
21798 command is received. See chapter <xref linkend="CHAPACL"/> for further details.
21799 </para>
21800 <para>
21801 <indexterm role="option">
21802 <primary><option>acl_smtp_mail</option></primary>
21803 </indexterm>
21804 </para>
21805 <informaltable frame="all">
21806 <tgroup cols="4" colsep="0" rowsep="0">
21807 <colspec colwidth="8*" align="left"/>
21808 <colspec colwidth="6*" align="center"/>
21809 <colspec colwidth="6*" align="center"/>
21810 <colspec colwidth="6*" align="right"/>
21811 <tbody>
21812 <row>
21813 <entry><option>acl_smtp_mail</option></entry>
21814 <entry>Use: <emphasis>main</emphasis></entry>
21815 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
21816 <entry>Default: <emphasis>unset</emphasis></entry>
21817 </row>
21818 </tbody>
21819 </tgroup>
21820 </informaltable>
21821 <para>
21822 <indexterm role="concept">
21823 <primary>MAIL</primary>
21824 <secondary>ACL for</secondary>
21825 </indexterm>
21826 This option defines the ACL that is run when an SMTP MAIL command is
21827 received. See chapter <xref linkend="CHAPACL"/> for further details.
21828 </para>
21829 <para>
21830 <indexterm role="option">
21831 <primary><option>acl_smtp_mailauth</option></primary>
21832 </indexterm>
21833 </para>
21834 <informaltable frame="all">
21835 <tgroup cols="4" colsep="0" rowsep="0">
21836 <colspec colwidth="8*" align="left"/>
21837 <colspec colwidth="6*" align="center"/>
21838 <colspec colwidth="6*" align="center"/>
21839 <colspec colwidth="6*" align="right"/>
21840 <tbody>
21841 <row>
21842 <entry><option>acl_smtp_mailauth</option></entry>
21843 <entry>Use: <emphasis>main</emphasis></entry>
21844 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
21845 <entry>Default: <emphasis>unset</emphasis></entry>
21846 </row>
21847 </tbody>
21848 </tgroup>
21849 </informaltable>
21850 <para>
21851 <indexterm role="concept">
21852 <primary>AUTH</primary>
21853 <secondary>on MAIL command</secondary>
21854 </indexterm>
21855 This option defines the ACL that is run when there is an AUTH parameter on
21856 a MAIL command. See chapter <xref linkend="CHAPACL"/> for details of ACLs, and chapter
21857 <xref linkend="CHAPSMTPAUTH"/> for details of authentication.
21858 </para>
21859 <para>
21860 <indexterm role="option">
21861 <primary><option>acl_smtp_mime</option></primary>
21862 </indexterm>
21863 </para>
21864 <informaltable frame="all">
21865 <tgroup cols="4" colsep="0" rowsep="0">
21866 <colspec colwidth="8*" align="left"/>
21867 <colspec colwidth="6*" align="center"/>
21868 <colspec colwidth="6*" align="center"/>
21869 <colspec colwidth="6*" align="right"/>
21870 <tbody>
21871 <row>
21872 <entry><option>acl_smtp_mime</option></entry>
21873 <entry>Use: <emphasis>main</emphasis></entry>
21874 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
21875 <entry>Default: <emphasis>unset</emphasis></entry>
21876 </row>
21877 </tbody>
21878 </tgroup>
21879 </informaltable>
21880 <para>
21881 <indexterm role="concept">
21882 <primary>MIME content scanning</primary>
21883 <secondary>ACL for</secondary>
21884 </indexterm>
21885 This option is available when Exim is built with the content-scanning
21886 extension. It defines the ACL that is run for each MIME part in a message. See
21887 section <xref linkend="SECTscanmimepart"/> for details.
21888 </para>
21889 <para>
21890 <indexterm role="option">
21891 <primary><option>acl_smtp_predata</option></primary>
21892 </indexterm>
21893 </para>
21894 <informaltable frame="all">
21895 <tgroup cols="4" colsep="0" rowsep="0">
21896 <colspec colwidth="8*" align="left"/>
21897 <colspec colwidth="6*" align="center"/>
21898 <colspec colwidth="6*" align="center"/>
21899 <colspec colwidth="6*" align="right"/>
21900 <tbody>
21901 <row>
21902 <entry><option>acl_smtp_predata</option></entry>
21903 <entry>Use: <emphasis>main</emphasis></entry>
21904 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
21905 <entry>Default: <emphasis>unset</emphasis></entry>
21906 </row>
21907 </tbody>
21908 </tgroup>
21909 </informaltable>
21910 <para>
21911 This option defines the ACL that is run when an SMTP DATA command is
21912 received, before the message itself is received. See chapter <xref linkend="CHAPACL"/> for
21913 further details.
21914 </para>
21915 <para>
21916 <indexterm role="option">
21917 <primary><option>acl_smtp_quit</option></primary>
21918 </indexterm>
21919 </para>
21920 <informaltable frame="all">
21921 <tgroup cols="4" colsep="0" rowsep="0">
21922 <colspec colwidth="8*" align="left"/>
21923 <colspec colwidth="6*" align="center"/>
21924 <colspec colwidth="6*" align="center"/>
21925 <colspec colwidth="6*" align="right"/>
21926 <tbody>
21927 <row>
21928 <entry><option>acl_smtp_quit</option></entry>
21929 <entry>Use: <emphasis>main</emphasis></entry>
21930 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
21931 <entry>Default: <emphasis>unset</emphasis></entry>
21932 </row>
21933 </tbody>
21934 </tgroup>
21935 </informaltable>
21936 <para>
21937 <indexterm role="concept">
21938 <primary>QUIT, ACL for</primary>
21939 </indexterm>
21940 This option defines the ACL that is run when an SMTP QUIT command is
21941 received. See chapter <xref linkend="CHAPACL"/> for further details.
21942 </para>
21943 <para>
21944 <indexterm role="option">
21945 <primary><option>acl_smtp_rcpt</option></primary>
21946 </indexterm>
21947 </para>
21948 <informaltable frame="all">
21949 <tgroup cols="4" colsep="0" rowsep="0">
21950 <colspec colwidth="8*" align="left"/>
21951 <colspec colwidth="6*" align="center"/>
21952 <colspec colwidth="6*" align="center"/>
21953 <colspec colwidth="6*" align="right"/>
21954 <tbody>
21955 <row>
21956 <entry><option>acl_smtp_rcpt</option></entry>
21957 <entry>Use: <emphasis>main</emphasis></entry>
21958 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
21959 <entry>Default: <emphasis>unset</emphasis></entry>
21960 </row>
21961 </tbody>
21962 </tgroup>
21963 </informaltable>
21964 <para>
21965 <indexterm role="concept">
21966 <primary>RCPT</primary>
21967 <secondary>ACL for</secondary>
21968 </indexterm>
21969 This option defines the ACL that is run when an SMTP RCPT command is
21970 received. See chapter <xref linkend="CHAPACL"/> for further details.
21971 </para>
21972 <para>
21973 <indexterm role="option">
21974 <primary><option>acl_smtp_starttls</option></primary>
21975 </indexterm>
21976 </para>
21977 <informaltable frame="all">
21978 <tgroup cols="4" colsep="0" rowsep="0">
21979 <colspec colwidth="8*" align="left"/>
21980 <colspec colwidth="6*" align="center"/>
21981 <colspec colwidth="6*" align="center"/>
21982 <colspec colwidth="6*" align="right"/>
21983 <tbody>
21984 <row>
21985 <entry><option>acl_smtp_starttls</option></entry>
21986 <entry>Use: <emphasis>main</emphasis></entry>
21987 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
21988 <entry>Default: <emphasis>unset</emphasis></entry>
21989 </row>
21990 </tbody>
21991 </tgroup>
21992 </informaltable>
21993 <para>
21994 <indexterm role="concept">
21995 <primary>STARTTLS, ACL for</primary>
21996 </indexterm>
21997 This option defines the ACL that is run when an SMTP STARTTLS command is
21998 received. See chapter <xref linkend="CHAPACL"/> for further details.
21999 </para>
22000 <para>
22001 <indexterm role="option">
22002 <primary><option>acl_smtp_vrfy</option></primary>
22003 </indexterm>
22004 </para>
22005 <informaltable frame="all">
22006 <tgroup cols="4" colsep="0" rowsep="0">
22007 <colspec colwidth="8*" align="left"/>
22008 <colspec colwidth="6*" align="center"/>
22009 <colspec colwidth="6*" align="center"/>
22010 <colspec colwidth="6*" align="right"/>
22011 <tbody>
22012 <row>
22013 <entry><option>acl_smtp_vrfy</option></entry>
22014 <entry>Use: <emphasis>main</emphasis></entry>
22015 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
22016 <entry>Default: <emphasis>unset</emphasis></entry>
22017 </row>
22018 </tbody>
22019 </tgroup>
22020 </informaltable>
22021 <para>
22022 <indexterm role="concept">
22023 <primary>VRFY</primary>
22024 <secondary>ACL for</secondary>
22025 </indexterm>
22026 This option defines the ACL that is run when an SMTP VRFY command is
22027 received. See chapter <xref linkend="CHAPACL"/> for further details.
22028 </para>
22029 <para>
22030 <indexterm role="option">
22031 <primary><option>admin_groups</option></primary>
22032 </indexterm>
22033 </para>
22034 <informaltable frame="all">
22035 <tgroup cols="4" colsep="0" rowsep="0">
22036 <colspec colwidth="8*" align="left"/>
22037 <colspec colwidth="6*" align="center"/>
22038 <colspec colwidth="6*" align="center"/>
22039 <colspec colwidth="6*" align="right"/>
22040 <tbody>
22041 <row>
22042 <entry><option>admin_groups</option></entry>
22043 <entry>Use: <emphasis>main</emphasis></entry>
22044 <entry>Type: <emphasis>string list</emphasis>&dagger;<emphasis></emphasis></entry>
22045 <entry>Default: <emphasis>unset</emphasis></entry>
22046 </row>
22047 </tbody>
22048 </tgroup>
22049 </informaltable>
22050 <para>
22051 <indexterm role="concept">
22052 <primary>admin user</primary>
22053 </indexterm>
22054 This option is expanded just once, at the start of Exim&#x2019;s processing. If the
22055 current group or any of the supplementary groups of an Exim caller is in this
22056 colon-separated list, the caller has admin privileges. If all your system
22057 programmers are in a specific group, for example, you can give them all Exim
22058 admin privileges by putting that group in <option>admin_groups</option>. However, this does
22059 not permit them to read Exim&#x2019;s spool files (whose group owner is the Exim gid).
22060 To permit this, you have to add individuals to the Exim group.
22061 </para>
22062 <para>
22063 <indexterm role="option">
22064 <primary><option>allow_domain_literals</option></primary>
22065 </indexterm>
22066 </para>
22067 <informaltable frame="all">
22068 <tgroup cols="4" colsep="0" rowsep="0">
22069 <colspec colwidth="8*" align="left"/>
22070 <colspec colwidth="6*" align="center"/>
22071 <colspec colwidth="6*" align="center"/>
22072 <colspec colwidth="6*" align="right"/>
22073 <tbody>
22074 <row>
22075 <entry><option>allow_domain_literals</option></entry>
22076 <entry>Use: <emphasis>main</emphasis></entry>
22077 <entry>Type: <emphasis>boolean</emphasis></entry>
22078 <entry>Default: <emphasis>false</emphasis></entry>
22079 </row>
22080 </tbody>
22081 </tgroup>
22082 </informaltable>
22083 <para>
22084 <indexterm role="concept">
22085 <primary>domain literal</primary>
22086 </indexterm>
22087 If this option is set, the RFC 2822 domain literal format is permitted in
22088 email addresses. The option is not set by default, because the domain literal
22089 format is not normally required these days, and few people know about it. It
22090 has, however, been exploited by mail abusers.
22091 </para>
22092 <para>
22093 Unfortunately, it seems that some DNS black list maintainers are using this
22094 format to report black listing to postmasters. If you want to accept messages
22095 addressed to your hosts by IP address, you need to set
22096 <option>allow_domain_literals</option> true, and also to add <literal>@[]</literal> to the list of local
22097 domains (defined in the named domain list <option>local_domains</option> in the default
22098 configuration). This <quote>magic string</quote> matches the domain literal form of all
22099 the local host&#x2019;s IP addresses.
22100 </para>
22101 <para>
22102 <indexterm role="option">
22103 <primary><option>allow_mx_to_ip</option></primary>
22104 </indexterm>
22105 </para>
22106 <informaltable frame="all">
22107 <tgroup cols="4" colsep="0" rowsep="0">
22108 <colspec colwidth="8*" align="left"/>
22109 <colspec colwidth="6*" align="center"/>
22110 <colspec colwidth="6*" align="center"/>
22111 <colspec colwidth="6*" align="right"/>
22112 <tbody>
22113 <row>
22114 <entry><option>allow_mx_to_ip</option></entry>
22115 <entry>Use: <emphasis>main</emphasis></entry>
22116 <entry>Type: <emphasis>boolean</emphasis></entry>
22117 <entry>Default: <emphasis>false</emphasis></entry>
22118 </row>
22119 </tbody>
22120 </tgroup>
22121 </informaltable>
22122 <para>
22123 <indexterm role="concept">
22124 <primary>MX record</primary>
22125 <secondary>pointing to IP address</secondary>
22126 </indexterm>
22127 It appears that more and more DNS zone administrators are breaking the rules
22128 and putting domain names that look like IP addresses on the right hand side of
22129 MX records. Exim follows the rules and rejects this, giving an error message
22130 that explains the mis-configuration. However, some other MTAs support this
22131 practice, so to avoid <quote>Why can&#x2019;t Exim do this?</quote> complaints,
22132 <option>allow_mx_to_ip</option> exists, in order to enable this heinous activity. It is not
22133 recommended, except when you have no other choice.
22134 </para>
22135 <para>
22136 <indexterm role="option">
22137 <primary><option>allow_utf8_domains</option></primary>
22138 </indexterm>
22139 </para>
22140 <informaltable frame="all">
22141 <tgroup cols="4" colsep="0" rowsep="0">
22142 <colspec colwidth="8*" align="left"/>
22143 <colspec colwidth="6*" align="center"/>
22144 <colspec colwidth="6*" align="center"/>
22145 <colspec colwidth="6*" align="right"/>
22146 <tbody>
22147 <row>
22148 <entry><option>allow_utf8_domains</option></entry>
22149 <entry>Use: <emphasis>main</emphasis></entry>
22150 <entry>Type: <emphasis>boolean</emphasis></entry>
22151 <entry>Default: <emphasis>false</emphasis></entry>
22152 </row>
22153 </tbody>
22154 </tgroup>
22155 </informaltable>
22156 <para>
22157 <indexterm role="concept">
22158 <primary>domain</primary>
22159 <secondary>UTF-8 characters in</secondary>
22160 </indexterm>
22161 <indexterm role="concept">
22162 <primary>UTF-8</primary>
22163 <secondary>in domain name</secondary>
22164 </indexterm>
22165 Lots of discussion is going on about internationalized domain names. One
22166 camp is strongly in favour of just using UTF-8 characters, and it seems
22167 that at least two other MTAs permit this. This option allows Exim users to
22168 experiment if they wish.
22169 </para>
22170 <para>
22171 If it is set true, Exim&#x2019;s domain parsing function allows valid
22172 UTF-8 multicharacters to appear in domain name components, in addition to
22173 letters, digits, and hyphens. However, just setting this option is not
22174 enough; if you want to look up these domain names in the DNS, you must also
22175 adjust the value of <option>dns_check_names_pattern</option> to match the extended form. A
22176 suitable setting is:
22177 </para>
22178 <literallayout class="monospaced">
22179 dns_check_names_pattern = (?i)^(?&gt;(?(1)\.|())[a-z0-9\xc0-\xff]\
22180   (?&gt;[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
22181 </literallayout>
22182 <para>
22183 Alternatively, you can just disable this feature by setting
22184 </para>
22185 <literallayout class="monospaced">
22186 dns_check_names_pattern =
22187 </literallayout>
22188 <para>
22189 That is, set the option to an empty string so that no check is done.
22190 </para>
22191 <para>
22192 <indexterm role="option">
22193 <primary><option>auth_advertise_hosts</option></primary>
22194 </indexterm>
22195 </para>
22196 <informaltable frame="all">
22197 <tgroup cols="4" colsep="0" rowsep="0">
22198 <colspec colwidth="8*" align="left"/>
22199 <colspec colwidth="6*" align="center"/>
22200 <colspec colwidth="6*" align="center"/>
22201 <colspec colwidth="6*" align="right"/>
22202 <tbody>
22203 <row>
22204 <entry><option>auth_advertise_hosts</option></entry>
22205 <entry>Use: <emphasis>main</emphasis></entry>
22206 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
22207 <entry>Default: <emphasis>*</emphasis></entry>
22208 </row>
22209 </tbody>
22210 </tgroup>
22211 </informaltable>
22212 <para>
22213 <indexterm role="concept">
22214 <primary>authentication</primary>
22215 <secondary>advertising</secondary>
22216 </indexterm>
22217 <indexterm role="concept">
22218 <primary>AUTH</primary>
22219 <secondary>advertising</secondary>
22220 </indexterm>
22221 If any server authentication mechanisms are configured, Exim advertises them in
22222 response to an EHLO command only if the calling host matches this list.
22223 Otherwise, Exim does not advertise AUTH.
22224 Exim does not accept AUTH commands from clients to which it has not
22225 advertised the availability of AUTH. The advertising of individual
22226 authentication mechanisms can be controlled by the use of the
22227 <option>server_advertise_condition</option> generic authenticator option on the individual
22228 authenticators. See chapter <xref linkend="CHAPSMTPAUTH"/> for further details.
22229 </para>
22230 <para>
22231 Certain mail clients (for example, Netscape) require the user to provide a name
22232 and password for authentication if AUTH is advertised, even though it may
22233 not be needed (the host may accept messages from hosts on its local LAN without
22234 authentication, for example). The <option>auth_advertise_hosts</option> option can be used
22235 to make these clients more friendly by excluding them from the set of hosts to
22236 which Exim advertises AUTH.
22237 </para>
22238 <para>
22239 <indexterm role="concept">
22240 <primary>AUTH</primary>
22241 <secondary>advertising when encrypted</secondary>
22242 </indexterm>
22243 If you want to advertise the availability of AUTH only when the connection
22244 is encrypted using TLS, you can make use of the fact that the value of this
22245 option is expanded, with a setting like this:
22246 </para>
22247 <literallayout class="monospaced">
22248 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
22249 </literallayout>
22250 <para>
22251 <indexterm role="variable">
22252 <primary><varname>$tls_in_cipher</varname></primary>
22253 </indexterm>
22254 If <varname>$tls_in_cipher</varname> is empty, the session is not encrypted, and the result of
22255 the expansion is empty, thus matching no hosts. Otherwise, the result of the
22256 expansion is *, which matches all hosts.
22257 </para>
22258 <para>
22259 <indexterm role="option">
22260 <primary><option>auto_thaw</option></primary>
22261 </indexterm>
22262 </para>
22263 <informaltable frame="all">
22264 <tgroup cols="4" colsep="0" rowsep="0">
22265 <colspec colwidth="8*" align="left"/>
22266 <colspec colwidth="6*" align="center"/>
22267 <colspec colwidth="6*" align="center"/>
22268 <colspec colwidth="6*" align="right"/>
22269 <tbody>
22270 <row>
22271 <entry><option>auto_thaw</option></entry>
22272 <entry>Use: <emphasis>main</emphasis></entry>
22273 <entry>Type: <emphasis>time</emphasis></entry>
22274 <entry>Default: <emphasis>0s</emphasis></entry>
22275 </row>
22276 </tbody>
22277 </tgroup>
22278 </informaltable>
22279 <para>
22280 <indexterm role="concept">
22281 <primary>thawing messages</primary>
22282 </indexterm>
22283 <indexterm role="concept">
22284 <primary>unfreezing messages</primary>
22285 </indexterm>
22286 If this option is set to a time greater than zero, a queue runner will try a
22287 new delivery attempt on any frozen message, other than a bounce message, if
22288 this much time has passed since it was frozen. This may result in the message
22289 being re-frozen if nothing has changed since the last attempt. It is a way of
22290 saying <quote>keep on trying, even though there are big problems</quote>.
22291 </para>
22292 <para>
22293 <emphasis role="bold">Note</emphasis>: This is an old option, which predates <option>timeout_frozen_after</option> and
22294 <option>ignore_bounce_errors_after</option>. It is retained for compatibility, but it is not
22295 thought to be very useful any more, and its use should probably be avoided.
22296 </para>
22297 <para>
22298 <indexterm role="option">
22299 <primary><option>av_scanner</option></primary>
22300 </indexterm>
22301 </para>
22302 <informaltable frame="all">
22303 <tgroup cols="4" colsep="0" rowsep="0">
22304 <colspec colwidth="8*" align="left"/>
22305 <colspec colwidth="6*" align="center"/>
22306 <colspec colwidth="6*" align="center"/>
22307 <colspec colwidth="6*" align="right"/>
22308 <tbody>
22309 <row>
22310 <entry><option>av_scanner</option></entry>
22311 <entry>Use: <emphasis>main</emphasis></entry>
22312 <entry>Type: <emphasis>string</emphasis></entry>
22313 <entry>Default: <emphasis>see below</emphasis></entry>
22314 </row>
22315 </tbody>
22316 </tgroup>
22317 </informaltable>
22318 <para>
22319 This option is available if Exim is built with the content-scanning extension.
22320 It specifies which anti-virus scanner to use. The default value is:
22321 </para>
22322 <literallayout class="monospaced">
22323 sophie:/var/run/sophie
22324 </literallayout>
22325 <para>
22326 If the value of <option>av_scanner</option> starts with a dollar character, it is expanded
22327 before use. See section <xref linkend="SECTscanvirus"/> for further details.
22328 </para>
22329 <para>
22330 <indexterm role="option">
22331 <primary><option>bi_command</option></primary>
22332 </indexterm>
22333 </para>
22334 <informaltable frame="all">
22335 <tgroup cols="4" colsep="0" rowsep="0">
22336 <colspec colwidth="8*" align="left"/>
22337 <colspec colwidth="6*" align="center"/>
22338 <colspec colwidth="6*" align="center"/>
22339 <colspec colwidth="6*" align="right"/>
22340 <tbody>
22341 <row>
22342 <entry><option>bi_command</option></entry>
22343 <entry>Use: <emphasis>main</emphasis></entry>
22344 <entry>Type: <emphasis>string</emphasis></entry>
22345 <entry>Default: <emphasis>unset</emphasis></entry>
22346 </row>
22347 </tbody>
22348 </tgroup>
22349 </informaltable>
22350 <para>
22351 <indexterm role="option">
22352 <primary><option>-bi</option></primary>
22353 </indexterm>
22354 This option supplies the name of a command that is run when Exim is called with
22355 the <option>-bi</option> option (see chapter <xref linkend="CHAPcommandline"/>). The string value is
22356 just the command name, it is not a complete command line. If an argument is
22357 required, it must come from the <option>-oA</option> command line option.
22358 </para>
22359 <para>
22360 <indexterm role="option">
22361 <primary><option>bounce_message_file</option></primary>
22362 </indexterm>
22363 </para>
22364 <informaltable frame="all">
22365 <tgroup cols="4" colsep="0" rowsep="0">
22366 <colspec colwidth="8*" align="left"/>
22367 <colspec colwidth="6*" align="center"/>
22368 <colspec colwidth="6*" align="center"/>
22369 <colspec colwidth="6*" align="right"/>
22370 <tbody>
22371 <row>
22372 <entry><option>bounce_message_file</option></entry>
22373 <entry>Use: <emphasis>main</emphasis></entry>
22374 <entry>Type: <emphasis>string</emphasis></entry>
22375 <entry>Default: <emphasis>unset</emphasis></entry>
22376 </row>
22377 </tbody>
22378 </tgroup>
22379 </informaltable>
22380 <para>
22381 <indexterm role="concept">
22382 <primary>bounce message</primary>
22383 <secondary>customizing</secondary>
22384 </indexterm>
22385 <indexterm role="concept">
22386 <primary>customizing</primary>
22387 <secondary>bounce message</secondary>
22388 </indexterm>
22389 This option defines a template file containing paragraphs of text to be used
22390 for constructing bounce messages.  Details of the file&#x2019;s contents are given in
22391 chapter <xref linkend="CHAPemsgcust"/>. See also <option>warn_message_file</option>.
22392 </para>
22393 <para>
22394 <indexterm role="option">
22395 <primary><option>bounce_message_text</option></primary>
22396 </indexterm>
22397 </para>
22398 <informaltable frame="all">
22399 <tgroup cols="4" colsep="0" rowsep="0">
22400 <colspec colwidth="8*" align="left"/>
22401 <colspec colwidth="6*" align="center"/>
22402 <colspec colwidth="6*" align="center"/>
22403 <colspec colwidth="6*" align="right"/>
22404 <tbody>
22405 <row>
22406 <entry><option>bounce_message_text</option></entry>
22407 <entry>Use: <emphasis>main</emphasis></entry>
22408 <entry>Type: <emphasis>string</emphasis></entry>
22409 <entry>Default: <emphasis>unset</emphasis></entry>
22410 </row>
22411 </tbody>
22412 </tgroup>
22413 </informaltable>
22414 <para>
22415 When this option is set, its contents are included in the default bounce
22416 message immediately after <quote>This message was created automatically by mail
22417 delivery software.</quote> It is not used if <option>bounce_message_file</option> is set.
22418 </para>
22419 <para>
22420 <indexterm role="option">
22421 <primary><option>bounce_return_body</option></primary>
22422 </indexterm>
22423 </para>
22424 <informaltable frame="all">
22425 <tgroup cols="4" colsep="0" rowsep="0">
22426 <colspec colwidth="8*" align="left"/>
22427 <colspec colwidth="6*" align="center"/>
22428 <colspec colwidth="6*" align="center"/>
22429 <colspec colwidth="6*" align="right"/>
22430 <tbody>
22431 <row>
22432 <entry><option>bounce_return_body</option></entry>
22433 <entry>Use: <emphasis>main</emphasis></entry>
22434 <entry>Type: <emphasis>boolean</emphasis></entry>
22435 <entry>Default: <emphasis>true</emphasis></entry>
22436 </row>
22437 </tbody>
22438 </tgroup>
22439 </informaltable>
22440 <para>
22441 <indexterm role="concept">
22442 <primary>bounce message</primary>
22443 <secondary>including body</secondary>
22444 </indexterm>
22445 This option controls whether the body of an incoming message is included in a
22446 bounce message when <option>bounce_return_message</option> is true. The default setting
22447 causes the entire message, both header and body, to be returned (subject to the
22448 value of <option>bounce_return_size_limit</option>). If this option is false, only the
22449 message header is included. In the case of a non-SMTP message containing an
22450 error that is detected during reception, only those header lines preceding the
22451 point at which the error was detected are returned.
22452 <indexterm role="concept">
22453 <primary>bounce message</primary>
22454 <secondary>including original</secondary>
22455 </indexterm>
22456 </para>
22457 <para>
22458 <indexterm role="option">
22459 <primary><option>bounce_return_message</option></primary>
22460 </indexterm>
22461 </para>
22462 <informaltable frame="all">
22463 <tgroup cols="4" colsep="0" rowsep="0">
22464 <colspec colwidth="8*" align="left"/>
22465 <colspec colwidth="6*" align="center"/>
22466 <colspec colwidth="6*" align="center"/>
22467 <colspec colwidth="6*" align="right"/>
22468 <tbody>
22469 <row>
22470 <entry><option>bounce_return_message</option></entry>
22471 <entry>Use: <emphasis>main</emphasis></entry>
22472 <entry>Type: <emphasis>boolean</emphasis></entry>
22473 <entry>Default: <emphasis>true</emphasis></entry>
22474 </row>
22475 </tbody>
22476 </tgroup>
22477 </informaltable>
22478 <para>
22479 If this option is set false, none of the original message is included in
22480 bounce messages generated by Exim. See also <option>bounce_return_size_limit</option> and
22481 <option>bounce_return_body</option>.
22482 </para>
22483 <para>
22484 <indexterm role="option">
22485 <primary><option>bounce_return_size_limit</option></primary>
22486 </indexterm>
22487 </para>
22488 <informaltable frame="all">
22489 <tgroup cols="4" colsep="0" rowsep="0">
22490 <colspec colwidth="8*" align="left"/>
22491 <colspec colwidth="6*" align="center"/>
22492 <colspec colwidth="6*" align="center"/>
22493 <colspec colwidth="6*" align="right"/>
22494 <tbody>
22495 <row>
22496 <entry><option>bounce_return_size_limit</option></entry>
22497 <entry>Use: <emphasis>main</emphasis></entry>
22498 <entry>Type: <emphasis>integer</emphasis></entry>
22499 <entry>Default: <emphasis>100K</emphasis></entry>
22500 </row>
22501 </tbody>
22502 </tgroup>
22503 </informaltable>
22504 <para>
22505 <indexterm role="concept">
22506 <primary>size</primary>
22507 <secondary>of bounce, limit</secondary>
22508 </indexterm>
22509 <indexterm role="concept">
22510 <primary>bounce message</primary>
22511 <secondary>size limit</secondary>
22512 </indexterm>
22513 <indexterm role="concept">
22514 <primary>limit</primary>
22515 <secondary>bounce message size</secondary>
22516 </indexterm>
22517 This option sets a limit in bytes on the size of messages that are returned to
22518 senders as part of bounce messages when <option>bounce_return_message</option> is true. The
22519 limit should be less than the value of the global <option>message_size_limit</option> and of
22520 any <option>message_size_limit</option> settings on transports, to allow for the bounce text
22521 that Exim generates. If this option is set to zero there is no limit.
22522 </para>
22523 <para>
22524 When the body of any message that is to be included in a bounce message is
22525 greater than the limit, it is truncated, and a comment pointing this out is
22526 added at the top. The actual cutoff may be greater than the value given, owing
22527 to the use of buffering for transferring the message in chunks (typically 8K in
22528 size). The idea is to save bandwidth on those undeliverable 15-megabyte
22529 messages.
22530 </para>
22531 <para>
22532 <indexterm role="option">
22533 <primary><option>bounce_sender_authentication</option></primary>
22534 </indexterm>
22535 </para>
22536 <informaltable frame="all">
22537 <tgroup cols="4" colsep="0" rowsep="0">
22538 <colspec colwidth="8*" align="left"/>
22539 <colspec colwidth="6*" align="center"/>
22540 <colspec colwidth="6*" align="center"/>
22541 <colspec colwidth="6*" align="right"/>
22542 <tbody>
22543 <row>
22544 <entry><option>bounce_sender_authentication</option></entry>
22545 <entry>Use: <emphasis>main</emphasis></entry>
22546 <entry>Type: <emphasis>string</emphasis></entry>
22547 <entry>Default: <emphasis>unset</emphasis></entry>
22548 </row>
22549 </tbody>
22550 </tgroup>
22551 </informaltable>
22552 <para>
22553 <indexterm role="concept">
22554 <primary>bounce message</primary>
22555 <secondary>sender authentication</secondary>
22556 </indexterm>
22557 <indexterm role="concept">
22558 <primary>authentication</primary>
22559 <secondary>bounce message</secondary>
22560 </indexterm>
22561 <indexterm role="concept">
22562 <primary>AUTH</primary>
22563 <secondary>on bounce message</secondary>
22564 </indexterm>
22565 This option provides an authenticated sender address that is sent with any
22566 bounce messages generated by Exim that are sent over an authenticated SMTP
22567 connection. A typical setting might be:
22568 </para>
22569 <literallayout class="monospaced">
22570 bounce_sender_authentication = mailer-daemon@my.domain.example
22571 </literallayout>
22572 <para>
22573 which would cause bounce messages to be sent using the SMTP command:
22574 </para>
22575 <literallayout class="monospaced">
22576 MAIL FROM:&lt;&gt; AUTH=mailer-daemon@my.domain.example
22577 </literallayout>
22578 <para>
22579 The value of <option>bounce_sender_authentication</option> must always be a complete email
22580 address.
22581 </para>
22582 <para>
22583 <indexterm role="option">
22584 <primary><option>callout_domain_negative_expire</option></primary>
22585 </indexterm>
22586 </para>
22587 <informaltable frame="all">
22588 <tgroup cols="4" colsep="0" rowsep="0">
22589 <colspec colwidth="8*" align="left"/>
22590 <colspec colwidth="6*" align="center"/>
22591 <colspec colwidth="6*" align="center"/>
22592 <colspec colwidth="6*" align="right"/>
22593 <tbody>
22594 <row>
22595 <entry><option>callout_domain_negative_expire</option></entry>
22596 <entry>Use: <emphasis>main</emphasis></entry>
22597 <entry>Type: <emphasis>time</emphasis></entry>
22598 <entry>Default: <emphasis>3h</emphasis></entry>
22599 </row>
22600 </tbody>
22601 </tgroup>
22602 </informaltable>
22603 <para>
22604 <indexterm role="concept">
22605 <primary>caching</primary>
22606 <secondary>callout timeouts</secondary>
22607 </indexterm>
22608 <indexterm role="concept">
22609 <primary>callout</primary>
22610 <secondary>caching timeouts</secondary>
22611 </indexterm>
22612 This option specifies the expiry time for negative callout cache data for a
22613 domain. See section <xref linkend="SECTcallver"/> for details of callout verification, and
22614 section <xref linkend="SECTcallvercache"/> for details of the caching.
22615 </para>
22616 <para>
22617 <indexterm role="option">
22618 <primary><option>callout_domain_positive_expire</option></primary>
22619 </indexterm>
22620 </para>
22621 <informaltable frame="all">
22622 <tgroup cols="4" colsep="0" rowsep="0">
22623 <colspec colwidth="8*" align="left"/>
22624 <colspec colwidth="6*" align="center"/>
22625 <colspec colwidth="6*" align="center"/>
22626 <colspec colwidth="6*" align="right"/>
22627 <tbody>
22628 <row>
22629 <entry><option>callout_domain_positive_expire</option></entry>
22630 <entry>Use: <emphasis>main</emphasis></entry>
22631 <entry>Type: <emphasis>time</emphasis></entry>
22632 <entry>Default: <emphasis>7d</emphasis></entry>
22633 </row>
22634 </tbody>
22635 </tgroup>
22636 </informaltable>
22637 <para>
22638 This option specifies the expiry time for positive callout cache data for a
22639 domain. See section <xref linkend="SECTcallver"/> for details of callout verification, and
22640 section <xref linkend="SECTcallvercache"/> for details of the caching.
22641 </para>
22642 <para>
22643 <indexterm role="option">
22644 <primary><option>callout_negative_expire</option></primary>
22645 </indexterm>
22646 </para>
22647 <informaltable frame="all">
22648 <tgroup cols="4" colsep="0" rowsep="0">
22649 <colspec colwidth="8*" align="left"/>
22650 <colspec colwidth="6*" align="center"/>
22651 <colspec colwidth="6*" align="center"/>
22652 <colspec colwidth="6*" align="right"/>
22653 <tbody>
22654 <row>
22655 <entry><option>callout_negative_expire</option></entry>
22656 <entry>Use: <emphasis>main</emphasis></entry>
22657 <entry>Type: <emphasis>time</emphasis></entry>
22658 <entry>Default: <emphasis>2h</emphasis></entry>
22659 </row>
22660 </tbody>
22661 </tgroup>
22662 </informaltable>
22663 <para>
22664 This option specifies the expiry time for negative callout cache data for an
22665 address. See section <xref linkend="SECTcallver"/> for details of callout verification, and
22666 section <xref linkend="SECTcallvercache"/> for details of the caching.
22667 </para>
22668 <para>
22669 <indexterm role="option">
22670 <primary><option>callout_positive_expire</option></primary>
22671 </indexterm>
22672 </para>
22673 <informaltable frame="all">
22674 <tgroup cols="4" colsep="0" rowsep="0">
22675 <colspec colwidth="8*" align="left"/>
22676 <colspec colwidth="6*" align="center"/>
22677 <colspec colwidth="6*" align="center"/>
22678 <colspec colwidth="6*" align="right"/>
22679 <tbody>
22680 <row>
22681 <entry><option>callout_positive_expire</option></entry>
22682 <entry>Use: <emphasis>main</emphasis></entry>
22683 <entry>Type: <emphasis>time</emphasis></entry>
22684 <entry>Default: <emphasis>24h</emphasis></entry>
22685 </row>
22686 </tbody>
22687 </tgroup>
22688 </informaltable>
22689 <para>
22690 This option specifies the expiry time for positive callout cache data for an
22691 address. See section <xref linkend="SECTcallver"/> for details of callout verification, and
22692 section <xref linkend="SECTcallvercache"/> for details of the caching.
22693 </para>
22694 <para>
22695 <indexterm role="option">
22696 <primary><option>callout_random_local_part</option></primary>
22697 </indexterm>
22698 </para>
22699 <informaltable frame="all">
22700 <tgroup cols="4" colsep="0" rowsep="0">
22701 <colspec colwidth="8*" align="left"/>
22702 <colspec colwidth="6*" align="center"/>
22703 <colspec colwidth="6*" align="center"/>
22704 <colspec colwidth="6*" align="right"/>
22705 <tbody>
22706 <row>
22707 <entry><option>callout_random_local_part</option></entry>
22708 <entry>Use: <emphasis>main</emphasis></entry>
22709 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
22710 <entry>Default: <emphasis>see below</emphasis></entry>
22711 </row>
22712 </tbody>
22713 </tgroup>
22714 </informaltable>
22715 <para>
22716 This option defines the <quote>random</quote> local part that can be used as part of
22717 callout verification. The default value is
22718 </para>
22719 <literallayout class="monospaced">
22720 $primary_hostname-$tod_epoch-testing
22721 </literallayout>
22722 <para>
22723 See section <xref linkend="CALLaddparcall"/> for details of how this value is used.
22724 </para>
22725 <para>
22726 <indexterm role="option">
22727 <primary><option>check_log_inodes</option></primary>
22728 </indexterm>
22729 </para>
22730 <informaltable frame="all">
22731 <tgroup cols="4" colsep="0" rowsep="0">
22732 <colspec colwidth="8*" align="left"/>
22733 <colspec colwidth="6*" align="center"/>
22734 <colspec colwidth="6*" align="center"/>
22735 <colspec colwidth="6*" align="right"/>
22736 <tbody>
22737 <row>
22738 <entry><option>check_log_inodes</option></entry>
22739 <entry>Use: <emphasis>main</emphasis></entry>
22740 <entry>Type: <emphasis>integer</emphasis></entry>
22741 <entry>Default: <emphasis>0</emphasis></entry>
22742 </row>
22743 </tbody>
22744 </tgroup>
22745 </informaltable>
22746 <para>
22747 See <option>check_spool_space</option> below.
22748 </para>
22749 <para>
22750 <indexterm role="option">
22751 <primary><option>check_log_space</option></primary>
22752 </indexterm>
22753 </para>
22754 <informaltable frame="all">
22755 <tgroup cols="4" colsep="0" rowsep="0">
22756 <colspec colwidth="8*" align="left"/>
22757 <colspec colwidth="6*" align="center"/>
22758 <colspec colwidth="6*" align="center"/>
22759 <colspec colwidth="6*" align="right"/>
22760 <tbody>
22761 <row>
22762 <entry><option>check_log_space</option></entry>
22763 <entry>Use: <emphasis>main</emphasis></entry>
22764 <entry>Type: <emphasis>integer</emphasis></entry>
22765 <entry>Default: <emphasis>0</emphasis></entry>
22766 </row>
22767 </tbody>
22768 </tgroup>
22769 </informaltable>
22770 <para>
22771 See <option>check_spool_space</option> below.
22772 </para>
22773 <para>
22774 <indexterm role="option">
22775 <primary><option>check_rfc2047_length</option></primary>
22776 </indexterm>
22777 <indexterm role="concept">
22778 <primary>RFC 2047</primary>
22779 <secondary>disabling length check</secondary>
22780 </indexterm>
22781 <indexterm role="option">
22782 <primary><option>check_rfc2047_length</option></primary>
22783 </indexterm>
22784 </para>
22785 <informaltable frame="all">
22786 <tgroup cols="4" colsep="0" rowsep="0">
22787 <colspec colwidth="8*" align="left"/>
22788 <colspec colwidth="6*" align="center"/>
22789 <colspec colwidth="6*" align="center"/>
22790 <colspec colwidth="6*" align="right"/>
22791 <tbody>
22792 <row>
22793 <entry><option>check_rfc2047_length</option></entry>
22794 <entry>Use: <emphasis>main</emphasis></entry>
22795 <entry>Type: <emphasis>boolean</emphasis></entry>
22796 <entry>Default: <emphasis>true</emphasis></entry>
22797 </row>
22798 </tbody>
22799 </tgroup>
22800 </informaltable>
22801 <para>
22802 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
22803 system of <quote>encoded words</quote>. The RFC specifies a maximum length for an encoded
22804 word; strings to be encoded that exceed this length are supposed to use
22805 multiple encoded words. By default, Exim does not recognize encoded words that
22806 exceed the maximum length. However, it seems that some software, in violation
22807 of the RFC, generates overlong encoded words. If <option>check_rfc2047_length</option> is
22808 set false, Exim recognizes encoded words of any length.
22809 </para>
22810 <para>
22811 <indexterm role="option">
22812 <primary><option>check_spool_inodes</option></primary>
22813 </indexterm>
22814 </para>
22815 <informaltable frame="all">
22816 <tgroup cols="4" colsep="0" rowsep="0">
22817 <colspec colwidth="8*" align="left"/>
22818 <colspec colwidth="6*" align="center"/>
22819 <colspec colwidth="6*" align="center"/>
22820 <colspec colwidth="6*" align="right"/>
22821 <tbody>
22822 <row>
22823 <entry><option>check_spool_inodes</option></entry>
22824 <entry>Use: <emphasis>main</emphasis></entry>
22825 <entry>Type: <emphasis>integer</emphasis></entry>
22826 <entry>Default: <emphasis>0</emphasis></entry>
22827 </row>
22828 </tbody>
22829 </tgroup>
22830 </informaltable>
22831 <para>
22832 See <option>check_spool_space</option> below.
22833 </para>
22834 <para>
22835 <indexterm role="option">
22836 <primary><option>check_spool_space</option></primary>
22837 </indexterm>
22838 </para>
22839 <informaltable frame="all">
22840 <tgroup cols="4" colsep="0" rowsep="0">
22841 <colspec colwidth="8*" align="left"/>
22842 <colspec colwidth="6*" align="center"/>
22843 <colspec colwidth="6*" align="center"/>
22844 <colspec colwidth="6*" align="right"/>
22845 <tbody>
22846 <row>
22847 <entry><option>check_spool_space</option></entry>
22848 <entry>Use: <emphasis>main</emphasis></entry>
22849 <entry>Type: <emphasis>integer</emphasis></entry>
22850 <entry>Default: <emphasis>0</emphasis></entry>
22851 </row>
22852 </tbody>
22853 </tgroup>
22854 </informaltable>
22855 <para>
22856 <indexterm role="concept">
22857 <primary>checking disk space</primary>
22858 </indexterm>
22859 <indexterm role="concept">
22860 <primary>disk space, checking</primary>
22861 </indexterm>
22862 <indexterm role="concept">
22863 <primary>spool directory</primary>
22864 <secondary>checking space</secondary>
22865 </indexterm>
22866 The four <option>check_...</option> options allow for checking of disk resources before a
22867 message is accepted.
22868 </para>
22869 <para>
22870 <indexterm role="variable">
22871 <primary><varname>$log_inodes</varname></primary>
22872 </indexterm>
22873 <indexterm role="variable">
22874 <primary><varname>$log_space</varname></primary>
22875 </indexterm>
22876 <indexterm role="variable">
22877 <primary><varname>$spool_inodes</varname></primary>
22878 </indexterm>
22879 <indexterm role="variable">
22880 <primary><varname>$spool_space</varname></primary>
22881 </indexterm>
22882 When any of these options are set, they apply to all incoming messages. If you
22883 want to apply different checks to different kinds of message, you can do so by
22884 testing the variables <varname>$log_inodes</varname>, <varname>$log_space</varname>, <varname>$spool_inodes</varname>, and
22885 <varname>$spool_space</varname> in an ACL with appropriate additional conditions.
22886 </para>
22887 <para>
22888 <option>check_spool_space</option> and <option>check_spool_inodes</option> check the spool partition if
22889 either value is greater than zero, for example:
22890 </para>
22891 <literallayout class="monospaced">
22892 check_spool_space = 10M
22893 check_spool_inodes = 100
22894 </literallayout>
22895 <para>
22896 The spool partition is the one that contains the directory defined by
22897 SPOOL_DIRECTORY in <filename>Local/Makefile</filename>. It is used for holding messages in
22898 transit.
22899 </para>
22900 <para>
22901 <option>check_log_space</option> and <option>check_log_inodes</option>  check the partition in which log
22902 files are written if either is greater than zero. These should be set only if
22903 <option>log_file_path</option> and <option>spool_directory</option> refer to different partitions.
22904 </para>
22905 <para>
22906 If there is less space or fewer inodes than requested, Exim refuses to accept
22907 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
22908 error response to the MAIL command. If ESMTP is in use and there was a
22909 SIZE parameter on the MAIL command, its value is added to the
22910 <option>check_spool_space</option> value, and the check is performed even if
22911 <option>check_spool_space</option> is zero, unless <option>no_smtp_check_spool_space</option> is set.
22912 </para>
22913 <para>
22914 The values for <option>check_spool_space</option> and <option>check_log_space</option> are held as a
22915 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
22916 </para>
22917 <para>
22918 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
22919 failure a message is written to stderr and Exim exits with a non-zero code, as
22920 it obviously cannot send an error message of any kind.
22921 </para>
22922 <para>
22923 <indexterm role="option">
22924 <primary><option>daemon_smtp_ports</option></primary>
22925 </indexterm>
22926 </para>
22927 <informaltable frame="all">
22928 <tgroup cols="4" colsep="0" rowsep="0">
22929 <colspec colwidth="8*" align="left"/>
22930 <colspec colwidth="6*" align="center"/>
22931 <colspec colwidth="6*" align="center"/>
22932 <colspec colwidth="6*" align="right"/>
22933 <tbody>
22934 <row>
22935 <entry><option>daemon_smtp_ports</option></entry>
22936 <entry>Use: <emphasis>main</emphasis></entry>
22937 <entry>Type: <emphasis>string</emphasis></entry>
22938 <entry>Default: <emphasis><literal>smtp</literal></emphasis></entry>
22939 </row>
22940 </tbody>
22941 </tgroup>
22942 </informaltable>
22943 <para>
22944 <indexterm role="concept">
22945 <primary>port</primary>
22946 <secondary>for daemon</secondary>
22947 </indexterm>
22948 <indexterm role="concept">
22949 <primary>TCP/IP</primary>
22950 <secondary>setting listening ports</secondary>
22951 </indexterm>
22952 This option specifies one or more default SMTP ports on which the Exim daemon
22953 listens. See chapter <xref linkend="CHAPinterfaces"/> for details of how it is used. For
22954 backward compatibility, <option>daemon_smtp_port</option> (singular) is a synonym.
22955 </para>
22956 <para>
22957 <indexterm role="option">
22958 <primary><option>daemon_startup_retries</option></primary>
22959 </indexterm>
22960 </para>
22961 <informaltable frame="all">
22962 <tgroup cols="4" colsep="0" rowsep="0">
22963 <colspec colwidth="8*" align="left"/>
22964 <colspec colwidth="6*" align="center"/>
22965 <colspec colwidth="6*" align="center"/>
22966 <colspec colwidth="6*" align="right"/>
22967 <tbody>
22968 <row>
22969 <entry><option>daemon_startup_retries</option></entry>
22970 <entry>Use: <emphasis>main</emphasis></entry>
22971 <entry>Type: <emphasis>integer</emphasis></entry>
22972 <entry>Default: <emphasis>9</emphasis></entry>
22973 </row>
22974 </tbody>
22975 </tgroup>
22976 </informaltable>
22977 <para>
22978 <indexterm role="concept">
22979 <primary>daemon startup, retrying</primary>
22980 </indexterm>
22981 This option, along with <option>daemon_startup_sleep</option>, controls the retrying done by
22982 the daemon at startup when it cannot immediately bind a listening socket
22983 (typically because the socket is already in use): <option>daemon_startup_retries</option>
22984 defines the number of retries after the first failure, and
22985 <option>daemon_startup_sleep</option> defines the length of time to wait between retries.
22986 </para>
22987 <para>
22988 <indexterm role="option">
22989 <primary><option>daemon_startup_sleep</option></primary>
22990 </indexterm>
22991 </para>
22992 <informaltable frame="all">
22993 <tgroup cols="4" colsep="0" rowsep="0">
22994 <colspec colwidth="8*" align="left"/>
22995 <colspec colwidth="6*" align="center"/>
22996 <colspec colwidth="6*" align="center"/>
22997 <colspec colwidth="6*" align="right"/>
22998 <tbody>
22999 <row>
23000 <entry><option>daemon_startup_sleep</option></entry>
23001 <entry>Use: <emphasis>main</emphasis></entry>
23002 <entry>Type: <emphasis>time</emphasis></entry>
23003 <entry>Default: <emphasis>30s</emphasis></entry>
23004 </row>
23005 </tbody>
23006 </tgroup>
23007 </informaltable>
23008 <para>
23009 See <option>daemon_startup_retries</option>.
23010 </para>
23011 <para>
23012 <indexterm role="option">
23013 <primary><option>delay_warning</option></primary>
23014 </indexterm>
23015 </para>
23016 <informaltable frame="all">
23017 <tgroup cols="4" colsep="0" rowsep="0">
23018 <colspec colwidth="8*" align="left"/>
23019 <colspec colwidth="6*" align="center"/>
23020 <colspec colwidth="6*" align="center"/>
23021 <colspec colwidth="6*" align="right"/>
23022 <tbody>
23023 <row>
23024 <entry><option>delay_warning</option></entry>
23025 <entry>Use: <emphasis>main</emphasis></entry>
23026 <entry>Type: <emphasis>time list</emphasis></entry>
23027 <entry>Default: <emphasis>24h</emphasis></entry>
23028 </row>
23029 </tbody>
23030 </tgroup>
23031 </informaltable>
23032 <para>
23033 <indexterm role="concept">
23034 <primary>warning of delay</primary>
23035 </indexterm>
23036 <indexterm role="concept">
23037 <primary>delay warning, specifying</primary>
23038 </indexterm>
23039 When a message is delayed, Exim sends a warning message to the sender at
23040 intervals specified by this option. The data is a colon-separated list of times
23041 after which to send warning messages. If the value of the option is an empty
23042 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
23043 message has been on the queue for longer than the last time, the last interval
23044 between the times is used to compute subsequent warning times. For example,
23045 with
23046 </para>
23047 <literallayout class="monospaced">
23048 delay_warning = 4h:8h:24h
23049 </literallayout>
23050 <para>
23051 the first message is sent after 4 hours, the second after 8 hours, and
23052 the third one after 24 hours. After that, messages are sent every 16 hours,
23053 because that is the interval between the last two times on the list. If you set
23054 just one time, it specifies the repeat interval. For example, with:
23055 </para>
23056 <literallayout class="monospaced">
23057 delay_warning = 6h
23058 </literallayout>
23059 <para>
23060 messages are repeated every six hours. To stop warnings after a given time, set
23061 a very large time at the end of the list. For example:
23062 </para>
23063 <literallayout class="monospaced">
23064 delay_warning = 2h:12h:99d
23065 </literallayout>
23066 <para>
23067 Note that the option is only evaluated at the time a delivery attempt fails,
23068 which depends on retry and queue-runner configuration.
23069 Typically retries will be configured more frequently than warning messages.
23070 </para>
23071 <para>
23072 <indexterm role="option">
23073 <primary><option>delay_warning_condition</option></primary>
23074 </indexterm>
23075 </para>
23076 <informaltable frame="all">
23077 <tgroup cols="4" colsep="0" rowsep="0">
23078 <colspec colwidth="8*" align="left"/>
23079 <colspec colwidth="6*" align="center"/>
23080 <colspec colwidth="6*" align="center"/>
23081 <colspec colwidth="6*" align="right"/>
23082 <tbody>
23083 <row>
23084 <entry><option>delay_warning_condition</option></entry>
23085 <entry>Use: <emphasis>main</emphasis></entry>
23086 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
23087 <entry>Default: <emphasis>see below</emphasis></entry>
23088 </row>
23089 </tbody>
23090 </tgroup>
23091 </informaltable>
23092 <para>
23093 <indexterm role="variable">
23094 <primary><varname>$domain</varname></primary>
23095 </indexterm>
23096 The string is expanded at the time a warning message might be sent. If all the
23097 deferred addresses have the same domain, it is set in <varname>$domain</varname> during the
23098 expansion. Otherwise <varname>$domain</varname> is empty. If the result of the expansion is a
23099 forced failure, an empty string, or a string matching any of <quote>0</quote>, <quote>no</quote> or
23100 <quote>false</quote> (the comparison being done caselessly) then the warning message is
23101 not sent. The default is:
23102 </para>
23103 <literallayout class="monospaced">
23104 delay_warning_condition = ${if or {\
23105   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
23106   { match{$h_precedence:}{(?i)bulk|list|junk} }\
23107   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
23108   } {no}{yes}}
23109 </literallayout>
23110 <para>
23111 This suppresses the sending of warnings for messages that contain <emphasis>List-ID:</emphasis>,
23112 <emphasis>List-Post:</emphasis>, or <emphasis>List-Subscribe:</emphasis> headers, or have <quote>bulk</quote>, <quote>list</quote> or
23113 <quote>junk</quote> in a <emphasis>Precedence:</emphasis> header, or have <quote>auto-generated</quote> or
23114 <quote>auto-replied</quote> in an <emphasis>Auto-Submitted:</emphasis> header.
23115 </para>
23116 <para>
23117 <indexterm role="option">
23118 <primary><option>deliver_drop_privilege</option></primary>
23119 </indexterm>
23120 </para>
23121 <informaltable frame="all">
23122 <tgroup cols="4" colsep="0" rowsep="0">
23123 <colspec colwidth="8*" align="left"/>
23124 <colspec colwidth="6*" align="center"/>
23125 <colspec colwidth="6*" align="center"/>
23126 <colspec colwidth="6*" align="right"/>
23127 <tbody>
23128 <row>
23129 <entry><option>deliver_drop_privilege</option></entry>
23130 <entry>Use: <emphasis>main</emphasis></entry>
23131 <entry>Type: <emphasis>boolean</emphasis></entry>
23132 <entry>Default: <emphasis>false</emphasis></entry>
23133 </row>
23134 </tbody>
23135 </tgroup>
23136 </informaltable>
23137 <para>
23138 <indexterm role="concept">
23139 <primary>unprivileged delivery</primary>
23140 </indexterm>
23141 <indexterm role="concept">
23142 <primary>delivery</primary>
23143 <secondary>unprivileged</secondary>
23144 </indexterm>
23145 If this option is set true, Exim drops its root privilege at the start of a
23146 delivery process, and runs as the Exim user throughout. This severely restricts
23147 the kinds of local delivery that are possible, but is viable in certain types
23148 of configuration. There is a discussion about the use of root privilege in
23149 chapter <xref linkend="CHAPsecurity"/>.
23150 </para>
23151 <para>
23152 <indexterm role="option">
23153 <primary><option>deliver_queue_load_max</option></primary>
23154 </indexterm>
23155 </para>
23156 <informaltable frame="all">
23157 <tgroup cols="4" colsep="0" rowsep="0">
23158 <colspec colwidth="8*" align="left"/>
23159 <colspec colwidth="6*" align="center"/>
23160 <colspec colwidth="6*" align="center"/>
23161 <colspec colwidth="6*" align="right"/>
23162 <tbody>
23163 <row>
23164 <entry><option>deliver_queue_load_max</option></entry>
23165 <entry>Use: <emphasis>main</emphasis></entry>
23166 <entry>Type: <emphasis>fixed-point</emphasis></entry>
23167 <entry>Default: <emphasis>unset</emphasis></entry>
23168 </row>
23169 </tbody>
23170 </tgroup>
23171 </informaltable>
23172 <para>
23173 <indexterm role="concept">
23174 <primary>load average</primary>
23175 </indexterm>
23176 <indexterm role="concept">
23177 <primary>queue runner</primary>
23178 <secondary>abandoning</secondary>
23179 </indexterm>
23180 When this option is set, a queue run is abandoned if the system load average
23181 becomes greater than the value of the option. The option has no effect on
23182 ancient operating systems on which Exim cannot determine the load average.
23183 See also <option>queue_only_load</option> and <option>smtp_load_reserve</option>.
23184 </para>
23185 <para>
23186 <indexterm role="option">
23187 <primary><option>delivery_date_remove</option></primary>
23188 </indexterm>
23189 </para>
23190 <informaltable frame="all">
23191 <tgroup cols="4" colsep="0" rowsep="0">
23192 <colspec colwidth="8*" align="left"/>
23193 <colspec colwidth="6*" align="center"/>
23194 <colspec colwidth="6*" align="center"/>
23195 <colspec colwidth="6*" align="right"/>
23196 <tbody>
23197 <row>
23198 <entry><option>delivery_date_remove</option></entry>
23199 <entry>Use: <emphasis>main</emphasis></entry>
23200 <entry>Type: <emphasis>boolean</emphasis></entry>
23201 <entry>Default: <emphasis>true</emphasis></entry>
23202 </row>
23203 </tbody>
23204 </tgroup>
23205 </informaltable>
23206 <para>
23207 <indexterm role="concept">
23208 <primary><emphasis>Delivery-date:</emphasis> header line</primary>
23209 </indexterm>
23210 Exim&#x2019;s transports have an option for adding a <emphasis>Delivery-date:</emphasis> header to a
23211 message when it is delivered, in exactly the same way as <emphasis>Return-path:</emphasis> is
23212 handled. <emphasis>Delivery-date:</emphasis> records the actual time of delivery. Such headers
23213 should not be present in incoming messages, and this option causes them to be
23214 removed at the time the message is received, to avoid any problems that might
23215 occur when a delivered message is subsequently sent on to some other recipient.
23216 </para>
23217 <para>
23218 <indexterm role="option">
23219 <primary><option>disable_fsync</option></primary>
23220 </indexterm>
23221 </para>
23222 <informaltable frame="all">
23223 <tgroup cols="4" colsep="0" rowsep="0">
23224 <colspec colwidth="8*" align="left"/>
23225 <colspec colwidth="6*" align="center"/>
23226 <colspec colwidth="6*" align="center"/>
23227 <colspec colwidth="6*" align="right"/>
23228 <tbody>
23229 <row>
23230 <entry><option>disable_fsync</option></entry>
23231 <entry>Use: <emphasis>main</emphasis></entry>
23232 <entry>Type: <emphasis>boolean</emphasis></entry>
23233 <entry>Default: <emphasis>false</emphasis></entry>
23234 </row>
23235 </tbody>
23236 </tgroup>
23237 </informaltable>
23238 <para>
23239 <indexterm role="concept">
23240 <primary><function>fsync()</function>, disabling</primary>
23241 </indexterm>
23242 This option is available only if Exim was built with the compile-time option
23243 ENABLE_DISABLE_FSYNC. When this is not set, a reference to <option>disable_fsync</option> in
23244 a runtime configuration generates an <quote>unknown option</quote> error. You should not
23245 build Exim with ENABLE_DISABLE_FSYNC or set <option>disable_fsync</option> unless you
23246 really, really, really understand what you are doing. <emphasis>No pre-compiled
23247 distributions of Exim should ever make this option available.</emphasis>
23248 </para>
23249 <para>
23250 When <option>disable_fsync</option> is set true, Exim no longer calls <function>fsync()</function> to force
23251 updated files&#x2019; data to be written to disc before continuing. Unexpected events
23252 such as crashes and power outages may cause data to be lost or scrambled.
23253 Here be Dragons. <emphasis role="bold">Beware.</emphasis>
23254 </para>
23255 <para>
23256 <indexterm role="option">
23257 <primary><option>disable_ipv6</option></primary>
23258 </indexterm>
23259 </para>
23260 <informaltable frame="all">
23261 <tgroup cols="4" colsep="0" rowsep="0">
23262 <colspec colwidth="8*" align="left"/>
23263 <colspec colwidth="6*" align="center"/>
23264 <colspec colwidth="6*" align="center"/>
23265 <colspec colwidth="6*" align="right"/>
23266 <tbody>
23267 <row>
23268 <entry><option>disable_ipv6</option></entry>
23269 <entry>Use: <emphasis>main</emphasis></entry>
23270 <entry>Type: <emphasis>boolean</emphasis></entry>
23271 <entry>Default: <emphasis>false</emphasis></entry>
23272 </row>
23273 </tbody>
23274 </tgroup>
23275 </informaltable>
23276 <para>
23277 <indexterm role="concept">
23278 <primary>IPv6</primary>
23279 <secondary>disabling</secondary>
23280 </indexterm>
23281 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
23282 activities take place. AAAA records are never looked up, and any IPv6 addresses
23283 that are listed in <option>local_interfaces</option>, data for the <option>manualroute</option> router,
23284 etc. are ignored. If IP literals are enabled, the <command>ipliteral</command> router declines
23285 to handle IPv6 literal addresses.
23286 </para>
23287 <para>
23288 <indexterm role="option">
23289 <primary><option>dns_again_means_nonexist</option></primary>
23290 </indexterm>
23291 </para>
23292 <informaltable frame="all">
23293 <tgroup cols="4" colsep="0" rowsep="0">
23294 <colspec colwidth="8*" align="left"/>
23295 <colspec colwidth="6*" align="center"/>
23296 <colspec colwidth="6*" align="center"/>
23297 <colspec colwidth="6*" align="right"/>
23298 <tbody>
23299 <row>
23300 <entry><option>dns_again_means_nonexist</option></entry>
23301 <entry>Use: <emphasis>main</emphasis></entry>
23302 <entry>Type: <emphasis>domain list</emphasis>&dagger;<emphasis></emphasis></entry>
23303 <entry>Default: <emphasis>unset</emphasis></entry>
23304 </row>
23305 </tbody>
23306 </tgroup>
23307 </informaltable>
23308 <para>
23309 <indexterm role="concept">
23310 <primary>DNS</primary>
23311 <secondary><quote>try again</quote> response; overriding</secondary>
23312 </indexterm>
23313 DNS lookups give a <quote>try again</quote> response for the DNS errors
23314 <quote>non-authoritative host not found</quote> and <quote>SERVERFAIL</quote>. This can cause Exim to
23315 keep trying to deliver a message, or to give repeated temporary errors to
23316 incoming mail. Sometimes the effect is caused by a badly set up name server and
23317 may persist for a long time. If a domain which exhibits this problem matches
23318 anything in <option>dns_again_means_nonexist</option>, it is treated as if it did not exist.
23319 This option should be used with care. You can make it apply to reverse lookups
23320 by a setting such as this:
23321 </para>
23322 <literallayout class="monospaced">
23323 dns_again_means_nonexist = *.in-addr.arpa
23324 </literallayout>
23325 <para>
23326 This option applies to all DNS lookups that Exim does. It also applies when the
23327 <function>gethostbyname()</function> or <function>getipnodebyname()</function> functions give temporary errors,
23328 since these are most likely to be caused by DNS lookup problems. The
23329 <command>dnslookup</command> router has some options of its own for controlling what happens
23330 when lookups for MX or SRV records give temporary errors. These more specific
23331 options are applied after this global option.
23332 </para>
23333 <para>
23334 <indexterm role="option">
23335 <primary><option>dns_check_names_pattern</option></primary>
23336 </indexterm>
23337 </para>
23338 <informaltable frame="all">
23339 <tgroup cols="4" colsep="0" rowsep="0">
23340 <colspec colwidth="8*" align="left"/>
23341 <colspec colwidth="6*" align="center"/>
23342 <colspec colwidth="6*" align="center"/>
23343 <colspec colwidth="6*" align="right"/>
23344 <tbody>
23345 <row>
23346 <entry><option>dns_check_names_pattern</option></entry>
23347 <entry>Use: <emphasis>main</emphasis></entry>
23348 <entry>Type: <emphasis>string</emphasis></entry>
23349 <entry>Default: <emphasis>see below</emphasis></entry>
23350 </row>
23351 </tbody>
23352 </tgroup>
23353 </informaltable>
23354 <para>
23355 <indexterm role="concept">
23356 <primary>DNS</primary>
23357 <secondary>pre-check of name syntax</secondary>
23358 </indexterm>
23359 When this option is set to a non-empty string, it causes Exim to check domain
23360 names for characters that are not allowed in host names before handing them to
23361 the DNS resolver, because some resolvers give temporary errors for names that
23362 contain unusual characters. If a domain name contains any unwanted characters,
23363 a <quote>not found</quote> result is forced, and the resolver is not called. The check is
23364 done by matching the domain name against a regular expression, which is the
23365 value of this option. The default pattern is
23366 </para>
23367 <literallayout class="monospaced">
23368 dns_check_names_pattern = \
23369   (?i)^(?&gt;(?(1)\.|())[^\W_](?&gt;[a-z0-9/-]*[^\W_])?)+$
23370 </literallayout>
23371 <para>
23372 which permits only letters, digits, slashes, and hyphens in components, but
23373 they must start and end with a letter or digit. Slashes are not, in fact,
23374 permitted in host names, but they are found in certain NS records (which can be
23375 accessed in Exim by using a <option>dnsdb</option> lookup). If you set
23376 <option>allow_utf8_domains</option>, you must modify this pattern, or set the option to an
23377 empty string.
23378 </para>
23379 <para>
23380 <indexterm role="option">
23381 <primary><option>dns_csa_search_limit</option></primary>
23382 </indexterm>
23383 </para>
23384 <informaltable frame="all">
23385 <tgroup cols="4" colsep="0" rowsep="0">
23386 <colspec colwidth="8*" align="left"/>
23387 <colspec colwidth="6*" align="center"/>
23388 <colspec colwidth="6*" align="center"/>
23389 <colspec colwidth="6*" align="right"/>
23390 <tbody>
23391 <row>
23392 <entry><option>dns_csa_search_limit</option></entry>
23393 <entry>Use: <emphasis>main</emphasis></entry>
23394 <entry>Type: <emphasis>integer</emphasis></entry>
23395 <entry>Default: <emphasis>5</emphasis></entry>
23396 </row>
23397 </tbody>
23398 </tgroup>
23399 </informaltable>
23400 <para>
23401 This option controls the depth of parental searching for CSA SRV records in the
23402 DNS, as described in more detail in section <xref linkend="SECTverifyCSA"/>.
23403 </para>
23404 <para>
23405 <indexterm role="option">
23406 <primary><option>dns_csa_use_reverse</option></primary>
23407 </indexterm>
23408 </para>
23409 <informaltable frame="all">
23410 <tgroup cols="4" colsep="0" rowsep="0">
23411 <colspec colwidth="8*" align="left"/>
23412 <colspec colwidth="6*" align="center"/>
23413 <colspec colwidth="6*" align="center"/>
23414 <colspec colwidth="6*" align="right"/>
23415 <tbody>
23416 <row>
23417 <entry><option>dns_csa_use_reverse</option></entry>
23418 <entry>Use: <emphasis>main</emphasis></entry>
23419 <entry>Type: <emphasis>boolean</emphasis></entry>
23420 <entry>Default: <emphasis>true</emphasis></entry>
23421 </row>
23422 </tbody>
23423 </tgroup>
23424 </informaltable>
23425 <para>
23426 This option controls whether or not an IP address, given as a CSA domain, is
23427 reversed and looked up in the reverse DNS, as described in more detail in
23428 section <xref linkend="SECTverifyCSA"/>.
23429 </para>
23430 <para>
23431 <indexterm role="option">
23432 <primary><option>dns_dnssec_ok</option></primary>
23433 </indexterm>
23434 </para>
23435 <informaltable frame="all">
23436 <tgroup cols="4" colsep="0" rowsep="0">
23437 <colspec colwidth="8*" align="left"/>
23438 <colspec colwidth="6*" align="center"/>
23439 <colspec colwidth="6*" align="center"/>
23440 <colspec colwidth="6*" align="right"/>
23441 <tbody>
23442 <row>
23443 <entry><option>dns_dnssec_ok</option></entry>
23444 <entry>Use: <emphasis>main</emphasis></entry>
23445 <entry>Type: <emphasis>integer</emphasis></entry>
23446 <entry>Default: <emphasis>-1</emphasis></entry>
23447 </row>
23448 </tbody>
23449 </tgroup>
23450 </informaltable>
23451 <para>
23452 <indexterm role="concept">
23453 <primary>DNS</primary>
23454 <secondary>resolver options</secondary>
23455 </indexterm>
23456 <indexterm role="concept">
23457 <primary>DNS</primary>
23458 <secondary>DNSSEC</secondary>
23459 </indexterm>
23460 If this option is set to a non-negative number then Exim will initialise the
23461 DNS resolver library to either use or not use DNSSEC, overriding the system
23462 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
23463 </para>
23464 <para>
23465 If the resolver library does not support DNSSEC then this option has no effect.
23466 </para>
23467 <para>
23468 <indexterm role="option">
23469 <primary><option>dns_ipv4_lookup</option></primary>
23470 </indexterm>
23471 </para>
23472 <informaltable frame="all">
23473 <tgroup cols="4" colsep="0" rowsep="0">
23474 <colspec colwidth="8*" align="left"/>
23475 <colspec colwidth="6*" align="center"/>
23476 <colspec colwidth="6*" align="center"/>
23477 <colspec colwidth="6*" align="right"/>
23478 <tbody>
23479 <row>
23480 <entry><option>dns_ipv4_lookup</option></entry>
23481 <entry>Use: <emphasis>main</emphasis></entry>
23482 <entry>Type: <emphasis>domain list</emphasis>&dagger;<emphasis></emphasis></entry>
23483 <entry>Default: <emphasis>unset</emphasis></entry>
23484 </row>
23485 </tbody>
23486 </tgroup>
23487 </informaltable>
23488 <para>
23489 <indexterm role="concept">
23490 <primary>IPv6</primary>
23491 <secondary>DNS lookup for AAAA records</secondary>
23492 </indexterm>
23493 <indexterm role="concept">
23494 <primary>DNS</primary>
23495 <secondary>IPv6 lookup for AAAA records</secondary>
23496 </indexterm>
23497 When Exim is compiled with IPv6 support and <option>disable_ipv6</option> is not set, it
23498 looks for IPv6 address records (AAAA records) as well as IPv4 address records
23499 (A records) when trying to find IP addresses for hosts, unless the host&#x2019;s
23500 domain matches this list.
23501 </para>
23502 <para>
23503 This is a fudge to help with name servers that give big delays or otherwise do
23504 not work for the AAAA record type. In due course, when the world&#x2019;s name
23505 servers have all been upgraded, there should be no need for this option.
23506 </para>
23507 <para>
23508 <indexterm role="option">
23509 <primary><option>dns_retrans</option></primary>
23510 </indexterm>
23511 </para>
23512 <informaltable frame="all">
23513 <tgroup cols="4" colsep="0" rowsep="0">
23514 <colspec colwidth="8*" align="left"/>
23515 <colspec colwidth="6*" align="center"/>
23516 <colspec colwidth="6*" align="center"/>
23517 <colspec colwidth="6*" align="right"/>
23518 <tbody>
23519 <row>
23520 <entry><option>dns_retrans</option></entry>
23521 <entry>Use: <emphasis>main</emphasis></entry>
23522 <entry>Type: <emphasis>time</emphasis></entry>
23523 <entry>Default: <emphasis>0s</emphasis></entry>
23524 </row>
23525 </tbody>
23526 </tgroup>
23527 </informaltable>
23528 <para>
23529 <indexterm role="concept">
23530 <primary>DNS</primary>
23531 <secondary>resolver options</secondary>
23532 </indexterm>
23533 The options <option>dns_retrans</option> and <option>dns_retry</option> can be used to set the
23534 retransmission and retry parameters for DNS lookups. Values of zero (the
23535 defaults) leave the system default settings unchanged. The first value is the
23536 time between retries, and the second is the number of retries. It isn&#x2019;t
23537 totally clear exactly how these settings affect the total time a DNS lookup may
23538 take. I haven&#x2019;t found any documentation about timeouts on DNS lookups; these
23539 parameter values are available in the external resolver interface structure,
23540 but nowhere does it seem to describe how they are used or what you might want
23541 to set in them.
23542 </para>
23543 <para>
23544 <indexterm role="option">
23545 <primary><option>dns_retry</option></primary>
23546 </indexterm>
23547 </para>
23548 <informaltable frame="all">
23549 <tgroup cols="4" colsep="0" rowsep="0">
23550 <colspec colwidth="8*" align="left"/>
23551 <colspec colwidth="6*" align="center"/>
23552 <colspec colwidth="6*" align="center"/>
23553 <colspec colwidth="6*" align="right"/>
23554 <tbody>
23555 <row>
23556 <entry><option>dns_retry</option></entry>
23557 <entry>Use: <emphasis>main</emphasis></entry>
23558 <entry>Type: <emphasis>integer</emphasis></entry>
23559 <entry>Default: <emphasis>0</emphasis></entry>
23560 </row>
23561 </tbody>
23562 </tgroup>
23563 </informaltable>
23564 <para>
23565 See <option>dns_retrans</option> above.
23566 </para>
23567 <para>
23568 <indexterm role="option">
23569 <primary><option>dns_use_edns0</option></primary>
23570 </indexterm>
23571 </para>
23572 <informaltable frame="all">
23573 <tgroup cols="4" colsep="0" rowsep="0">
23574 <colspec colwidth="8*" align="left"/>
23575 <colspec colwidth="6*" align="center"/>
23576 <colspec colwidth="6*" align="center"/>
23577 <colspec colwidth="6*" align="right"/>
23578 <tbody>
23579 <row>
23580 <entry><option>dns_use_edns0</option></entry>
23581 <entry>Use: <emphasis>main</emphasis></entry>
23582 <entry>Type: <emphasis>integer</emphasis></entry>
23583 <entry>Default: <emphasis>-1</emphasis></entry>
23584 </row>
23585 </tbody>
23586 </tgroup>
23587 </informaltable>
23588 <para>
23589 <indexterm role="concept">
23590 <primary>DNS</primary>
23591 <secondary>resolver options</secondary>
23592 </indexterm>
23593 <indexterm role="concept">
23594 <primary>DNS</primary>
23595 <secondary>EDNS0</secondary>
23596 </indexterm>
23597 If this option is set to a non-negative number then Exim will initialise the
23598 DNS resolver library to either use or not use EDNS0 extensions, overriding
23599 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
23600 on.
23601 </para>
23602 <para>
23603 If the resolver library does not support EDNS0 then this option has no effect.
23604 </para>
23605 <para>
23606 <indexterm role="option">
23607 <primary><option>drop_cr</option></primary>
23608 </indexterm>
23609 </para>
23610 <informaltable frame="all">
23611 <tgroup cols="4" colsep="0" rowsep="0">
23612 <colspec colwidth="8*" align="left"/>
23613 <colspec colwidth="6*" align="center"/>
23614 <colspec colwidth="6*" align="center"/>
23615 <colspec colwidth="6*" align="right"/>
23616 <tbody>
23617 <row>
23618 <entry><option>drop_cr</option></entry>
23619 <entry>Use: <emphasis>main</emphasis></entry>
23620 <entry>Type: <emphasis>boolean</emphasis></entry>
23621 <entry>Default: <emphasis>false</emphasis></entry>
23622 </row>
23623 </tbody>
23624 </tgroup>
23625 </informaltable>
23626 <para>
23627 This is an obsolete option that is now a no-op. It used to affect the way Exim
23628 handled CR and LF characters in incoming messages. What happens now is
23629 described in section <xref linkend="SECTlineendings"/>.
23630 </para>
23631 <para>
23632 <indexterm role="option">
23633 <primary><option>dsn_from</option></primary>
23634 </indexterm>
23635 </para>
23636 <informaltable frame="all">
23637 <tgroup cols="4" colsep="0" rowsep="0">
23638 <colspec colwidth="8*" align="left"/>
23639 <colspec colwidth="6*" align="center"/>
23640 <colspec colwidth="6*" align="center"/>
23641 <colspec colwidth="6*" align="right"/>
23642 <tbody>
23643 <row>
23644 <entry><option>dsn_from</option></entry>
23645 <entry>Use: <emphasis>main</emphasis></entry>
23646 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
23647 <entry>Default: <emphasis>see below</emphasis></entry>
23648 </row>
23649 </tbody>
23650 </tgroup>
23651 </informaltable>
23652 <para>
23653 <indexterm role="concept">
23654 <primary><emphasis>From:</emphasis> header line</primary>
23655 <secondary>in bounces</secondary>
23656 </indexterm>
23657 <indexterm role="concept">
23658 <primary>bounce messages</primary>
23659 <secondary><emphasis>From:</emphasis> line, specifying</secondary>
23660 </indexterm>
23661 This option can be used to vary the contents of <emphasis>From:</emphasis> header lines in
23662 bounces and other automatically generated messages (<quote>Delivery Status
23663 Notifications</quote> &ndash; hence the name of the option). The default setting is:
23664 </para>
23665 <literallayout class="monospaced">
23666 dsn_from = Mail Delivery System &lt;Mailer-Daemon@$qualify_domain&gt;
23667 </literallayout>
23668 <para>
23669 The value is expanded every time it is needed. If the expansion fails, a
23670 panic is logged, and the default value is used.
23671 </para>
23672 <para>
23673 <indexterm role="option">
23674 <primary><option>envelope_to_remove</option></primary>
23675 </indexterm>
23676 </para>
23677 <informaltable frame="all">
23678 <tgroup cols="4" colsep="0" rowsep="0">
23679 <colspec colwidth="8*" align="left"/>
23680 <colspec colwidth="6*" align="center"/>
23681 <colspec colwidth="6*" align="center"/>
23682 <colspec colwidth="6*" align="right"/>
23683 <tbody>
23684 <row>
23685 <entry><option>envelope_to_remove</option></entry>
23686 <entry>Use: <emphasis>main</emphasis></entry>
23687 <entry>Type: <emphasis>boolean</emphasis></entry>
23688 <entry>Default: <emphasis>true</emphasis></entry>
23689 </row>
23690 </tbody>
23691 </tgroup>
23692 </informaltable>
23693 <para>
23694 <indexterm role="concept">
23695 <primary><emphasis>Envelope-to:</emphasis> header line</primary>
23696 </indexterm>
23697 Exim&#x2019;s transports have an option for adding an <emphasis>Envelope-to:</emphasis> header to a
23698 message when it is delivered, in exactly the same way as <emphasis>Return-path:</emphasis> is
23699 handled. <emphasis>Envelope-to:</emphasis> records the original recipient address from the
23700 messages&#x2019;s envelope that caused the delivery to happen. Such headers should not
23701 be present in incoming messages, and this option causes them to be removed at
23702 the time the message is received, to avoid any problems that might occur when a
23703 delivered message is subsequently sent on to some other recipient.
23704 </para>
23705 <para>
23706 <indexterm role="option">
23707 <primary><option>errors_copy</option></primary>
23708 </indexterm>
23709 </para>
23710 <informaltable frame="all">
23711 <tgroup cols="4" colsep="0" rowsep="0">
23712 <colspec colwidth="8*" align="left"/>
23713 <colspec colwidth="6*" align="center"/>
23714 <colspec colwidth="6*" align="center"/>
23715 <colspec colwidth="6*" align="right"/>
23716 <tbody>
23717 <row>
23718 <entry><option>errors_copy</option></entry>
23719 <entry>Use: <emphasis>main</emphasis></entry>
23720 <entry>Type: <emphasis>string list</emphasis>&dagger;<emphasis></emphasis></entry>
23721 <entry>Default: <emphasis>unset</emphasis></entry>
23722 </row>
23723 </tbody>
23724 </tgroup>
23725 </informaltable>
23726 <para>
23727 <indexterm role="concept">
23728 <primary>bounce message</primary>
23729 <secondary>copy to other address</secondary>
23730 </indexterm>
23731 <indexterm role="concept">
23732 <primary>copy of bounce message</primary>
23733 </indexterm>
23734 Setting this option causes Exim to send bcc copies of bounce messages that it
23735 generates to other addresses. <emphasis role="bold">Note</emphasis>: This does not apply to bounce messages
23736 coming from elsewhere. The value of the option is a colon-separated list of
23737 items. Each item consists of a pattern, terminated by white space, followed by
23738 a comma-separated list of email addresses. If a pattern contains spaces, it
23739 must be enclosed in double quotes.
23740 </para>
23741 <para>
23742 Each pattern is processed in the same way as a single item in an address list
23743 (see section <xref linkend="SECTaddresslist"/>). When a pattern matches the recipient of
23744 the bounce message, the message is copied to the addresses on the list. The
23745 items are scanned in order, and once a matching one is found, no further items
23746 are examined. For example:
23747 </para>
23748 <literallayout class="monospaced">
23749 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
23750               rqps@mydomain   hostmaster@mydomain.example,\
23751                               postmaster@mydomain.example
23752 </literallayout>
23753 <para>
23754 <indexterm role="variable">
23755 <primary><varname>$domain</varname></primary>
23756 </indexterm>
23757 <indexterm role="variable">
23758 <primary><varname>$local_part</varname></primary>
23759 </indexterm>
23760 The address list is expanded before use. The expansion variables <varname>$local_part</varname>
23761 and <varname>$domain</varname> are set from the original recipient of the error message, and if
23762 there was any wildcard matching in the pattern, the expansion
23763 <indexterm role="concept">
23764 <primary>numerical variables (<varname>$1</varname> <varname>$2</varname> etc)</primary>
23765 <secondary>in <option>errors_copy</option></secondary>
23766 </indexterm>
23767 variables <varname>$0</varname>, <varname>$1</varname>, etc. are set in the normal way.
23768 </para>
23769 <para>
23770 <indexterm role="option">
23771 <primary><option>errors_reply_to</option></primary>
23772 </indexterm>
23773 </para>
23774 <informaltable frame="all">
23775 <tgroup cols="4" colsep="0" rowsep="0">
23776 <colspec colwidth="8*" align="left"/>
23777 <colspec colwidth="6*" align="center"/>
23778 <colspec colwidth="6*" align="center"/>
23779 <colspec colwidth="6*" align="right"/>
23780 <tbody>
23781 <row>
23782 <entry><option>errors_reply_to</option></entry>
23783 <entry>Use: <emphasis>main</emphasis></entry>
23784 <entry>Type: <emphasis>string</emphasis></entry>
23785 <entry>Default: <emphasis>unset</emphasis></entry>
23786 </row>
23787 </tbody>
23788 </tgroup>
23789 </informaltable>
23790 <para>
23791 <indexterm role="concept">
23792 <primary>bounce message</primary>
23793 <secondary><emphasis>Reply-to:</emphasis> in</secondary>
23794 </indexterm>
23795 By default, Exim&#x2019;s bounce and delivery warning messages contain the header line
23796 </para>
23797 <literallayout>
23798 <literal>From: Mail Delivery System &lt;Mailer-Daemon@</literal><emphasis>qualify-domain</emphasis><literal>&gt;</literal>
23799 </literallayout>
23800 <para>
23801 <indexterm role="option">
23802 <primary><option>quota_warn_message</option></primary>
23803 </indexterm>
23804 where <emphasis>qualify-domain</emphasis> is the value of the <option>qualify_domain</option> option.
23805 A warning message that is generated by the <option>quota_warn_message</option> option in an
23806 <command>appendfile</command> transport may contain its own <emphasis>From:</emphasis> header line that
23807 overrides the default.
23808 </para>
23809 <para>
23810 Experience shows that people reply to bounce messages. If the
23811 <option>errors_reply_to</option> option is set, a <emphasis>Reply-To:</emphasis> header is added to bounce
23812 and warning messages. For example:
23813 </para>
23814 <literallayout class="monospaced">
23815 errors_reply_to = postmaster@my.domain.example
23816 </literallayout>
23817 <para>
23818 The value of the option is not expanded. It must specify a valid RFC 2822
23819 address. However, if a warning message that is generated by the
23820 <option>quota_warn_message</option> option in an <command>appendfile</command> transport contain its
23821 own <emphasis>Reply-To:</emphasis> header line, the value of the <option>errors_reply_to</option> option is
23822 not used.
23823 </para>
23824 <para>
23825 <indexterm role="option">
23826 <primary><option>exim_group</option></primary>
23827 </indexterm>
23828 </para>
23829 <informaltable frame="all">
23830 <tgroup cols="4" colsep="0" rowsep="0">
23831 <colspec colwidth="8*" align="left"/>
23832 <colspec colwidth="6*" align="center"/>
23833 <colspec colwidth="6*" align="center"/>
23834 <colspec colwidth="6*" align="right"/>
23835 <tbody>
23836 <row>
23837 <entry><option>exim_group</option></entry>
23838 <entry>Use: <emphasis>main</emphasis></entry>
23839 <entry>Type: <emphasis>string</emphasis></entry>
23840 <entry>Default: <emphasis>compile-time configured</emphasis></entry>
23841 </row>
23842 </tbody>
23843 </tgroup>
23844 </informaltable>
23845 <para>
23846 <indexterm role="concept">
23847 <primary>gid (group id)</primary>
23848 <secondary>Exim&#x2019;s own</secondary>
23849 </indexterm>
23850 <indexterm role="concept">
23851 <primary>Exim group</primary>
23852 </indexterm>
23853 This option changes the gid under which Exim runs when it gives up root
23854 privilege. The default value is compiled into the binary. The value of this
23855 option is used only when <option>exim_user</option> is also set. Unless it consists entirely
23856 of digits, the string is looked up using <function>getgrnam()</function>, and failure causes a
23857 configuration error. See chapter <xref linkend="CHAPsecurity"/> for a discussion of
23858 security issues.
23859 </para>
23860 <para>
23861 <indexterm role="option">
23862 <primary><option>exim_path</option></primary>
23863 </indexterm>
23864 </para>
23865 <informaltable frame="all">
23866 <tgroup cols="4" colsep="0" rowsep="0">
23867 <colspec colwidth="8*" align="left"/>
23868 <colspec colwidth="6*" align="center"/>
23869 <colspec colwidth="6*" align="center"/>
23870 <colspec colwidth="6*" align="right"/>
23871 <tbody>
23872 <row>
23873 <entry><option>exim_path</option></entry>
23874 <entry>Use: <emphasis>main</emphasis></entry>
23875 <entry>Type: <emphasis>string</emphasis></entry>
23876 <entry>Default: <emphasis>see below</emphasis></entry>
23877 </row>
23878 </tbody>
23879 </tgroup>
23880 </informaltable>
23881 <para>
23882 <indexterm role="concept">
23883 <primary>Exim binary, path name</primary>
23884 </indexterm>
23885 This option specifies the path name of the Exim binary, which is used when Exim
23886 needs to re-exec itself. The default is set up to point to the file <emphasis>exim</emphasis> in
23887 the directory configured at compile time by the BIN_DIRECTORY setting. It
23888 is necessary to change <option>exim_path</option> if, exceptionally, Exim is run from some
23889 other place.
23890 <emphasis role="bold">Warning</emphasis>: Do not use a macro to define the value of this option, because
23891 you will break those Exim utilities that scan the configuration file to find
23892 where the binary is. (They then use the <option>-bP</option> option to extract option
23893 settings such as the value of <option>spool_directory</option>.)
23894 </para>
23895 <para>
23896 <indexterm role="option">
23897 <primary><option>exim_user</option></primary>
23898 </indexterm>
23899 </para>
23900 <informaltable frame="all">
23901 <tgroup cols="4" colsep="0" rowsep="0">
23902 <colspec colwidth="8*" align="left"/>
23903 <colspec colwidth="6*" align="center"/>
23904 <colspec colwidth="6*" align="center"/>
23905 <colspec colwidth="6*" align="right"/>
23906 <tbody>
23907 <row>
23908 <entry><option>exim_user</option></entry>
23909 <entry>Use: <emphasis>main</emphasis></entry>
23910 <entry>Type: <emphasis>string</emphasis></entry>
23911 <entry>Default: <emphasis>compile-time configured</emphasis></entry>
23912 </row>
23913 </tbody>
23914 </tgroup>
23915 </informaltable>
23916 <para>
23917 <indexterm role="concept">
23918 <primary>uid (user id)</primary>
23919 <secondary>Exim&#x2019;s own</secondary>
23920 </indexterm>
23921 <indexterm role="concept">
23922 <primary>Exim user</primary>
23923 </indexterm>
23924 This option changes the uid under which Exim runs when it gives up root
23925 privilege. The default value is compiled into the binary. Ownership of the run
23926 time configuration file and the use of the <option>-C</option> and <option>-D</option> command line
23927 options is checked against the values in the binary, not what is set here.
23928 </para>
23929 <para>
23930 Unless it consists entirely of digits, the string is looked up using
23931 <function>getpwnam()</function>, and failure causes a configuration error. If <option>exim_group</option> is
23932 not also supplied, the gid is taken from the result of <function>getpwnam()</function> if it is
23933 used. See chapter <xref linkend="CHAPsecurity"/> for a discussion of security issues.
23934 </para>
23935 <para>
23936 <indexterm role="option">
23937 <primary><option>extra_local_interfaces</option></primary>
23938 </indexterm>
23939 </para>
23940 <informaltable frame="all">
23941 <tgroup cols="4" colsep="0" rowsep="0">
23942 <colspec colwidth="8*" align="left"/>
23943 <colspec colwidth="6*" align="center"/>
23944 <colspec colwidth="6*" align="center"/>
23945 <colspec colwidth="6*" align="right"/>
23946 <tbody>
23947 <row>
23948 <entry><option>extra_local_interfaces</option></entry>
23949 <entry>Use: <emphasis>main</emphasis></entry>
23950 <entry>Type: <emphasis>string list</emphasis></entry>
23951 <entry>Default: <emphasis>unset</emphasis></entry>
23952 </row>
23953 </tbody>
23954 </tgroup>
23955 </informaltable>
23956 <para>
23957 This option defines network interfaces that are to be considered local when
23958 routing, but which are not used for listening by the daemon. See section
23959 <xref linkend="SECTreclocipadd"/> for details.
23960 </para>
23961 <para>
23962 <indexterm role="option">
23963 <primary><option>extract_addresses_remove_arguments</option></primary>
23964 </indexterm>
23965 </para>
23966 <informaltable frame="all">
23967 <tgroup cols="4" colsep="0" rowsep="0">
23968 <colspec colwidth="8*" align="left"/>
23969 <colspec colwidth="6*" align="center"/>
23970 <colspec colwidth="6*" align="center"/>
23971 <colspec colwidth="6*" align="right"/>
23972 <tbody>
23973 <row>
23974 <entry><option>extract_addresses_remove_ &nbsp;&nbsp;arguments</option></entry>
23975 <entry>Use: <emphasis>main</emphasis></entry>
23976 <entry>Type: <emphasis>boolean</emphasis></entry>
23977 <entry>Default: <emphasis>true</emphasis></entry>
23978 </row>
23979 </tbody>
23980 </tgroup>
23981 </informaltable>
23982 <para>
23983 <indexterm role="option">
23984 <primary><option>-t</option></primary>
23985 </indexterm>
23986 <indexterm role="concept">
23987 <primary>command line</primary>
23988 <secondary>addresses with <option>-t</option></secondary>
23989 </indexterm>
23990 <indexterm role="concept">
23991 <primary>Sendmail compatibility</primary>
23992 <secondary><option>-t</option> option</secondary>
23993 </indexterm>
23994 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
23995 are present on the command line when the <option>-t</option> option is used to build an
23996 envelope from a message&#x2019;s <emphasis>To:</emphasis>, <emphasis>Cc:</emphasis> and <emphasis>Bcc:</emphasis> headers, the command
23997 line addresses are removed from the recipients list. This is also how Smail
23998 behaves. However, other Sendmail documentation (the O&#x2019;Reilly book) states that
23999 command line addresses are added to those obtained from the header lines. When
24000 <option>extract_addresses_remove_arguments</option> is true (the default), Exim subtracts
24001 argument headers. If it is set false, Exim adds rather than removes argument
24002 addresses.
24003 </para>
24004 <para>
24005 <indexterm role="option">
24006 <primary><option>finduser_retries</option></primary>
24007 </indexterm>
24008 </para>
24009 <informaltable frame="all">
24010 <tgroup cols="4" colsep="0" rowsep="0">
24011 <colspec colwidth="8*" align="left"/>
24012 <colspec colwidth="6*" align="center"/>
24013 <colspec colwidth="6*" align="center"/>
24014 <colspec colwidth="6*" align="right"/>
24015 <tbody>
24016 <row>
24017 <entry><option>finduser_retries</option></entry>
24018 <entry>Use: <emphasis>main</emphasis></entry>
24019 <entry>Type: <emphasis>integer</emphasis></entry>
24020 <entry>Default: <emphasis>0</emphasis></entry>
24021 </row>
24022 </tbody>
24023 </tgroup>
24024 </informaltable>
24025 <para>
24026 <indexterm role="concept">
24027 <primary>NIS, retrying user lookups</primary>
24028 </indexterm>
24029 On systems running NIS or other schemes in which user and group information is
24030 distributed from a remote system, there can be times when <function>getpwnam()</function> and
24031 related functions fail, even when given valid data, because things time out.
24032 Unfortunately these failures cannot be distinguished from genuine <quote>not found</quote>
24033 errors. If <option>finduser_retries</option> is set greater than zero, Exim will try that
24034 many extra times to find a user or a group, waiting for one second between
24035 retries.
24036 </para>
24037 <para>
24038 <indexterm role="concept">
24039 <primary><filename>/etc/passwd</filename></primary>
24040 <secondary>multiple reading of</secondary>
24041 </indexterm>
24042 You should not set this option greater than zero if your user information is in
24043 a traditional <filename>/etc/passwd</filename> file, because it will cause Exim needlessly to
24044 search the file multiple times for non-existent users, and also cause delay.
24045 </para>
24046 <para>
24047 <indexterm role="option">
24048 <primary><option>freeze_tell</option></primary>
24049 </indexterm>
24050 </para>
24051 <informaltable frame="all">
24052 <tgroup cols="4" colsep="0" rowsep="0">
24053 <colspec colwidth="8*" align="left"/>
24054 <colspec colwidth="6*" align="center"/>
24055 <colspec colwidth="6*" align="center"/>
24056 <colspec colwidth="6*" align="right"/>
24057 <tbody>
24058 <row>
24059 <entry><option>freeze_tell</option></entry>
24060 <entry>Use: <emphasis>main</emphasis></entry>
24061 <entry>Type: <emphasis>string list, comma separated</emphasis></entry>
24062 <entry>Default: <emphasis>unset</emphasis></entry>
24063 </row>
24064 </tbody>
24065 </tgroup>
24066 </informaltable>
24067 <para>
24068 <indexterm role="concept">
24069 <primary>freezing messages</primary>
24070 <secondary>sending a message when freezing</secondary>
24071 </indexterm>
24072 On encountering certain errors, or when configured to do so in a system filter,
24073 ACL, or special router, Exim freezes a message. This means that no further
24074 delivery attempts take place until an administrator thaws the message, or the
24075 <option>auto_thaw</option>, <option>ignore_bounce_errors_after</option>, or <option>timeout_frozen_after</option>
24076 feature cause it to be processed. If <option>freeze_tell</option> is set, Exim generates a
24077 warning message whenever it freezes something, unless the message it is
24078 freezing is a locally-generated bounce message. (Without this exception there
24079 is the possibility of looping.) The warning message is sent to the addresses
24080 supplied as the comma-separated value of this option. If several of the
24081 message&#x2019;s addresses cause freezing, only a single message is sent. If the
24082 freezing was automatic, the reason(s) for freezing can be found in the message
24083 log. If you configure freezing in a filter or ACL, you must arrange for any
24084 logging that you require.
24085 </para>
24086 <para>
24087 <indexterm role="option">
24088 <primary><option>gecos_name</option></primary>
24089 </indexterm>
24090 </para>
24091 <informaltable frame="all">
24092 <tgroup cols="4" colsep="0" rowsep="0">
24093 <colspec colwidth="8*" align="left"/>
24094 <colspec colwidth="6*" align="center"/>
24095 <colspec colwidth="6*" align="center"/>
24096 <colspec colwidth="6*" align="right"/>
24097 <tbody>
24098 <row>
24099 <entry><option>gecos_name</option></entry>
24100 <entry>Use: <emphasis>main</emphasis></entry>
24101 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
24102 <entry>Default: <emphasis>unset</emphasis></entry>
24103 </row>
24104 </tbody>
24105 </tgroup>
24106 </informaltable>
24107 <para>
24108 <indexterm role="concept">
24109 <primary>HP-UX</primary>
24110 </indexterm>
24111 <indexterm role="concept">
24112 <primary><quote>gecos</quote> field, parsing</primary>
24113 </indexterm>
24114 Some operating systems, notably HP-UX, use the <quote>gecos</quote> field in the system
24115 password file to hold other information in addition to users&#x2019; real names. Exim
24116 looks up this field for use when it is creating <emphasis>Sender:</emphasis> or <emphasis>From:</emphasis>
24117 headers. If either <option>gecos_pattern</option> or <option>gecos_name</option> are unset, the contents
24118 of the field are used unchanged, except that, if an ampersand is encountered,
24119 it is replaced by the user&#x2019;s login name with the first character forced to
24120 upper case, since this is a convention that is observed on many systems.
24121 </para>
24122 <para>
24123 When these options are set, <option>gecos_pattern</option> is treated as a regular
24124 expression that is to be applied to the field (again with &amp; replaced by the
24125 login name), and if it matches, <option>gecos_name</option> is expanded and used as the
24126 user&#x2019;s name.
24127 </para>
24128 <para>
24129 <indexterm role="concept">
24130 <primary>numerical variables (<varname>$1</varname> <varname>$2</varname> etc)</primary>
24131 <secondary>in <option>gecos_name</option></secondary>
24132 </indexterm>
24133 Numeric variables such as <varname>$1</varname>, <varname>$2</varname>, etc. can be used in the expansion to
24134 pick up sub-fields that were matched by the pattern. In HP-UX, where the user&#x2019;s
24135 name terminates at the first comma, the following can be used:
24136 </para>
24137 <literallayout class="monospaced">
24138 gecos_pattern = ([^,]*)
24139 gecos_name = $1
24140 </literallayout>
24141 <para>
24142 <indexterm role="option">
24143 <primary><option>gecos_pattern</option></primary>
24144 </indexterm>
24145 </para>
24146 <informaltable frame="all">
24147 <tgroup cols="4" colsep="0" rowsep="0">
24148 <colspec colwidth="8*" align="left"/>
24149 <colspec colwidth="6*" align="center"/>
24150 <colspec colwidth="6*" align="center"/>
24151 <colspec colwidth="6*" align="right"/>
24152 <tbody>
24153 <row>
24154 <entry><option>gecos_pattern</option></entry>
24155 <entry>Use: <emphasis>main</emphasis></entry>
24156 <entry>Type: <emphasis>string</emphasis></entry>
24157 <entry>Default: <emphasis>unset</emphasis></entry>
24158 </row>
24159 </tbody>
24160 </tgroup>
24161 </informaltable>
24162 <para>
24163 See <option>gecos_name</option> above.
24164 </para>
24165 <para>
24166 <indexterm role="option">
24167 <primary><option>gnutls_compat_mode</option></primary>
24168 </indexterm>
24169 </para>
24170 <informaltable frame="all">
24171 <tgroup cols="4" colsep="0" rowsep="0">
24172 <colspec colwidth="8*" align="left"/>
24173 <colspec colwidth="6*" align="center"/>
24174 <colspec colwidth="6*" align="center"/>
24175 <colspec colwidth="6*" align="right"/>
24176 <tbody>
24177 <row>
24178 <entry><option>gnutls_compat_mode</option></entry>
24179 <entry>Use: <emphasis>main</emphasis></entry>
24180 <entry>Type: <emphasis>boolean</emphasis></entry>
24181 <entry>Default: <emphasis>unset</emphasis></entry>
24182 </row>
24183 </tbody>
24184 </tgroup>
24185 </informaltable>
24186 <para>
24187 This option controls whether GnuTLS is used in compatibility mode in an Exim
24188 server. This reduces security slightly, but improves interworking with older
24189 implementations of TLS.
24190 </para>
24191 <para>
24192 option gnutls_allow_auto_pkcs11 main boolean unset
24193 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
24194 the p11-kit configuration files in <filename>/etc/pkcs11/modules/</filename>.
24195 </para>
24196 <para>
24197 See
24198 <emphasis role="bold"><ulink url="http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs">http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs</ulink></emphasis>
24199 for documentation.
24200 </para>
24201 <para>
24202 <indexterm role="option">
24203 <primary><option>headers_charset</option></primary>
24204 </indexterm>
24205 </para>
24206 <informaltable frame="all">
24207 <tgroup cols="4" colsep="0" rowsep="0">
24208 <colspec colwidth="8*" align="left"/>
24209 <colspec colwidth="6*" align="center"/>
24210 <colspec colwidth="6*" align="center"/>
24211 <colspec colwidth="6*" align="right"/>
24212 <tbody>
24213 <row>
24214 <entry><option>headers_charset</option></entry>
24215 <entry>Use: <emphasis>main</emphasis></entry>
24216 <entry>Type: <emphasis>string</emphasis></entry>
24217 <entry>Default: <emphasis>see below</emphasis></entry>
24218 </row>
24219 </tbody>
24220 </tgroup>
24221 </informaltable>
24222 <para>
24223 This option sets a default character set for translating from encoded MIME
24224 <quote>words</quote> in header lines, when referenced by an <varname>$h_xxx</varname> expansion item. The
24225 default is the value of HEADERS_CHARSET in <filename>Local/Makefile</filename>. The
24226 ultimate default is ISO-8859-1. For more details see the description of header
24227 insertions in section <xref linkend="SECTexpansionitems"/>.
24228 </para>
24229 <para>
24230 <indexterm role="option">
24231 <primary><option>header_maxsize</option></primary>
24232 </indexterm>
24233 </para>
24234 <informaltable frame="all">
24235 <tgroup cols="4" colsep="0" rowsep="0">
24236 <colspec colwidth="8*" align="left"/>
24237 <colspec colwidth="6*" align="center"/>
24238 <colspec colwidth="6*" align="center"/>
24239 <colspec colwidth="6*" align="right"/>
24240 <tbody>
24241 <row>
24242 <entry><option>header_maxsize</option></entry>
24243 <entry>Use: <emphasis>main</emphasis></entry>
24244 <entry>Type: <emphasis>integer</emphasis></entry>
24245 <entry>Default: <emphasis>see below</emphasis></entry>
24246 </row>
24247 </tbody>
24248 </tgroup>
24249 </informaltable>
24250 <para>
24251 <indexterm role="concept">
24252 <primary>header section</primary>
24253 <secondary>maximum size of</secondary>
24254 </indexterm>
24255 <indexterm role="concept">
24256 <primary>limit</primary>
24257 <secondary>size of message header section</secondary>
24258 </indexterm>
24259 This option controls the overall maximum size of a message&#x2019;s header
24260 section. The default is the value of HEADER_MAXSIZE in
24261 <filename>Local/Makefile</filename>; the default for that is 1M. Messages with larger header
24262 sections are rejected.
24263 </para>
24264 <para>
24265 <indexterm role="option">
24266 <primary><option>header_line_maxsize</option></primary>
24267 </indexterm>
24268 </para>
24269 <informaltable frame="all">
24270 <tgroup cols="4" colsep="0" rowsep="0">
24271 <colspec colwidth="8*" align="left"/>
24272 <colspec colwidth="6*" align="center"/>
24273 <colspec colwidth="6*" align="center"/>
24274 <colspec colwidth="6*" align="right"/>
24275 <tbody>
24276 <row>
24277 <entry><option>header_line_maxsize</option></entry>
24278 <entry>Use: <emphasis>main</emphasis></entry>
24279 <entry>Type: <emphasis>integer</emphasis></entry>
24280 <entry>Default: <emphasis>0</emphasis></entry>
24281 </row>
24282 </tbody>
24283 </tgroup>
24284 </informaltable>
24285 <para>
24286 <indexterm role="concept">
24287 <primary>header lines</primary>
24288 <secondary>maximum size of</secondary>
24289 </indexterm>
24290 <indexterm role="concept">
24291 <primary>limit</primary>
24292 <secondary>size of one header line</secondary>
24293 </indexterm>
24294 This option limits the length of any individual header line in a message, after
24295 all the continuations have been joined together. Messages with individual
24296 header lines that are longer than the limit are rejected. The default value of
24297 zero means <quote>no limit</quote>.
24298 </para>
24299 <para>
24300 <indexterm role="option">
24301 <primary><option>helo_accept_junk_hosts</option></primary>
24302 </indexterm>
24303 </para>
24304 <informaltable frame="all">
24305 <tgroup cols="4" colsep="0" rowsep="0">
24306 <colspec colwidth="8*" align="left"/>
24307 <colspec colwidth="6*" align="center"/>
24308 <colspec colwidth="6*" align="center"/>
24309 <colspec colwidth="6*" align="right"/>
24310 <tbody>
24311 <row>
24312 <entry><option>helo_accept_junk_hosts</option></entry>
24313 <entry>Use: <emphasis>main</emphasis></entry>
24314 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
24315 <entry>Default: <emphasis>unset</emphasis></entry>
24316 </row>
24317 </tbody>
24318 </tgroup>
24319 </informaltable>
24320 <para>
24321 <indexterm role="concept">
24322 <primary>HELO</primary>
24323 <secondary>accepting junk data</secondary>
24324 </indexterm>
24325 <indexterm role="concept">
24326 <primary>EHLO</primary>
24327 <secondary>accepting junk data</secondary>
24328 </indexterm>
24329 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
24330 mail, and gives an error response for invalid data. Unfortunately, there are
24331 some SMTP clients that send syntactic junk. They can be accommodated by setting
24332 this option. Note that this is a syntax check only. See <option>helo_verify_hosts</option>
24333 if you want to do semantic checking.
24334 See also <option>helo_allow_chars</option> for a way of extending the permitted character
24335 set.
24336 </para>
24337 <para>
24338 <indexterm role="option">
24339 <primary><option>helo_allow_chars</option></primary>
24340 </indexterm>
24341 </para>
24342 <informaltable frame="all">
24343 <tgroup cols="4" colsep="0" rowsep="0">
24344 <colspec colwidth="8*" align="left"/>
24345 <colspec colwidth="6*" align="center"/>
24346 <colspec colwidth="6*" align="center"/>
24347 <colspec colwidth="6*" align="right"/>
24348 <tbody>
24349 <row>
24350 <entry><option>helo_allow_chars</option></entry>
24351 <entry>Use: <emphasis>main</emphasis></entry>
24352 <entry>Type: <emphasis>string</emphasis></entry>
24353 <entry>Default: <emphasis>unset</emphasis></entry>
24354 </row>
24355 </tbody>
24356 </tgroup>
24357 </informaltable>
24358 <para>
24359 <indexterm role="concept">
24360 <primary>HELO</primary>
24361 <secondary>underscores in</secondary>
24362 </indexterm>
24363 <indexterm role="concept">
24364 <primary>EHLO</primary>
24365 <secondary>underscores in</secondary>
24366 </indexterm>
24367 <indexterm role="concept">
24368 <primary>underscore in EHLO/HELO</primary>
24369 </indexterm>
24370 This option can be set to a string of rogue characters that are permitted in
24371 all EHLO and HELO names in addition to the standard letters, digits,
24372 hyphens, and dots. If you really must allow underscores, you can set
24373 </para>
24374 <literallayout class="monospaced">
24375 helo_allow_chars = _
24376 </literallayout>
24377 <para>
24378 Note that the value is one string, not a list.
24379 </para>
24380 <para>
24381 <indexterm role="option">
24382 <primary><option>helo_lookup_domains</option></primary>
24383 </indexterm>
24384 </para>
24385 <informaltable frame="all">
24386 <tgroup cols="4" colsep="0" rowsep="0">
24387 <colspec colwidth="8*" align="left"/>
24388 <colspec colwidth="6*" align="center"/>
24389 <colspec colwidth="6*" align="center"/>
24390 <colspec colwidth="6*" align="right"/>
24391 <tbody>
24392 <row>
24393 <entry><option>helo_lookup_domains</option></entry>
24394 <entry>Use: <emphasis>main</emphasis></entry>
24395 <entry>Type: <emphasis>domain list</emphasis>&dagger;<emphasis></emphasis></entry>
24396 <entry>Default: <emphasis><literal>@:@[]</literal></emphasis></entry>
24397 </row>
24398 </tbody>
24399 </tgroup>
24400 </informaltable>
24401 <para>
24402 <indexterm role="concept">
24403 <primary>HELO</primary>
24404 <secondary>forcing reverse lookup</secondary>
24405 </indexterm>
24406 <indexterm role="concept">
24407 <primary>EHLO</primary>
24408 <secondary>forcing reverse lookup</secondary>
24409 </indexterm>
24410 If the domain given by a client in a HELO or EHLO command matches this
24411 list, a reverse lookup is done in order to establish the host&#x2019;s true name. The
24412 default forces a lookup if the client host gives the server&#x2019;s name or any of
24413 its IP addresses (in brackets), something that broken clients have been seen to
24414 do.
24415 </para>
24416 <para>
24417 <indexterm role="option">
24418 <primary><option>helo_try_verify_hosts</option></primary>
24419 </indexterm>
24420 </para>
24421 <informaltable frame="all">
24422 <tgroup cols="4" colsep="0" rowsep="0">
24423 <colspec colwidth="8*" align="left"/>
24424 <colspec colwidth="6*" align="center"/>
24425 <colspec colwidth="6*" align="center"/>
24426 <colspec colwidth="6*" align="right"/>
24427 <tbody>
24428 <row>
24429 <entry><option>helo_try_verify_hosts</option></entry>
24430 <entry>Use: <emphasis>main</emphasis></entry>
24431 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
24432 <entry>Default: <emphasis>unset</emphasis></entry>
24433 </row>
24434 </tbody>
24435 </tgroup>
24436 </informaltable>
24437 <para>
24438 <indexterm role="concept">
24439 <primary>HELO verifying</primary>
24440 <secondary>optional</secondary>
24441 </indexterm>
24442 <indexterm role="concept">
24443 <primary>EHLO</primary>
24444 <secondary>verifying, optional</secondary>
24445 </indexterm>
24446 By default, Exim just checks the syntax of HELO and EHLO commands (see
24447 <option>helo_accept_junk_hosts</option> and <option>helo_allow_chars</option>). However, some sites like
24448 to do more extensive checking of the data supplied by these commands. The ACL
24449 condition <literal>verify = helo</literal> is provided to make this possible.
24450 Formerly, it was necessary also to set this option (<option>helo_try_verify_hosts</option>)
24451 to force the check to occur. From release 4.53 onwards, this is no longer
24452 necessary. If the check has not been done before <literal>verify = helo</literal> is
24453 encountered, it is done at that time. Consequently, this option is obsolete.
24454 Its specification is retained here for backwards compatibility.
24455 </para>
24456 <para>
24457 When an EHLO or HELO command is received, if the calling host matches
24458 <option>helo_try_verify_hosts</option>, Exim checks that the host name given in the HELO or
24459 EHLO command either:
24460 </para>
24461 <itemizedlist>
24462 <listitem>
24463 <para>
24464 is an IP literal matching the calling address of the host, or
24465 </para>
24466 </listitem>
24467 <listitem>
24468 <para>
24469 <indexterm role="concept">
24470 <primary>DNS</primary>
24471 <secondary>reverse lookup</secondary>
24472 </indexterm>
24473 <indexterm role="concept">
24474 <primary>reverse DNS lookup</primary>
24475 </indexterm>
24476 matches the host name that Exim obtains by doing a reverse lookup of the
24477 calling host address, or
24478 </para>
24479 </listitem>
24480 <listitem>
24481 <para>
24482 when looked up using <function>gethostbyname()</function> (or <function>getipnodebyname()</function> when
24483 available) yields the calling host address.
24484 </para>
24485 </listitem>
24486 </itemizedlist>
24487 <para>
24488 However, the EHLO or HELO command is not rejected if any of the checks
24489 fail. Processing continues, but the result of the check is remembered, and can
24490 be detected later in an ACL by the <literal>verify = helo</literal> condition.
24491 </para>
24492 <para>
24493 <indexterm role="option">
24494 <primary><option>helo_verify_hosts</option></primary>
24495 </indexterm>
24496 </para>
24497 <informaltable frame="all">
24498 <tgroup cols="4" colsep="0" rowsep="0">
24499 <colspec colwidth="8*" align="left"/>
24500 <colspec colwidth="6*" align="center"/>
24501 <colspec colwidth="6*" align="center"/>
24502 <colspec colwidth="6*" align="right"/>
24503 <tbody>
24504 <row>
24505 <entry><option>helo_verify_hosts</option></entry>
24506 <entry>Use: <emphasis>main</emphasis></entry>
24507 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
24508 <entry>Default: <emphasis>unset</emphasis></entry>
24509 </row>
24510 </tbody>
24511 </tgroup>
24512 </informaltable>
24513 <para>
24514 <indexterm role="concept">
24515 <primary>HELO verifying</primary>
24516 <secondary>mandatory</secondary>
24517 </indexterm>
24518 <indexterm role="concept">
24519 <primary>EHLO</primary>
24520 <secondary>verifying, mandatory</secondary>
24521 </indexterm>
24522 Like <option>helo_try_verify_hosts</option>, this option is obsolete, and retained only for
24523 backwards compatibility. For hosts that match this option, Exim checks the host
24524 name given in the HELO or EHLO in the same way as for
24525 <option>helo_try_verify_hosts</option>. If the check fails, the HELO or EHLO command is
24526 rejected with a 550 error, and entries are written to the main and reject logs.
24527 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
24528 error.
24529 </para>
24530 <para>
24531 <indexterm role="option">
24532 <primary><option>hold_domains</option></primary>
24533 </indexterm>
24534 </para>
24535 <informaltable frame="all">
24536 <tgroup cols="4" colsep="0" rowsep="0">
24537 <colspec colwidth="8*" align="left"/>
24538 <colspec colwidth="6*" align="center"/>
24539 <colspec colwidth="6*" align="center"/>
24540 <colspec colwidth="6*" align="right"/>
24541 <tbody>
24542 <row>
24543 <entry><option>hold_domains</option></entry>
24544 <entry>Use: <emphasis>main</emphasis></entry>
24545 <entry>Type: <emphasis>domain list</emphasis>&dagger;<emphasis></emphasis></entry>
24546 <entry>Default: <emphasis>unset</emphasis></entry>
24547 </row>
24548 </tbody>
24549 </tgroup>
24550 </informaltable>
24551 <para>
24552 <indexterm role="concept">
24553 <primary>domain</primary>
24554 <secondary>delaying delivery</secondary>
24555 </indexterm>
24556 <indexterm role="concept">
24557 <primary>delivery</primary>
24558 <secondary>delaying certain domains</secondary>
24559 </indexterm>
24560 This option allows mail for particular domains to be held on the queue
24561 manually. The option is overridden if a message delivery is forced with the
24562 <option>-M</option>, <option>-qf</option>, <option>-Rf</option> or <option>-Sf</option> options, and also while testing or
24563 verifying addresses using <option>-bt</option> or <option>-bv</option>. Otherwise, if a domain matches an
24564 item in <option>hold_domains</option>, no routing or delivery for that address is done, and
24565 it is deferred every time the message is looked at.
24566 </para>
24567 <para>
24568 This option is intended as a temporary operational measure for delaying the
24569 delivery of mail while some problem is being sorted out, or some new
24570 configuration tested. If you just want to delay the processing of some
24571 domains until a queue run occurs, you should use <option>queue_domains</option> or
24572 <option>queue_smtp_domains</option>, not <option>hold_domains</option>.
24573 </para>
24574 <para>
24575 A setting of <option>hold_domains</option> does not override Exim&#x2019;s code for removing
24576 messages from the queue if they have been there longer than the longest retry
24577 time in any retry rule. If you want to hold messages for longer than the normal
24578 retry times, insert a dummy retry rule with a long retry time.
24579 </para>
24580 <para>
24581 <indexterm role="option">
24582 <primary><option>host_lookup</option></primary>
24583 </indexterm>
24584 </para>
24585 <informaltable frame="all">
24586 <tgroup cols="4" colsep="0" rowsep="0">
24587 <colspec colwidth="8*" align="left"/>
24588 <colspec colwidth="6*" align="center"/>
24589 <colspec colwidth="6*" align="center"/>
24590 <colspec colwidth="6*" align="right"/>
24591 <tbody>
24592 <row>
24593 <entry><option>host_lookup</option></entry>
24594 <entry>Use: <emphasis>main</emphasis></entry>
24595 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
24596 <entry>Default: <emphasis>unset</emphasis></entry>
24597 </row>
24598 </tbody>
24599 </tgroup>
24600 </informaltable>
24601 <para>
24602 <indexterm role="concept">
24603 <primary>host name</primary>
24604 <secondary>lookup, forcing</secondary>
24605 </indexterm>
24606 Exim does not look up the name of a calling host from its IP address unless it
24607 is required to compare against some host list, or the host matches
24608 <option>helo_try_verify_hosts</option> or <option>helo_verify_hosts</option>, or the host matches this
24609 option (which normally contains IP addresses rather than host names). The
24610 default configuration file contains
24611 </para>
24612 <literallayout class="monospaced">
24613 host_lookup = *
24614 </literallayout>
24615 <para>
24616 which causes a lookup to happen for all hosts. If the expense of these lookups
24617 is felt to be too great, the setting can be changed or removed.
24618 </para>
24619 <para>
24620 After a successful reverse lookup, Exim does a forward lookup on the name it
24621 has obtained, to verify that it yields the IP address that it started with. If
24622 this check fails, Exim behaves as if the name lookup failed.
24623 </para>
24624 <para>
24625 <indexterm role="variable">
24626 <primary><varname>$host_lookup_failed</varname></primary>
24627 </indexterm>
24628 <indexterm role="variable">
24629 <primary><varname>$sender_host_name</varname></primary>
24630 </indexterm>
24631 After any kind of failure, the host name (in <varname>$sender_host_name</varname>) remains
24632 unset, and <varname>$host_lookup_failed</varname> is set to the string <quote>1</quote>. See also
24633 <option>dns_again_means_nonexist</option>, <option>helo_lookup_domains</option>, and
24634 <literal>verify = reverse_host_lookup</literal> in ACLs.
24635 </para>
24636 <para>
24637 <indexterm role="option">
24638 <primary><option>host_lookup_order</option></primary>
24639 </indexterm>
24640 </para>
24641 <informaltable frame="all">
24642 <tgroup cols="4" colsep="0" rowsep="0">
24643 <colspec colwidth="8*" align="left"/>
24644 <colspec colwidth="6*" align="center"/>
24645 <colspec colwidth="6*" align="center"/>
24646 <colspec colwidth="6*" align="right"/>
24647 <tbody>
24648 <row>
24649 <entry><option>host_lookup_order</option></entry>
24650 <entry>Use: <emphasis>main</emphasis></entry>
24651 <entry>Type: <emphasis>string list</emphasis></entry>
24652 <entry>Default: <emphasis><literal>bydns:byaddr</literal></emphasis></entry>
24653 </row>
24654 </tbody>
24655 </tgroup>
24656 </informaltable>
24657 <para>
24658 This option specifies the order of different lookup methods when Exim is trying
24659 to find a host name from an IP address. The default is to do a DNS lookup
24660 first, and then to try a local lookup (using <function>gethostbyaddr()</function> or equivalent)
24661 if that fails. You can change the order of these lookups, or omit one entirely,
24662 if you want.
24663 </para>
24664 <para>
24665 <emphasis role="bold">Warning</emphasis>: The <quote>byaddr</quote> method does not always yield aliases when there are
24666 multiple PTR records in the DNS and the IP address is not listed in
24667 <filename>/etc/hosts</filename>. Different operating systems give different results in this
24668 case. That is why the default tries a DNS lookup first.
24669 </para>
24670 <para>
24671 <indexterm role="option">
24672 <primary><option>host_reject_connection</option></primary>
24673 </indexterm>
24674 </para>
24675 <informaltable frame="all">
24676 <tgroup cols="4" colsep="0" rowsep="0">
24677 <colspec colwidth="8*" align="left"/>
24678 <colspec colwidth="6*" align="center"/>
24679 <colspec colwidth="6*" align="center"/>
24680 <colspec colwidth="6*" align="right"/>
24681 <tbody>
24682 <row>
24683 <entry><option>host_reject_connection</option></entry>
24684 <entry>Use: <emphasis>main</emphasis></entry>
24685 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
24686 <entry>Default: <emphasis>unset</emphasis></entry>
24687 </row>
24688 </tbody>
24689 </tgroup>
24690 </informaltable>
24691 <para>
24692 <indexterm role="concept">
24693 <primary>host</primary>
24694 <secondary>rejecting connections from</secondary>
24695 </indexterm>
24696 If this option is set, incoming SMTP calls from the hosts listed are rejected
24697 as soon as the connection is made.
24698 This option is obsolete, and retained only for backward compatibility, because
24699 nowadays the ACL specified by <option>acl_smtp_connect</option> can also reject incoming
24700 connections immediately.
24701 </para>
24702 <para>
24703 The ability to give an immediate rejection (either by this option or using an
24704 ACL) is provided for use in unusual cases. Many hosts will just try again,
24705 sometimes without much delay. Normally, it is better to use an ACL to reject
24706 incoming messages at a later stage, such as after RCPT commands. See
24707 chapter <xref linkend="CHAPACL"/>.
24708 </para>
24709 <para>
24710 <indexterm role="option">
24711 <primary><option>hosts_connection_nolog</option></primary>
24712 </indexterm>
24713 </para>
24714 <informaltable frame="all">
24715 <tgroup cols="4" colsep="0" rowsep="0">
24716 <colspec colwidth="8*" align="left"/>
24717 <colspec colwidth="6*" align="center"/>
24718 <colspec colwidth="6*" align="center"/>
24719 <colspec colwidth="6*" align="right"/>
24720 <tbody>
24721 <row>
24722 <entry><option>hosts_connection_nolog</option></entry>
24723 <entry>Use: <emphasis>main</emphasis></entry>
24724 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
24725 <entry>Default: <emphasis>unset</emphasis></entry>
24726 </row>
24727 </tbody>
24728 </tgroup>
24729 </informaltable>
24730 <para>
24731 <indexterm role="concept">
24732 <primary>host</primary>
24733 <secondary>not logging connections from</secondary>
24734 </indexterm>
24735 This option defines a list of hosts for which connection logging does not
24736 happen, even though the <option>smtp_connection</option> log selector is set. For example,
24737 you might want not to log SMTP connections from local processes, or from
24738 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
24739 the daemon; you should therefore strive to restrict its value to a short inline
24740 list of IP addresses and networks. To disable logging SMTP connections from
24741 local processes, you must create a host list with an empty item. For example:
24742 </para>
24743 <literallayout class="monospaced">
24744 hosts_connection_nolog = :
24745 </literallayout>
24746 <para>
24747 If the <option>smtp_connection</option> log selector is not set, this option has no effect.
24748 </para>
24749 <para>
24750 <indexterm role="option">
24751 <primary><option>hosts_treat_as_local</option></primary>
24752 </indexterm>
24753 </para>
24754 <informaltable frame="all">
24755 <tgroup cols="4" colsep="0" rowsep="0">
24756 <colspec colwidth="8*" align="left"/>
24757 <colspec colwidth="6*" align="center"/>
24758 <colspec colwidth="6*" align="center"/>
24759 <colspec colwidth="6*" align="right"/>
24760 <tbody>
24761 <row>
24762 <entry><option>hosts_treat_as_local</option></entry>
24763 <entry>Use: <emphasis>main</emphasis></entry>
24764 <entry>Type: <emphasis>domain list</emphasis>&dagger;<emphasis></emphasis></entry>
24765 <entry>Default: <emphasis>unset</emphasis></entry>
24766 </row>
24767 </tbody>
24768 </tgroup>
24769 </informaltable>
24770 <para>
24771 <indexterm role="concept">
24772 <primary>local host</primary>
24773 <secondary>domains treated as</secondary>
24774 </indexterm>
24775 <indexterm role="concept">
24776 <primary>host</primary>
24777 <secondary>treated as local</secondary>
24778 </indexterm>
24779 If this option is set, any host names that match the domain list are treated as
24780 if they were the local host when Exim is scanning host lists obtained from MX
24781 records
24782 or other sources. Note that the value of this option is a domain list, not a
24783 host list, because it is always used to check host names, not IP addresses.
24784 </para>
24785 <para>
24786 This option also applies when Exim is matching the special items
24787 <literal>@mx_any</literal>, <literal>@mx_primary</literal>, and <literal>@mx_secondary</literal> in a domain list (see
24788 section <xref linkend="SECTdomainlist"/>), and when checking the <option>hosts</option> option in the
24789 <command>smtp</command> transport for the local host (see the <option>allow_localhost</option> option in
24790 that transport). See also <option>local_interfaces</option>, <option>extra_local_interfaces</option>, and
24791 chapter <xref linkend="CHAPinterfaces"/>, which contains a discussion about local network
24792 interfaces and recognizing the local host.
24793 </para>
24794 <para>
24795 <indexterm role="option">
24796 <primary><option>ibase_servers</option></primary>
24797 </indexterm>
24798 </para>
24799 <informaltable frame="all">
24800 <tgroup cols="4" colsep="0" rowsep="0">
24801 <colspec colwidth="8*" align="left"/>
24802 <colspec colwidth="6*" align="center"/>
24803 <colspec colwidth="6*" align="center"/>
24804 <colspec colwidth="6*" align="right"/>
24805 <tbody>
24806 <row>
24807 <entry><option>ibase_servers</option></entry>
24808 <entry>Use: <emphasis>main</emphasis></entry>
24809 <entry>Type: <emphasis>string list</emphasis></entry>
24810 <entry>Default: <emphasis>unset</emphasis></entry>
24811 </row>
24812 </tbody>
24813 </tgroup>
24814 </informaltable>
24815 <para>
24816 <indexterm role="concept">
24817 <primary>InterBase</primary>
24818 <secondary>server list</secondary>
24819 </indexterm>
24820 This option provides a list of InterBase servers and associated connection data,
24821 to be used in conjunction with <command>ibase</command> lookups (see section <xref linkend="SECID72"/>).
24822 The option is available only if Exim has been built with InterBase support.
24823 </para>
24824 <para>
24825 <indexterm role="option">
24826 <primary><option>ignore_bounce_errors_after</option></primary>
24827 </indexterm>
24828 </para>
24829 <informaltable frame="all">
24830 <tgroup cols="4" colsep="0" rowsep="0">
24831 <colspec colwidth="8*" align="left"/>
24832 <colspec colwidth="6*" align="center"/>
24833 <colspec colwidth="6*" align="center"/>
24834 <colspec colwidth="6*" align="right"/>
24835 <tbody>
24836 <row>
24837 <entry><option>ignore_bounce_errors_after</option></entry>
24838 <entry>Use: <emphasis>main</emphasis></entry>
24839 <entry>Type: <emphasis>time</emphasis></entry>
24840 <entry>Default: <emphasis>10w</emphasis></entry>
24841 </row>
24842 </tbody>
24843 </tgroup>
24844 </informaltable>
24845 <para>
24846 <indexterm role="concept">
24847 <primary>bounce message</primary>
24848 <secondary>discarding</secondary>
24849 </indexterm>
24850 <indexterm role="concept">
24851 <primary>discarding bounce message</primary>
24852 </indexterm>
24853 This option affects the processing of bounce messages that cannot be delivered,
24854 that is, those that suffer a permanent delivery failure. (Bounce messages that
24855 suffer temporary delivery failures are of course retried in the usual way.)
24856 </para>
24857 <para>
24858 After a permanent delivery failure, bounce messages are frozen,
24859 because there is no sender to whom they can be returned. When a frozen bounce
24860 message has been on the queue for more than the given time, it is unfrozen at
24861 the next queue run, and a further delivery is attempted. If delivery fails
24862 again, the bounce message is discarded. This makes it possible to keep failed
24863 bounce messages around for a shorter time than the normal maximum retry time
24864 for frozen messages. For example,
24865 </para>
24866 <literallayout class="monospaced">
24867 ignore_bounce_errors_after = 12h
24868 </literallayout>
24869 <para>
24870 retries failed bounce message deliveries after 12 hours, discarding any further
24871 failures. If the value of this option is set to a zero time period, bounce
24872 failures are discarded immediately. Setting a very long time (as in the default
24873 value) has the effect of disabling this option. For ways of automatically
24874 dealing with other kinds of frozen message, see <option>auto_thaw</option> and
24875 <option>timeout_frozen_after</option>.
24876 </para>
24877 <para>
24878 <indexterm role="option">
24879 <primary><option>ignore_fromline_hosts</option></primary>
24880 </indexterm>
24881 </para>
24882 <informaltable frame="all">
24883 <tgroup cols="4" colsep="0" rowsep="0">
24884 <colspec colwidth="8*" align="left"/>
24885 <colspec colwidth="6*" align="center"/>
24886 <colspec colwidth="6*" align="center"/>
24887 <colspec colwidth="6*" align="right"/>
24888 <tbody>
24889 <row>
24890 <entry><option>ignore_fromline_hosts</option></entry>
24891 <entry>Use: <emphasis>main</emphasis></entry>
24892 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
24893 <entry>Default: <emphasis>unset</emphasis></entry>
24894 </row>
24895 </tbody>
24896 </tgroup>
24897 </informaltable>
24898 <para>
24899 <indexterm role="concept">
24900 <primary><quote>From</quote> line</primary>
24901 </indexterm>
24902 <indexterm role="concept">
24903 <primary>UUCP</primary>
24904 <secondary><quote>From</quote> line</secondary>
24905 </indexterm>
24906 Some broken SMTP clients insist on sending a UUCP-like <quote>From&nbsp;</quote> line before
24907 the headers of a message. By default this is treated as the start of the
24908 message&#x2019;s body, which means that any following headers are not recognized as
24909 such. Exim can be made to ignore it by setting <option>ignore_fromline_hosts</option> to
24910 match those hosts that insist on sending it. If the sender is actually a local
24911 process rather than a remote host, and is using <option>-bs</option> to inject the messages,
24912 <option>ignore_fromline_local</option> must be set to achieve this effect.
24913 </para>
24914 <para>
24915 <indexterm role="option">
24916 <primary><option>ignore_fromline_local</option></primary>
24917 </indexterm>
24918 </para>
24919 <informaltable frame="all">
24920 <tgroup cols="4" colsep="0" rowsep="0">
24921 <colspec colwidth="8*" align="left"/>
24922 <colspec colwidth="6*" align="center"/>
24923 <colspec colwidth="6*" align="center"/>
24924 <colspec colwidth="6*" align="right"/>
24925 <tbody>
24926 <row>
24927 <entry><option>ignore_fromline_local</option></entry>
24928 <entry>Use: <emphasis>main</emphasis></entry>
24929 <entry>Type: <emphasis>boolean</emphasis></entry>
24930 <entry>Default: <emphasis>false</emphasis></entry>
24931 </row>
24932 </tbody>
24933 </tgroup>
24934 </informaltable>
24935 <para>
24936 See <option>ignore_fromline_hosts</option> above.
24937 </para>
24938 <para>
24939 <indexterm role="option">
24940 <primary><option>keep_malformed</option></primary>
24941 </indexterm>
24942 </para>
24943 <informaltable frame="all">
24944 <tgroup cols="4" colsep="0" rowsep="0">
24945 <colspec colwidth="8*" align="left"/>
24946 <colspec colwidth="6*" align="center"/>
24947 <colspec colwidth="6*" align="center"/>
24948 <colspec colwidth="6*" align="right"/>
24949 <tbody>
24950 <row>
24951 <entry><option>keep_malformed</option></entry>
24952 <entry>Use: <emphasis>main</emphasis></entry>
24953 <entry>Type: <emphasis>time</emphasis></entry>
24954 <entry>Default: <emphasis>4d</emphasis></entry>
24955 </row>
24956 </tbody>
24957 </tgroup>
24958 </informaltable>
24959 <para>
24960 This option specifies the length of time to keep messages whose spool files
24961 have been corrupted in some way. This should, of course, never happen. At the
24962 next attempt to deliver such a message, it gets removed. The incident is
24963 logged.
24964 </para>
24965 <para>
24966 <indexterm role="option">
24967 <primary><option>ldap_ca_cert_dir</option></primary>
24968 </indexterm>
24969 </para>
24970 <informaltable frame="all">
24971 <tgroup cols="4" colsep="0" rowsep="0">
24972 <colspec colwidth="8*" align="left"/>
24973 <colspec colwidth="6*" align="center"/>
24974 <colspec colwidth="6*" align="center"/>
24975 <colspec colwidth="6*" align="right"/>
24976 <tbody>
24977 <row>
24978 <entry><option>ldap_ca_cert_dir</option></entry>
24979 <entry>Use: <emphasis>main</emphasis></entry>
24980 <entry>Type: <emphasis>string</emphasis></entry>
24981 <entry>Default: <emphasis>unset</emphasis></entry>
24982 </row>
24983 </tbody>
24984 </tgroup>
24985 </informaltable>
24986 <para>
24987 <indexterm role="concept">
24988 <primary>LDAP</primary>
24989 <secondary>,</secondary>
24990 </indexterm>
24991 This option indicates which directory contains CA certificates for verifying
24992 a TLS certificate presented by an LDAP server.
24993 While Exim does not provide a default value, your SSL library may.
24994 Analogous to <option>tls_verify_certificates</option> but as a client-side option for LDAP
24995 and constrained to be a directory.
24996 </para>
24997 <para>
24998 <indexterm role="option">
24999 <primary><option>ldap_ca_cert_file</option></primary>
25000 </indexterm>
25001 </para>
25002 <informaltable frame="all">
25003 <tgroup cols="4" colsep="0" rowsep="0">
25004 <colspec colwidth="8*" align="left"/>
25005 <colspec colwidth="6*" align="center"/>
25006 <colspec colwidth="6*" align="center"/>
25007 <colspec colwidth="6*" align="right"/>
25008 <tbody>
25009 <row>
25010 <entry><option>ldap_ca_cert_file</option></entry>
25011 <entry>Use: <emphasis>main</emphasis></entry>
25012 <entry>Type: <emphasis>string</emphasis></entry>
25013 <entry>Default: <emphasis>unset</emphasis></entry>
25014 </row>
25015 </tbody>
25016 </tgroup>
25017 </informaltable>
25018 <para>
25019 <indexterm role="concept">
25020 <primary>LDAP</primary>
25021 <secondary>,</secondary>
25022 </indexterm>
25023 This option indicates which file contains CA certificates for verifying
25024 a TLS certificate presented by an LDAP server.
25025 While Exim does not provide a default value, your SSL library may.
25026 Analogous to <option>tls_verify_certificates</option> but as a client-side option for LDAP
25027 and constrained to be a file.
25028 </para>
25029 <para>
25030 <indexterm role="option">
25031 <primary><option>ldap_cert_file</option></primary>
25032 </indexterm>
25033 </para>
25034 <informaltable frame="all">
25035 <tgroup cols="4" colsep="0" rowsep="0">
25036 <colspec colwidth="8*" align="left"/>
25037 <colspec colwidth="6*" align="center"/>
25038 <colspec colwidth="6*" align="center"/>
25039 <colspec colwidth="6*" align="right"/>
25040 <tbody>
25041 <row>
25042 <entry><option>ldap_cert_file</option></entry>
25043 <entry>Use: <emphasis>main</emphasis></entry>
25044 <entry>Type: <emphasis>string</emphasis></entry>
25045 <entry>Default: <emphasis>unset</emphasis></entry>
25046 </row>
25047 </tbody>
25048 </tgroup>
25049 </informaltable>
25050 <para>
25051 <indexterm role="concept">
25052 <primary>LDAP</primary>
25053 <secondary>TLS client certificate file</secondary>
25054 </indexterm>
25055 This option indicates which file contains an TLS client certificate which
25056 Exim should present to the LDAP server during TLS negotiation.
25057 Should be used together with <option>ldap_cert_key</option>.
25058 </para>
25059 <para>
25060 <indexterm role="option">
25061 <primary><option>ldap_cert_key</option></primary>
25062 </indexterm>
25063 </para>
25064 <informaltable frame="all">
25065 <tgroup cols="4" colsep="0" rowsep="0">
25066 <colspec colwidth="8*" align="left"/>
25067 <colspec colwidth="6*" align="center"/>
25068 <colspec colwidth="6*" align="center"/>
25069 <colspec colwidth="6*" align="right"/>
25070 <tbody>
25071 <row>
25072 <entry><option>ldap_cert_key</option></entry>
25073 <entry>Use: <emphasis>main</emphasis></entry>
25074 <entry>Type: <emphasis>string</emphasis></entry>
25075 <entry>Default: <emphasis>unset</emphasis></entry>
25076 </row>
25077 </tbody>
25078 </tgroup>
25079 </informaltable>
25080 <para>
25081 <indexterm role="concept">
25082 <primary>LDAP</primary>
25083 <secondary>TLS client key file</secondary>
25084 </indexterm>
25085 This option indicates which file contains the secret/private key to use
25086 to prove identity to the LDAP server during TLS negotiation.
25087 Should be used together with <option>ldap_cert_file</option>, which contains the
25088 identity to be proven.
25089 </para>
25090 <para>
25091 <indexterm role="option">
25092 <primary><option>ldap_cipher_suite</option></primary>
25093 </indexterm>
25094 </para>
25095 <informaltable frame="all">
25096 <tgroup cols="4" colsep="0" rowsep="0">
25097 <colspec colwidth="8*" align="left"/>
25098 <colspec colwidth="6*" align="center"/>
25099 <colspec colwidth="6*" align="center"/>
25100 <colspec colwidth="6*" align="right"/>
25101 <tbody>
25102 <row>
25103 <entry><option>ldap_cipher_suite</option></entry>
25104 <entry>Use: <emphasis>main</emphasis></entry>
25105 <entry>Type: <emphasis>string</emphasis></entry>
25106 <entry>Default: <emphasis>unset</emphasis></entry>
25107 </row>
25108 </tbody>
25109 </tgroup>
25110 </informaltable>
25111 <para>
25112 <indexterm role="concept">
25113 <primary>LDAP</primary>
25114 <secondary>TLS cipher suite</secondary>
25115 </indexterm>
25116 This controls the TLS cipher-suite negotiation during TLS negotiation with
25117 the LDAP server.  See <xref linkend="SECTreqciphssl"/> for more details of the format of
25118 cipher-suite options with OpenSSL (as used by LDAP client libraries).
25119 </para>
25120 <para>
25121 <indexterm role="option">
25122 <primary><option>ldap_default_servers</option></primary>
25123 </indexterm>
25124 </para>
25125 <informaltable frame="all">
25126 <tgroup cols="4" colsep="0" rowsep="0">
25127 <colspec colwidth="8*" align="left"/>
25128 <colspec colwidth="6*" align="center"/>
25129 <colspec colwidth="6*" align="center"/>
25130 <colspec colwidth="6*" align="right"/>
25131 <tbody>
25132 <row>
25133 <entry><option>ldap_default_servers</option></entry>
25134 <entry>Use: <emphasis>main</emphasis></entry>
25135 <entry>Type: <emphasis>string list</emphasis></entry>
25136 <entry>Default: <emphasis>unset</emphasis></entry>
25137 </row>
25138 </tbody>
25139 </tgroup>
25140 </informaltable>
25141 <para>
25142 <indexterm role="concept">
25143 <primary>LDAP</primary>
25144 <secondary>default servers</secondary>
25145 </indexterm>
25146 This option provides a list of LDAP servers which are tried in turn when an
25147 LDAP query does not contain a server. See section <xref linkend="SECTforldaque"/> for
25148 details of LDAP queries. This option is available only when Exim has been built
25149 with LDAP support.
25150 </para>
25151 <para>
25152 <indexterm role="option">
25153 <primary><option>ldap_require_cert</option></primary>
25154 </indexterm>
25155 </para>
25156 <informaltable frame="all">
25157 <tgroup cols="4" colsep="0" rowsep="0">
25158 <colspec colwidth="8*" align="left"/>
25159 <colspec colwidth="6*" align="center"/>
25160 <colspec colwidth="6*" align="center"/>
25161 <colspec colwidth="6*" align="right"/>
25162 <tbody>
25163 <row>
25164 <entry><option>ldap_require_cert</option></entry>
25165 <entry>Use: <emphasis>main</emphasis></entry>
25166 <entry>Type: <emphasis>string</emphasis></entry>
25167 <entry>Default: <emphasis>unset.</emphasis></entry>
25168 </row>
25169 </tbody>
25170 </tgroup>
25171 </informaltable>
25172 <para>
25173 <indexterm role="concept">
25174 <primary>LDAP</primary>
25175 <secondary>policy for LDAP server TLS cert presentation</secondary>
25176 </indexterm>
25177 This should be one of the values "hard", "demand", "allow", "try" or "never".
25178 A value other than one of these is interpreted as "never".
25179 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
25180 Although Exim does not set a default, the LDAP library probably defaults
25181 to hard/demand.
25182 </para>
25183 <para>
25184 <indexterm role="option">
25185 <primary><option>ldap_start_tls</option></primary>
25186 </indexterm>
25187 </para>
25188 <informaltable frame="all">
25189 <tgroup cols="4" colsep="0" rowsep="0">
25190 <colspec colwidth="8*" align="left"/>
25191 <colspec colwidth="6*" align="center"/>
25192 <colspec colwidth="6*" align="center"/>
25193 <colspec colwidth="6*" align="right"/>
25194 <tbody>
25195 <row>
25196 <entry><option>ldap_start_tls</option></entry>
25197 <entry>Use: <emphasis>main</emphasis></entry>
25198 <entry>Type: <emphasis>boolean</emphasis></entry>
25199 <entry>Default: <emphasis>false</emphasis></entry>
25200 </row>
25201 </tbody>
25202 </tgroup>
25203 </informaltable>
25204 <para>
25205 <indexterm role="concept">
25206 <primary>LDAP</primary>
25207 <secondary>whether or not to negotiate TLS</secondary>
25208 </indexterm>
25209 If set, Exim will attempt to negotiate TLS with the LDAP server when
25210 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP&#x2019;s
25211 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
25212 of SSL-on-connect.
25213 In the event of failure to negotiate TLS, the action taken is controlled
25214 by <option>ldap_require_cert</option>.
25215 </para>
25216 <para>
25217 <indexterm role="option">
25218 <primary><option>ldap_version</option></primary>
25219 </indexterm>
25220 </para>
25221 <informaltable frame="all">
25222 <tgroup cols="4" colsep="0" rowsep="0">
25223 <colspec colwidth="8*" align="left"/>
25224 <colspec colwidth="6*" align="center"/>
25225 <colspec colwidth="6*" align="center"/>
25226 <colspec colwidth="6*" align="right"/>
25227 <tbody>
25228 <row>
25229 <entry><option>ldap_version</option></entry>
25230 <entry>Use: <emphasis>main</emphasis></entry>
25231 <entry>Type: <emphasis>integer</emphasis></entry>
25232 <entry>Default: <emphasis>unset</emphasis></entry>
25233 </row>
25234 </tbody>
25235 </tgroup>
25236 </informaltable>
25237 <para>
25238 <indexterm role="concept">
25239 <primary>LDAP</primary>
25240 <secondary>protocol version, forcing</secondary>
25241 </indexterm>
25242 This option can be used to force Exim to set a specific protocol version for
25243 LDAP. If it option is unset, it is shown by the <option>-bP</option> command line option as
25244 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
25245 the LDAP headers; otherwise it is 2. This option is available only when Exim
25246 has been built with LDAP support.
25247 </para>
25248 <para>
25249 <indexterm role="option">
25250 <primary><option>local_from_check</option></primary>
25251 </indexterm>
25252 </para>
25253 <informaltable frame="all">
25254 <tgroup cols="4" colsep="0" rowsep="0">
25255 <colspec colwidth="8*" align="left"/>
25256 <colspec colwidth="6*" align="center"/>
25257 <colspec colwidth="6*" align="center"/>
25258 <colspec colwidth="6*" align="right"/>
25259 <tbody>
25260 <row>
25261 <entry><option>local_from_check</option></entry>
25262 <entry>Use: <emphasis>main</emphasis></entry>
25263 <entry>Type: <emphasis>boolean</emphasis></entry>
25264 <entry>Default: <emphasis>true</emphasis></entry>
25265 </row>
25266 </tbody>
25267 </tgroup>
25268 </informaltable>
25269 <para>
25270 <indexterm role="concept">
25271 <primary><emphasis>Sender:</emphasis> header line</primary>
25272 <secondary>disabling addition of</secondary>
25273 </indexterm>
25274 <indexterm role="concept">
25275 <primary><emphasis>From:</emphasis> header line</primary>
25276 <secondary>disabling checking of</secondary>
25277 </indexterm>
25278 When a message is submitted locally (that is, not over a TCP/IP connection) by
25279 an untrusted user, Exim removes any existing <emphasis>Sender:</emphasis> header line, and
25280 checks that the <emphasis>From:</emphasis> header line matches the login of the calling user and
25281 the domain specified by <option>qualify_domain</option>.
25282 </para>
25283 <para>
25284 <emphasis role="bold">Note</emphasis>: An unqualified address (no domain) in the <emphasis>From:</emphasis> header in a
25285 locally submitted message is automatically qualified by Exim, unless the
25286 <option>-bnq</option> command line option is used.
25287 </para>
25288 <para>
25289 You can use <option>local_from_prefix</option> and <option>local_from_suffix</option> to permit affixes
25290 on the local part. If the <emphasis>From:</emphasis> header line does not match, Exim adds a
25291 <emphasis>Sender:</emphasis> header with an address constructed from the calling user&#x2019;s login
25292 and the default qualify domain.
25293 </para>
25294 <para>
25295 If <option>local_from_check</option> is set false, the <emphasis>From:</emphasis> header check is disabled,
25296 and no <emphasis>Sender:</emphasis> header is ever added. If, in addition, you want to retain
25297 <emphasis>Sender:</emphasis> header lines supplied by untrusted users, you must also set
25298 <option>local_sender_retain</option> to be true.
25299 </para>
25300 <para>
25301 <indexterm role="concept">
25302 <primary>envelope sender</primary>
25303 </indexterm>
25304 These options affect only the header lines in the message. The envelope sender
25305 is still forced to be the login id at the qualify domain unless
25306 <option>untrusted_set_sender</option> permits the user to supply an envelope sender.
25307 </para>
25308 <para>
25309 For messages received over TCP/IP, an ACL can specify <quote>submission mode</quote> to
25310 request similar header line checking. See section <xref linkend="SECTthesenhea"/>, which
25311 has more details about <emphasis>Sender:</emphasis> processing.
25312 </para>
25313 <para>
25314 <indexterm role="option">
25315 <primary><option>local_from_prefix</option></primary>
25316 </indexterm>
25317 </para>
25318 <informaltable frame="all">
25319 <tgroup cols="4" colsep="0" rowsep="0">
25320 <colspec colwidth="8*" align="left"/>
25321 <colspec colwidth="6*" align="center"/>
25322 <colspec colwidth="6*" align="center"/>
25323 <colspec colwidth="6*" align="right"/>
25324 <tbody>
25325 <row>
25326 <entry><option>local_from_prefix</option></entry>
25327 <entry>Use: <emphasis>main</emphasis></entry>
25328 <entry>Type: <emphasis>string</emphasis></entry>
25329 <entry>Default: <emphasis>unset</emphasis></entry>
25330 </row>
25331 </tbody>
25332 </tgroup>
25333 </informaltable>
25334 <para>
25335 When Exim checks the <emphasis>From:</emphasis> header line of locally submitted messages for
25336 matching the login id (see <option>local_from_check</option> above), it can be configured to
25337 ignore certain prefixes and suffixes in the local part of the address. This is
25338 done by setting <option>local_from_prefix</option> and/or <option>local_from_suffix</option> to
25339 appropriate lists, in the same form as the <option>local_part_prefix</option> and
25340 <option>local_part_suffix</option> router options (see chapter <xref linkend="CHAProutergeneric"/>). For
25341 example, if
25342 </para>
25343 <literallayout class="monospaced">
25344 local_from_prefix = *-
25345 </literallayout>
25346 <para>
25347 is set, a <emphasis>From:</emphasis> line containing
25348 </para>
25349 <literallayout class="monospaced">
25350 From: anything-user@your.domain.example
25351 </literallayout>
25352 <para>
25353 will not cause a <emphasis>Sender:</emphasis> header to be added if <emphasis>user@your.domain.example</emphasis>
25354 matches the actual sender address that is constructed from the login name and
25355 qualify domain.
25356 </para>
25357 <para>
25358 <indexterm role="option">
25359 <primary><option>local_from_suffix</option></primary>
25360 </indexterm>
25361 </para>
25362 <informaltable frame="all">
25363 <tgroup cols="4" colsep="0" rowsep="0">
25364 <colspec colwidth="8*" align="left"/>
25365 <colspec colwidth="6*" align="center"/>
25366 <colspec colwidth="6*" align="center"/>
25367 <colspec colwidth="6*" align="right"/>
25368 <tbody>
25369 <row>
25370 <entry><option>local_from_suffix</option></entry>
25371 <entry>Use: <emphasis>main</emphasis></entry>
25372 <entry>Type: <emphasis>string</emphasis></entry>
25373 <entry>Default: <emphasis>unset</emphasis></entry>
25374 </row>
25375 </tbody>
25376 </tgroup>
25377 </informaltable>
25378 <para>
25379 See <option>local_from_prefix</option> above.
25380 </para>
25381 <para>
25382 <indexterm role="option">
25383 <primary><option>local_interfaces</option></primary>
25384 </indexterm>
25385 </para>
25386 <informaltable frame="all">
25387 <tgroup cols="4" colsep="0" rowsep="0">
25388 <colspec colwidth="8*" align="left"/>
25389 <colspec colwidth="6*" align="center"/>
25390 <colspec colwidth="6*" align="center"/>
25391 <colspec colwidth="6*" align="right"/>
25392 <tbody>
25393 <row>
25394 <entry><option>local_interfaces</option></entry>
25395 <entry>Use: <emphasis>main</emphasis></entry>
25396 <entry>Type: <emphasis>string list</emphasis></entry>
25397 <entry>Default: <emphasis>see below</emphasis></entry>
25398 </row>
25399 </tbody>
25400 </tgroup>
25401 </informaltable>
25402 <para>
25403 This option controls which network interfaces are used by the daemon for
25404 listening; they are also used to identify the local host when routing. Chapter
25405 <xref linkend="CHAPinterfaces"/> contains a full description of this option and the related
25406 options <option>daemon_smtp_ports</option>, <option>extra_local_interfaces</option>,
25407 <option>hosts_treat_as_local</option>, and <option>tls_on_connect_ports</option>. The default value for
25408 <option>local_interfaces</option> is
25409 </para>
25410 <literallayout class="monospaced">
25411 local_interfaces = 0.0.0.0
25412 </literallayout>
25413 <para>
25414 when Exim is built without IPv6 support; otherwise it is
25415 </para>
25416 <literallayout class="monospaced">
25417 local_interfaces = &lt;; ::0 ; 0.0.0.0
25418 </literallayout>
25419 <para>
25420 <indexterm role="option">
25421 <primary><option>local_scan_timeout</option></primary>
25422 </indexterm>
25423 </para>
25424 <informaltable frame="all">
25425 <tgroup cols="4" colsep="0" rowsep="0">
25426 <colspec colwidth="8*" align="left"/>
25427 <colspec colwidth="6*" align="center"/>
25428 <colspec colwidth="6*" align="center"/>
25429 <colspec colwidth="6*" align="right"/>
25430 <tbody>
25431 <row>
25432 <entry><option>local_scan_timeout</option></entry>
25433 <entry>Use: <emphasis>main</emphasis></entry>
25434 <entry>Type: <emphasis>time</emphasis></entry>
25435 <entry>Default: <emphasis>5m</emphasis></entry>
25436 </row>
25437 </tbody>
25438 </tgroup>
25439 </informaltable>
25440 <para>
25441 <indexterm role="concept">
25442 <primary>timeout</primary>
25443 <secondary>for <function>local_scan()</function> function</secondary>
25444 </indexterm>
25445 <indexterm role="concept">
25446 <primary><function>local_scan()</function> function</primary>
25447 <secondary>timeout</secondary>
25448 </indexterm>
25449 This timeout applies to the <function>local_scan()</function> function (see chapter
25450 <xref linkend="CHAPlocalscan"/>). Zero means <quote>no timeout</quote>. If the timeout is exceeded,
25451 the incoming message is rejected with a temporary error if it is an SMTP
25452 message. For a non-SMTP message, the message is dropped and Exim ends with a
25453 non-zero code. The incident is logged on the main and reject logs.
25454 </para>
25455 <para>
25456 <indexterm role="option">
25457 <primary><option>local_sender_retain</option></primary>
25458 </indexterm>
25459 </para>
25460 <informaltable frame="all">
25461 <tgroup cols="4" colsep="0" rowsep="0">
25462 <colspec colwidth="8*" align="left"/>
25463 <colspec colwidth="6*" align="center"/>
25464 <colspec colwidth="6*" align="center"/>
25465 <colspec colwidth="6*" align="right"/>
25466 <tbody>
25467 <row>
25468 <entry><option>local_sender_retain</option></entry>
25469 <entry>Use: <emphasis>main</emphasis></entry>
25470 <entry>Type: <emphasis>boolean</emphasis></entry>
25471 <entry>Default: <emphasis>false</emphasis></entry>
25472 </row>
25473 </tbody>
25474 </tgroup>
25475 </informaltable>
25476 <para>
25477 <indexterm role="concept">
25478 <primary><emphasis>Sender:</emphasis> header line</primary>
25479 <secondary>retaining from local submission</secondary>
25480 </indexterm>
25481 When a message is submitted locally (that is, not over a TCP/IP connection) by
25482 an untrusted user, Exim removes any existing <emphasis>Sender:</emphasis> header line. If you
25483 do not want this to happen, you must set <option>local_sender_retain</option>, and you must
25484 also set <option>local_from_check</option> to be false (Exim will complain if you do not).
25485 See also the ACL modifier <literal>control = suppress_local_fixups</literal>. Section
25486 <xref linkend="SECTthesenhea"/> has more details about <emphasis>Sender:</emphasis> processing.
25487 </para>
25488 <para>
25489 <indexterm role="option">
25490 <primary><option>localhost_number</option></primary>
25491 </indexterm>
25492 </para>
25493 <informaltable frame="all">
25494 <tgroup cols="4" colsep="0" rowsep="0">
25495 <colspec colwidth="8*" align="left"/>
25496 <colspec colwidth="6*" align="center"/>
25497 <colspec colwidth="6*" align="center"/>
25498 <colspec colwidth="6*" align="right"/>
25499 <tbody>
25500 <row>
25501 <entry><option>localhost_number</option></entry>
25502 <entry>Use: <emphasis>main</emphasis></entry>
25503 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
25504 <entry>Default: <emphasis>unset</emphasis></entry>
25505 </row>
25506 </tbody>
25507 </tgroup>
25508 </informaltable>
25509 <para>
25510 <indexterm role="concept">
25511 <primary>host</primary>
25512 <secondary>locally unique number for</secondary>
25513 </indexterm>
25514 <indexterm role="concept">
25515 <primary>message ids</primary>
25516 <secondary>with multiple hosts</secondary>
25517 </indexterm>
25518 <indexterm role="variable">
25519 <primary><varname>$localhost_number</varname></primary>
25520 </indexterm>
25521 Exim&#x2019;s message ids are normally unique only within the local host. If
25522 uniqueness among a set of hosts is required, each host must set a different
25523 value for the <option>localhost_number</option> option. The string is expanded immediately
25524 after reading the configuration file (so that a number can be computed from the
25525 host name, for example) and the result of the expansion must be a number in the
25526 range 0&ndash;16 (or 0&ndash;10 on operating systems with case-insensitive file
25527 systems). This is available in subsequent string expansions via the variable
25528 <varname>$localhost_number</varname>. When <option>localhost_number is set</option>, the final two
25529 characters of the message id, instead of just being a fractional part of the
25530 time, are computed from the time and the local host number as described in
25531 section <xref linkend="SECTmessiden"/>.
25532 </para>
25533 <para>
25534 <indexterm role="option">
25535 <primary><option>log_file_path</option></primary>
25536 </indexterm>
25537 </para>
25538 <informaltable frame="all">
25539 <tgroup cols="4" colsep="0" rowsep="0">
25540 <colspec colwidth="8*" align="left"/>
25541 <colspec colwidth="6*" align="center"/>
25542 <colspec colwidth="6*" align="center"/>
25543 <colspec colwidth="6*" align="right"/>
25544 <tbody>
25545 <row>
25546 <entry><option>log_file_path</option></entry>
25547 <entry>Use: <emphasis>main</emphasis></entry>
25548 <entry>Type: <emphasis>string list</emphasis>&dagger;<emphasis></emphasis></entry>
25549 <entry>Default: <emphasis>set at compile time</emphasis></entry>
25550 </row>
25551 </tbody>
25552 </tgroup>
25553 </informaltable>
25554 <para>
25555 <indexterm role="concept">
25556 <primary>log</primary>
25557 <secondary>file path for</secondary>
25558 </indexterm>
25559 This option sets the path which is used to determine the names of Exim&#x2019;s log
25560 files, or indicates that logging is to be to syslog, or both. It is expanded
25561 when Exim is entered, so it can, for example, contain a reference to the host
25562 name. If no specific path is set for the log files at compile or run time, they
25563 are written in a sub-directory called <filename>log</filename> in Exim&#x2019;s spool directory.
25564 Chapter <xref linkend="CHAPlog"/> contains further details about Exim&#x2019;s logging, and
25565 section <xref linkend="SECTwhelogwri"/> describes how the contents of <option>log_file_path</option> are
25566 used. If this string is fixed at your installation (contains no expansion
25567 variables) it is recommended that you do not set this option in the
25568 configuration file, but instead supply the path using LOG_FILE_PATH in
25569 <filename>Local/Makefile</filename> so that it is available to Exim for logging errors detected
25570 early on &ndash; in particular, failure to read the configuration file.
25571 </para>
25572 <para>
25573 <indexterm role="option">
25574 <primary><option>log_selector</option></primary>
25575 </indexterm>
25576 </para>
25577 <informaltable frame="all">
25578 <tgroup cols="4" colsep="0" rowsep="0">
25579 <colspec colwidth="8*" align="left"/>
25580 <colspec colwidth="6*" align="center"/>
25581 <colspec colwidth="6*" align="center"/>
25582 <colspec colwidth="6*" align="right"/>
25583 <tbody>
25584 <row>
25585 <entry><option>log_selector</option></entry>
25586 <entry>Use: <emphasis>main</emphasis></entry>
25587 <entry>Type: <emphasis>string</emphasis></entry>
25588 <entry>Default: <emphasis>unset</emphasis></entry>
25589 </row>
25590 </tbody>
25591 </tgroup>
25592 </informaltable>
25593 <para>
25594 <indexterm role="concept">
25595 <primary>log</primary>
25596 <secondary>selectors</secondary>
25597 </indexterm>
25598 This option can be used to reduce or increase the number of things that Exim
25599 writes to its log files. Its argument is made up of names preceded by plus or
25600 minus characters. For example:
25601 </para>
25602 <literallayout class="monospaced">
25603 log_selector = +arguments -retry_defer
25604 </literallayout>
25605 <para>
25606 A list of possible names and what they control is given in the chapter on
25607 logging, in section <xref linkend="SECTlogselector"/>.
25608 </para>
25609 <para>
25610 <indexterm role="option">
25611 <primary><option>log_timezone</option></primary>
25612 </indexterm>
25613 </para>
25614 <informaltable frame="all">
25615 <tgroup cols="4" colsep="0" rowsep="0">
25616 <colspec colwidth="8*" align="left"/>
25617 <colspec colwidth="6*" align="center"/>
25618 <colspec colwidth="6*" align="center"/>
25619 <colspec colwidth="6*" align="right"/>
25620 <tbody>
25621 <row>
25622 <entry><option>log_timezone</option></entry>
25623 <entry>Use: <emphasis>main</emphasis></entry>
25624 <entry>Type: <emphasis>boolean</emphasis></entry>
25625 <entry>Default: <emphasis>false</emphasis></entry>
25626 </row>
25627 </tbody>
25628 </tgroup>
25629 </informaltable>
25630 <para>
25631 <indexterm role="concept">
25632 <primary>log</primary>
25633 <secondary>timezone for entries</secondary>
25634 </indexterm>
25635 <indexterm role="variable">
25636 <primary><varname>$tod_log</varname></primary>
25637 </indexterm>
25638 <indexterm role="variable">
25639 <primary><varname>$tod_zone</varname></primary>
25640 </indexterm>
25641 By default, the timestamps on log lines are in local time without the
25642 timezone. This means that if your timezone changes twice a year, the timestamps
25643 in log lines are ambiguous for an hour when the clocks go back. One way of
25644 avoiding this problem is to set the timezone to UTC. An alternative is to set
25645 <option>log_timezone</option> true. This turns on the addition of the timezone offset to
25646 timestamps in log lines. Turning on this option can add quite a lot to the size
25647 of log files because each line is extended by 6 characters. Note that the
25648 <varname>$tod_log</varname> variable contains the log timestamp without the zone, but there is
25649 another variable called <varname>$tod_zone</varname> that contains just the timezone offset.
25650 </para>
25651 <para>
25652 <indexterm role="option">
25653 <primary><option>lookup_open_max</option></primary>
25654 </indexterm>
25655 </para>
25656 <informaltable frame="all">
25657 <tgroup cols="4" colsep="0" rowsep="0">
25658 <colspec colwidth="8*" align="left"/>
25659 <colspec colwidth="6*" align="center"/>
25660 <colspec colwidth="6*" align="center"/>
25661 <colspec colwidth="6*" align="right"/>
25662 <tbody>
25663 <row>
25664 <entry><option>lookup_open_max</option></entry>
25665 <entry>Use: <emphasis>main</emphasis></entry>
25666 <entry>Type: <emphasis>integer</emphasis></entry>
25667 <entry>Default: <emphasis>25</emphasis></entry>
25668 </row>
25669 </tbody>
25670 </tgroup>
25671 </informaltable>
25672 <para>
25673 <indexterm role="concept">
25674 <primary>too many open files</primary>
25675 </indexterm>
25676 <indexterm role="concept">
25677 <primary>open files, too many</primary>
25678 </indexterm>
25679 <indexterm role="concept">
25680 <primary>file</primary>
25681 <secondary>too many open</secondary>
25682 </indexterm>
25683 <indexterm role="concept">
25684 <primary>lookup</primary>
25685 <secondary>maximum open files</secondary>
25686 </indexterm>
25687 <indexterm role="concept">
25688 <primary>limit</primary>
25689 <secondary>open files for lookups</secondary>
25690 </indexterm>
25691 This option limits the number of simultaneously open files for single-key
25692 lookups that use regular files (that is, <command>lsearch</command>, <command>dbm</command>, and <command>cdb</command>).
25693 Exim normally keeps these files open during routing, because often the same
25694 file is required several times. If the limit is reached, Exim closes the least
25695 recently used file. Note that if you are using the <emphasis>ndbm</emphasis> library, it
25696 actually opens two files for each logical DBM database, though it still counts
25697 as one for the purposes of <option>lookup_open_max</option>. If you are getting <quote>too many
25698 open files</quote> errors with NDBM, you need to reduce the value of
25699 <option>lookup_open_max</option>.
25700 </para>
25701 <para>
25702 <indexterm role="option">
25703 <primary><option>max_username_length</option></primary>
25704 </indexterm>
25705 </para>
25706 <informaltable frame="all">
25707 <tgroup cols="4" colsep="0" rowsep="0">
25708 <colspec colwidth="8*" align="left"/>
25709 <colspec colwidth="6*" align="center"/>
25710 <colspec colwidth="6*" align="center"/>
25711 <colspec colwidth="6*" align="right"/>
25712 <tbody>
25713 <row>
25714 <entry><option>max_username_length</option></entry>
25715 <entry>Use: <emphasis>main</emphasis></entry>
25716 <entry>Type: <emphasis>integer</emphasis></entry>
25717 <entry>Default: <emphasis>0</emphasis></entry>
25718 </row>
25719 </tbody>
25720 </tgroup>
25721 </informaltable>
25722 <para>
25723 <indexterm role="concept">
25724 <primary>length of login name</primary>
25725 </indexterm>
25726 <indexterm role="concept">
25727 <primary>user name</primary>
25728 <secondary>maximum length</secondary>
25729 </indexterm>
25730 <indexterm role="concept">
25731 <primary>limit</primary>
25732 <secondary>user name length</secondary>
25733 </indexterm>
25734 Some operating systems are broken in that they truncate long arguments to
25735 <function>getpwnam()</function> to eight characters, instead of returning <quote>no such user</quote>. If
25736 this option is set greater than zero, any attempt to call <function>getpwnam()</function> with
25737 an argument that is longer behaves as if <function>getpwnam()</function> failed.
25738 </para>
25739 <para>
25740 <indexterm role="option">
25741 <primary><option>message_body_newlines</option></primary>
25742 </indexterm>
25743 </para>
25744 <informaltable frame="all">
25745 <tgroup cols="4" colsep="0" rowsep="0">
25746 <colspec colwidth="8*" align="left"/>
25747 <colspec colwidth="6*" align="center"/>
25748 <colspec colwidth="6*" align="center"/>
25749 <colspec colwidth="6*" align="right"/>
25750 <tbody>
25751 <row>
25752 <entry><option>message_body_newlines</option></entry>
25753 <entry>Use: <emphasis>main</emphasis></entry>
25754 <entry>Type: <emphasis>bool</emphasis></entry>
25755 <entry>Default: <emphasis>false</emphasis></entry>
25756 </row>
25757 </tbody>
25758 </tgroup>
25759 </informaltable>
25760 <para>
25761 <indexterm role="concept">
25762 <primary>message body</primary>
25763 <secondary>newlines in variables</secondary>
25764 </indexterm>
25765 <indexterm role="concept">
25766 <primary>newline</primary>
25767 <secondary>in message body variables</secondary>
25768 </indexterm>
25769 <indexterm role="variable">
25770 <primary><varname>$message_body</varname></primary>
25771 </indexterm>
25772 <indexterm role="variable">
25773 <primary><varname>$message_body_end</varname></primary>
25774 </indexterm>
25775 By default, newlines in the message body are replaced by spaces when setting
25776 the <varname>$message_body</varname> and <varname>$message_body_end</varname> expansion variables. If this
25777 option is set true, this no longer happens.
25778 </para>
25779 <para>
25780 <indexterm role="option">
25781 <primary><option>message_body_visible</option></primary>
25782 </indexterm>
25783 </para>
25784 <informaltable frame="all">
25785 <tgroup cols="4" colsep="0" rowsep="0">
25786 <colspec colwidth="8*" align="left"/>
25787 <colspec colwidth="6*" align="center"/>
25788 <colspec colwidth="6*" align="center"/>
25789 <colspec colwidth="6*" align="right"/>
25790 <tbody>
25791 <row>
25792 <entry><option>message_body_visible</option></entry>
25793 <entry>Use: <emphasis>main</emphasis></entry>
25794 <entry>Type: <emphasis>integer</emphasis></entry>
25795 <entry>Default: <emphasis>500</emphasis></entry>
25796 </row>
25797 </tbody>
25798 </tgroup>
25799 </informaltable>
25800 <para>
25801 <indexterm role="concept">
25802 <primary>body of message</primary>
25803 <secondary>visible size</secondary>
25804 </indexterm>
25805 <indexterm role="concept">
25806 <primary>message body</primary>
25807 <secondary>visible size</secondary>
25808 </indexterm>
25809 <indexterm role="variable">
25810 <primary><varname>$message_body</varname></primary>
25811 </indexterm>
25812 <indexterm role="variable">
25813 <primary><varname>$message_body_end</varname></primary>
25814 </indexterm>
25815 This option specifies how much of a message&#x2019;s body is to be included in the
25816 <varname>$message_body</varname> and <varname>$message_body_end</varname> expansion variables.
25817 </para>
25818 <para>
25819 <indexterm role="option">
25820 <primary><option>message_id_header_domain</option></primary>
25821 </indexterm>
25822 </para>
25823 <informaltable frame="all">
25824 <tgroup cols="4" colsep="0" rowsep="0">
25825 <colspec colwidth="8*" align="left"/>
25826 <colspec colwidth="6*" align="center"/>
25827 <colspec colwidth="6*" align="center"/>
25828 <colspec colwidth="6*" align="right"/>
25829 <tbody>
25830 <row>
25831 <entry><option>message_id_header_domain</option></entry>
25832 <entry>Use: <emphasis>main</emphasis></entry>
25833 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
25834 <entry>Default: <emphasis>unset</emphasis></entry>
25835 </row>
25836 </tbody>
25837 </tgroup>
25838 </informaltable>
25839 <para>
25840 <indexterm role="concept">
25841 <primary><emphasis>Message-ID:</emphasis> header line</primary>
25842 </indexterm>
25843 If this option is set, the string is expanded and used as the right hand side
25844 (domain) of the <emphasis>Message-ID:</emphasis> header that Exim creates if a
25845 locally-originated incoming message does not have one. <quote>Locally-originated</quote>
25846 means <quote>not received over TCP/IP.</quote>
25847 Otherwise, the primary host name is used.
25848 Only letters, digits, dot and hyphen are accepted; any other characters are
25849 replaced by hyphens. If the expansion is forced to fail, or if the result is an
25850 empty string, the option is ignored.
25851 </para>
25852 <para>
25853 <indexterm role="option">
25854 <primary><option>message_id_header_text</option></primary>
25855 </indexterm>
25856 </para>
25857 <informaltable frame="all">
25858 <tgroup cols="4" colsep="0" rowsep="0">
25859 <colspec colwidth="8*" align="left"/>
25860 <colspec colwidth="6*" align="center"/>
25861 <colspec colwidth="6*" align="center"/>
25862 <colspec colwidth="6*" align="right"/>
25863 <tbody>
25864 <row>
25865 <entry><option>message_id_header_text</option></entry>
25866 <entry>Use: <emphasis>main</emphasis></entry>
25867 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
25868 <entry>Default: <emphasis>unset</emphasis></entry>
25869 </row>
25870 </tbody>
25871 </tgroup>
25872 </informaltable>
25873 <para>
25874 If this variable is set, the string is expanded and used to augment the text of
25875 the <emphasis>Message-id:</emphasis> header that Exim creates if a locally-originated incoming
25876 message does not have one. The text of this header is required by RFC 2822 to
25877 take the form of an address. By default, Exim uses its internal message id as
25878 the local part, and the primary host name as the domain. If this option is set,
25879 it is expanded, and provided the expansion is not forced to fail, and does not
25880 yield an empty string, the result is inserted into the header immediately
25881 before the @, separated from the internal message id by a dot. Any characters
25882 that are illegal in an address are automatically converted into hyphens. This
25883 means that variables such as <varname>$tod_log</varname> can be used, because the spaces and
25884 colons will become hyphens.
25885 </para>
25886 <para>
25887 <indexterm role="option">
25888 <primary><option>message_logs</option></primary>
25889 </indexterm>
25890 </para>
25891 <informaltable frame="all">
25892 <tgroup cols="4" colsep="0" rowsep="0">
25893 <colspec colwidth="8*" align="left"/>
25894 <colspec colwidth="6*" align="center"/>
25895 <colspec colwidth="6*" align="center"/>
25896 <colspec colwidth="6*" align="right"/>
25897 <tbody>
25898 <row>
25899 <entry><option>message_logs</option></entry>
25900 <entry>Use: <emphasis>main</emphasis></entry>
25901 <entry>Type: <emphasis>boolean</emphasis></entry>
25902 <entry>Default: <emphasis>true</emphasis></entry>
25903 </row>
25904 </tbody>
25905 </tgroup>
25906 </informaltable>
25907 <para>
25908 <indexterm role="concept">
25909 <primary>message logs</primary>
25910 <secondary>disabling</secondary>
25911 </indexterm>
25912 <indexterm role="concept">
25913 <primary>log</primary>
25914 <secondary>message log; disabling</secondary>
25915 </indexterm>
25916 If this option is turned off, per-message log files are not created in the
25917 <filename>msglog</filename> spool sub-directory. This reduces the amount of disk I/O required by
25918 Exim, by reducing the number of files involved in handling a message from a
25919 minimum of four (header spool file, body spool file, delivery journal, and
25920 per-message log) to three. The other major I/O activity is Exim&#x2019;s main log,
25921 which is not affected by this option.
25922 </para>
25923 <para>
25924 <indexterm role="option">
25925 <primary><option>message_size_limit</option></primary>
25926 </indexterm>
25927 </para>
25928 <informaltable frame="all">
25929 <tgroup cols="4" colsep="0" rowsep="0">
25930 <colspec colwidth="8*" align="left"/>
25931 <colspec colwidth="6*" align="center"/>
25932 <colspec colwidth="6*" align="center"/>
25933 <colspec colwidth="6*" align="right"/>
25934 <tbody>
25935 <row>
25936 <entry><option>message_size_limit</option></entry>
25937 <entry>Use: <emphasis>main</emphasis></entry>
25938 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
25939 <entry>Default: <emphasis>50M</emphasis></entry>
25940 </row>
25941 </tbody>
25942 </tgroup>
25943 </informaltable>
25944 <para>
25945 <indexterm role="concept">
25946 <primary>message</primary>
25947 <secondary>size limit</secondary>
25948 </indexterm>
25949 <indexterm role="concept">
25950 <primary>limit</primary>
25951 <secondary>message size</secondary>
25952 </indexterm>
25953 <indexterm role="concept">
25954 <primary>size</primary>
25955 <secondary>of message, limit</secondary>
25956 </indexterm>
25957 This option limits the maximum size of message that Exim will process. The
25958 value is expanded for each incoming connection so, for example, it can be made
25959 to depend on the IP address of the remote host for messages arriving via
25960 TCP/IP. After expansion, the value must be a sequence of decimal digits,
25961 optionally followed by K or M.
25962 </para>
25963 <para>
25964 <emphasis role="bold">Note</emphasis>: This limit cannot be made to depend on a message&#x2019;s sender or any
25965 other properties of an individual message, because it has to be advertised in
25966 the server&#x2019;s response to EHLO. String expansion failure causes a temporary
25967 error. A value of zero means no limit, but its use is not recommended. See also
25968 <option>bounce_return_size_limit</option>.
25969 </para>
25970 <para>
25971 Incoming SMTP messages are failed with a 552 error if the limit is
25972 exceeded; locally-generated messages either get a stderr message or a delivery
25973 failure message to the sender, depending on the <option>-oe</option> setting. Rejection of
25974 an oversized message is logged in both the main and the reject logs. See also
25975 the generic transport option <option>message_size_limit</option>, which limits the size of
25976 message that an individual transport can process.
25977 </para>
25978 <para>
25979 If you use a virus-scanner and set this option to to a value larger than the
25980 maximum size that your virus-scanner is configured to support, you may get
25981 failures triggered by large mails.  The right size to configure for the
25982 virus-scanner depends upon what data is passed and the options in use but it&#x2019;s
25983 probably safest to just set it to a little larger than this value.  Eg, with a
25984 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
25985 some problems may result.
25986 </para>
25987 <para>
25988 A value of 0 will disable size limit checking; Exim will still advertise the
25989 SIZE extension in an EHLO response, but without a limit, so as to permit
25990 SMTP clients to still indicate the message size along with the MAIL verb.
25991 </para>
25992 <para>
25993 <indexterm role="option">
25994 <primary><option>move_frozen_messages</option></primary>
25995 </indexterm>
25996 </para>
25997 <informaltable frame="all">
25998 <tgroup cols="4" colsep="0" rowsep="0">
25999 <colspec colwidth="8*" align="left"/>
26000 <colspec colwidth="6*" align="center"/>
26001 <colspec colwidth="6*" align="center"/>
26002 <colspec colwidth="6*" align="right"/>
26003 <tbody>
26004 <row>
26005 <entry><option>move_frozen_messages</option></entry>
26006 <entry>Use: <emphasis>main</emphasis></entry>
26007 <entry>Type: <emphasis>boolean</emphasis></entry>
26008 <entry>Default: <emphasis>false</emphasis></entry>
26009 </row>
26010 </tbody>
26011 </tgroup>
26012 </informaltable>
26013 <para>
26014 <indexterm role="concept">
26015 <primary>frozen messages</primary>
26016 <secondary>moving</secondary>
26017 </indexterm>
26018 This option, which is available only if Exim has been built with the setting
26019 </para>
26020 <literallayout class="monospaced">
26021 SUPPORT_MOVE_FROZEN_MESSAGES=yes
26022 </literallayout>
26023 <para>
26024 in <filename>Local/Makefile</filename>, causes frozen messages and their message logs to be
26025 moved from the <filename>input</filename> and <filename>msglog</filename> directories on the spool to <filename>Finput</filename>
26026 and <filename>Fmsglog</filename>, respectively. There is currently no support in Exim or the
26027 standard utilities for handling such moved messages, and they do not show up in
26028 lists generated by <option>-bp</option> or by the Exim monitor.
26029 </para>
26030 <para>
26031 <indexterm role="option">
26032 <primary><option>mua_wrapper</option></primary>
26033 </indexterm>
26034 </para>
26035 <informaltable frame="all">
26036 <tgroup cols="4" colsep="0" rowsep="0">
26037 <colspec colwidth="8*" align="left"/>
26038 <colspec colwidth="6*" align="center"/>
26039 <colspec colwidth="6*" align="center"/>
26040 <colspec colwidth="6*" align="right"/>
26041 <tbody>
26042 <row>
26043 <entry><option>mua_wrapper</option></entry>
26044 <entry>Use: <emphasis>main</emphasis></entry>
26045 <entry>Type: <emphasis>boolean</emphasis></entry>
26046 <entry>Default: <emphasis>false</emphasis></entry>
26047 </row>
26048 </tbody>
26049 </tgroup>
26050 </informaltable>
26051 <para>
26052 Setting this option true causes Exim to run in a very restrictive mode in which
26053 it passes messages synchronously to a smart host. Chapter <xref linkend="CHAPnonqueueing"/>
26054 contains a full description of this facility.
26055 </para>
26056 <para>
26057 <indexterm role="option">
26058 <primary><option>mysql_servers</option></primary>
26059 </indexterm>
26060 </para>
26061 <informaltable frame="all">
26062 <tgroup cols="4" colsep="0" rowsep="0">
26063 <colspec colwidth="8*" align="left"/>
26064 <colspec colwidth="6*" align="center"/>
26065 <colspec colwidth="6*" align="center"/>
26066 <colspec colwidth="6*" align="right"/>
26067 <tbody>
26068 <row>
26069 <entry><option>mysql_servers</option></entry>
26070 <entry>Use: <emphasis>main</emphasis></entry>
26071 <entry>Type: <emphasis>string list</emphasis></entry>
26072 <entry>Default: <emphasis>unset</emphasis></entry>
26073 </row>
26074 </tbody>
26075 </tgroup>
26076 </informaltable>
26077 <para>
26078 <indexterm role="concept">
26079 <primary>MySQL</primary>
26080 <secondary>server list</secondary>
26081 </indexterm>
26082 This option provides a list of MySQL servers and associated connection data, to
26083 be used in conjunction with <command>mysql</command> lookups (see section <xref linkend="SECID72"/>). The
26084 option is available only if Exim has been built with MySQL support.
26085 </para>
26086 <para>
26087 <indexterm role="option">
26088 <primary><option>never_users</option></primary>
26089 </indexterm>
26090 </para>
26091 <informaltable frame="all">
26092 <tgroup cols="4" colsep="0" rowsep="0">
26093 <colspec colwidth="8*" align="left"/>
26094 <colspec colwidth="6*" align="center"/>
26095 <colspec colwidth="6*" align="center"/>
26096 <colspec colwidth="6*" align="right"/>
26097 <tbody>
26098 <row>
26099 <entry><option>never_users</option></entry>
26100 <entry>Use: <emphasis>main</emphasis></entry>
26101 <entry>Type: <emphasis>string list</emphasis>&dagger;<emphasis></emphasis></entry>
26102 <entry>Default: <emphasis>unset</emphasis></entry>
26103 </row>
26104 </tbody>
26105 </tgroup>
26106 </informaltable>
26107 <para>
26108 This option is expanded just once, at the start of Exim&#x2019;s processing. Local
26109 message deliveries are normally run in processes that are setuid to the
26110 recipient, and remote deliveries are normally run under Exim&#x2019;s own uid and gid.
26111 It is usually desirable to prevent any deliveries from running as root, as a
26112 safety precaution.
26113 </para>
26114 <para>
26115 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
26116 list of users that must not be used for local deliveries. This list is fixed in
26117 the binary and cannot be overridden by the configuration file. By default, it
26118 contains just the single user name <quote>root</quote>. The <option>never_users</option> runtime option
26119 can be used to add more users to the fixed list.
26120 </para>
26121 <para>
26122 If a message is to be delivered as one of the users on the fixed list or the
26123 <option>never_users</option> list, an error occurs, and delivery is deferred. A common
26124 example is
26125 </para>
26126 <literallayout class="monospaced">
26127 never_users = root:daemon:bin
26128 </literallayout>
26129 <para>
26130 Including root is redundant if it is also on the fixed list, but it does no
26131 harm. This option overrides the <option>pipe_as_creator</option> option of the <command>pipe</command>
26132 transport driver.
26133 </para>
26134 <para>
26135 <indexterm role="option">
26136 <primary><option>openssl_options</option></primary>
26137 </indexterm>
26138 </para>
26139 <informaltable frame="all">
26140 <tgroup cols="4" colsep="0" rowsep="0">
26141 <colspec colwidth="8*" align="left"/>
26142 <colspec colwidth="6*" align="center"/>
26143 <colspec colwidth="6*" align="center"/>
26144 <colspec colwidth="6*" align="right"/>
26145 <tbody>
26146 <row>
26147 <entry><option>openssl_options</option></entry>
26148 <entry>Use: <emphasis>main</emphasis></entry>
26149 <entry>Type: <emphasis>string list</emphasis></entry>
26150 <entry>Default: <emphasis>+no_sslv2</emphasis></entry>
26151 </row>
26152 </tbody>
26153 </tgroup>
26154 </informaltable>
26155 <para>
26156 <indexterm role="concept">
26157 <primary>OpenSSL </primary>
26158 <secondary>compatibility</secondary>
26159 </indexterm>
26160 This option allows an administrator to adjust the SSL options applied
26161 by OpenSSL to connections.  It is given as a space-separated list of items,
26162 each one to be +added or -subtracted from the current value.
26163 </para>
26164 <para>
26165 This option is only available if Exim is built against OpenSSL.  The values
26166 available for this option vary according to the age of your OpenSSL install.
26167 The <quote>all</quote> value controls a subset of flags which are available, typically
26168 the bug workaround options.  The <emphasis>SSL_CTX_set_options</emphasis> man page will
26169 list the values known on your system and Exim should support all the
26170 <quote>bug workaround</quote> options and many of the <quote>modifying</quote> options.  The Exim
26171 names lose the leading <quote>SSL_OP_</quote> and are lower-cased.
26172 </para>
26173 <para>
26174 Note that adjusting the options can have severe impact upon the security of
26175 SSL as used by Exim.  It is possible to disable safety checks and shoot
26176 yourself in the foot in various unpleasant ways.  This option should not be
26177 adjusted lightly.  An unrecognised item will be detected at startup, by
26178 invoking Exim with the <option>-bV</option> flag.
26179 </para>
26180 <para>
26181 Historical note: prior to release 4.80, Exim defaulted this value to
26182 "+dont_insert_empty_fragments", which may still be needed for compatibility
26183 with some clients, but which lowers security by increasing exposure to
26184 some now infamous attacks.
26185 </para>
26186 <para>
26187 An example:
26188 </para>
26189 <literallayout class="monospaced">
26190 # Make both old MS and old Eudora happy:
26191 openssl_options = -all +microsoft_big_sslv3_buffer \
26192                        +dont_insert_empty_fragments
26193 </literallayout>
26194 <para>
26195 Possible options may include:
26196 </para>
26197 <itemizedlist>
26198 <listitem>
26199 <para>
26200 <literal>all</literal>
26201 </para>
26202 </listitem>
26203 <listitem>
26204 <para>
26205 <literal>allow_unsafe_legacy_renegotiation</literal>
26206 </para>
26207 </listitem>
26208 <listitem>
26209 <para>
26210 <literal>cipher_server_preference</literal>
26211 </para>
26212 </listitem>
26213 <listitem>
26214 <para>
26215 <literal>dont_insert_empty_fragments</literal>
26216 </para>
26217 </listitem>
26218 <listitem>
26219 <para>
26220 <literal>ephemeral_rsa</literal>
26221 </para>
26222 </listitem>
26223 <listitem>
26224 <para>
26225 <literal>legacy_server_connect</literal>
26226 </para>
26227 </listitem>
26228 <listitem>
26229 <para>
26230 <literal>microsoft_big_sslv3_buffer</literal>
26231 </para>
26232 </listitem>
26233 <listitem>
26234 <para>
26235 <literal>microsoft_sess_id_bug</literal>
26236 </para>
26237 </listitem>
26238 <listitem>
26239 <para>
26240 <literal>msie_sslv2_rsa_padding</literal>
26241 </para>
26242 </listitem>
26243 <listitem>
26244 <para>
26245 <literal>netscape_challenge_bug</literal>
26246 </para>
26247 </listitem>
26248 <listitem>
26249 <para>
26250 <literal>netscape_reuse_cipher_change_bug</literal>
26251 </para>
26252 </listitem>
26253 <listitem>
26254 <para>
26255 <literal>no_compression</literal>
26256 </para>
26257 </listitem>
26258 <listitem>
26259 <para>
26260 <literal>no_session_resumption_on_renegotiation</literal>
26261 </para>
26262 </listitem>
26263 <listitem>
26264 <para>
26265 <literal>no_sslv2</literal>
26266 </para>
26267 </listitem>
26268 <listitem>
26269 <para>
26270 <literal>no_sslv3</literal>
26271 </para>
26272 </listitem>
26273 <listitem>
26274 <para>
26275 <literal>no_ticket</literal>
26276 </para>
26277 </listitem>
26278 <listitem>
26279 <para>
26280 <literal>no_tlsv1</literal>
26281 </para>
26282 </listitem>
26283 <listitem>
26284 <para>
26285 <literal>no_tlsv1_1</literal>
26286 </para>
26287 </listitem>
26288 <listitem>
26289 <para>
26290 <literal>no_tlsv1_2</literal>
26291 </para>
26292 </listitem>
26293 <listitem>
26294 <para>
26295 <literal>safari_ecdhe_ecdsa_bug</literal>
26296 </para>
26297 </listitem>
26298 <listitem>
26299 <para>
26300 <literal>single_dh_use</literal>
26301 </para>
26302 </listitem>
26303 <listitem>
26304 <para>
26305 <literal>single_ecdh_use</literal>
26306 </para>
26307 </listitem>
26308 <listitem>
26309 <para>
26310 <literal>ssleay_080_client_dh_bug</literal>
26311 </para>
26312 </listitem>
26313 <listitem>
26314 <para>
26315 <literal>sslref2_reuse_cert_type_bug</literal>
26316 </para>
26317 </listitem>
26318 <listitem>
26319 <para>
26320 <literal>tls_block_padding_bug</literal>
26321 </para>
26322 </listitem>
26323 <listitem>
26324 <para>
26325 <literal>tls_d5_bug</literal>
26326 </para>
26327 </listitem>
26328 <listitem>
26329 <para>
26330 <literal>tls_rollback_bug</literal>
26331 </para>
26332 </listitem>
26333 </itemizedlist>
26334 <para>
26335 As an aside, the <literal>safari_ecdhe_ecdsa_bug</literal> item is a misnomer and affects
26336 all clients connecting using the MacOS SecureTransport TLS facility prior
26337 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
26338 to negotiate TLS then this option value might help, provided that your OpenSSL
26339 release is new enough to contain this work-around.  This may be a situation
26340 where you have to upgrade OpenSSL to get buggy clients working.
26341 </para>
26342 <para>
26343 <indexterm role="option">
26344 <primary><option>oracle_servers</option></primary>
26345 </indexterm>
26346 </para>
26347 <informaltable frame="all">
26348 <tgroup cols="4" colsep="0" rowsep="0">
26349 <colspec colwidth="8*" align="left"/>
26350 <colspec colwidth="6*" align="center"/>
26351 <colspec colwidth="6*" align="center"/>
26352 <colspec colwidth="6*" align="right"/>
26353 <tbody>
26354 <row>
26355 <entry><option>oracle_servers</option></entry>
26356 <entry>Use: <emphasis>main</emphasis></entry>
26357 <entry>Type: <emphasis>string list</emphasis></entry>
26358 <entry>Default: <emphasis>unset</emphasis></entry>
26359 </row>
26360 </tbody>
26361 </tgroup>
26362 </informaltable>
26363 <para>
26364 <indexterm role="concept">
26365 <primary>Oracle</primary>
26366 <secondary>server list</secondary>
26367 </indexterm>
26368 This option provides a list of Oracle servers and associated connection data,
26369 to be used in conjunction with <command>oracle</command> lookups (see section <xref linkend="SECID72"/>).
26370 The option is available only if Exim has been built with Oracle support.
26371 </para>
26372 <para>
26373 <indexterm role="option">
26374 <primary><option>percent_hack_domains</option></primary>
26375 </indexterm>
26376 </para>
26377 <informaltable frame="all">
26378 <tgroup cols="4" colsep="0" rowsep="0">
26379 <colspec colwidth="8*" align="left"/>
26380 <colspec colwidth="6*" align="center"/>
26381 <colspec colwidth="6*" align="center"/>
26382 <colspec colwidth="6*" align="right"/>
26383 <tbody>
26384 <row>
26385 <entry><option>percent_hack_domains</option></entry>
26386 <entry>Use: <emphasis>main</emphasis></entry>
26387 <entry>Type: <emphasis>domain list</emphasis>&dagger;<emphasis></emphasis></entry>
26388 <entry>Default: <emphasis>unset</emphasis></entry>
26389 </row>
26390 </tbody>
26391 </tgroup>
26392 </informaltable>
26393 <para>
26394 <indexterm role="concept">
26395 <primary><quote>percent hack</quote></primary>
26396 </indexterm>
26397 <indexterm role="concept">
26398 <primary>source routing</primary>
26399 <secondary>in email address</secondary>
26400 </indexterm>
26401 <indexterm role="concept">
26402 <primary>address</primary>
26403 <secondary>source-routed</secondary>
26404 </indexterm>
26405 The <quote>percent hack</quote> is the convention whereby a local part containing a
26406 percent sign is re-interpreted as a new email address, with the percent
26407 replaced by @. This is sometimes called <quote>source routing</quote>, though that term is
26408 also applied to RFC 2822 addresses that begin with an @ character. If this
26409 option is set, Exim implements the percent facility for those domains listed,
26410 but no others. This happens before an incoming SMTP address is tested against
26411 an ACL.
26412 </para>
26413 <para>
26414 <emphasis role="bold">Warning</emphasis>: The <quote>percent hack</quote> has often been abused by people who are
26415 trying to get round relaying restrictions. For this reason, it is best avoided
26416 if at all possible. Unfortunately, a number of less security-conscious MTAs
26417 implement it unconditionally. If you are running Exim on a gateway host, and
26418 routing mail through to internal MTAs without processing the local parts, it is
26419 a good idea to reject recipient addresses with percent characters in their
26420 local parts. Exim&#x2019;s default configuration does this.
26421 </para>
26422 <para>
26423 <indexterm role="option">
26424 <primary><option>perl_at_start</option></primary>
26425 </indexterm>
26426 </para>
26427 <informaltable frame="all">
26428 <tgroup cols="4" colsep="0" rowsep="0">
26429 <colspec colwidth="8*" align="left"/>
26430 <colspec colwidth="6*" align="center"/>
26431 <colspec colwidth="6*" align="center"/>
26432 <colspec colwidth="6*" align="right"/>
26433 <tbody>
26434 <row>
26435 <entry><option>perl_at_start</option></entry>
26436 <entry>Use: <emphasis>main</emphasis></entry>
26437 <entry>Type: <emphasis>boolean</emphasis></entry>
26438 <entry>Default: <emphasis>false</emphasis></entry>
26439 </row>
26440 </tbody>
26441 </tgroup>
26442 </informaltable>
26443 <para>
26444 This option is available only when Exim is built with an embedded Perl
26445 interpreter. See chapter <xref linkend="CHAPperl"/> for details of its use.
26446 </para>
26447 <para>
26448 <indexterm role="option">
26449 <primary><option>perl_startup</option></primary>
26450 </indexterm>
26451 </para>
26452 <informaltable frame="all">
26453 <tgroup cols="4" colsep="0" rowsep="0">
26454 <colspec colwidth="8*" align="left"/>
26455 <colspec colwidth="6*" align="center"/>
26456 <colspec colwidth="6*" align="center"/>
26457 <colspec colwidth="6*" align="right"/>
26458 <tbody>
26459 <row>
26460 <entry><option>perl_startup</option></entry>
26461 <entry>Use: <emphasis>main</emphasis></entry>
26462 <entry>Type: <emphasis>string</emphasis></entry>
26463 <entry>Default: <emphasis>unset</emphasis></entry>
26464 </row>
26465 </tbody>
26466 </tgroup>
26467 </informaltable>
26468 <para>
26469 This option is available only when Exim is built with an embedded Perl
26470 interpreter. See chapter <xref linkend="CHAPperl"/> for details of its use.
26471 </para>
26472 <para>
26473 <indexterm role="option">
26474 <primary><option>pgsql_servers</option></primary>
26475 </indexterm>
26476 </para>
26477 <informaltable frame="all">
26478 <tgroup cols="4" colsep="0" rowsep="0">
26479 <colspec colwidth="8*" align="left"/>
26480 <colspec colwidth="6*" align="center"/>
26481 <colspec colwidth="6*" align="center"/>
26482 <colspec colwidth="6*" align="right"/>
26483 <tbody>
26484 <row>
26485 <entry><option>pgsql_servers</option></entry>
26486 <entry>Use: <emphasis>main</emphasis></entry>
26487 <entry>Type: <emphasis>string list</emphasis></entry>
26488 <entry>Default: <emphasis>unset</emphasis></entry>
26489 </row>
26490 </tbody>
26491 </tgroup>
26492 </informaltable>
26493 <para>
26494 <indexterm role="concept">
26495 <primary>PostgreSQL lookup type</primary>
26496 <secondary>server list</secondary>
26497 </indexterm>
26498 This option provides a list of PostgreSQL servers and associated connection
26499 data, to be used in conjunction with <command>pgsql</command> lookups (see section
26500 <xref linkend="SECID72"/>). The option is available only if Exim has been built with
26501 PostgreSQL support.
26502 </para>
26503 <para>
26504 <indexterm role="option">
26505 <primary><option>pid_file_path</option></primary>
26506 </indexterm>
26507 </para>
26508 <informaltable frame="all">
26509 <tgroup cols="4" colsep="0" rowsep="0">
26510 <colspec colwidth="8*" align="left"/>
26511 <colspec colwidth="6*" align="center"/>
26512 <colspec colwidth="6*" align="center"/>
26513 <colspec colwidth="6*" align="right"/>
26514 <tbody>
26515 <row>
26516 <entry><option>pid_file_path</option></entry>
26517 <entry>Use: <emphasis>main</emphasis></entry>
26518 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
26519 <entry>Default: <emphasis>set at compile time</emphasis></entry>
26520 </row>
26521 </tbody>
26522 </tgroup>
26523 </informaltable>
26524 <para>
26525 <indexterm role="concept">
26526 <primary>daemon</primary>
26527 <secondary>pid file path</secondary>
26528 </indexterm>
26529 <indexterm role="concept">
26530 <primary>pid file, path for</primary>
26531 </indexterm>
26532 This option sets the name of the file to which the Exim daemon writes its
26533 process id. The string is expanded, so it can contain, for example, references
26534 to the host name:
26535 </para>
26536 <literallayout class="monospaced">
26537 pid_file_path = /var/log/$primary_hostname/exim.pid
26538 </literallayout>
26539 <para>
26540 If no path is set, the pid is written to the file <filename>exim-daemon.pid</filename> in Exim&#x2019;s
26541 spool directory.
26542 The value set by the option can be overridden by the <option>-oP</option> command line
26543 option. A pid file is not written if a <quote>non-standard</quote> daemon is run by means
26544 of the <option>-oX</option> option, unless a path is explicitly supplied by <option>-oP</option>.
26545 </para>
26546 <para>
26547 <indexterm role="option">
26548 <primary><option>pipelining_advertise_hosts</option></primary>
26549 </indexterm>
26550 </para>
26551 <informaltable frame="all">
26552 <tgroup cols="4" colsep="0" rowsep="0">
26553 <colspec colwidth="8*" align="left"/>
26554 <colspec colwidth="6*" align="center"/>
26555 <colspec colwidth="6*" align="center"/>
26556 <colspec colwidth="6*" align="right"/>
26557 <tbody>
26558 <row>
26559 <entry><option>pipelining_advertise_hosts</option></entry>
26560 <entry>Use: <emphasis>main</emphasis></entry>
26561 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
26562 <entry>Default: <emphasis>*</emphasis></entry>
26563 </row>
26564 </tbody>
26565 </tgroup>
26566 </informaltable>
26567 <para>
26568 <indexterm role="concept">
26569 <primary>PIPELINING</primary>
26570 <secondary>suppressing advertising</secondary>
26571 </indexterm>
26572 This option can be used to suppress the advertisement of the SMTP
26573 PIPELINING extension to specific hosts. See also the <emphasis role="bold">no_pipelining</emphasis>
26574 control in section <xref linkend="SECTcontrols"/>. When PIPELINING is not advertised and
26575 <option>smtp_enforce_sync</option> is true, an Exim server enforces strict synchronization
26576 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
26577 that clients will use it; <quote>out of order</quote> commands that are <quote>expected</quote> do
26578 not count as protocol errors (see <option>smtp_max_synprot_errors</option>).
26579 </para>
26580 <para>
26581 <indexterm role="option">
26582 <primary><option>prdr_enable</option></primary>
26583 </indexterm>
26584 </para>
26585 <informaltable frame="all">
26586 <tgroup cols="4" colsep="0" rowsep="0">
26587 <colspec colwidth="8*" align="left"/>
26588 <colspec colwidth="6*" align="center"/>
26589 <colspec colwidth="6*" align="center"/>
26590 <colspec colwidth="6*" align="right"/>
26591 <tbody>
26592 <row>
26593 <entry><option>prdr_enable</option></entry>
26594 <entry>Use: <emphasis>main</emphasis></entry>
26595 <entry>Type: <emphasis>boolean</emphasis></entry>
26596 <entry>Default: <emphasis>false</emphasis></entry>
26597 </row>
26598 </tbody>
26599 </tgroup>
26600 </informaltable>
26601 <para>
26602 <indexterm role="concept">
26603 <primary>PRDR</primary>
26604 <secondary>enabling on server</secondary>
26605 </indexterm>
26606 This option can be used to enable the Per-Recipient Data Response extension
26607 to SMTP, defined by Eric Hall.
26608 If the option is set, PRDR is advertised by Exim when operating as a server.
26609 If the client requests PRDR, and more than one recipient, for a message 
26610 an additional ACL is called for each recipient after the message content
26611 is recieved.  See section <xref linkend="SECTPRDRACL"/>.
26612 </para>
26613 <para>
26614 <indexterm role="option">
26615 <primary><option>preserve_message_logs</option></primary>
26616 </indexterm>
26617 </para>
26618 <informaltable frame="all">
26619 <tgroup cols="4" colsep="0" rowsep="0">
26620 <colspec colwidth="8*" align="left"/>
26621 <colspec colwidth="6*" align="center"/>
26622 <colspec colwidth="6*" align="center"/>
26623 <colspec colwidth="6*" align="right"/>
26624 <tbody>
26625 <row>
26626 <entry><option>preserve_message_logs</option></entry>
26627 <entry>Use: <emphasis>main</emphasis></entry>
26628 <entry>Type: <emphasis>boolean</emphasis></entry>
26629 <entry>Default: <emphasis>false</emphasis></entry>
26630 </row>
26631 </tbody>
26632 </tgroup>
26633 </informaltable>
26634 <para>
26635 <indexterm role="concept">
26636 <primary>message logs</primary>
26637 <secondary>preserving</secondary>
26638 </indexterm>
26639 If this option is set, message log files are not deleted when messages are
26640 completed. Instead, they are moved to a sub-directory of the spool directory
26641 called <filename>msglog.OLD</filename>, where they remain available for statistical or debugging
26642 purposes. This is a dangerous option to set on systems with any appreciable
26643 volume of mail. Use with care!
26644 </para>
26645 <para>
26646 <indexterm role="option">
26647 <primary><option>primary_hostname</option></primary>
26648 </indexterm>
26649 </para>
26650 <informaltable frame="all">
26651 <tgroup cols="4" colsep="0" rowsep="0">
26652 <colspec colwidth="8*" align="left"/>
26653 <colspec colwidth="6*" align="center"/>
26654 <colspec colwidth="6*" align="center"/>
26655 <colspec colwidth="6*" align="right"/>
26656 <tbody>
26657 <row>
26658 <entry><option>primary_hostname</option></entry>
26659 <entry>Use: <emphasis>main</emphasis></entry>
26660 <entry>Type: <emphasis>string</emphasis></entry>
26661 <entry>Default: <emphasis>see below</emphasis></entry>
26662 </row>
26663 </tbody>
26664 </tgroup>
26665 </informaltable>
26666 <para>
26667 <indexterm role="concept">
26668 <primary>name</primary>
26669 <secondary>of local host</secondary>
26670 </indexterm>
26671 <indexterm role="concept">
26672 <primary>host</primary>
26673 <secondary>name of local</secondary>
26674 </indexterm>
26675 <indexterm role="concept">
26676 <primary>local host</primary>
26677 <secondary>name of</secondary>
26678 </indexterm>
26679 <indexterm role="variable">
26680 <primary><varname>$primary_hostname</varname></primary>
26681 </indexterm>
26682 This specifies the name of the current host. It is used in the default EHLO or
26683 HELO command for outgoing SMTP messages (changeable via the <option>helo_data</option>
26684 option in the <command>smtp</command> transport), and as the default for <option>qualify_domain</option>.
26685 The value is also used by default in some SMTP response messages from an Exim
26686 server. This can be changed dynamically by setting <option>smtp_active_hostname</option>.
26687 </para>
26688 <para>
26689 If <option>primary_hostname</option> is not set, Exim calls <function>uname()</function> to find the host
26690 name. If this fails, Exim panics and dies. If the name returned by <function>uname()</function>
26691 contains only one component, Exim passes it to <function>gethostbyname()</function> (or
26692 <function>getipnodebyname()</function> when available) in order to obtain the fully qualified
26693 version. The variable <varname>$primary_hostname</varname> contains the host name, whether set
26694 explicitly by this option, or defaulted.
26695 </para>
26696 <para>
26697 <indexterm role="option">
26698 <primary><option>print_topbitchars</option></primary>
26699 </indexterm>
26700 </para>
26701 <informaltable frame="all">
26702 <tgroup cols="4" colsep="0" rowsep="0">
26703 <colspec colwidth="8*" align="left"/>
26704 <colspec colwidth="6*" align="center"/>
26705 <colspec colwidth="6*" align="center"/>
26706 <colspec colwidth="6*" align="right"/>
26707 <tbody>
26708 <row>
26709 <entry><option>print_topbitchars</option></entry>
26710 <entry>Use: <emphasis>main</emphasis></entry>
26711 <entry>Type: <emphasis>boolean</emphasis></entry>
26712 <entry>Default: <emphasis>false</emphasis></entry>
26713 </row>
26714 </tbody>
26715 </tgroup>
26716 </informaltable>
26717 <para>
26718 <indexterm role="concept">
26719 <primary>printing characters</primary>
26720 </indexterm>
26721 <indexterm role="concept">
26722 <primary>8-bit characters</primary>
26723 </indexterm>
26724 By default, Exim considers only those characters whose codes lie in the range
26725 32&ndash;126 to be printing characters. In a number of circumstances (for example,
26726 when writing log entries) non-printing characters are converted into escape
26727 sequences, primarily to avoid messing up the layout. If <option>print_topbitchars</option>
26728 is set, code values of 128 and above are also considered to be printing
26729 characters.
26730 </para>
26731 <para>
26732 This option also affects the header syntax checks performed by the
26733 <command>autoreply</command> transport, and whether Exim uses RFC 2047 encoding of
26734 the user&#x2019;s full name when constructing From: and Sender: addresses (as
26735 described in section <xref linkend="SECTconstr"/>). Setting this option can cause
26736 Exim to generate eight bit message headers that do not conform to the
26737 standards.
26738 </para>
26739 <para>
26740 <indexterm role="option">
26741 <primary><option>process_log_path</option></primary>
26742 </indexterm>
26743 </para>
26744 <informaltable frame="all">
26745 <tgroup cols="4" colsep="0" rowsep="0">
26746 <colspec colwidth="8*" align="left"/>
26747 <colspec colwidth="6*" align="center"/>
26748 <colspec colwidth="6*" align="center"/>
26749 <colspec colwidth="6*" align="right"/>
26750 <tbody>
26751 <row>
26752 <entry><option>process_log_path</option></entry>
26753 <entry>Use: <emphasis>main</emphasis></entry>
26754 <entry>Type: <emphasis>string</emphasis></entry>
26755 <entry>Default: <emphasis>unset</emphasis></entry>
26756 </row>
26757 </tbody>
26758 </tgroup>
26759 </informaltable>
26760 <para>
26761 <indexterm role="concept">
26762 <primary>process log path</primary>
26763 </indexterm>
26764 <indexterm role="concept">
26765 <primary>log</primary>
26766 <secondary>process log</secondary>
26767 </indexterm>
26768 <indexterm role="concept">
26769 <primary><emphasis>exiwhat</emphasis></primary>
26770 </indexterm>
26771 This option sets the name of the file to which an Exim process writes its
26772 <quote>process log</quote> when sent a USR1 signal. This is used by the <emphasis>exiwhat</emphasis>
26773 utility script. If this option is unset, the file called <filename>exim-process.info</filename>
26774 in Exim&#x2019;s spool directory is used. The ability to specify the name explicitly
26775 can be useful in environments where two different Exims are running, using
26776 different spool directories.
26777 </para>
26778 <para>
26779 <indexterm role="option">
26780 <primary><option>prod_requires_admin</option></primary>
26781 </indexterm>
26782 </para>
26783 <informaltable frame="all">
26784 <tgroup cols="4" colsep="0" rowsep="0">
26785 <colspec colwidth="8*" align="left"/>
26786 <colspec colwidth="6*" align="center"/>
26787 <colspec colwidth="6*" align="center"/>
26788 <colspec colwidth="6*" align="right"/>
26789 <tbody>
26790 <row>
26791 <entry><option>prod_requires_admin</option></entry>
26792 <entry>Use: <emphasis>main</emphasis></entry>
26793 <entry>Type: <emphasis>boolean</emphasis></entry>
26794 <entry>Default: <emphasis>true</emphasis></entry>
26795 </row>
26796 </tbody>
26797 </tgroup>
26798 </informaltable>
26799 <para>
26800 <indexterm role="option">
26801 <primary><option>-M</option></primary>
26802 </indexterm>
26803 <indexterm role="option">
26804 <primary><option>-R</option></primary>
26805 </indexterm>
26806 <indexterm role="option">
26807 <primary><option>-q</option></primary>
26808 </indexterm>
26809 The <option>-M</option>, <option>-R</option>, and <option>-q</option> command-line options require the caller to be an
26810 admin user unless <option>prod_requires_admin</option> is set false. See also
26811 <option>queue_list_requires_admin</option>.
26812 </para>
26813 <para>
26814 <indexterm role="option">
26815 <primary><option>qualify_domain</option></primary>
26816 </indexterm>
26817 </para>
26818 <informaltable frame="all">
26819 <tgroup cols="4" colsep="0" rowsep="0">
26820 <colspec colwidth="8*" align="left"/>
26821 <colspec colwidth="6*" align="center"/>
26822 <colspec colwidth="6*" align="center"/>
26823 <colspec colwidth="6*" align="right"/>
26824 <tbody>
26825 <row>
26826 <entry><option>qualify_domain</option></entry>
26827 <entry>Use: <emphasis>main</emphasis></entry>
26828 <entry>Type: <emphasis>string</emphasis></entry>
26829 <entry>Default: <emphasis>see below</emphasis></entry>
26830 </row>
26831 </tbody>
26832 </tgroup>
26833 </informaltable>
26834 <para>
26835 <indexterm role="concept">
26836 <primary>domain</primary>
26837 <secondary>for qualifying addresses</secondary>
26838 </indexterm>
26839 <indexterm role="concept">
26840 <primary>address</primary>
26841 <secondary>qualification</secondary>
26842 </indexterm>
26843 This option specifies the domain name that is added to any envelope sender
26844 addresses that do not have a domain qualification. It also applies to
26845 recipient addresses if <option>qualify_recipient</option> is not set. Unqualified addresses
26846 are accepted by default only for locally-generated messages. Qualification is
26847 also applied to addresses in header lines such as <emphasis>From:</emphasis> and <emphasis>To:</emphasis> for
26848 locally-generated messages, unless the <option>-bnq</option> command line option is used.
26849 </para>
26850 <para>
26851 Messages from external sources must always contain fully qualified addresses,
26852 unless the sending host matches <option>sender_unqualified_hosts</option> or
26853 <option>recipient_unqualified_hosts</option> (as appropriate), in which case incoming
26854 addresses are qualified with <option>qualify_domain</option> or <option>qualify_recipient</option> as
26855 necessary. Internally, Exim always works with fully qualified envelope
26856 addresses. If <option>qualify_domain</option> is not set, it defaults to the
26857 <option>primary_hostname</option> value.
26858 </para>
26859 <para>
26860 <indexterm role="option">
26861 <primary><option>qualify_recipient</option></primary>
26862 </indexterm>
26863 </para>
26864 <informaltable frame="all">
26865 <tgroup cols="4" colsep="0" rowsep="0">
26866 <colspec colwidth="8*" align="left"/>
26867 <colspec colwidth="6*" align="center"/>
26868 <colspec colwidth="6*" align="center"/>
26869 <colspec colwidth="6*" align="right"/>
26870 <tbody>
26871 <row>
26872 <entry><option>qualify_recipient</option></entry>
26873 <entry>Use: <emphasis>main</emphasis></entry>
26874 <entry>Type: <emphasis>string</emphasis></entry>
26875 <entry>Default: <emphasis>see below</emphasis></entry>
26876 </row>
26877 </tbody>
26878 </tgroup>
26879 </informaltable>
26880 <para>
26881 This option allows you to specify a different domain for qualifying recipient
26882 addresses to the one that is used for senders. See <option>qualify_domain</option> above.
26883 </para>
26884 <para>
26885 <indexterm role="option">
26886 <primary><option>queue_domains</option></primary>
26887 </indexterm>
26888 </para>
26889 <informaltable frame="all">
26890 <tgroup cols="4" colsep="0" rowsep="0">
26891 <colspec colwidth="8*" align="left"/>
26892 <colspec colwidth="6*" align="center"/>
26893 <colspec colwidth="6*" align="center"/>
26894 <colspec colwidth="6*" align="right"/>
26895 <tbody>
26896 <row>
26897 <entry><option>queue_domains</option></entry>
26898 <entry>Use: <emphasis>main</emphasis></entry>
26899 <entry>Type: <emphasis>domain list</emphasis>&dagger;<emphasis></emphasis></entry>
26900 <entry>Default: <emphasis>unset</emphasis></entry>
26901 </row>
26902 </tbody>
26903 </tgroup>
26904 </informaltable>
26905 <para>
26906 <indexterm role="concept">
26907 <primary>domain</primary>
26908 <secondary>specifying non-immediate delivery</secondary>
26909 </indexterm>
26910 <indexterm role="concept">
26911 <primary>queueing incoming messages</primary>
26912 </indexterm>
26913 <indexterm role="concept">
26914 <primary>message</primary>
26915 <secondary>queueing certain domains</secondary>
26916 </indexterm>
26917 This option lists domains for which immediate delivery is not required.
26918 A delivery process is started whenever a message is received, but only those
26919 domains that do not match are processed. All other deliveries wait until the
26920 next queue run. See also <option>hold_domains</option> and <option>queue_smtp_domains</option>.
26921 </para>
26922 <para>
26923 <indexterm role="option">
26924 <primary><option>queue_list_requires_admin</option></primary>
26925 </indexterm>
26926 </para>
26927 <informaltable frame="all">
26928 <tgroup cols="4" colsep="0" rowsep="0">
26929 <colspec colwidth="8*" align="left"/>
26930 <colspec colwidth="6*" align="center"/>
26931 <colspec colwidth="6*" align="center"/>
26932 <colspec colwidth="6*" align="right"/>
26933 <tbody>
26934 <row>
26935 <entry><option>queue_list_requires_admin</option></entry>
26936 <entry>Use: <emphasis>main</emphasis></entry>
26937 <entry>Type: <emphasis>boolean</emphasis></entry>
26938 <entry>Default: <emphasis>true</emphasis></entry>
26939 </row>
26940 </tbody>
26941 </tgroup>
26942 </informaltable>
26943 <para>
26944 <indexterm role="option">
26945 <primary><option>-bp</option></primary>
26946 </indexterm>
26947 The <option>-bp</option> command-line option, which lists the messages that are on the
26948 queue, requires the caller to be an admin user unless
26949 <option>queue_list_requires_admin</option> is set false. See also <option>prod_requires_admin</option>.
26950 </para>
26951 <para>
26952 <indexterm role="option">
26953 <primary><option>queue_only</option></primary>
26954 </indexterm>
26955 </para>
26956 <informaltable frame="all">
26957 <tgroup cols="4" colsep="0" rowsep="0">
26958 <colspec colwidth="8*" align="left"/>
26959 <colspec colwidth="6*" align="center"/>
26960 <colspec colwidth="6*" align="center"/>
26961 <colspec colwidth="6*" align="right"/>
26962 <tbody>
26963 <row>
26964 <entry><option>queue_only</option></entry>
26965 <entry>Use: <emphasis>main</emphasis></entry>
26966 <entry>Type: <emphasis>boolean</emphasis></entry>
26967 <entry>Default: <emphasis>false</emphasis></entry>
26968 </row>
26969 </tbody>
26970 </tgroup>
26971 </informaltable>
26972 <para>
26973 <indexterm role="concept">
26974 <primary>queueing incoming messages</primary>
26975 </indexterm>
26976 <indexterm role="concept">
26977 <primary>message</primary>
26978 <secondary>queueing unconditionally</secondary>
26979 </indexterm>
26980 If <option>queue_only</option> is set, a delivery process is not automatically started
26981 whenever a message is received. Instead, the message waits on the queue for the
26982 next queue run. Even if <option>queue_only</option> is false, incoming messages may not get
26983 delivered immediately when certain conditions (such as heavy load) occur.
26984 </para>
26985 <para>
26986 The <option>-odq</option> command line has the same effect as <option>queue_only</option>. The <option>-odb</option>
26987 and <option>-odi</option> command line options override <option>queue_only</option> unless
26988 <option>queue_only_override</option> is set false. See also <option>queue_only_file</option>,
26989 <option>queue_only_load</option>, and <option>smtp_accept_queue</option>.
26990 </para>
26991 <para>
26992 <indexterm role="option">
26993 <primary><option>queue_only_file</option></primary>
26994 </indexterm>
26995 </para>
26996 <informaltable frame="all">
26997 <tgroup cols="4" colsep="0" rowsep="0">
26998 <colspec colwidth="8*" align="left"/>
26999 <colspec colwidth="6*" align="center"/>
27000 <colspec colwidth="6*" align="center"/>
27001 <colspec colwidth="6*" align="right"/>
27002 <tbody>
27003 <row>
27004 <entry><option>queue_only_file</option></entry>
27005 <entry>Use: <emphasis>main</emphasis></entry>
27006 <entry>Type: <emphasis>string</emphasis></entry>
27007 <entry>Default: <emphasis>unset</emphasis></entry>
27008 </row>
27009 </tbody>
27010 </tgroup>
27011 </informaltable>
27012 <para>
27013 <indexterm role="concept">
27014 <primary>queueing incoming messages</primary>
27015 </indexterm>
27016 <indexterm role="concept">
27017 <primary>message</primary>
27018 <secondary>queueing by file existence</secondary>
27019 </indexterm>
27020 This option can be set to a colon-separated list of absolute path names, each
27021 one optionally preceded by <quote>smtp</quote>. When Exim is receiving a message,
27022 it tests for the existence of each listed path using a call to <function>stat()</function>. For
27023 each path that exists, the corresponding queueing option is set.
27024 For paths with no prefix, <option>queue_only</option> is set; for paths prefixed by
27025 <quote>smtp</quote>, <option>queue_smtp_domains</option> is set to match all domains. So, for example,
27026 </para>
27027 <literallayout class="monospaced">
27028 queue_only_file = smtp/some/file
27029 </literallayout>
27030 <para>
27031 causes Exim to behave as if <option>queue_smtp_domains</option> were set to <quote>*</quote> whenever
27032 <filename>/some/file</filename> exists.
27033 </para>
27034 <para>
27035 <indexterm role="option">
27036 <primary><option>queue_only_load</option></primary>
27037 </indexterm>
27038 </para>
27039 <informaltable frame="all">
27040 <tgroup cols="4" colsep="0" rowsep="0">
27041 <colspec colwidth="8*" align="left"/>
27042 <colspec colwidth="6*" align="center"/>
27043 <colspec colwidth="6*" align="center"/>
27044 <colspec colwidth="6*" align="right"/>
27045 <tbody>
27046 <row>
27047 <entry><option>queue_only_load</option></entry>
27048 <entry>Use: <emphasis>main</emphasis></entry>
27049 <entry>Type: <emphasis>fixed-point</emphasis></entry>
27050 <entry>Default: <emphasis>unset</emphasis></entry>
27051 </row>
27052 </tbody>
27053 </tgroup>
27054 </informaltable>
27055 <para>
27056 <indexterm role="concept">
27057 <primary>load average</primary>
27058 </indexterm>
27059 <indexterm role="concept">
27060 <primary>queueing incoming messages</primary>
27061 </indexterm>
27062 <indexterm role="concept">
27063 <primary>message</primary>
27064 <secondary>queueing by load</secondary>
27065 </indexterm>
27066 If the system load average is higher than this value, incoming messages from
27067 all sources are queued, and no automatic deliveries are started. If this
27068 happens during local or remote SMTP input, all subsequent messages received on
27069 the same SMTP connection are queued by default, whatever happens to the load in
27070 the meantime, but this can be changed by setting <option>queue_only_load_latch</option>
27071 false.
27072 </para>
27073 <para>
27074 Deliveries will subsequently be performed by queue runner processes. This
27075 option has no effect on ancient operating systems on which Exim cannot
27076 determine the load average. See also <option>deliver_queue_load_max</option> and
27077 <option>smtp_load_reserve</option>.
27078 </para>
27079 <para>
27080 <indexterm role="option">
27081 <primary><option>queue_only_load_latch</option></primary>
27082 </indexterm>
27083 </para>
27084 <informaltable frame="all">
27085 <tgroup cols="4" colsep="0" rowsep="0">
27086 <colspec colwidth="8*" align="left"/>
27087 <colspec colwidth="6*" align="center"/>
27088 <colspec colwidth="6*" align="center"/>
27089 <colspec colwidth="6*" align="right"/>
27090 <tbody>
27091 <row>
27092 <entry><option>queue_only_load_latch</option></entry>
27093 <entry>Use: <emphasis>main</emphasis></entry>
27094 <entry>Type: <emphasis>boolean</emphasis></entry>
27095 <entry>Default: <emphasis>true</emphasis></entry>
27096 </row>
27097 </tbody>
27098 </tgroup>
27099 </informaltable>
27100 <para>
27101 <indexterm role="concept">
27102 <primary>load average</primary>
27103 <secondary>re-evaluating per message</secondary>
27104 </indexterm>
27105 When this option is true (the default), once one message has been queued
27106 because the load average is higher than the value set by <option>queue_only_load</option>,
27107 all subsequent messages received on the same SMTP connection are also queued.
27108 This is a deliberate choice; even though the load average may fall below the
27109 threshold, it doesn&#x2019;t seem right to deliver later messages on the same
27110 connection when not delivering earlier ones. However, there are special
27111 circumstances such as very long-lived connections from scanning appliances
27112 where this is not the best strategy. In such cases, <option>queue_only_load_latch</option>
27113 should be set false. This causes the value of the load average to be
27114 re-evaluated for each message.
27115 </para>
27116 <para>
27117 <indexterm role="option">
27118 <primary><option>queue_only_override</option></primary>
27119 </indexterm>
27120 </para>
27121 <informaltable frame="all">
27122 <tgroup cols="4" colsep="0" rowsep="0">
27123 <colspec colwidth="8*" align="left"/>
27124 <colspec colwidth="6*" align="center"/>
27125 <colspec colwidth="6*" align="center"/>
27126 <colspec colwidth="6*" align="right"/>
27127 <tbody>
27128 <row>
27129 <entry><option>queue_only_override</option></entry>
27130 <entry>Use: <emphasis>main</emphasis></entry>
27131 <entry>Type: <emphasis>boolean</emphasis></entry>
27132 <entry>Default: <emphasis>true</emphasis></entry>
27133 </row>
27134 </tbody>
27135 </tgroup>
27136 </informaltable>
27137 <para>
27138 <indexterm role="concept">
27139 <primary>queueing incoming messages</primary>
27140 </indexterm>
27141 When this option is true, the <option>-od</option><emphasis>x</emphasis> command line options override the
27142 setting of <option>queue_only</option> or <option>queue_only_file</option> in the configuration file. If
27143 <option>queue_only_override</option> is set false, the <option>-od</option><emphasis>x</emphasis> options cannot be used
27144 to override; they are accepted, but ignored.
27145 </para>
27146 <para>
27147 <indexterm role="option">
27148 <primary><option>queue_run_in_order</option></primary>
27149 </indexterm>
27150 </para>
27151 <informaltable frame="all">
27152 <tgroup cols="4" colsep="0" rowsep="0">
27153 <colspec colwidth="8*" align="left"/>
27154 <colspec colwidth="6*" align="center"/>
27155 <colspec colwidth="6*" align="center"/>
27156 <colspec colwidth="6*" align="right"/>
27157 <tbody>
27158 <row>
27159 <entry><option>queue_run_in_order</option></entry>
27160 <entry>Use: <emphasis>main</emphasis></entry>
27161 <entry>Type: <emphasis>boolean</emphasis></entry>
27162 <entry>Default: <emphasis>false</emphasis></entry>
27163 </row>
27164 </tbody>
27165 </tgroup>
27166 </informaltable>
27167 <para>
27168 <indexterm role="concept">
27169 <primary>queue runner</primary>
27170 <secondary>processing messages in order</secondary>
27171 </indexterm>
27172 If this option is set, queue runs happen in order of message arrival instead of
27173 in an arbitrary order. For this to happen, a complete list of the entire queue
27174 must be set up before the deliveries start. When the queue is all held in a
27175 single directory (the default), a single list is created for both the ordered
27176 and the non-ordered cases. However, if <option>split_spool_directory</option> is set, a
27177 single list is not created when <option>queue_run_in_order</option> is false. In this case,
27178 the sub-directories are processed one at a time (in a random order), and this
27179 avoids setting up one huge list for the whole queue. Thus, setting
27180 <option>queue_run_in_order</option> with <option>split_spool_directory</option> may degrade performance
27181 when the queue is large, because of the extra work in setting up the single,
27182 large list. In most situations, <option>queue_run_in_order</option> should not be set.
27183 </para>
27184 <para>
27185 <indexterm role="option">
27186 <primary><option>queue_run_max</option></primary>
27187 </indexterm>
27188 </para>
27189 <informaltable frame="all">
27190 <tgroup cols="4" colsep="0" rowsep="0">
27191 <colspec colwidth="8*" align="left"/>
27192 <colspec colwidth="6*" align="center"/>
27193 <colspec colwidth="6*" align="center"/>
27194 <colspec colwidth="6*" align="right"/>
27195 <tbody>
27196 <row>
27197 <entry><option>queue_run_max</option></entry>
27198 <entry>Use: <emphasis>main</emphasis></entry>
27199 <entry>Type: <emphasis>integer</emphasis></entry>
27200 <entry>Default: <emphasis>5</emphasis></entry>
27201 </row>
27202 </tbody>
27203 </tgroup>
27204 </informaltable>
27205 <para>
27206 <indexterm role="concept">
27207 <primary>queue runner</primary>
27208 <secondary>maximum number of</secondary>
27209 </indexterm>
27210 This controls the maximum number of queue runner processes that an Exim daemon
27211 can run simultaneously. This does not mean that it starts them all at once,
27212 but rather that if the maximum number are still running when the time comes to
27213 start another one, it refrains from starting another one. This can happen with
27214 very large queues and/or very sluggish deliveries. This option does not,
27215 however, interlock with other processes, so additional queue runners can be
27216 started by other means, or by killing and restarting the daemon.
27217 </para>
27218 <para>
27219 Setting this option to zero does not suppress queue runs; rather, it disables
27220 the limit, allowing any number of simultaneous queue runner processes to be
27221 run. If you do not want queue runs to occur, omit the <option>-q</option><emphasis>xx</emphasis> setting on
27222 the daemon&#x2019;s command line.
27223 </para>
27224 <para>
27225 <indexterm role="option">
27226 <primary><option>queue_smtp_domains</option></primary>
27227 </indexterm>
27228 </para>
27229 <informaltable frame="all">
27230 <tgroup cols="4" colsep="0" rowsep="0">
27231 <colspec colwidth="8*" align="left"/>
27232 <colspec colwidth="6*" align="center"/>
27233 <colspec colwidth="6*" align="center"/>
27234 <colspec colwidth="6*" align="right"/>
27235 <tbody>
27236 <row>
27237 <entry><option>queue_smtp_domains</option></entry>
27238 <entry>Use: <emphasis>main</emphasis></entry>
27239 <entry>Type: <emphasis>domain list</emphasis>&dagger;<emphasis></emphasis></entry>
27240 <entry>Default: <emphasis>unset</emphasis></entry>
27241 </row>
27242 </tbody>
27243 </tgroup>
27244 </informaltable>
27245 <para>
27246 <indexterm role="concept">
27247 <primary>queueing incoming messages</primary>
27248 </indexterm>
27249 <indexterm role="concept">
27250 <primary>message</primary>
27251 <secondary>queueing remote deliveries</secondary>
27252 </indexterm>
27253 When this option is set, a delivery process is started whenever a message is
27254 received, routing is performed, and local deliveries take place.
27255 However, if any SMTP deliveries are required for domains that match
27256 <option>queue_smtp_domains</option>, they are not immediately delivered, but instead the
27257 message waits on the queue for the next queue run. Since routing of the message
27258 has taken place, Exim knows to which remote hosts it must be delivered, and so
27259 when the queue run happens, multiple messages for the same host are delivered
27260 over a single SMTP connection. The <option>-odqs</option> command line option causes all
27261 SMTP deliveries to be queued in this way, and is equivalent to setting
27262 <option>queue_smtp_domains</option> to <quote>*</quote>. See also <option>hold_domains</option> and
27263 <option>queue_domains</option>.
27264 </para>
27265 <para>
27266 <indexterm role="option">
27267 <primary><option>receive_timeout</option></primary>
27268 </indexterm>
27269 </para>
27270 <informaltable frame="all">
27271 <tgroup cols="4" colsep="0" rowsep="0">
27272 <colspec colwidth="8*" align="left"/>
27273 <colspec colwidth="6*" align="center"/>
27274 <colspec colwidth="6*" align="center"/>
27275 <colspec colwidth="6*" align="right"/>
27276 <tbody>
27277 <row>
27278 <entry><option>receive_timeout</option></entry>
27279 <entry>Use: <emphasis>main</emphasis></entry>
27280 <entry>Type: <emphasis>time</emphasis></entry>
27281 <entry>Default: <emphasis>0s</emphasis></entry>
27282 </row>
27283 </tbody>
27284 </tgroup>
27285 </informaltable>
27286 <para>
27287 <indexterm role="concept">
27288 <primary>timeout</primary>
27289 <secondary>for non-SMTP input</secondary>
27290 </indexterm>
27291 This option sets the timeout for accepting a non-SMTP message, that is, the
27292 maximum time that Exim waits when reading a message on the standard input. If
27293 the value is zero, it will wait for ever. This setting is overridden by the
27294 <option>-or</option> command line option. The timeout for incoming SMTP messages is
27295 controlled by <option>smtp_receive_timeout</option>.
27296 </para>
27297 <para>
27298 <indexterm role="option">
27299 <primary><option>received_header_text</option></primary>
27300 </indexterm>
27301 </para>
27302 <informaltable frame="all">
27303 <tgroup cols="4" colsep="0" rowsep="0">
27304 <colspec colwidth="8*" align="left"/>
27305 <colspec colwidth="6*" align="center"/>
27306 <colspec colwidth="6*" align="center"/>
27307 <colspec colwidth="6*" align="right"/>
27308 <tbody>
27309 <row>
27310 <entry><option>received_header_text</option></entry>
27311 <entry>Use: <emphasis>main</emphasis></entry>
27312 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
27313 <entry>Default: <emphasis>see below</emphasis></entry>
27314 </row>
27315 </tbody>
27316 </tgroup>
27317 </informaltable>
27318 <para>
27319 <indexterm role="concept">
27320 <primary>customizing</primary>
27321 <secondary><emphasis>Received:</emphasis> header</secondary>
27322 </indexterm>
27323 <indexterm role="concept">
27324 <primary><emphasis>Received:</emphasis> header line</primary>
27325 <secondary>customizing</secondary>
27326 </indexterm>
27327 This string defines the contents of the <emphasis>Received:</emphasis> message header that is
27328 added to each message, except for the timestamp, which is automatically added
27329 on at the end (preceded by a semicolon). The string is expanded each time it is
27330 used. If the expansion yields an empty string, no <emphasis>Received:</emphasis> header line is
27331 added to the message. Otherwise, the string should start with the text
27332 <quote>Received:</quote> and conform to the RFC 2822 specification for <emphasis>Received:</emphasis>
27333 header lines. The default setting is:
27334 </para>
27335 <literallayout class="monospaced">
27336 received_header_text = Received: \
27337   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
27338   {${if def:sender_ident \
27339   {from ${quote_local_part:$sender_ident} }}\
27340   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
27341   by $primary_hostname \
27342   ${if def:received_protocol {with $received_protocol}} \
27343   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
27344   (Exim $version_number)\n\t\
27345   ${if def:sender_address \
27346   {(envelope-from &lt;$sender_address&gt;)\n\t}}\
27347   id $message_exim_id\
27348   ${if def:received_for {\n\tfor $received_for}}
27349 </literallayout>
27350 <para>
27351 The reference to the TLS cipher is omitted when Exim is built without TLS
27352 support. The use of conditional expansions ensures that this works for both
27353 locally generated messages and messages received from remote hosts, giving
27354 header lines such as the following:
27355 </para>
27356 <literallayout class="monospaced">
27357 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
27358 by marley.carol.example with esmtp (Exim 4.00)
27359 (envelope-from &lt;bob@carol.example&gt;)
27360 id 16IOWa-00019l-00
27361 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
27362 Received: by scrooge.carol.example with local (Exim 4.00)
27363 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
27364 </literallayout>
27365 <para>
27366 Until the body of the message has been received, the timestamp is the time when
27367 the message started to be received. Once the body has arrived, and all policy
27368 checks have taken place, the timestamp is updated to the time at which the
27369 message was accepted.
27370 </para>
27371 <para>
27372 <indexterm role="option">
27373 <primary><option>received_headers_max</option></primary>
27374 </indexterm>
27375 </para>
27376 <informaltable frame="all">
27377 <tgroup cols="4" colsep="0" rowsep="0">
27378 <colspec colwidth="8*" align="left"/>
27379 <colspec colwidth="6*" align="center"/>
27380 <colspec colwidth="6*" align="center"/>
27381 <colspec colwidth="6*" align="right"/>
27382 <tbody>
27383 <row>
27384 <entry><option>received_headers_max</option></entry>
27385 <entry>Use: <emphasis>main</emphasis></entry>
27386 <entry>Type: <emphasis>integer</emphasis></entry>
27387 <entry>Default: <emphasis>30</emphasis></entry>
27388 </row>
27389 </tbody>
27390 </tgroup>
27391 </informaltable>
27392 <para>
27393 <indexterm role="concept">
27394 <primary>loop</primary>
27395 <secondary>prevention</secondary>
27396 </indexterm>
27397 <indexterm role="concept">
27398 <primary>mail loop prevention</primary>
27399 </indexterm>
27400 <indexterm role="concept">
27401 <primary><emphasis>Received:</emphasis> header line</primary>
27402 <secondary>counting</secondary>
27403 </indexterm>
27404 When a message is to be delivered, the number of <emphasis>Received:</emphasis> headers is
27405 counted, and if it is greater than this parameter, a mail loop is assumed to
27406 have occurred, the delivery is abandoned, and an error message is generated.
27407 This applies to both local and remote deliveries.
27408 </para>
27409 <para>
27410 <indexterm role="option">
27411 <primary><option>recipient_unqualified_hosts</option></primary>
27412 </indexterm>
27413 </para>
27414 <informaltable frame="all">
27415 <tgroup cols="4" colsep="0" rowsep="0">
27416 <colspec colwidth="8*" align="left"/>
27417 <colspec colwidth="6*" align="center"/>
27418 <colspec colwidth="6*" align="center"/>
27419 <colspec colwidth="6*" align="right"/>
27420 <tbody>
27421 <row>
27422 <entry><option>recipient_unqualified_hosts</option></entry>
27423 <entry>Use: <emphasis>main</emphasis></entry>
27424 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
27425 <entry>Default: <emphasis>unset</emphasis></entry>
27426 </row>
27427 </tbody>
27428 </tgroup>
27429 </informaltable>
27430 <para>
27431 <indexterm role="concept">
27432 <primary>unqualified addresses</primary>
27433 </indexterm>
27434 <indexterm role="concept">
27435 <primary>host</primary>
27436 <secondary>unqualified addresses from</secondary>
27437 </indexterm>
27438 This option lists those hosts from which Exim is prepared to accept unqualified
27439 recipient addresses in message envelopes. The addresses are made fully
27440 qualified by the addition of the <option>qualify_recipient</option> value. This option also
27441 affects message header lines. Exim does not reject unqualified recipient
27442 addresses in headers, but it qualifies them only if the message came from a
27443 host that matches <option>recipient_unqualified_hosts</option>,
27444 or if the message was submitted locally (not using TCP/IP), and the <option>-bnq</option>
27445 option was not set.
27446 </para>
27447 <para>
27448 <indexterm role="option">
27449 <primary><option>recipients_max</option></primary>
27450 </indexterm>
27451 </para>
27452 <informaltable frame="all">
27453 <tgroup cols="4" colsep="0" rowsep="0">
27454 <colspec colwidth="8*" align="left"/>
27455 <colspec colwidth="6*" align="center"/>
27456 <colspec colwidth="6*" align="center"/>
27457 <colspec colwidth="6*" align="right"/>
27458 <tbody>
27459 <row>
27460 <entry><option>recipients_max</option></entry>
27461 <entry>Use: <emphasis>main</emphasis></entry>
27462 <entry>Type: <emphasis>integer</emphasis></entry>
27463 <entry>Default: <emphasis>0</emphasis></entry>
27464 </row>
27465 </tbody>
27466 </tgroup>
27467 </informaltable>
27468 <para>
27469 <indexterm role="concept">
27470 <primary>limit</primary>
27471 <secondary>number of recipients</secondary>
27472 </indexterm>
27473 <indexterm role="concept">
27474 <primary>recipient</primary>
27475 <secondary>maximum number</secondary>
27476 </indexterm>
27477 If this option is set greater than zero, it specifies the maximum number of
27478 original recipients for any message. Additional recipients that are generated
27479 by aliasing or forwarding do not count. SMTP messages get a 452 response for
27480 all recipients over the limit; earlier recipients are delivered as normal.
27481 Non-SMTP messages with too many recipients are failed, and no deliveries are
27482 done.
27483 </para>
27484 <para>
27485 <indexterm role="concept">
27486 <primary>RCPT</primary>
27487 <secondary>maximum number of incoming</secondary>
27488 </indexterm>
27489 <emphasis role="bold">Note</emphasis>: The RFCs specify that an SMTP server should accept at least 100
27490 RCPT commands in a single message.
27491 </para>
27492 <para>
27493 <indexterm role="option">
27494 <primary><option>recipients_max_reject</option></primary>
27495 </indexterm>
27496 </para>
27497 <informaltable frame="all">
27498 <tgroup cols="4" colsep="0" rowsep="0">
27499 <colspec colwidth="8*" align="left"/>
27500 <colspec colwidth="6*" align="center"/>
27501 <colspec colwidth="6*" align="center"/>
27502 <colspec colwidth="6*" align="right"/>
27503 <tbody>
27504 <row>
27505 <entry><option>recipients_max_reject</option></entry>
27506 <entry>Use: <emphasis>main</emphasis></entry>
27507 <entry>Type: <emphasis>boolean</emphasis></entry>
27508 <entry>Default: <emphasis>false</emphasis></entry>
27509 </row>
27510 </tbody>
27511 </tgroup>
27512 </informaltable>
27513 <para>
27514 If this option is set true, Exim rejects SMTP messages containing too many
27515 recipients by giving 552 errors to the surplus RCPT commands, and a 554
27516 error to the eventual DATA command. Otherwise (the default) it gives a 452
27517 error to the surplus RCPT commands and accepts the message on behalf of the
27518 initial set of recipients. The remote server should then re-send the message
27519 for the remaining recipients at a later time.
27520 </para>
27521 <para>
27522 <indexterm role="option">
27523 <primary><option>remote_max_parallel</option></primary>
27524 </indexterm>
27525 </para>
27526 <informaltable frame="all">
27527 <tgroup cols="4" colsep="0" rowsep="0">
27528 <colspec colwidth="8*" align="left"/>
27529 <colspec colwidth="6*" align="center"/>
27530 <colspec colwidth="6*" align="center"/>
27531 <colspec colwidth="6*" align="right"/>
27532 <tbody>
27533 <row>
27534 <entry><option>remote_max_parallel</option></entry>
27535 <entry>Use: <emphasis>main</emphasis></entry>
27536 <entry>Type: <emphasis>integer</emphasis></entry>
27537 <entry>Default: <emphasis>2</emphasis></entry>
27538 </row>
27539 </tbody>
27540 </tgroup>
27541 </informaltable>
27542 <para>
27543 <indexterm role="concept">
27544 <primary>delivery</primary>
27545 <secondary>parallelism for remote</secondary>
27546 </indexterm>
27547 This option controls parallel delivery of one message to a number of remote
27548 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
27549 does all the remote deliveries for a message one by one. Otherwise, if a single
27550 message has to be delivered to more than one remote host, or if several copies
27551 have to be sent to the same remote host, up to <option>remote_max_parallel</option>
27552 deliveries are done simultaneously. If more than <option>remote_max_parallel</option>
27553 deliveries are required, the maximum number of processes are started, and as
27554 each one finishes, another is begun. The order of starting processes is the
27555 same as if sequential delivery were being done, and can be controlled by the
27556 <option>remote_sort_domains</option> option. If parallel delivery takes place while running
27557 with debugging turned on, the debugging output from each delivery process is
27558 tagged with its process id.
27559 </para>
27560 <para>
27561 This option controls only the maximum number of parallel deliveries for one
27562 message in one Exim delivery process. Because Exim has no central queue
27563 manager, there is no way of controlling the total number of simultaneous
27564 deliveries if the configuration allows a delivery attempt as soon as a message
27565 is received.
27566 </para>
27567 <para>
27568 <indexterm role="concept">
27569 <primary>number of deliveries</primary>
27570 </indexterm>
27571 <indexterm role="concept">
27572 <primary>delivery</primary>
27573 <secondary>maximum number of</secondary>
27574 </indexterm>
27575 If you want to control the total number of deliveries on the system, you
27576 need to set the <option>queue_only</option> option. This ensures that all incoming messages
27577 are added to the queue without starting a delivery process. Then set up an Exim
27578 daemon to start queue runner processes at appropriate intervals (probably
27579 fairly often, for example, every minute), and limit the total number of queue
27580 runners by setting the <option>queue_run_max</option> parameter. Because each queue runner
27581 delivers only one message at a time, the maximum number of deliveries that can
27582 then take place at once is <option>queue_run_max</option> multiplied by
27583 <option>remote_max_parallel</option>.
27584 </para>
27585 <para>
27586 If it is purely remote deliveries you want to control, use
27587 <option>queue_smtp_domains</option> instead of <option>queue_only</option>. This has the added benefit of
27588 doing the SMTP routing before queueing, so that several messages for the same
27589 host will eventually get delivered down the same connection.
27590 </para>
27591 <para>
27592 <indexterm role="option">
27593 <primary><option>remote_sort_domains</option></primary>
27594 </indexterm>
27595 </para>
27596 <informaltable frame="all">
27597 <tgroup cols="4" colsep="0" rowsep="0">
27598 <colspec colwidth="8*" align="left"/>
27599 <colspec colwidth="6*" align="center"/>
27600 <colspec colwidth="6*" align="center"/>
27601 <colspec colwidth="6*" align="right"/>
27602 <tbody>
27603 <row>
27604 <entry><option>remote_sort_domains</option></entry>
27605 <entry>Use: <emphasis>main</emphasis></entry>
27606 <entry>Type: <emphasis>domain list</emphasis>&dagger;<emphasis></emphasis></entry>
27607 <entry>Default: <emphasis>unset</emphasis></entry>
27608 </row>
27609 </tbody>
27610 </tgroup>
27611 </informaltable>
27612 <para>
27613 <indexterm role="concept">
27614 <primary>sorting remote deliveries</primary>
27615 </indexterm>
27616 <indexterm role="concept">
27617 <primary>delivery</primary>
27618 <secondary>sorting remote</secondary>
27619 </indexterm>
27620 When there are a number of remote deliveries for a message, they are sorted by
27621 domain into the order given by this list. For example,
27622 </para>
27623 <literallayout class="monospaced">
27624 remote_sort_domains = *.cam.ac.uk:*.uk
27625 </literallayout>
27626 <para>
27627 would attempt to deliver to all addresses in the <emphasis>cam.ac.uk</emphasis> domain first,
27628 then to those in the <option>uk</option> domain, then to any others.
27629 </para>
27630 <para>
27631 <indexterm role="option">
27632 <primary><option>retry_data_expire</option></primary>
27633 </indexterm>
27634 </para>
27635 <informaltable frame="all">
27636 <tgroup cols="4" colsep="0" rowsep="0">
27637 <colspec colwidth="8*" align="left"/>
27638 <colspec colwidth="6*" align="center"/>
27639 <colspec colwidth="6*" align="center"/>
27640 <colspec colwidth="6*" align="right"/>
27641 <tbody>
27642 <row>
27643 <entry><option>retry_data_expire</option></entry>
27644 <entry>Use: <emphasis>main</emphasis></entry>
27645 <entry>Type: <emphasis>time</emphasis></entry>
27646 <entry>Default: <emphasis>7d</emphasis></entry>
27647 </row>
27648 </tbody>
27649 </tgroup>
27650 </informaltable>
27651 <para>
27652 <indexterm role="concept">
27653 <primary>hints database</primary>
27654 <secondary>data expiry</secondary>
27655 </indexterm>
27656 This option sets a <quote>use before</quote> time on retry information in Exim&#x2019;s hints
27657 database. Any older retry data is ignored. This means that, for example, once a
27658 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
27659 past failures.
27660 </para>
27661 <para>
27662 <indexterm role="option">
27663 <primary><option>retry_interval_max</option></primary>
27664 </indexterm>
27665 </para>
27666 <informaltable frame="all">
27667 <tgroup cols="4" colsep="0" rowsep="0">
27668 <colspec colwidth="8*" align="left"/>
27669 <colspec colwidth="6*" align="center"/>
27670 <colspec colwidth="6*" align="center"/>
27671 <colspec colwidth="6*" align="right"/>
27672 <tbody>
27673 <row>
27674 <entry><option>retry_interval_max</option></entry>
27675 <entry>Use: <emphasis>main</emphasis></entry>
27676 <entry>Type: <emphasis>time</emphasis></entry>
27677 <entry>Default: <emphasis>24h</emphasis></entry>
27678 </row>
27679 </tbody>
27680 </tgroup>
27681 </informaltable>
27682 <para>
27683 <indexterm role="concept">
27684 <primary>retry</primary>
27685 <secondary>limit on interval</secondary>
27686 </indexterm>
27687 <indexterm role="concept">
27688 <primary>limit</primary>
27689 <secondary>on retry interval</secondary>
27690 </indexterm>
27691 Chapter <xref linkend="CHAPretry"/> describes Exim&#x2019;s mechanisms for controlling the
27692 intervals between delivery attempts for messages that cannot be delivered
27693 straight away. This option sets an overall limit to the length of time between
27694 retries. It cannot be set greater than 24 hours; any attempt to do so forces
27695 the default value.
27696 </para>
27697 <para>
27698 <indexterm role="option">
27699 <primary><option>return_path_remove</option></primary>
27700 </indexterm>
27701 </para>
27702 <informaltable frame="all">
27703 <tgroup cols="4" colsep="0" rowsep="0">
27704 <colspec colwidth="8*" align="left"/>
27705 <colspec colwidth="6*" align="center"/>
27706 <colspec colwidth="6*" align="center"/>
27707 <colspec colwidth="6*" align="right"/>
27708 <tbody>
27709 <row>
27710 <entry><option>return_path_remove</option></entry>
27711 <entry>Use: <emphasis>main</emphasis></entry>
27712 <entry>Type: <emphasis>boolean</emphasis></entry>
27713 <entry>Default: <emphasis>true</emphasis></entry>
27714 </row>
27715 </tbody>
27716 </tgroup>
27717 </informaltable>
27718 <para>
27719 <indexterm role="concept">
27720 <primary><emphasis>Return-path:</emphasis> header line</primary>
27721 <secondary>removing</secondary>
27722 </indexterm>
27723 RFC 2821, section 4.4, states that an SMTP server must insert a
27724 <emphasis>Return-path:</emphasis> header line into a message when it makes a <quote>final delivery</quote>.
27725 The <emphasis>Return-path:</emphasis> header preserves the sender address as received in the
27726 MAIL command. This description implies that this header should not be present
27727 in an incoming message. If <option>return_path_remove</option> is true, any existing
27728 <emphasis>Return-path:</emphasis> headers are removed from messages at the time they are
27729 received. Exim&#x2019;s transports have options for adding <emphasis>Return-path:</emphasis> headers at
27730 the time of delivery. They are normally used only for final local deliveries.
27731 </para>
27732 <para>
27733 <indexterm role="option">
27734 <primary><option>return_size_limit</option></primary>
27735 </indexterm>
27736 </para>
27737 <informaltable frame="all">
27738 <tgroup cols="4" colsep="0" rowsep="0">
27739 <colspec colwidth="8*" align="left"/>
27740 <colspec colwidth="6*" align="center"/>
27741 <colspec colwidth="6*" align="center"/>
27742 <colspec colwidth="6*" align="right"/>
27743 <tbody>
27744 <row>
27745 <entry><option>return_size_limit</option></entry>
27746 <entry>Use: <emphasis>main</emphasis></entry>
27747 <entry>Type: <emphasis>integer</emphasis></entry>
27748 <entry>Default: <emphasis>100K</emphasis></entry>
27749 </row>
27750 </tbody>
27751 </tgroup>
27752 </informaltable>
27753 <para>
27754 This option is an obsolete synonym for <option>bounce_return_size_limit</option>.
27755 </para>
27756 <para>
27757 <indexterm role="option">
27758 <primary><option>rfc1413_hosts</option></primary>
27759 </indexterm>
27760 </para>
27761 <informaltable frame="all">
27762 <tgroup cols="4" colsep="0" rowsep="0">
27763 <colspec colwidth="8*" align="left"/>
27764 <colspec colwidth="6*" align="center"/>
27765 <colspec colwidth="6*" align="center"/>
27766 <colspec colwidth="6*" align="right"/>
27767 <tbody>
27768 <row>
27769 <entry><option>rfc1413_hosts</option></entry>
27770 <entry>Use: <emphasis>main</emphasis></entry>
27771 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
27772 <entry>Default: <emphasis>*</emphasis></entry>
27773 </row>
27774 </tbody>
27775 </tgroup>
27776 </informaltable>
27777 <para>
27778 <indexterm role="concept">
27779 <primary>RFC 1413</primary>
27780 </indexterm>
27781 <indexterm role="concept">
27782 <primary>host</primary>
27783 <secondary>for RFC 1413 calls</secondary>
27784 </indexterm>
27785 RFC 1413 identification calls are made to any client host which matches an item
27786 in the list.
27787 </para>
27788 <para>
27789 <indexterm role="option">
27790 <primary><option>rfc1413_query_timeout</option></primary>
27791 </indexterm>
27792 </para>
27793 <informaltable frame="all">
27794 <tgroup cols="4" colsep="0" rowsep="0">
27795 <colspec colwidth="8*" align="left"/>
27796 <colspec colwidth="6*" align="center"/>
27797 <colspec colwidth="6*" align="center"/>
27798 <colspec colwidth="6*" align="right"/>
27799 <tbody>
27800 <row>
27801 <entry><option>rfc1413_query_timeout</option></entry>
27802 <entry>Use: <emphasis>main</emphasis></entry>
27803 <entry>Type: <emphasis>time</emphasis></entry>
27804 <entry>Default: <emphasis>5s</emphasis></entry>
27805 </row>
27806 </tbody>
27807 </tgroup>
27808 </informaltable>
27809 <para>
27810 <indexterm role="concept">
27811 <primary>RFC 1413</primary>
27812 <secondary>query timeout</secondary>
27813 </indexterm>
27814 <indexterm role="concept">
27815 <primary>timeout</primary>
27816 <secondary>for RFC 1413 call</secondary>
27817 </indexterm>
27818 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
27819 no RFC 1413 calls are ever made.
27820 </para>
27821 <para>
27822 <indexterm role="option">
27823 <primary><option>sender_unqualified_hosts</option></primary>
27824 </indexterm>
27825 </para>
27826 <informaltable frame="all">
27827 <tgroup cols="4" colsep="0" rowsep="0">
27828 <colspec colwidth="8*" align="left"/>
27829 <colspec colwidth="6*" align="center"/>
27830 <colspec colwidth="6*" align="center"/>
27831 <colspec colwidth="6*" align="right"/>
27832 <tbody>
27833 <row>
27834 <entry><option>sender_unqualified_hosts</option></entry>
27835 <entry>Use: <emphasis>main</emphasis></entry>
27836 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
27837 <entry>Default: <emphasis>unset</emphasis></entry>
27838 </row>
27839 </tbody>
27840 </tgroup>
27841 </informaltable>
27842 <para>
27843 <indexterm role="concept">
27844 <primary>unqualified addresses</primary>
27845 </indexterm>
27846 <indexterm role="concept">
27847 <primary>host</primary>
27848 <secondary>unqualified addresses from</secondary>
27849 </indexterm>
27850 This option lists those hosts from which Exim is prepared to accept unqualified
27851 sender addresses. The addresses are made fully qualified by the addition of
27852 <option>qualify_domain</option>. This option also affects message header lines. Exim does
27853 not reject unqualified addresses in headers that contain sender addresses, but
27854 it qualifies them only if the message came from a host that matches
27855 <option>sender_unqualified_hosts</option>, or if the message was submitted locally (not
27856 using TCP/IP), and the <option>-bnq</option> option was not set.
27857 </para>
27858 <para>
27859 <indexterm role="option">
27860 <primary><option>smtp_accept_keepalive</option></primary>
27861 </indexterm>
27862 </para>
27863 <informaltable frame="all">
27864 <tgroup cols="4" colsep="0" rowsep="0">
27865 <colspec colwidth="8*" align="left"/>
27866 <colspec colwidth="6*" align="center"/>
27867 <colspec colwidth="6*" align="center"/>
27868 <colspec colwidth="6*" align="right"/>
27869 <tbody>
27870 <row>
27871 <entry><option>smtp_accept_keepalive</option></entry>
27872 <entry>Use: <emphasis>main</emphasis></entry>
27873 <entry>Type: <emphasis>boolean</emphasis></entry>
27874 <entry>Default: <emphasis>true</emphasis></entry>
27875 </row>
27876 </tbody>
27877 </tgroup>
27878 </informaltable>
27879 <para>
27880 <indexterm role="concept">
27881 <primary>keepalive</primary>
27882 <secondary>on incoming connection</secondary>
27883 </indexterm>
27884 This option controls the setting of the SO_KEEPALIVE option on incoming
27885 TCP/IP socket connections. When set, it causes the kernel to probe idle
27886 connections periodically, by sending packets with <quote>old</quote> sequence numbers. The
27887 other end of the connection should send an acknowledgment if the connection is
27888 still okay or a reset if the connection has been aborted. The reason for doing
27889 this is that it has the beneficial effect of freeing up certain types of
27890 connection that can get stuck when the remote host is disconnected without
27891 tidying up the TCP/IP call properly. The keepalive mechanism takes several
27892 hours to detect unreachable hosts.
27893 </para>
27894 <para>
27895 <indexterm role="option">
27896 <primary><option>smtp_accept_max</option></primary>
27897 </indexterm>
27898 </para>
27899 <informaltable frame="all">
27900 <tgroup cols="4" colsep="0" rowsep="0">
27901 <colspec colwidth="8*" align="left"/>
27902 <colspec colwidth="6*" align="center"/>
27903 <colspec colwidth="6*" align="center"/>
27904 <colspec colwidth="6*" align="right"/>
27905 <tbody>
27906 <row>
27907 <entry><option>smtp_accept_max</option></entry>
27908 <entry>Use: <emphasis>main</emphasis></entry>
27909 <entry>Type: <emphasis>integer</emphasis></entry>
27910 <entry>Default: <emphasis>20</emphasis></entry>
27911 </row>
27912 </tbody>
27913 </tgroup>
27914 </informaltable>
27915 <para>
27916 <indexterm role="concept">
27917 <primary>limit</primary>
27918 <secondary>incoming SMTP connections</secondary>
27919 </indexterm>
27920 <indexterm role="concept">
27921 <primary>SMTP</primary>
27922 <secondary>incoming connection count</secondary>
27923 </indexterm>
27924 <indexterm role="concept">
27925 <primary>inetd</primary>
27926 </indexterm>
27927 This option specifies the maximum number of simultaneous incoming SMTP calls
27928 that Exim will accept. It applies only to the listening daemon; there is no
27929 control (in Exim) when incoming SMTP is being handled by <emphasis>inetd</emphasis>. If the
27930 value is set to zero, no limit is applied. However, it is required to be
27931 non-zero if either <option>smtp_accept_max_per_host</option> or <option>smtp_accept_queue</option> is
27932 set. See also <option>smtp_accept_reserve</option> and <option>smtp_load_reserve</option>.
27933 </para>
27934 <para>
27935 A new SMTP connection is immediately rejected if the <option>smtp_accept_max</option> limit
27936 has been reached. If not, Exim first checks <option>smtp_accept_max_per_host</option>. If
27937 that limit has not been reached for the client host, <option>smtp_accept_reserve</option>
27938 and <option>smtp_load_reserve</option> are then checked before accepting the connection.
27939 </para>
27940 <para>
27941 <indexterm role="option">
27942 <primary><option>smtp_accept_max_nonmail</option></primary>
27943 </indexterm>
27944 </para>
27945 <informaltable frame="all">
27946 <tgroup cols="4" colsep="0" rowsep="0">
27947 <colspec colwidth="8*" align="left"/>
27948 <colspec colwidth="6*" align="center"/>
27949 <colspec colwidth="6*" align="center"/>
27950 <colspec colwidth="6*" align="right"/>
27951 <tbody>
27952 <row>
27953 <entry><option>smtp_accept_max_nonmail</option></entry>
27954 <entry>Use: <emphasis>main</emphasis></entry>
27955 <entry>Type: <emphasis>integer</emphasis></entry>
27956 <entry>Default: <emphasis>10</emphasis></entry>
27957 </row>
27958 </tbody>
27959 </tgroup>
27960 </informaltable>
27961 <para>
27962 <indexterm role="concept">
27963 <primary>limit</primary>
27964 <secondary>non-mail SMTP commands</secondary>
27965 </indexterm>
27966 <indexterm role="concept">
27967 <primary>SMTP</primary>
27968 <secondary>limiting non-mail commands</secondary>
27969 </indexterm>
27970 Exim counts the number of <quote>non-mail</quote> commands in an SMTP session, and drops
27971 the connection if there are too many. This option defines <quote>too many</quote>. The
27972 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
27973 client looping sending EHLO, for example. The check is applied only if the
27974 client host matches <option>smtp_accept_max_nonmail_hosts</option>.
27975 </para>
27976 <para>
27977 When a new message is expected, one occurrence of RSET is not counted. This
27978 allows a client to send one RSET between messages (this is not necessary,
27979 but some clients do it). Exim also allows one uncounted occurrence of HELO
27980 or EHLO, and one occurrence of STARTTLS between messages. After
27981 starting up a TLS session, another EHLO is expected, and so it too is not
27982 counted. The first occurrence of AUTH in a connection, or immediately
27983 following STARTTLS is not counted. Otherwise, all commands other than
27984 MAIL, RCPT, DATA, and QUIT are counted.
27985 </para>
27986 <para>
27987 <indexterm role="option">
27988 <primary><option>smtp_accept_max_nonmail_hosts</option></primary>
27989 </indexterm>
27990 </para>
27991 <informaltable frame="all">
27992 <tgroup cols="4" colsep="0" rowsep="0">
27993 <colspec colwidth="8*" align="left"/>
27994 <colspec colwidth="6*" align="center"/>
27995 <colspec colwidth="6*" align="center"/>
27996 <colspec colwidth="6*" align="right"/>
27997 <tbody>
27998 <row>
27999 <entry><option>smtp_accept_max_nonmail_hosts</option></entry>
28000 <entry>Use: <emphasis>main</emphasis></entry>
28001 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
28002 <entry>Default: <emphasis>*</emphasis></entry>
28003 </row>
28004 </tbody>
28005 </tgroup>
28006 </informaltable>
28007 <para>
28008 You can control which hosts are subject to the <option>smtp_accept_max_nonmail</option>
28009 check by setting this option. The default value makes it apply to all hosts. By
28010 changing the value, you can exclude any badly-behaved hosts that you have to
28011 live with.
28012 </para>
28013 <para>
28014 <indexterm role="option">
28015 <primary><option>smtp_accept_max_per_connection</option></primary>
28016 </indexterm>
28017 </para>
28018 <informaltable frame="all">
28019 <tgroup cols="4" colsep="0" rowsep="0">
28020 <colspec colwidth="8*" align="left"/>
28021 <colspec colwidth="6*" align="center"/>
28022 <colspec colwidth="6*" align="center"/>
28023 <colspec colwidth="6*" align="right"/>
28024 <tbody>
28025 <row>
28026 <entry><option>smtp_accept_max_per_connection</option></entry>
28027 <entry>Use: <emphasis>main</emphasis></entry>
28028 <entry>Type: <emphasis>integer</emphasis></entry>
28029 <entry>Default: <emphasis>1000</emphasis></entry>
28030 </row>
28031 </tbody>
28032 </tgroup>
28033 </informaltable>
28034 <para>
28035 <indexterm role="concept">
28036 <primary>SMTP</primary>
28037 <secondary>limiting incoming message count</secondary>
28038 </indexterm>
28039 <indexterm role="concept">
28040 <primary>limit</primary>
28041 <secondary>messages per SMTP connection</secondary>
28042 </indexterm>
28043 The value of this option limits the number of MAIL commands that Exim is
28044 prepared to accept over a single SMTP connection, whether or not each command
28045 results in the transfer of a message. After the limit is reached, a 421
28046 response is given to subsequent MAIL commands. This limit is a safety
28047 precaution against a client that goes mad (incidents of this type have been
28048 seen).
28049 </para>
28050 <para>
28051 <indexterm role="option">
28052 <primary><option>smtp_accept_max_per_host</option></primary>
28053 </indexterm>
28054 </para>
28055 <informaltable frame="all">
28056 <tgroup cols="4" colsep="0" rowsep="0">
28057 <colspec colwidth="8*" align="left"/>
28058 <colspec colwidth="6*" align="center"/>
28059 <colspec colwidth="6*" align="center"/>
28060 <colspec colwidth="6*" align="right"/>
28061 <tbody>
28062 <row>
28063 <entry><option>smtp_accept_max_per_host</option></entry>
28064 <entry>Use: <emphasis>main</emphasis></entry>
28065 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
28066 <entry>Default: <emphasis>unset</emphasis></entry>
28067 </row>
28068 </tbody>
28069 </tgroup>
28070 </informaltable>
28071 <para>
28072 <indexterm role="concept">
28073 <primary>limit</primary>
28074 <secondary>SMTP connections from one host</secondary>
28075 </indexterm>
28076 <indexterm role="concept">
28077 <primary>host</primary>
28078 <secondary>limiting SMTP connections from</secondary>
28079 </indexterm>
28080 This option restricts the number of simultaneous IP connections from a single
28081 host (strictly, from a single IP address) to the Exim daemon. The option is
28082 expanded, to enable different limits to be applied to different hosts by
28083 reference to <varname>$sender_host_address</varname>. Once the limit is reached, additional
28084 connection attempts from the same host are rejected with error code 421. This
28085 is entirely independent of <option>smtp_accept_reserve</option>. The option&#x2019;s default value
28086 of zero imposes no limit. If this option is set greater than zero, it is
28087 required that <option>smtp_accept_max</option> be non-zero.
28088 </para>
28089 <para>
28090 <emphasis role="bold">Warning</emphasis>: When setting this option you should not use any expansion
28091 constructions that take an appreciable amount of time. The expansion and test
28092 happen in the main daemon loop, in order to reject additional connections
28093 without forking additional processes (otherwise a denial-of-service attack
28094 could cause a vast number or processes to be created). While the daemon is
28095 doing this processing, it cannot accept any other incoming connections.
28096 </para>
28097 <para>
28098 <indexterm role="option">
28099 <primary><option>smtp_accept_queue</option></primary>
28100 </indexterm>
28101 </para>
28102 <informaltable frame="all">
28103 <tgroup cols="4" colsep="0" rowsep="0">
28104 <colspec colwidth="8*" align="left"/>
28105 <colspec colwidth="6*" align="center"/>
28106 <colspec colwidth="6*" align="center"/>
28107 <colspec colwidth="6*" align="right"/>
28108 <tbody>
28109 <row>
28110 <entry><option>smtp_accept_queue</option></entry>
28111 <entry>Use: <emphasis>main</emphasis></entry>
28112 <entry>Type: <emphasis>integer</emphasis></entry>
28113 <entry>Default: <emphasis>0</emphasis></entry>
28114 </row>
28115 </tbody>
28116 </tgroup>
28117 </informaltable>
28118 <para>
28119 <indexterm role="concept">
28120 <primary>SMTP</primary>
28121 <secondary>incoming connection count</secondary>
28122 </indexterm>
28123 <indexterm role="concept">
28124 <primary>queueing incoming messages</primary>
28125 </indexterm>
28126 <indexterm role="concept">
28127 <primary>message</primary>
28128 <secondary>queueing by SMTP connection count</secondary>
28129 </indexterm>
28130 If the number of simultaneous incoming SMTP connections being handled via the
28131 listening daemon exceeds this value, messages received by SMTP are just placed
28132 on the queue; no delivery processes are started automatically. The count is
28133 fixed at the start of an SMTP connection. It cannot be updated in the
28134 subprocess that receives messages, and so the queueing or not queueing applies
28135 to all messages received in the same connection.
28136 </para>
28137 <para>
28138 A value of zero implies no limit, and clearly any non-zero value is useful only
28139 if it is less than the <option>smtp_accept_max</option> value (unless that is zero). See
28140 also <option>queue_only</option>, <option>queue_only_load</option>, <option>queue_smtp_domains</option>, and the
28141 various <option>-od</option><emphasis>x</emphasis> command line options.
28142 </para>
28143 <para>
28144 <indexterm role="option">
28145 <primary><option>smtp_accept_queue_per_connection</option></primary>
28146 </indexterm>
28147 </para>
28148 <informaltable frame="all">
28149 <tgroup cols="4" colsep="0" rowsep="0">
28150 <colspec colwidth="8*" align="left"/>
28151 <colspec colwidth="6*" align="center"/>
28152 <colspec colwidth="6*" align="center"/>
28153 <colspec colwidth="6*" align="right"/>
28154 <tbody>
28155 <row>
28156 <entry><option>smtp_accept_queue_per_connection</option></entry>
28157 <entry>Use: <emphasis>main</emphasis></entry>
28158 <entry>Type: <emphasis>integer</emphasis></entry>
28159 <entry>Default: <emphasis>10</emphasis></entry>
28160 </row>
28161 </tbody>
28162 </tgroup>
28163 </informaltable>
28164 <para>
28165 <indexterm role="concept">
28166 <primary>queueing incoming messages</primary>
28167 </indexterm>
28168 <indexterm role="concept">
28169 <primary>message</primary>
28170 <secondary>queueing by message count</secondary>
28171 </indexterm>
28172 This option limits the number of delivery processes that Exim starts
28173 automatically when receiving messages via SMTP, whether via the daemon or by
28174 the use of <option>-bs</option> or <option>-bS</option>. If the value of the option is greater than zero,
28175 and the number of messages received in a single SMTP session exceeds this
28176 number, subsequent messages are placed on the queue, but no delivery processes
28177 are started. This helps to limit the number of Exim processes when a server
28178 restarts after downtime and there is a lot of mail waiting for it on other
28179 systems. On large systems, the default should probably be increased, and on
28180 dial-in client systems it should probably be set to zero (that is, disabled).
28181 </para>
28182 <para>
28183 <indexterm role="option">
28184 <primary><option>smtp_accept_reserve</option></primary>
28185 </indexterm>
28186 </para>
28187 <informaltable frame="all">
28188 <tgroup cols="4" colsep="0" rowsep="0">
28189 <colspec colwidth="8*" align="left"/>
28190 <colspec colwidth="6*" align="center"/>
28191 <colspec colwidth="6*" align="center"/>
28192 <colspec colwidth="6*" align="right"/>
28193 <tbody>
28194 <row>
28195 <entry><option>smtp_accept_reserve</option></entry>
28196 <entry>Use: <emphasis>main</emphasis></entry>
28197 <entry>Type: <emphasis>integer</emphasis></entry>
28198 <entry>Default: <emphasis>0</emphasis></entry>
28199 </row>
28200 </tbody>
28201 </tgroup>
28202 </informaltable>
28203 <para>
28204 <indexterm role="concept">
28205 <primary>SMTP</primary>
28206 <secondary>incoming call count</secondary>
28207 </indexterm>
28208 <indexterm role="concept">
28209 <primary>host</primary>
28210 <secondary>reserved</secondary>
28211 </indexterm>
28212 When <option>smtp_accept_max</option> is set greater than zero, this option specifies a
28213 number of SMTP connections that are reserved for connections from the hosts
28214 that are specified in <option>smtp_reserve_hosts</option>. The value set in
28215 <option>smtp_accept_max</option> includes this reserve pool. The specified hosts are not
28216 restricted to this number of connections; the option specifies a minimum number
28217 of connection slots for them, not a maximum. It is a guarantee that this group
28218 of hosts can always get at least <option>smtp_accept_reserve</option> connections. However,
28219 the limit specified by <option>smtp_accept_max_per_host</option> is still applied to each
28220 individual host.
28221 </para>
28222 <para>
28223 For example, if <option>smtp_accept_max</option> is set to 50 and <option>smtp_accept_reserve</option> is
28224 set to 5, once there are 45 active connections (from any hosts), new
28225 connections are accepted only from hosts listed in <option>smtp_reserve_hosts</option>,
28226 provided the other criteria for acceptance are met.
28227 </para>
28228 <para>
28229 <indexterm role="option">
28230 <primary><option>smtp_active_hostname</option></primary>
28231 </indexterm>
28232 </para>
28233 <informaltable frame="all">
28234 <tgroup cols="4" colsep="0" rowsep="0">
28235 <colspec colwidth="8*" align="left"/>
28236 <colspec colwidth="6*" align="center"/>
28237 <colspec colwidth="6*" align="center"/>
28238 <colspec colwidth="6*" align="right"/>
28239 <tbody>
28240 <row>
28241 <entry><option>smtp_active_hostname</option></entry>
28242 <entry>Use: <emphasis>main</emphasis></entry>
28243 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
28244 <entry>Default: <emphasis>unset</emphasis></entry>
28245 </row>
28246 </tbody>
28247 </tgroup>
28248 </informaltable>
28249 <para>
28250 <indexterm role="concept">
28251 <primary>host</primary>
28252 <secondary>name in SMTP responses</secondary>
28253 </indexterm>
28254 <indexterm role="concept">
28255 <primary>SMTP</primary>
28256 <secondary>host name in responses</secondary>
28257 </indexterm>
28258 <indexterm role="variable">
28259 <primary><varname>$primary_hostname</varname></primary>
28260 </indexterm>
28261 This option is provided for multi-homed servers that want to masquerade as
28262 several different hosts. At the start of an incoming SMTP connection, its value
28263 is expanded and used instead of the value of <varname>$primary_hostname</varname> in SMTP
28264 responses. For example, it is used as domain name in the response to an
28265 incoming HELO or EHLO command.
28266 </para>
28267 <para>
28268 <indexterm role="variable">
28269 <primary><varname>$smtp_active_hostname</varname></primary>
28270 </indexterm>
28271 The active hostname is placed in the <varname>$smtp_active_hostname</varname> variable, which
28272 is saved with any messages that are received. It is therefore available for use
28273 in routers and transports when the message is later delivered.
28274 </para>
28275 <para>
28276 If this option is unset, or if its expansion is forced to fail, or if the
28277 expansion results in an empty string, the value of <varname>$primary_hostname</varname> is
28278 used. Other expansion failures cause a message to be written to the main and
28279 panic logs, and the SMTP command receives a temporary error. Typically, the
28280 value of <option>smtp_active_hostname</option> depends on the incoming interface address.
28281 For example:
28282 </para>
28283 <literallayout class="monospaced">
28284 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
28285   {cox.mydomain}{box.mydomain}}
28286 </literallayout>
28287 <para>
28288 Although <varname>$smtp_active_hostname</varname> is primarily concerned with incoming
28289 messages, it is also used as the default for HELO commands in callout
28290 verification if there is no remote transport from which to obtain a
28291 <option>helo_data</option> value.
28292 </para>
28293 <para>
28294 <indexterm role="option">
28295 <primary><option>smtp_banner</option></primary>
28296 </indexterm>
28297 </para>
28298 <informaltable frame="all">
28299 <tgroup cols="4" colsep="0" rowsep="0">
28300 <colspec colwidth="8*" align="left"/>
28301 <colspec colwidth="6*" align="center"/>
28302 <colspec colwidth="6*" align="center"/>
28303 <colspec colwidth="6*" align="right"/>
28304 <tbody>
28305 <row>
28306 <entry><option>smtp_banner</option></entry>
28307 <entry>Use: <emphasis>main</emphasis></entry>
28308 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
28309 <entry>Default: <emphasis>see below</emphasis></entry>
28310 </row>
28311 </tbody>
28312 </tgroup>
28313 </informaltable>
28314 <para>
28315 <indexterm role="concept">
28316 <primary>SMTP</primary>
28317 <secondary>welcome banner</secondary>
28318 </indexterm>
28319 <indexterm role="concept">
28320 <primary>banner for SMTP</primary>
28321 </indexterm>
28322 <indexterm role="concept">
28323 <primary>welcome banner for SMTP</primary>
28324 </indexterm>
28325 <indexterm role="concept">
28326 <primary>customizing</primary>
28327 <secondary>SMTP banner</secondary>
28328 </indexterm>
28329 This string, which is expanded every time it is used, is output as the initial
28330 positive response to an SMTP connection. The default setting is:
28331 </para>
28332 <literallayout class="monospaced">
28333 smtp_banner = $smtp_active_hostname ESMTP Exim \
28334   $version_number $tod_full
28335 </literallayout>
28336 <para>
28337 Failure to expand the string causes a panic error. If you want to create a
28338 multiline response to the initial SMTP connection, use <quote>\n</quote> in the string at
28339 appropriate points, but not at the end. Note that the 220 code is not included
28340 in this string. Exim adds it automatically (several times in the case of a
28341 multiline response).
28342 </para>
28343 <para>
28344 <indexterm role="option">
28345 <primary><option>smtp_check_spool_space</option></primary>
28346 </indexterm>
28347 </para>
28348 <informaltable frame="all">
28349 <tgroup cols="4" colsep="0" rowsep="0">
28350 <colspec colwidth="8*" align="left"/>
28351 <colspec colwidth="6*" align="center"/>
28352 <colspec colwidth="6*" align="center"/>
28353 <colspec colwidth="6*" align="right"/>
28354 <tbody>
28355 <row>
28356 <entry><option>smtp_check_spool_space</option></entry>
28357 <entry>Use: <emphasis>main</emphasis></entry>
28358 <entry>Type: <emphasis>boolean</emphasis></entry>
28359 <entry>Default: <emphasis>true</emphasis></entry>
28360 </row>
28361 </tbody>
28362 </tgroup>
28363 </informaltable>
28364 <para>
28365 <indexterm role="concept">
28366 <primary>checking disk space</primary>
28367 </indexterm>
28368 <indexterm role="concept">
28369 <primary>disk space, checking</primary>
28370 </indexterm>
28371 <indexterm role="concept">
28372 <primary>spool directory</primary>
28373 <secondary>checking space</secondary>
28374 </indexterm>
28375 When this option is set, if an incoming SMTP session encounters the SIZE
28376 option on a MAIL command, it checks that there is enough space in the
28377 spool directory&#x2019;s partition to accept a message of that size, while still
28378 leaving free the amount specified by <option>check_spool_space</option> (even if that value
28379 is zero). If there isn&#x2019;t enough space, a temporary error code is returned.
28380 </para>
28381 <para>
28382 <indexterm role="option">
28383 <primary><option>smtp_connect_backlog</option></primary>
28384 </indexterm>
28385 </para>
28386 <informaltable frame="all">
28387 <tgroup cols="4" colsep="0" rowsep="0">
28388 <colspec colwidth="8*" align="left"/>
28389 <colspec colwidth="6*" align="center"/>
28390 <colspec colwidth="6*" align="center"/>
28391 <colspec colwidth="6*" align="right"/>
28392 <tbody>
28393 <row>
28394 <entry><option>smtp_connect_backlog</option></entry>
28395 <entry>Use: <emphasis>main</emphasis></entry>
28396 <entry>Type: <emphasis>integer</emphasis></entry>
28397 <entry>Default: <emphasis>20</emphasis></entry>
28398 </row>
28399 </tbody>
28400 </tgroup>
28401 </informaltable>
28402 <para>
28403 <indexterm role="concept">
28404 <primary>connection backlog</primary>
28405 </indexterm>
28406 <indexterm role="concept">
28407 <primary>SMTP</primary>
28408 <secondary>connection backlog</secondary>
28409 </indexterm>
28410 <indexterm role="concept">
28411 <primary>backlog of connections</primary>
28412 </indexterm>
28413 This option specifies a maximum number of waiting SMTP connections. Exim passes
28414 this value to the TCP/IP system when it sets up its listener. Once this number
28415 of connections are waiting for the daemon&#x2019;s attention, subsequent connection
28416 attempts are refused at the TCP/IP level. At least, that is what the manuals
28417 say; in some circumstances such connection attempts have been observed to time
28418 out instead. For large systems it is probably a good idea to increase the
28419 value (to 50, say). It also gives some protection against denial-of-service
28420 attacks by SYN flooding.
28421 </para>
28422 <para>
28423 <indexterm role="option">
28424 <primary><option>smtp_enforce_sync</option></primary>
28425 </indexterm>
28426 </para>
28427 <informaltable frame="all">
28428 <tgroup cols="4" colsep="0" rowsep="0">
28429 <colspec colwidth="8*" align="left"/>
28430 <colspec colwidth="6*" align="center"/>
28431 <colspec colwidth="6*" align="center"/>
28432 <colspec colwidth="6*" align="right"/>
28433 <tbody>
28434 <row>
28435 <entry><option>smtp_enforce_sync</option></entry>
28436 <entry>Use: <emphasis>main</emphasis></entry>
28437 <entry>Type: <emphasis>boolean</emphasis></entry>
28438 <entry>Default: <emphasis>true</emphasis></entry>
28439 </row>
28440 </tbody>
28441 </tgroup>
28442 </informaltable>
28443 <para>
28444 <indexterm role="concept">
28445 <primary>SMTP</primary>
28446 <secondary>synchronization checking</secondary>
28447 </indexterm>
28448 <indexterm role="concept">
28449 <primary>synchronization checking in SMTP</primary>
28450 </indexterm>
28451 The SMTP protocol specification requires the client to wait for a response from
28452 the server at certain points in the dialogue. Without PIPELINING these
28453 synchronization points are after every command; with PIPELINING they are
28454 fewer, but they still exist.
28455 </para>
28456 <para>
28457 Some spamming sites send out a complete set of SMTP commands without waiting
28458 for any response. Exim protects against this by rejecting a message if the
28459 client has sent further input when it should not have. The error response <quote>554
28460 SMTP synchronization error</quote> is sent, and the connection is dropped. Testing
28461 for this error cannot be perfect because of transmission delays (unexpected
28462 input may be on its way but not yet received when Exim checks). However, it
28463 does detect many instances.
28464 </para>
28465 <para>
28466 The check can be globally disabled by setting <option>smtp_enforce_sync</option> false.
28467 If you want to disable the check selectively (for example, only for certain
28468 hosts), you can do so by an appropriate use of a <option>control</option> modifier in an ACL
28469 (see section <xref linkend="SECTcontrols"/>). See also <option>pipelining_advertise_hosts</option>.
28470 </para>
28471 <para>
28472 <indexterm role="option">
28473 <primary><option>smtp_etrn_command</option></primary>
28474 </indexterm>
28475 </para>
28476 <informaltable frame="all">
28477 <tgroup cols="4" colsep="0" rowsep="0">
28478 <colspec colwidth="8*" align="left"/>
28479 <colspec colwidth="6*" align="center"/>
28480 <colspec colwidth="6*" align="center"/>
28481 <colspec colwidth="6*" align="right"/>
28482 <tbody>
28483 <row>
28484 <entry><option>smtp_etrn_command</option></entry>
28485 <entry>Use: <emphasis>main</emphasis></entry>
28486 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
28487 <entry>Default: <emphasis>unset</emphasis></entry>
28488 </row>
28489 </tbody>
28490 </tgroup>
28491 </informaltable>
28492 <para>
28493 <indexterm role="concept">
28494 <primary>ETRN</primary>
28495 <secondary>command to be run</secondary>
28496 </indexterm>
28497 <indexterm role="variable">
28498 <primary><varname>$domain</varname></primary>
28499 </indexterm>
28500 If this option is set, the given command is run whenever an SMTP ETRN
28501 command is received from a host that is permitted to issue such commands (see
28502 chapter <xref linkend="CHAPACL"/>). The string is split up into separate arguments which
28503 are independently expanded. The expansion variable <varname>$domain</varname> is set to the
28504 argument of the ETRN command, and no syntax checking is done on it. For
28505 example:
28506 </para>
28507 <literallayout class="monospaced">
28508 smtp_etrn_command = /etc/etrn_command $domain \
28509                     $sender_host_address
28510 </literallayout>
28511 <para>
28512 A new process is created to run the command, but Exim does not wait for it to
28513 complete. Consequently, its status cannot be checked. If the command cannot be
28514 run, a line is written to the panic log, but the ETRN caller still receives
28515 a 250 success response. Exim is normally running under its own uid when
28516 receiving SMTP, so it is not possible for it to change the uid before running
28517 the command.
28518 </para>
28519 <para>
28520 <indexterm role="option">
28521 <primary><option>smtp_etrn_serialize</option></primary>
28522 </indexterm>
28523 </para>
28524 <informaltable frame="all">
28525 <tgroup cols="4" colsep="0" rowsep="0">
28526 <colspec colwidth="8*" align="left"/>
28527 <colspec colwidth="6*" align="center"/>
28528 <colspec colwidth="6*" align="center"/>
28529 <colspec colwidth="6*" align="right"/>
28530 <tbody>
28531 <row>
28532 <entry><option>smtp_etrn_serialize</option></entry>
28533 <entry>Use: <emphasis>main</emphasis></entry>
28534 <entry>Type: <emphasis>boolean</emphasis></entry>
28535 <entry>Default: <emphasis>true</emphasis></entry>
28536 </row>
28537 </tbody>
28538 </tgroup>
28539 </informaltable>
28540 <para>
28541 <indexterm role="concept">
28542 <primary>ETRN</primary>
28543 <secondary>serializing</secondary>
28544 </indexterm>
28545 When this option is set, it prevents the simultaneous execution of more than
28546 one identical command as a result of ETRN in an SMTP connection. See
28547 section <xref linkend="SECTETRN"/> for details.
28548 </para>
28549 <para>
28550 <indexterm role="option">
28551 <primary><option>smtp_load_reserve</option></primary>
28552 </indexterm>
28553 </para>
28554 <informaltable frame="all">
28555 <tgroup cols="4" colsep="0" rowsep="0">
28556 <colspec colwidth="8*" align="left"/>
28557 <colspec colwidth="6*" align="center"/>
28558 <colspec colwidth="6*" align="center"/>
28559 <colspec colwidth="6*" align="right"/>
28560 <tbody>
28561 <row>
28562 <entry><option>smtp_load_reserve</option></entry>
28563 <entry>Use: <emphasis>main</emphasis></entry>
28564 <entry>Type: <emphasis>fixed-point</emphasis></entry>
28565 <entry>Default: <emphasis>unset</emphasis></entry>
28566 </row>
28567 </tbody>
28568 </tgroup>
28569 </informaltable>
28570 <para>
28571 <indexterm role="concept">
28572 <primary>load average</primary>
28573 </indexterm>
28574 If the system load average ever gets higher than this, incoming SMTP calls are
28575 accepted only from those hosts that match an entry in <option>smtp_reserve_hosts</option>.
28576 If <option>smtp_reserve_hosts</option> is not set, no incoming SMTP calls are accepted when
28577 the load is over the limit. The option has no effect on ancient operating
28578 systems on which Exim cannot determine the load average. See also
28579 <option>deliver_queue_load_max</option> and <option>queue_only_load</option>.
28580 </para>
28581 <para>
28582 <indexterm role="option">
28583 <primary><option>smtp_max_synprot_errors</option></primary>
28584 </indexterm>
28585 </para>
28586 <informaltable frame="all">
28587 <tgroup cols="4" colsep="0" rowsep="0">
28588 <colspec colwidth="8*" align="left"/>
28589 <colspec colwidth="6*" align="center"/>
28590 <colspec colwidth="6*" align="center"/>
28591 <colspec colwidth="6*" align="right"/>
28592 <tbody>
28593 <row>
28594 <entry><option>smtp_max_synprot_errors</option></entry>
28595 <entry>Use: <emphasis>main</emphasis></entry>
28596 <entry>Type: <emphasis>integer</emphasis></entry>
28597 <entry>Default: <emphasis>3</emphasis></entry>
28598 </row>
28599 </tbody>
28600 </tgroup>
28601 </informaltable>
28602 <para>
28603 <indexterm role="concept">
28604 <primary>SMTP</primary>
28605 <secondary>limiting syntax and protocol errors</secondary>
28606 </indexterm>
28607 <indexterm role="concept">
28608 <primary>limit</primary>
28609 <secondary>SMTP syntax and protocol errors</secondary>
28610 </indexterm>
28611 Exim rejects SMTP commands that contain syntax or protocol errors. In
28612 particular, a syntactically invalid email address, as in this command:
28613 </para>
28614 <literallayout class="monospaced">
28615 RCPT TO:&lt;abc xyz@a.b.c&gt;
28616 </literallayout>
28617 <para>
28618 causes immediate rejection of the command, before any other tests are done.
28619 (The ACL cannot be run if there is no valid address to set up for it.) An
28620 example of a protocol error is receiving RCPT before MAIL. If there are
28621 too many syntax or protocol errors in one SMTP session, the connection is
28622 dropped. The limit is set by this option.
28623 </para>
28624 <para>
28625 <indexterm role="concept">
28626 <primary>PIPELINING</primary>
28627 <secondary>expected errors</secondary>
28628 </indexterm>
28629 When the PIPELINING extension to SMTP is in use, some protocol errors are
28630 <quote>expected</quote>, for instance, a RCPT command after a rejected MAIL command.
28631 Exim assumes that PIPELINING will be used if it advertises it (see
28632 <option>pipelining_advertise_hosts</option>), and in this situation, <quote>expected</quote> errors do
28633 not count towards the limit.
28634 </para>
28635 <para>
28636 <indexterm role="option">
28637 <primary><option>smtp_max_unknown_commands</option></primary>
28638 </indexterm>
28639 </para>
28640 <informaltable frame="all">
28641 <tgroup cols="4" colsep="0" rowsep="0">
28642 <colspec colwidth="8*" align="left"/>
28643 <colspec colwidth="6*" align="center"/>
28644 <colspec colwidth="6*" align="center"/>
28645 <colspec colwidth="6*" align="right"/>
28646 <tbody>
28647 <row>
28648 <entry><option>smtp_max_unknown_commands</option></entry>
28649 <entry>Use: <emphasis>main</emphasis></entry>
28650 <entry>Type: <emphasis>integer</emphasis></entry>
28651 <entry>Default: <emphasis>3</emphasis></entry>
28652 </row>
28653 </tbody>
28654 </tgroup>
28655 </informaltable>
28656 <para>
28657 <indexterm role="concept">
28658 <primary>SMTP</primary>
28659 <secondary>limiting unknown commands</secondary>
28660 </indexterm>
28661 <indexterm role="concept">
28662 <primary>limit</primary>
28663 <secondary>unknown SMTP commands</secondary>
28664 </indexterm>
28665 If there are too many unrecognized commands in an incoming SMTP session, an
28666 Exim server drops the connection. This is a defence against some kinds of abuse
28667 that subvert web
28668 clients
28669 into making connections to SMTP ports; in these circumstances, a number of
28670 non-SMTP command lines are sent first.
28671 </para>
28672 <para>
28673 <indexterm role="option">
28674 <primary><option>smtp_ratelimit_hosts</option></primary>
28675 </indexterm>
28676 </para>
28677 <informaltable frame="all">
28678 <tgroup cols="4" colsep="0" rowsep="0">
28679 <colspec colwidth="8*" align="left"/>
28680 <colspec colwidth="6*" align="center"/>
28681 <colspec colwidth="6*" align="center"/>
28682 <colspec colwidth="6*" align="right"/>
28683 <tbody>
28684 <row>
28685 <entry><option>smtp_ratelimit_hosts</option></entry>
28686 <entry>Use: <emphasis>main</emphasis></entry>
28687 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
28688 <entry>Default: <emphasis>unset</emphasis></entry>
28689 </row>
28690 </tbody>
28691 </tgroup>
28692 </informaltable>
28693 <para>
28694 <indexterm role="concept">
28695 <primary>SMTP</primary>
28696 <secondary>rate limiting</secondary>
28697 </indexterm>
28698 <indexterm role="concept">
28699 <primary>limit</primary>
28700 <secondary>rate of message arrival</secondary>
28701 </indexterm>
28702 <indexterm role="concept">
28703 <primary>RCPT</primary>
28704 <secondary>rate limiting</secondary>
28705 </indexterm>
28706 Some sites find it helpful to be able to limit the rate at which certain hosts
28707 can send them messages, and the rate at which an individual message can specify
28708 recipients.
28709 </para>
28710 <para>
28711 Exim has two rate-limiting facilities. This section describes the older
28712 facility, which can limit rates within a single connection. The newer
28713 <option>ratelimit</option> ACL condition can limit rates across all connections. See section
28714 <xref linkend="SECTratelimiting"/> for details of the newer facility.
28715 </para>
28716 <para>
28717 When a host matches <option>smtp_ratelimit_hosts</option>, the values of
28718 <option>smtp_ratelimit_mail</option> and <option>smtp_ratelimit_rcpt</option> are used to control the
28719 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
28720 respectively. Each option, if set, must contain a set of four comma-separated
28721 values:
28722 </para>
28723 <itemizedlist>
28724 <listitem>
28725 <para>
28726 A threshold, before which there is no rate limiting.
28727 </para>
28728 </listitem>
28729 <listitem>
28730 <para>
28731 An initial time delay. Unlike other times in Exim, numbers with decimal
28732 fractional parts are allowed here.
28733 </para>
28734 </listitem>
28735 <listitem>
28736 <para>
28737 A factor by which to increase the delay each time.
28738 </para>
28739 </listitem>
28740 <listitem>
28741 <para>
28742 A maximum value for the delay. This should normally be less than 5 minutes,
28743 because after that time, the client is liable to timeout the SMTP command.
28744 </para>
28745 </listitem>
28746 </itemizedlist>
28747 <para>
28748 For example, these settings have been used successfully at the site which
28749 first suggested this feature, for controlling mail from their customers:
28750 </para>
28751 <literallayout class="monospaced">
28752 smtp_ratelimit_mail = 2,0.5s,1.05,4m
28753 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
28754 </literallayout>
28755 <para>
28756 The first setting specifies delays that are applied to MAIL commands after
28757 two have been received over a single connection. The initial delay is 0.5
28758 seconds, increasing by a factor of 1.05 each time. The second setting applies
28759 delays to RCPT commands when more than four occur in a single message.
28760 </para>
28761 <para>
28762 <indexterm role="option">
28763 <primary><option>smtp_ratelimit_mail</option></primary>
28764 </indexterm>
28765 </para>
28766 <informaltable frame="all">
28767 <tgroup cols="4" colsep="0" rowsep="0">
28768 <colspec colwidth="8*" align="left"/>
28769 <colspec colwidth="6*" align="center"/>
28770 <colspec colwidth="6*" align="center"/>
28771 <colspec colwidth="6*" align="right"/>
28772 <tbody>
28773 <row>
28774 <entry><option>smtp_ratelimit_mail</option></entry>
28775 <entry>Use: <emphasis>main</emphasis></entry>
28776 <entry>Type: <emphasis>string</emphasis></entry>
28777 <entry>Default: <emphasis>unset</emphasis></entry>
28778 </row>
28779 </tbody>
28780 </tgroup>
28781 </informaltable>
28782 <para>
28783 See <option>smtp_ratelimit_hosts</option> above.
28784 </para>
28785 <para>
28786 <indexterm role="option">
28787 <primary><option>smtp_ratelimit_rcpt</option></primary>
28788 </indexterm>
28789 </para>
28790 <informaltable frame="all">
28791 <tgroup cols="4" colsep="0" rowsep="0">
28792 <colspec colwidth="8*" align="left"/>
28793 <colspec colwidth="6*" align="center"/>
28794 <colspec colwidth="6*" align="center"/>
28795 <colspec colwidth="6*" align="right"/>
28796 <tbody>
28797 <row>
28798 <entry><option>smtp_ratelimit_rcpt</option></entry>
28799 <entry>Use: <emphasis>main</emphasis></entry>
28800 <entry>Type: <emphasis>string</emphasis></entry>
28801 <entry>Default: <emphasis>unset</emphasis></entry>
28802 </row>
28803 </tbody>
28804 </tgroup>
28805 </informaltable>
28806 <para>
28807 See <option>smtp_ratelimit_hosts</option> above.
28808 </para>
28809 <para>
28810 <indexterm role="option">
28811 <primary><option>smtp_receive_timeout</option></primary>
28812 </indexterm>
28813 </para>
28814 <informaltable frame="all">
28815 <tgroup cols="4" colsep="0" rowsep="0">
28816 <colspec colwidth="8*" align="left"/>
28817 <colspec colwidth="6*" align="center"/>
28818 <colspec colwidth="6*" align="center"/>
28819 <colspec colwidth="6*" align="right"/>
28820 <tbody>
28821 <row>
28822 <entry><option>smtp_receive_timeout</option></entry>
28823 <entry>Use: <emphasis>main</emphasis></entry>
28824 <entry>Type: <emphasis>time</emphasis></entry>
28825 <entry>Default: <emphasis>5m</emphasis></entry>
28826 </row>
28827 </tbody>
28828 </tgroup>
28829 </informaltable>
28830 <para>
28831 <indexterm role="concept">
28832 <primary>timeout</primary>
28833 <secondary>for SMTP input</secondary>
28834 </indexterm>
28835 <indexterm role="concept">
28836 <primary>SMTP</primary>
28837 <secondary>input timeout</secondary>
28838 </indexterm>
28839 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
28840 input, including batch SMTP. If a line of input (either an SMTP command or a
28841 data line) is not received within this time, the SMTP connection is dropped and
28842 the message is abandoned.
28843 A line is written to the log containing one of the following messages:
28844 </para>
28845 <literallayout class="monospaced">
28846 SMTP command timeout on connection from...
28847 SMTP data timeout on connection from...
28848 </literallayout>
28849 <para>
28850 The former means that Exim was expecting to read an SMTP command; the latter
28851 means that it was in the DATA phase, reading the contents of a message.
28852 </para>
28853 <para>
28854 <indexterm role="option">
28855 <primary><option>-os</option></primary>
28856 </indexterm>
28857 The value set by this option can be overridden by the
28858 <option>-os</option> command-line option. A setting of zero time disables the timeout, but
28859 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
28860 of local input using <option>-bs</option> or <option>-bS</option>.) For non-SMTP input, the reception
28861 timeout is controlled by <option>receive_timeout</option> and <option>-or</option>.
28862 </para>
28863 <para>
28864 <indexterm role="option">
28865 <primary><option>smtp_reserve_hosts</option></primary>
28866 </indexterm>
28867 </para>
28868 <informaltable frame="all">
28869 <tgroup cols="4" colsep="0" rowsep="0">
28870 <colspec colwidth="8*" align="left"/>
28871 <colspec colwidth="6*" align="center"/>
28872 <colspec colwidth="6*" align="center"/>
28873 <colspec colwidth="6*" align="right"/>
28874 <tbody>
28875 <row>
28876 <entry><option>smtp_reserve_hosts</option></entry>
28877 <entry>Use: <emphasis>main</emphasis></entry>
28878 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
28879 <entry>Default: <emphasis>unset</emphasis></entry>
28880 </row>
28881 </tbody>
28882 </tgroup>
28883 </informaltable>
28884 <para>
28885 This option defines hosts for which SMTP connections are reserved; see
28886 <option>smtp_accept_reserve</option> and <option>smtp_load_reserve</option> above.
28887 </para>
28888 <para>
28889 <indexterm role="option">
28890 <primary><option>smtp_return_error_details</option></primary>
28891 </indexterm>
28892 </para>
28893 <informaltable frame="all">
28894 <tgroup cols="4" colsep="0" rowsep="0">
28895 <colspec colwidth="8*" align="left"/>
28896 <colspec colwidth="6*" align="center"/>
28897 <colspec colwidth="6*" align="center"/>
28898 <colspec colwidth="6*" align="right"/>
28899 <tbody>
28900 <row>
28901 <entry><option>smtp_return_error_details</option></entry>
28902 <entry>Use: <emphasis>main</emphasis></entry>
28903 <entry>Type: <emphasis>boolean</emphasis></entry>
28904 <entry>Default: <emphasis>false</emphasis></entry>
28905 </row>
28906 </tbody>
28907 </tgroup>
28908 </informaltable>
28909 <para>
28910 <indexterm role="concept">
28911 <primary>SMTP</primary>
28912 <secondary>details policy failures</secondary>
28913 </indexterm>
28914 <indexterm role="concept">
28915 <primary>policy control</primary>
28916 <secondary>rejection, returning details</secondary>
28917 </indexterm>
28918 In the default state, Exim uses bland messages such as
28919 <quote>Administrative prohibition</quote> when it rejects SMTP commands for policy
28920 reasons. Many sysadmins like this because it gives away little information
28921 to spammers. However, some other sysadmins who are applying strict checking
28922 policies want to give out much fuller information about failures. Setting
28923 <option>smtp_return_error_details</option> true causes Exim to be more forthcoming. For
28924 example, instead of <quote>Administrative prohibition</quote>, it might give:
28925 </para>
28926 <literallayout class="monospaced">
28927 550-Rejected after DATA: '&gt;' missing at end of address:
28928 550 failing address in "From" header is: &lt;user@dom.ain
28929 </literallayout>
28930 <para>
28931 <indexterm role="option">
28932 <primary><option>spamd_address</option></primary>
28933 </indexterm>
28934 </para>
28935 <informaltable frame="all">
28936 <tgroup cols="4" colsep="0" rowsep="0">
28937 <colspec colwidth="8*" align="left"/>
28938 <colspec colwidth="6*" align="center"/>
28939 <colspec colwidth="6*" align="center"/>
28940 <colspec colwidth="6*" align="right"/>
28941 <tbody>
28942 <row>
28943 <entry><option>spamd_address</option></entry>
28944 <entry>Use: <emphasis>main</emphasis></entry>
28945 <entry>Type: <emphasis>string</emphasis></entry>
28946 <entry>Default: <emphasis>see below</emphasis></entry>
28947 </row>
28948 </tbody>
28949 </tgroup>
28950 </informaltable>
28951 <para>
28952 This option is available when Exim is compiled with the content-scanning
28953 extension. It specifies how Exim connects to SpamAssassin&#x2019;s <option>spamd</option> daemon.
28954 The default value is
28955 </para>
28956 <literallayout class="monospaced">
28957 127.0.0.1 783
28958 </literallayout>
28959 <para>
28960 See section <xref linkend="SECTscanspamass"/> for more details.
28961 </para>
28962 <para>
28963 <indexterm role="option">
28964 <primary><option>split_spool_directory</option></primary>
28965 </indexterm>
28966 </para>
28967 <informaltable frame="all">
28968 <tgroup cols="4" colsep="0" rowsep="0">
28969 <colspec colwidth="8*" align="left"/>
28970 <colspec colwidth="6*" align="center"/>
28971 <colspec colwidth="6*" align="center"/>
28972 <colspec colwidth="6*" align="right"/>
28973 <tbody>
28974 <row>
28975 <entry><option>split_spool_directory</option></entry>
28976 <entry>Use: <emphasis>main</emphasis></entry>
28977 <entry>Type: <emphasis>boolean</emphasis></entry>
28978 <entry>Default: <emphasis>false</emphasis></entry>
28979 </row>
28980 </tbody>
28981 </tgroup>
28982 </informaltable>
28983 <para>
28984 <indexterm role="concept">
28985 <primary>multiple spool directories</primary>
28986 </indexterm>
28987 <indexterm role="concept">
28988 <primary>spool directory</primary>
28989 <secondary>split</secondary>
28990 </indexterm>
28991 <indexterm role="concept">
28992 <primary>directories, multiple</primary>
28993 </indexterm>
28994 If this option is set, it causes Exim to split its input directory into 62
28995 subdirectories, each with a single alphanumeric character as its name. The
28996 sixth character of the message id is used to allocate messages to
28997 subdirectories; this is the least significant base-62 digit of the time of
28998 arrival of the message.
28999 </para>
29000 <para>
29001 Splitting up the spool in this way may provide better performance on systems
29002 where there are long mail queues, by reducing the number of files in any one
29003 directory. The msglog directory is also split up in a similar way to the input
29004 directory; however, if <option>preserve_message_logs</option> is set, all old msglog files
29005 are still placed in the single directory <filename>msglog.OLD</filename>.
29006 </para>
29007 <para>
29008 It is not necessary to take any special action for existing messages when
29009 changing <option>split_spool_directory</option>. Exim notices messages that are in the
29010 <quote>wrong</quote> place, and continues to process them. If the option is turned off
29011 after a period of being on, the subdirectories will eventually empty and be
29012 automatically deleted.
29013 </para>
29014 <para>
29015 When <option>split_spool_directory</option> is set, the behaviour of queue runner processes
29016 changes. Instead of creating a list of all messages in the queue, and then
29017 trying to deliver each one in turn, it constructs a list of those in one
29018 sub-directory and tries to deliver them, before moving on to the next
29019 sub-directory. The sub-directories are processed in a random order. This
29020 spreads out the scanning of the input directories, and uses less memory. It is
29021 particularly beneficial when there are lots of messages on the queue. However,
29022 if <option>queue_run_in_order</option> is set, none of this new processing happens. The
29023 entire queue has to be scanned and sorted before any deliveries can start.
29024 </para>
29025 <para>
29026 <indexterm role="option">
29027 <primary><option>spool_directory</option></primary>
29028 </indexterm>
29029 </para>
29030 <informaltable frame="all">
29031 <tgroup cols="4" colsep="0" rowsep="0">
29032 <colspec colwidth="8*" align="left"/>
29033 <colspec colwidth="6*" align="center"/>
29034 <colspec colwidth="6*" align="center"/>
29035 <colspec colwidth="6*" align="right"/>
29036 <tbody>
29037 <row>
29038 <entry><option>spool_directory</option></entry>
29039 <entry>Use: <emphasis>main</emphasis></entry>
29040 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
29041 <entry>Default: <emphasis>set at compile time</emphasis></entry>
29042 </row>
29043 </tbody>
29044 </tgroup>
29045 </informaltable>
29046 <para>
29047 <indexterm role="concept">
29048 <primary>spool directory</primary>
29049 <secondary>path to</secondary>
29050 </indexterm>
29051 This defines the directory in which Exim keeps its spool, that is, the messages
29052 it is waiting to deliver. The default value is taken from the compile-time
29053 configuration setting, if there is one. If not, this option must be set. The
29054 string is expanded, so it can contain, for example, a reference to
29055 <varname>$primary_hostname</varname>.
29056 </para>
29057 <para>
29058 If the spool directory name is fixed on your installation, it is recommended
29059 that you set it at build time rather than from this option, particularly if the
29060 log files are being written to the spool directory (see <option>log_file_path</option>).
29061 Otherwise log files cannot be used for errors that are detected early on, such
29062 as failures in the configuration file.
29063 </para>
29064 <para>
29065 By using this option to override the compiled-in path, it is possible to run
29066 tests of Exim without using the standard spool.
29067 </para>
29068 <para>
29069 <indexterm role="option">
29070 <primary><option>sqlite_lock_timeout</option></primary>
29071 </indexterm>
29072 </para>
29073 <informaltable frame="all">
29074 <tgroup cols="4" colsep="0" rowsep="0">
29075 <colspec colwidth="8*" align="left"/>
29076 <colspec colwidth="6*" align="center"/>
29077 <colspec colwidth="6*" align="center"/>
29078 <colspec colwidth="6*" align="right"/>
29079 <tbody>
29080 <row>
29081 <entry><option>sqlite_lock_timeout</option></entry>
29082 <entry>Use: <emphasis>main</emphasis></entry>
29083 <entry>Type: <emphasis>time</emphasis></entry>
29084 <entry>Default: <emphasis>5s</emphasis></entry>
29085 </row>
29086 </tbody>
29087 </tgroup>
29088 </informaltable>
29089 <para>
29090 <indexterm role="concept">
29091 <primary>sqlite lookup type</primary>
29092 <secondary>lock timeout</secondary>
29093 </indexterm>
29094 This option controls the timeout that the <command>sqlite</command> lookup uses when trying to
29095 access an SQLite database. See section <xref linkend="SECTsqlite"/> for more details.
29096 </para>
29097 <para>
29098 <indexterm role="option">
29099 <primary><option>strict_acl_vars</option></primary>
29100 </indexterm>
29101 </para>
29102 <informaltable frame="all">
29103 <tgroup cols="4" colsep="0" rowsep="0">
29104 <colspec colwidth="8*" align="left"/>
29105 <colspec colwidth="6*" align="center"/>
29106 <colspec colwidth="6*" align="center"/>
29107 <colspec colwidth="6*" align="right"/>
29108 <tbody>
29109 <row>
29110 <entry><option>strict_acl_vars</option></entry>
29111 <entry>Use: <emphasis>main</emphasis></entry>
29112 <entry>Type: <emphasis>boolean</emphasis></entry>
29113 <entry>Default: <emphasis>false</emphasis></entry>
29114 </row>
29115 </tbody>
29116 </tgroup>
29117 </informaltable>
29118 <para>
29119 <indexterm role="concept">
29120 <primary>access control lists (ACLs)</primary>
29121 <secondary>variables, handling unset</secondary>
29122 </indexterm>
29123 This option controls what happens if a syntactically valid but undefined ACL
29124 variable is referenced. If it is false (the default), an empty string
29125 is substituted; if it is true, an error is generated. See section
29126 <xref linkend="SECTaclvariables"/> for details of ACL variables.
29127 </para>
29128 <para>
29129 <indexterm role="option">
29130 <primary><option>strip_excess_angle_brackets</option></primary>
29131 </indexterm>
29132 </para>
29133 <informaltable frame="all">
29134 <tgroup cols="4" colsep="0" rowsep="0">
29135 <colspec colwidth="8*" align="left"/>
29136 <colspec colwidth="6*" align="center"/>
29137 <colspec colwidth="6*" align="center"/>
29138 <colspec colwidth="6*" align="right"/>
29139 <tbody>
29140 <row>
29141 <entry><option>strip_excess_angle_brackets</option></entry>
29142 <entry>Use: <emphasis>main</emphasis></entry>
29143 <entry>Type: <emphasis>boolean</emphasis></entry>
29144 <entry>Default: <emphasis>false</emphasis></entry>
29145 </row>
29146 </tbody>
29147 </tgroup>
29148 </informaltable>
29149 <para>
29150 <indexterm role="concept">
29151 <primary>angle brackets, excess</primary>
29152 </indexterm>
29153 If this option is set, redundant pairs of angle brackets round <quote>route-addr</quote>
29154 items in addresses are stripped. For example, <emphasis>&lt;&lt;xxx@a.b.c.d&gt;&gt;</emphasis> is
29155 treated as <emphasis>&lt;xxx@a.b.c.d&gt;</emphasis>. If this is in the envelope and the message is
29156 passed on to another MTA, the excess angle brackets are not passed on. If this
29157 option is not set, multiple pairs of angle brackets cause a syntax error.
29158 </para>
29159 <para>
29160 <indexterm role="option">
29161 <primary><option>strip_trailing_dot</option></primary>
29162 </indexterm>
29163 </para>
29164 <informaltable frame="all">
29165 <tgroup cols="4" colsep="0" rowsep="0">
29166 <colspec colwidth="8*" align="left"/>
29167 <colspec colwidth="6*" align="center"/>
29168 <colspec colwidth="6*" align="center"/>
29169 <colspec colwidth="6*" align="right"/>
29170 <tbody>
29171 <row>
29172 <entry><option>strip_trailing_dot</option></entry>
29173 <entry>Use: <emphasis>main</emphasis></entry>
29174 <entry>Type: <emphasis>boolean</emphasis></entry>
29175 <entry>Default: <emphasis>false</emphasis></entry>
29176 </row>
29177 </tbody>
29178 </tgroup>
29179 </informaltable>
29180 <para>
29181 <indexterm role="concept">
29182 <primary>trailing dot on domain</primary>
29183 </indexterm>
29184 <indexterm role="concept">
29185 <primary>dot</primary>
29186 <secondary>trailing on domain</secondary>
29187 </indexterm>
29188 If this option is set, a trailing dot at the end of a domain in an address is
29189 ignored. If this is in the envelope and the message is passed on to another
29190 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
29191 domain causes a syntax error.
29192 However, addresses in header lines are checked only when an ACL requests header
29193 syntax checking.
29194 </para>
29195 <para>
29196 <indexterm role="option">
29197 <primary><option>syslog_duplication</option></primary>
29198 </indexterm>
29199 </para>
29200 <informaltable frame="all">
29201 <tgroup cols="4" colsep="0" rowsep="0">
29202 <colspec colwidth="8*" align="left"/>
29203 <colspec colwidth="6*" align="center"/>
29204 <colspec colwidth="6*" align="center"/>
29205 <colspec colwidth="6*" align="right"/>
29206 <tbody>
29207 <row>
29208 <entry><option>syslog_duplication</option></entry>
29209 <entry>Use: <emphasis>main</emphasis></entry>
29210 <entry>Type: <emphasis>boolean</emphasis></entry>
29211 <entry>Default: <emphasis>true</emphasis></entry>
29212 </row>
29213 </tbody>
29214 </tgroup>
29215 </informaltable>
29216 <para>
29217 <indexterm role="concept">
29218 <primary>syslog</primary>
29219 <secondary>duplicate log lines; suppressing</secondary>
29220 </indexterm>
29221 When Exim is logging to syslog, it writes the log lines for its three
29222 separate logs at different syslog priorities so that they can in principle
29223 be separated on the logging hosts. Some installations do not require this
29224 separation, and in those cases, the duplication of certain log lines is a
29225 nuisance. If <option>syslog_duplication</option> is set false, only one copy of any
29226 particular log line is written to syslog. For lines that normally go to
29227 both the main log and the reject log, the reject log version (possibly
29228 containing message header lines) is written, at LOG_NOTICE priority.
29229 Lines that normally go to both the main and the panic log are written at
29230 the LOG_ALERT priority.
29231 </para>
29232 <para>
29233 <indexterm role="option">
29234 <primary><option>syslog_facility</option></primary>
29235 </indexterm>
29236 </para>
29237 <informaltable frame="all">
29238 <tgroup cols="4" colsep="0" rowsep="0">
29239 <colspec colwidth="8*" align="left"/>
29240 <colspec colwidth="6*" align="center"/>
29241 <colspec colwidth="6*" align="center"/>
29242 <colspec colwidth="6*" align="right"/>
29243 <tbody>
29244 <row>
29245 <entry><option>syslog_facility</option></entry>
29246 <entry>Use: <emphasis>main</emphasis></entry>
29247 <entry>Type: <emphasis>string</emphasis></entry>
29248 <entry>Default: <emphasis>unset</emphasis></entry>
29249 </row>
29250 </tbody>
29251 </tgroup>
29252 </informaltable>
29253 <para>
29254 <indexterm role="concept">
29255 <primary>syslog</primary>
29256 <secondary>facility; setting</secondary>
29257 </indexterm>
29258 This option sets the syslog <quote>facility</quote> name, used when Exim is logging to
29259 syslog. The value must be one of the strings <quote>mail</quote>, <quote>user</quote>, <quote>news</quote>,
29260 <quote>uucp</quote>, <quote>daemon</quote>, or <quote>local<emphasis>x</emphasis></quote> where <emphasis>x</emphasis> is a digit between 0 and 7.
29261 If this option is unset, <quote>mail</quote> is used. See chapter <xref linkend="CHAPlog"/> for
29262 details of Exim&#x2019;s logging.
29263 </para>
29264 <para>
29265 <indexterm role="option">
29266 <primary><option>syslog_processname</option></primary>
29267 </indexterm>
29268 </para>
29269 <informaltable frame="all">
29270 <tgroup cols="4" colsep="0" rowsep="0">
29271 <colspec colwidth="8*" align="left"/>
29272 <colspec colwidth="6*" align="center"/>
29273 <colspec colwidth="6*" align="center"/>
29274 <colspec colwidth="6*" align="right"/>
29275 <tbody>
29276 <row>
29277 <entry><option>syslog_processname</option></entry>
29278 <entry>Use: <emphasis>main</emphasis></entry>
29279 <entry>Type: <emphasis>string</emphasis></entry>
29280 <entry>Default: <emphasis><literal>exim</literal></emphasis></entry>
29281 </row>
29282 </tbody>
29283 </tgroup>
29284 </informaltable>
29285 <para>
29286 <indexterm role="concept">
29287 <primary>syslog</primary>
29288 <secondary>process name; setting</secondary>
29289 </indexterm>
29290 This option sets the syslog <quote>ident</quote> name, used when Exim is logging to
29291 syslog. The value must be no longer than 32 characters. See chapter
29292 <xref linkend="CHAPlog"/> for details of Exim&#x2019;s logging.
29293 </para>
29294 <para>
29295 <indexterm role="option">
29296 <primary><option>syslog_timestamp</option></primary>
29297 </indexterm>
29298 </para>
29299 <informaltable frame="all">
29300 <tgroup cols="4" colsep="0" rowsep="0">
29301 <colspec colwidth="8*" align="left"/>
29302 <colspec colwidth="6*" align="center"/>
29303 <colspec colwidth="6*" align="center"/>
29304 <colspec colwidth="6*" align="right"/>
29305 <tbody>
29306 <row>
29307 <entry><option>syslog_timestamp</option></entry>
29308 <entry>Use: <emphasis>main</emphasis></entry>
29309 <entry>Type: <emphasis>boolean</emphasis></entry>
29310 <entry>Default: <emphasis>true</emphasis></entry>
29311 </row>
29312 </tbody>
29313 </tgroup>
29314 </informaltable>
29315 <para>
29316 <indexterm role="concept">
29317 <primary>syslog</primary>
29318 <secondary>timestamps</secondary>
29319 </indexterm>
29320 If <option>syslog_timestamp</option> is set false, the timestamps on Exim&#x2019;s log lines are
29321 omitted when these lines are sent to syslog. See chapter <xref linkend="CHAPlog"/> for
29322 details of Exim&#x2019;s logging.
29323 </para>
29324 <para>
29325 <indexterm role="option">
29326 <primary><option>system_filter</option></primary>
29327 </indexterm>
29328 </para>
29329 <informaltable frame="all">
29330 <tgroup cols="4" colsep="0" rowsep="0">
29331 <colspec colwidth="8*" align="left"/>
29332 <colspec colwidth="6*" align="center"/>
29333 <colspec colwidth="6*" align="center"/>
29334 <colspec colwidth="6*" align="right"/>
29335 <tbody>
29336 <row>
29337 <entry><option>system_filter</option></entry>
29338 <entry>Use: <emphasis>main</emphasis></entry>
29339 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
29340 <entry>Default: <emphasis>unset</emphasis></entry>
29341 </row>
29342 </tbody>
29343 </tgroup>
29344 </informaltable>
29345 <para>
29346 <indexterm role="concept">
29347 <primary>filter</primary>
29348 <secondary>system filter</secondary>
29349 </indexterm>
29350 <indexterm role="concept">
29351 <primary>system filter</primary>
29352 <secondary>specifying</secondary>
29353 </indexterm>
29354 <indexterm role="concept">
29355 <primary>Sieve filter</primary>
29356 <secondary>not available for system filter</secondary>
29357 </indexterm>
29358 This option specifies an Exim filter file that is applied to all messages at
29359 the start of each delivery attempt, before any routing is done. System filters
29360 must be Exim filters; they cannot be Sieve filters. If the system filter
29361 generates any deliveries to files or pipes, or any new mail messages, the
29362 appropriate <option>system_filter_..._transport</option> option(s) must be set, to define
29363 which transports are to be used. Details of this facility are given in chapter
29364 <xref linkend="CHAPsystemfilter"/>.
29365 </para>
29366 <para>
29367 <indexterm role="option">
29368 <primary><option>system_filter_directory_transport</option></primary>
29369 </indexterm>
29370 </para>
29371 <informaltable frame="all">
29372 <tgroup cols="4" colsep="0" rowsep="0">
29373 <colspec colwidth="8*" align="left"/>
29374 <colspec colwidth="6*" align="center"/>
29375 <colspec colwidth="6*" align="center"/>
29376 <colspec colwidth="6*" align="right"/>
29377 <tbody>
29378 <row>
29379 <entry><option>system_filter_directory_transport</option></entry>
29380 <entry>Use: <emphasis>main</emphasis></entry>
29381 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
29382 <entry>Default: <emphasis>unset</emphasis></entry>
29383 </row>
29384 </tbody>
29385 </tgroup>
29386 </informaltable>
29387 <para>
29388 <indexterm role="variable">
29389 <primary><varname>$address_file</varname></primary>
29390 </indexterm>
29391 This sets the name of the transport driver that is to be used when the
29392 <option>save</option> command in a system message filter specifies a path ending in <quote>/</quote>,
29393 implying delivery of each message into a separate file in some directory.
29394 During the delivery, the variable <varname>$address_file</varname> contains the path name.
29395 </para>
29396 <para>
29397 <indexterm role="option">
29398 <primary><option>system_filter_file_transport</option></primary>
29399 </indexterm>
29400 </para>
29401 <informaltable frame="all">
29402 <tgroup cols="4" colsep="0" rowsep="0">
29403 <colspec colwidth="8*" align="left"/>
29404 <colspec colwidth="6*" align="center"/>
29405 <colspec colwidth="6*" align="center"/>
29406 <colspec colwidth="6*" align="right"/>
29407 <tbody>
29408 <row>
29409 <entry><option>system_filter_file_transport</option></entry>
29410 <entry>Use: <emphasis>main</emphasis></entry>
29411 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
29412 <entry>Default: <emphasis>unset</emphasis></entry>
29413 </row>
29414 </tbody>
29415 </tgroup>
29416 </informaltable>
29417 <para>
29418 <indexterm role="concept">
29419 <primary>file</primary>
29420 <secondary>transport for system filter</secondary>
29421 </indexterm>
29422 This sets the name of the transport driver that is to be used when the <option>save</option>
29423 command in a system message filter specifies a path not ending in <quote>/</quote>. During
29424 the delivery, the variable <varname>$address_file</varname> contains the path name.
29425 </para>
29426 <para>
29427 <indexterm role="option">
29428 <primary><option>system_filter_group</option></primary>
29429 </indexterm>
29430 </para>
29431 <informaltable frame="all">
29432 <tgroup cols="4" colsep="0" rowsep="0">
29433 <colspec colwidth="8*" align="left"/>
29434 <colspec colwidth="6*" align="center"/>
29435 <colspec colwidth="6*" align="center"/>
29436 <colspec colwidth="6*" align="right"/>
29437 <tbody>
29438 <row>
29439 <entry><option>system_filter_group</option></entry>
29440 <entry>Use: <emphasis>main</emphasis></entry>
29441 <entry>Type: <emphasis>string</emphasis></entry>
29442 <entry>Default: <emphasis>unset</emphasis></entry>
29443 </row>
29444 </tbody>
29445 </tgroup>
29446 </informaltable>
29447 <para>
29448 <indexterm role="concept">
29449 <primary>gid (group id)</primary>
29450 <secondary>system filter</secondary>
29451 </indexterm>
29452 This option is used only when <option>system_filter_user</option> is also set. It sets the
29453 gid under which the system filter is run, overriding any gid that is associated
29454 with the user. The value may be numerical or symbolic.
29455 </para>
29456 <para>
29457 <indexterm role="option">
29458 <primary><option>system_filter_pipe_transport</option></primary>
29459 </indexterm>
29460 </para>
29461 <informaltable frame="all">
29462 <tgroup cols="4" colsep="0" rowsep="0">
29463 <colspec colwidth="8*" align="left"/>
29464 <colspec colwidth="6*" align="center"/>
29465 <colspec colwidth="6*" align="center"/>
29466 <colspec colwidth="6*" align="right"/>
29467 <tbody>
29468 <row>
29469 <entry><option>system_filter_pipe_transport</option></entry>
29470 <entry>Use: <emphasis>main</emphasis></entry>
29471 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
29472 <entry>Default: <emphasis>unset</emphasis></entry>
29473 </row>
29474 </tbody>
29475 </tgroup>
29476 </informaltable>
29477 <para>
29478 <indexterm role="concept">
29479 <primary><command>pipe</command> transport</primary>
29480 <secondary>for system filter</secondary>
29481 </indexterm>
29482 <indexterm role="variable">
29483 <primary><varname>$address_pipe</varname></primary>
29484 </indexterm>
29485 This specifies the transport driver that is to be used when a <option>pipe</option> command
29486 is used in a system filter. During the delivery, the variable <varname>$address_pipe</varname>
29487 contains the pipe command.
29488 </para>
29489 <para>
29490 <indexterm role="option">
29491 <primary><option>system_filter_reply_transport</option></primary>
29492 </indexterm>
29493 </para>
29494 <informaltable frame="all">
29495 <tgroup cols="4" colsep="0" rowsep="0">
29496 <colspec colwidth="8*" align="left"/>
29497 <colspec colwidth="6*" align="center"/>
29498 <colspec colwidth="6*" align="center"/>
29499 <colspec colwidth="6*" align="right"/>
29500 <tbody>
29501 <row>
29502 <entry><option>system_filter_reply_transport</option></entry>
29503 <entry>Use: <emphasis>main</emphasis></entry>
29504 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
29505 <entry>Default: <emphasis>unset</emphasis></entry>
29506 </row>
29507 </tbody>
29508 </tgroup>
29509 </informaltable>
29510 <para>
29511 <indexterm role="concept">
29512 <primary><command>autoreply</command> transport</primary>
29513 <secondary>for system filter</secondary>
29514 </indexterm>
29515 This specifies the transport driver that is to be used when a <option>mail</option> command
29516 is used in a system filter.
29517 </para>
29518 <para>
29519 <indexterm role="option">
29520 <primary><option>system_filter_user</option></primary>
29521 </indexterm>
29522 </para>
29523 <informaltable frame="all">
29524 <tgroup cols="4" colsep="0" rowsep="0">
29525 <colspec colwidth="8*" align="left"/>
29526 <colspec colwidth="6*" align="center"/>
29527 <colspec colwidth="6*" align="center"/>
29528 <colspec colwidth="6*" align="right"/>
29529 <tbody>
29530 <row>
29531 <entry><option>system_filter_user</option></entry>
29532 <entry>Use: <emphasis>main</emphasis></entry>
29533 <entry>Type: <emphasis>string</emphasis></entry>
29534 <entry>Default: <emphasis>unset</emphasis></entry>
29535 </row>
29536 </tbody>
29537 </tgroup>
29538 </informaltable>
29539 <para>
29540 <indexterm role="concept">
29541 <primary>uid (user id)</primary>
29542 <secondary>system filter</secondary>
29543 </indexterm>
29544 If this option is set to root, the system filter is run in the main Exim
29545 delivery process, as root.  Otherwise, the system filter runs in a separate
29546 process, as the given user, defaulting to the Exim run-time user.
29547 Unless the string consists entirely of digits, it
29548 is looked up in the password data. Failure to find the named user causes a
29549 configuration error. The gid is either taken from the password data, or
29550 specified by <option>system_filter_group</option>. When the uid is specified numerically,
29551 <option>system_filter_group</option> is required to be set.
29552 </para>
29553 <para>
29554 If the system filter generates any pipe, file, or reply deliveries, the uid
29555 under which the filter is run is used when transporting them, unless a
29556 transport option overrides.
29557 </para>
29558 <para>
29559 <indexterm role="option">
29560 <primary><option>tcp_nodelay</option></primary>
29561 </indexterm>
29562 </para>
29563 <informaltable frame="all">
29564 <tgroup cols="4" colsep="0" rowsep="0">
29565 <colspec colwidth="8*" align="left"/>
29566 <colspec colwidth="6*" align="center"/>
29567 <colspec colwidth="6*" align="center"/>
29568 <colspec colwidth="6*" align="right"/>
29569 <tbody>
29570 <row>
29571 <entry><option>tcp_nodelay</option></entry>
29572 <entry>Use: <emphasis>main</emphasis></entry>
29573 <entry>Type: <emphasis>boolean</emphasis></entry>
29574 <entry>Default: <emphasis>true</emphasis></entry>
29575 </row>
29576 </tbody>
29577 </tgroup>
29578 </informaltable>
29579 <para>
29580 <indexterm role="concept">
29581 <primary>daemon</primary>
29582 <secondary>TCP_NODELAY on sockets</secondary>
29583 </indexterm>
29584 <indexterm role="concept">
29585 <primary>Nagle algorithm</primary>
29586 </indexterm>
29587 <indexterm role="concept">
29588 <primary>TCP_NODELAY on listening sockets</primary>
29589 </indexterm>
29590 If this option is set false, it stops the Exim daemon setting the
29591 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
29592 turns off the <quote>Nagle algorithm</quote>, which is a way of improving network
29593 performance in interactive (character-by-character) situations. Turning it off
29594 should improve Exim&#x2019;s performance a bit, so that is what happens by default.
29595 However, it appears that some broken clients cannot cope, and time out. Hence
29596 this option. It affects only those sockets that are set up for listening by the
29597 daemon. Sockets created by the smtp transport for delivering mail always set
29598 TCP_NODELAY.
29599 </para>
29600 <para>
29601 <indexterm role="option">
29602 <primary><option>timeout_frozen_after</option></primary>
29603 </indexterm>
29604 </para>
29605 <informaltable frame="all">
29606 <tgroup cols="4" colsep="0" rowsep="0">
29607 <colspec colwidth="8*" align="left"/>
29608 <colspec colwidth="6*" align="center"/>
29609 <colspec colwidth="6*" align="center"/>
29610 <colspec colwidth="6*" align="right"/>
29611 <tbody>
29612 <row>
29613 <entry><option>timeout_frozen_after</option></entry>
29614 <entry>Use: <emphasis>main</emphasis></entry>
29615 <entry>Type: <emphasis>time</emphasis></entry>
29616 <entry>Default: <emphasis>0s</emphasis></entry>
29617 </row>
29618 </tbody>
29619 </tgroup>
29620 </informaltable>
29621 <para>
29622 <indexterm role="concept">
29623 <primary>frozen messages</primary>
29624 <secondary>timing out</secondary>
29625 </indexterm>
29626 <indexterm role="concept">
29627 <primary>timeout</primary>
29628 <secondary>frozen messages</secondary>
29629 </indexterm>
29630 If <option>timeout_frozen_after</option> is set to a time greater than zero, a frozen
29631 message of any kind that has been on the queue for longer than the given time
29632 is automatically cancelled at the next queue run. If the frozen message is a
29633 bounce message, it is just discarded; otherwise, a bounce is sent to the
29634 sender, in a similar manner to cancellation by the <option>-Mg</option> command line option.
29635 If you want to timeout frozen bounce messages earlier than other kinds of
29636 frozen message, see <option>ignore_bounce_errors_after</option>.
29637 </para>
29638 <para>
29639 <emphasis role="bold">Note:</emphasis> the default value of zero means no timeouts; with this setting,
29640 frozen messages remain on the queue forever (except for any frozen bounce
29641 messages that are released by <option>ignore_bounce_errors_after</option>).
29642 </para>
29643 <para>
29644 <indexterm role="option">
29645 <primary><option>timezone</option></primary>
29646 </indexterm>
29647 </para>
29648 <informaltable frame="all">
29649 <tgroup cols="4" colsep="0" rowsep="0">
29650 <colspec colwidth="8*" align="left"/>
29651 <colspec colwidth="6*" align="center"/>
29652 <colspec colwidth="6*" align="center"/>
29653 <colspec colwidth="6*" align="right"/>
29654 <tbody>
29655 <row>
29656 <entry><option>timezone</option></entry>
29657 <entry>Use: <emphasis>main</emphasis></entry>
29658 <entry>Type: <emphasis>string</emphasis></entry>
29659 <entry>Default: <emphasis>unset</emphasis></entry>
29660 </row>
29661 </tbody>
29662 </tgroup>
29663 </informaltable>
29664 <para>
29665 <indexterm role="concept">
29666 <primary>timezone, setting</primary>
29667 </indexterm>
29668 The value of <option>timezone</option> is used to set the environment variable TZ while
29669 running Exim (if it is different on entry). This ensures that all timestamps
29670 created by Exim are in the required timezone. If you want all your timestamps
29671 to be in UTC (aka GMT) you should set
29672 </para>
29673 <literallayout class="monospaced">
29674 timezone = UTC
29675 </literallayout>
29676 <para>
29677 The default value is taken from TIMEZONE_DEFAULT in <filename>Local/Makefile</filename>,
29678 or, if that is not set, from the value of the TZ environment variable when Exim
29679 is built. If <option>timezone</option> is set to the empty string, either at build or run
29680 time, any existing TZ variable is removed from the environment when Exim
29681 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
29682 unfortunately not all, operating systems.
29683 </para>
29684 <para>
29685 <indexterm role="option">
29686 <primary><option>tls_advertise_hosts</option></primary>
29687 </indexterm>
29688 </para>
29689 <informaltable frame="all">
29690 <tgroup cols="4" colsep="0" rowsep="0">
29691 <colspec colwidth="8*" align="left"/>
29692 <colspec colwidth="6*" align="center"/>
29693 <colspec colwidth="6*" align="center"/>
29694 <colspec colwidth="6*" align="right"/>
29695 <tbody>
29696 <row>
29697 <entry><option>tls_advertise_hosts</option></entry>
29698 <entry>Use: <emphasis>main</emphasis></entry>
29699 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
29700 <entry>Default: <emphasis>unset</emphasis></entry>
29701 </row>
29702 </tbody>
29703 </tgroup>
29704 </informaltable>
29705 <para>
29706 <indexterm role="concept">
29707 <primary>TLS</primary>
29708 <secondary>advertising</secondary>
29709 </indexterm>
29710 <indexterm role="concept">
29711 <primary>encryption</primary>
29712 <secondary>on SMTP connection</secondary>
29713 </indexterm>
29714 <indexterm role="concept">
29715 <primary>SMTP</primary>
29716 <secondary>encrypted connection</secondary>
29717 </indexterm>
29718 When Exim is built with support for TLS encrypted connections, the availability
29719 of the STARTTLS command to set up an encrypted session is advertised in
29720 response to EHLO only to those client hosts that match this option. See
29721 chapter <xref linkend="CHAPTLS"/> for details of Exim&#x2019;s support for TLS.
29722 </para>
29723 <para>
29724 <indexterm role="option">
29725 <primary><option>tls_certificate</option></primary>
29726 </indexterm>
29727 </para>
29728 <informaltable frame="all">
29729 <tgroup cols="4" colsep="0" rowsep="0">
29730 <colspec colwidth="8*" align="left"/>
29731 <colspec colwidth="6*" align="center"/>
29732 <colspec colwidth="6*" align="center"/>
29733 <colspec colwidth="6*" align="right"/>
29734 <tbody>
29735 <row>
29736 <entry><option>tls_certificate</option></entry>
29737 <entry>Use: <emphasis>main</emphasis></entry>
29738 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
29739 <entry>Default: <emphasis>unset</emphasis></entry>
29740 </row>
29741 </tbody>
29742 </tgroup>
29743 </informaltable>
29744 <para>
29745 <indexterm role="concept">
29746 <primary>TLS</primary>
29747 <secondary>server certificate; location of</secondary>
29748 </indexterm>
29749 <indexterm role="concept">
29750 <primary>certificate</primary>
29751 <secondary>server, location of</secondary>
29752 </indexterm>
29753 The value of this option is expanded, and must then be the absolute path to a
29754 file which contains the server&#x2019;s certificates. The server&#x2019;s private key is also
29755 assumed to be in this file if <option>tls_privatekey</option> is unset. See chapter
29756 <xref linkend="CHAPTLS"/> for further details.
29757 </para>
29758 <para>
29759 <emphasis role="bold">Note</emphasis>: The certificates defined by this option are used only when Exim is
29760 receiving incoming messages as a server. If you want to supply certificates for
29761 use when sending messages as a client, you must set the <option>tls_certificate</option>
29762 option in the relevant <command>smtp</command> transport.
29763 </para>
29764 <para>
29765 If the option contains <varname>$tls_out_sni</varname> and Exim is built against OpenSSL, then
29766 if the OpenSSL build supports TLS extensions and the TLS client sends the
29767 Server Name Indication extension, then this option and others documented in
29768 <xref linkend="SECTtlssni"/> will be re-expanded.
29769 </para>
29770 <para>
29771 <indexterm role="option">
29772 <primary><option>tls_crl</option></primary>
29773 </indexterm>
29774 </para>
29775 <informaltable frame="all">
29776 <tgroup cols="4" colsep="0" rowsep="0">
29777 <colspec colwidth="8*" align="left"/>
29778 <colspec colwidth="6*" align="center"/>
29779 <colspec colwidth="6*" align="center"/>
29780 <colspec colwidth="6*" align="right"/>
29781 <tbody>
29782 <row>
29783 <entry><option>tls_crl</option></entry>
29784 <entry>Use: <emphasis>main</emphasis></entry>
29785 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
29786 <entry>Default: <emphasis>unset</emphasis></entry>
29787 </row>
29788 </tbody>
29789 </tgroup>
29790 </informaltable>
29791 <para>
29792 <indexterm role="concept">
29793 <primary>TLS</primary>
29794 <secondary>server certificate revocation list</secondary>
29795 </indexterm>
29796 <indexterm role="concept">
29797 <primary>certificate</primary>
29798 <secondary>revocation list for server</secondary>
29799 </indexterm>
29800 This option specifies a certificate revocation list. The expanded value must
29801 be the name of a file that contains a CRL in PEM format.
29802 </para>
29803 <para>
29804 See <xref linkend="SECTtlssni"/> for discussion of when this option might be re-expanded.
29805 </para>
29806 <para>
29807 <indexterm role="option">
29808 <primary><option>tls_dh_max_bits</option></primary>
29809 </indexterm>
29810 </para>
29811 <informaltable frame="all">
29812 <tgroup cols="4" colsep="0" rowsep="0">
29813 <colspec colwidth="8*" align="left"/>
29814 <colspec colwidth="6*" align="center"/>
29815 <colspec colwidth="6*" align="center"/>
29816 <colspec colwidth="6*" align="right"/>
29817 <tbody>
29818 <row>
29819 <entry><option>tls_dh_max_bits</option></entry>
29820 <entry>Use: <emphasis>main</emphasis></entry>
29821 <entry>Type: <emphasis>integer</emphasis></entry>
29822 <entry>Default: <emphasis>2236</emphasis></entry>
29823 </row>
29824 </tbody>
29825 </tgroup>
29826 </informaltable>
29827 <para>
29828 <indexterm role="concept">
29829 <primary>TLS</primary>
29830 <secondary>D-H bit count</secondary>
29831 </indexterm>
29832 The number of bits used for Diffie-Hellman key-exchange may be suggested by
29833 the chosen TLS library.  That value might prove to be too high for
29834 interoperability.  This option provides a maximum clamp on the value
29835 suggested, trading off security for interoperability.
29836 </para>
29837 <para>
29838 The value must be at least 1024.
29839 </para>
29840 <para>
29841 The value 2236 was chosen because, at time of adding the option, it was the
29842 hard-coded maximum value supported by the NSS cryptographic library, as used
29843 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
29844 </para>
29845 <para>
29846 If you prefer more security and are willing to break some clients, raise this
29847 number.
29848 </para>
29849 <para>
29850 Note that the value passed to GnuTLS for *generating* a new prime may be a
29851 little less than this figure, because GnuTLS is inexact and may produce a
29852 larger prime than requested.
29853 </para>
29854 <para>
29855 <indexterm role="option">
29856 <primary><option>tls_dhparam</option></primary>
29857 </indexterm>
29858 </para>
29859 <informaltable frame="all">
29860 <tgroup cols="4" colsep="0" rowsep="0">
29861 <colspec colwidth="8*" align="left"/>
29862 <colspec colwidth="6*" align="center"/>
29863 <colspec colwidth="6*" align="center"/>
29864 <colspec colwidth="6*" align="right"/>
29865 <tbody>
29866 <row>
29867 <entry><option>tls_dhparam</option></entry>
29868 <entry>Use: <emphasis>main</emphasis></entry>
29869 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
29870 <entry>Default: <emphasis>unset</emphasis></entry>
29871 </row>
29872 </tbody>
29873 </tgroup>
29874 </informaltable>
29875 <para>
29876 <indexterm role="concept">
29877 <primary>TLS</primary>
29878 <secondary>D-H parameters for server</secondary>
29879 </indexterm>
29880 The value of this option is expanded and indicates the source of DH parameters
29881 to be used by Exim.
29882 </para>
29883 <para>
29884 If it is a filename starting with a <literal>/</literal>, then it names a file from which DH
29885 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
29886 PKCS#3 representation of the DH prime.  If the file does not exist, for
29887 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
29888 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
29889 loading the file is greater than <option>tls_dh_max_bits</option> then it will be ignored,
29890 and treated as though the <option>tls_dhparam</option> were set to "none".
29891 </para>
29892 <para>
29893 If this option expands to the string "none", then no DH parameters will be
29894 loaded by Exim.
29895 </para>
29896 <para>
29897 If this option expands to the string "historic" and Exim is using GnuTLS, then
29898 Exim will attempt to load a file from inside the spool directory.  If the file
29899 does not exist, Exim will attempt to create it.
29900 See section <xref linkend="SECTgnutlsparam"/> for further details.
29901 </para>
29902 <para>
29903 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
29904 a default DH prime; the default is the 2048 bit prime described in section
29905 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
29906 in IKE is assigned number 23.
29907 </para>
29908 <para>
29909 Otherwise, the option must expand to the name used by Exim for any of a number
29910 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
29911 "ike" followed by the number used by IKE, of "default" which corresponds to
29912 "ike23".
29913 </para>
29914 <para>
29915 The available primes are:
29916 <literal>ike1</literal>, <literal>ike2</literal>, <literal>ike5</literal>,
29917 <literal>ike14</literal>, <literal>ike15</literal>, <literal>ike16</literal>, <literal>ike17</literal>, <literal>ike18</literal>,
29918 <literal>ike22</literal>, <literal>ike23</literal> (aka <literal>default</literal>) and <literal>ike24</literal>.
29919 </para>
29920 <para>
29921 Some of these will be too small to be accepted by clients.
29922 Some may be too large to be accepted by clients.
29923 </para>
29924 <para>
29925 The TLS protocol does not negotiate an acceptable size for this; clients tend
29926 to hard-drop connections if what is offered by the server is unacceptable,
29927 whether too large or too small, and there&#x2019;s no provision for the client to
29928 tell the server what these constraints are.  Thus, as a server operator, you
29929 need to make an educated guess as to what is most likely to work for your
29930 userbase.
29931 </para>
29932 <para>
29933 Some known size constraints suggest that a bit-size in the range 2048 to 2236
29934 is most likely to maximise interoperability.  The upper bound comes from
29935 applications using the Mozilla Network Security Services (NSS) library, which
29936 used to set its <literal>DH_MAX_P_BITS</literal> upper-bound to 2236.  This affects many
29937 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
29938 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
29939 acceptable bound from 1024 to 2048.
29940 </para>
29941 <para>
29942 <indexterm role="option">
29943 <primary><option>tls_ocsp_file</option></primary>
29944 </indexterm>
29945 </para>
29946 <informaltable frame="all">
29947 <tgroup cols="4" colsep="0" rowsep="0">
29948 <colspec colwidth="8*" align="left"/>
29949 <colspec colwidth="6*" align="center"/>
29950 <colspec colwidth="6*" align="center"/>
29951 <colspec colwidth="6*" align="right"/>
29952 <tbody>
29953 <row>
29954 <entry><option>tls_ocsp_file</option></entry>
29955 <entry>Use: <emphasis>main</emphasis></entry>
29956 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
29957 <entry>Default: <emphasis>unset</emphasis></entry>
29958 </row>
29959 </tbody>
29960 </tgroup>
29961 </informaltable>
29962 <para>
29963 This option
29964 must if set expand to the absolute path to a file which contains a current
29965 status proof for the server&#x2019;s certificate, as obtained from the
29966 Certificate Authority.
29967 </para>
29968 <para>
29969 <indexterm role="option">
29970 <primary><option>tls_on_connect_ports</option></primary>
29971 </indexterm>
29972 </para>
29973 <informaltable frame="all">
29974 <tgroup cols="4" colsep="0" rowsep="0">
29975 <colspec colwidth="8*" align="left"/>
29976 <colspec colwidth="6*" align="center"/>
29977 <colspec colwidth="6*" align="center"/>
29978 <colspec colwidth="6*" align="right"/>
29979 <tbody>
29980 <row>
29981 <entry><option>tls_on_connect_ports</option></entry>
29982 <entry>Use: <emphasis>main</emphasis></entry>
29983 <entry>Type: <emphasis>string list</emphasis></entry>
29984 <entry>Default: <emphasis>unset</emphasis></entry>
29985 </row>
29986 </tbody>
29987 </tgroup>
29988 </informaltable>
29989 <para>
29990 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
29991 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
29992 set up without waiting for the client to issue a STARTTLS command. For
29993 further details, see section <xref linkend="SECTsupobssmt"/>.
29994 </para>
29995 <para>
29996 <indexterm role="option">
29997 <primary><option>tls_privatekey</option></primary>
29998 </indexterm>
29999 </para>
30000 <informaltable frame="all">
30001 <tgroup cols="4" colsep="0" rowsep="0">
30002 <colspec colwidth="8*" align="left"/>
30003 <colspec colwidth="6*" align="center"/>
30004 <colspec colwidth="6*" align="center"/>
30005 <colspec colwidth="6*" align="right"/>
30006 <tbody>
30007 <row>
30008 <entry><option>tls_privatekey</option></entry>
30009 <entry>Use: <emphasis>main</emphasis></entry>
30010 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
30011 <entry>Default: <emphasis>unset</emphasis></entry>
30012 </row>
30013 </tbody>
30014 </tgroup>
30015 </informaltable>
30016 <para>
30017 <indexterm role="concept">
30018 <primary>TLS</primary>
30019 <secondary>server private key; location of</secondary>
30020 </indexterm>
30021 The value of this option is expanded, and must then be the absolute path to a
30022 file which contains the server&#x2019;s private key. If this option is unset, or if
30023 the expansion is forced to fail, or the result is an empty string, the private
30024 key is assumed to be in the same file as the server&#x2019;s certificates. See chapter
30025 <xref linkend="CHAPTLS"/> for further details.
30026 </para>
30027 <para>
30028 See <xref linkend="SECTtlssni"/> for discussion of when this option might be re-expanded.
30029 </para>
30030 <para>
30031 <indexterm role="option">
30032 <primary><option>tls_remember_esmtp</option></primary>
30033 </indexterm>
30034 </para>
30035 <informaltable frame="all">
30036 <tgroup cols="4" colsep="0" rowsep="0">
30037 <colspec colwidth="8*" align="left"/>
30038 <colspec colwidth="6*" align="center"/>
30039 <colspec colwidth="6*" align="center"/>
30040 <colspec colwidth="6*" align="right"/>
30041 <tbody>
30042 <row>
30043 <entry><option>tls_remember_esmtp</option></entry>
30044 <entry>Use: <emphasis>main</emphasis></entry>
30045 <entry>Type: <emphasis>boolean</emphasis></entry>
30046 <entry>Default: <emphasis>false</emphasis></entry>
30047 </row>
30048 </tbody>
30049 </tgroup>
30050 </informaltable>
30051 <para>
30052 <indexterm role="concept">
30053 <primary>TLS</primary>
30054 <secondary>esmtp state; remembering</secondary>
30055 </indexterm>
30056 <indexterm role="concept">
30057 <primary>TLS</primary>
30058 <secondary>broken clients</secondary>
30059 </indexterm>
30060 If this option is set true, Exim violates the RFCs by remembering that it is in
30061 <quote>esmtp</quote> state after successfully negotiating a TLS session. This provides
30062 support for broken clients that fail to send a new EHLO after starting a
30063 TLS session.
30064 </para>
30065 <para>
30066 <indexterm role="option">
30067 <primary><option>tls_require_ciphers</option></primary>
30068 </indexterm>
30069 </para>
30070 <informaltable frame="all">
30071 <tgroup cols="4" colsep="0" rowsep="0">
30072 <colspec colwidth="8*" align="left"/>
30073 <colspec colwidth="6*" align="center"/>
30074 <colspec colwidth="6*" align="center"/>
30075 <colspec colwidth="6*" align="right"/>
30076 <tbody>
30077 <row>
30078 <entry><option>tls_require_ciphers</option></entry>
30079 <entry>Use: <emphasis>main</emphasis></entry>
30080 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
30081 <entry>Default: <emphasis>unset</emphasis></entry>
30082 </row>
30083 </tbody>
30084 </tgroup>
30085 </informaltable>
30086 <para>
30087 <indexterm role="concept">
30088 <primary>TLS</primary>
30089 <secondary>requiring specific ciphers</secondary>
30090 </indexterm>
30091 <indexterm role="concept">
30092 <primary>cipher</primary>
30093 <secondary>requiring specific</secondary>
30094 </indexterm>
30095 This option controls which ciphers can be used for incoming TLS connections.
30096 The <command>smtp</command> transport has an option of the same name for controlling outgoing
30097 connections. This option is expanded for each connection, so can be varied for
30098 different clients if required. The value of this option must be a list of
30099 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
30100 in somewhat different ways. If GnuTLS is being used, the client controls the
30101 preference order of the available ciphers. Details are given in sections
30102 <xref linkend="SECTreqciphssl"/> and <xref linkend="SECTreqciphgnu"/>.
30103 </para>
30104 <para>
30105 <indexterm role="option">
30106 <primary><option>tls_try_verify_hosts</option></primary>
30107 </indexterm>
30108 </para>
30109 <informaltable frame="all">
30110 <tgroup cols="4" colsep="0" rowsep="0">
30111 <colspec colwidth="8*" align="left"/>
30112 <colspec colwidth="6*" align="center"/>
30113 <colspec colwidth="6*" align="center"/>
30114 <colspec colwidth="6*" align="right"/>
30115 <tbody>
30116 <row>
30117 <entry><option>tls_try_verify_hosts</option></entry>
30118 <entry>Use: <emphasis>main</emphasis></entry>
30119 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
30120 <entry>Default: <emphasis>unset</emphasis></entry>
30121 </row>
30122 </tbody>
30123 </tgroup>
30124 </informaltable>
30125 <para>
30126 <indexterm role="concept">
30127 <primary>TLS</primary>
30128 <secondary>client certificate verification</secondary>
30129 </indexterm>
30130 <indexterm role="concept">
30131 <primary>certificate</primary>
30132 <secondary>verification of client</secondary>
30133 </indexterm>
30134 See <option>tls_verify_hosts</option> below.
30135 </para>
30136 <para>
30137 <indexterm role="option">
30138 <primary><option>tls_verify_certificates</option></primary>
30139 </indexterm>
30140 </para>
30141 <informaltable frame="all">
30142 <tgroup cols="4" colsep="0" rowsep="0">
30143 <colspec colwidth="8*" align="left"/>
30144 <colspec colwidth="6*" align="center"/>
30145 <colspec colwidth="6*" align="center"/>
30146 <colspec colwidth="6*" align="right"/>
30147 <tbody>
30148 <row>
30149 <entry><option>tls_verify_certificates</option></entry>
30150 <entry>Use: <emphasis>main</emphasis></entry>
30151 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
30152 <entry>Default: <emphasis>unset</emphasis></entry>
30153 </row>
30154 </tbody>
30155 </tgroup>
30156 </informaltable>
30157 <para>
30158 <indexterm role="concept">
30159 <primary>TLS</primary>
30160 <secondary>client certificate verification</secondary>
30161 </indexterm>
30162 <indexterm role="concept">
30163 <primary>certificate</primary>
30164 <secondary>verification of client</secondary>
30165 </indexterm>
30166 The value of this option is expanded, and must then be the absolute path to
30167 a file containing permitted certificates for clients that
30168 match <option>tls_verify_hosts</option> or <option>tls_try_verify_hosts</option>. Alternatively, if you
30169 are using OpenSSL, you can set <option>tls_verify_certificates</option> to the name of a
30170 directory containing certificate files. This does not work with GnuTLS; the
30171 option must be set to the name of a single file if you are using GnuTLS.
30172 </para>
30173 <para>
30174 These certificates should be for the certificate authorities trusted, rather
30175 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
30176 the value is a file then the certificates are sent by Exim as a server to
30177 connecting clients, defining the list of accepted certificate authorities.
30178 Thus the values defined should be considered public data.  To avoid this,
30179 use OpenSSL with a directory.
30180 </para>
30181 <para>
30182 See <xref linkend="SECTtlssni"/> for discussion of when this option might be re-expanded.
30183 </para>
30184 <para>
30185 A forced expansion failure or setting to an empty string is equivalent to
30186 being unset.
30187 </para>
30188 <para>
30189 <indexterm role="option">
30190 <primary><option>tls_verify_hosts</option></primary>
30191 </indexterm>
30192 </para>
30193 <informaltable frame="all">
30194 <tgroup cols="4" colsep="0" rowsep="0">
30195 <colspec colwidth="8*" align="left"/>
30196 <colspec colwidth="6*" align="center"/>
30197 <colspec colwidth="6*" align="center"/>
30198 <colspec colwidth="6*" align="right"/>
30199 <tbody>
30200 <row>
30201 <entry><option>tls_verify_hosts</option></entry>
30202 <entry>Use: <emphasis>main</emphasis></entry>
30203 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
30204 <entry>Default: <emphasis>unset</emphasis></entry>
30205 </row>
30206 </tbody>
30207 </tgroup>
30208 </informaltable>
30209 <para>
30210 <indexterm role="concept">
30211 <primary>TLS</primary>
30212 <secondary>client certificate verification</secondary>
30213 </indexterm>
30214 <indexterm role="concept">
30215 <primary>certificate</primary>
30216 <secondary>verification of client</secondary>
30217 </indexterm>
30218 This option, along with <option>tls_try_verify_hosts</option>, controls the checking of
30219 certificates from clients. The expected certificates are defined by
30220 <option>tls_verify_certificates</option>, which must be set. A configuration error occurs if
30221 either <option>tls_verify_hosts</option> or <option>tls_try_verify_hosts</option> is set and
30222 <option>tls_verify_certificates</option> is not set.
30223 </para>
30224 <para>
30225 Any client that matches <option>tls_verify_hosts</option> is constrained by
30226 <option>tls_verify_certificates</option>. When the client initiates a TLS session, it must
30227 present one of the listed certificates. If it does not, the connection is
30228 aborted. <emphasis role="bold">Warning</emphasis>: Including a host in <option>tls_verify_hosts</option> does not require
30229 the host to use TLS. It can still send SMTP commands through unencrypted
30230 connections. Forcing a client to use TLS has to be done separately using an
30231 ACL to reject inappropriate commands when the connection is not encrypted.
30232 </para>
30233 <para>
30234 A weaker form of checking is provided by <option>tls_try_verify_hosts</option>. If a client
30235 matches this option (but not <option>tls_verify_hosts</option>), Exim requests a
30236 certificate and checks it against <option>tls_verify_certificates</option>, but does not
30237 abort the connection if there is no certificate or if it does not match. This
30238 state can be detected in an ACL, which makes it possible to implement policies
30239 such as <quote>accept for relay only if a verified certificate has been received,
30240 but accept for local delivery if encrypted, even without a verified
30241 certificate</quote>.
30242 </para>
30243 <para>
30244 Client hosts that match neither of these lists are not asked to present
30245 certificates.
30246 </para>
30247 <para>
30248 <indexterm role="option">
30249 <primary><option>trusted_groups</option></primary>
30250 </indexterm>
30251 </para>
30252 <informaltable frame="all">
30253 <tgroup cols="4" colsep="0" rowsep="0">
30254 <colspec colwidth="8*" align="left"/>
30255 <colspec colwidth="6*" align="center"/>
30256 <colspec colwidth="6*" align="center"/>
30257 <colspec colwidth="6*" align="right"/>
30258 <tbody>
30259 <row>
30260 <entry><option>trusted_groups</option></entry>
30261 <entry>Use: <emphasis>main</emphasis></entry>
30262 <entry>Type: <emphasis>string list</emphasis>&dagger;<emphasis></emphasis></entry>
30263 <entry>Default: <emphasis>unset</emphasis></entry>
30264 </row>
30265 </tbody>
30266 </tgroup>
30267 </informaltable>
30268 <para>
30269 <indexterm role="concept">
30270 <primary>trusted groups</primary>
30271 </indexterm>
30272 <indexterm role="concept">
30273 <primary>groups</primary>
30274 <secondary>trusted</secondary>
30275 </indexterm>
30276 This option is expanded just once, at the start of Exim&#x2019;s processing. If this
30277 option is set, any process that is running in one of the listed groups, or
30278 which has one of them as a supplementary group, is trusted. The groups can be
30279 specified numerically or by name. See section <xref linkend="SECTtrustedadmin"/> for
30280 details of what trusted callers are permitted to do. If neither
30281 <option>trusted_groups</option> nor <option>trusted_users</option> is set, only root and the Exim user
30282 are trusted.
30283 </para>
30284 <para>
30285 <indexterm role="option">
30286 <primary><option>trusted_users</option></primary>
30287 </indexterm>
30288 </para>
30289 <informaltable frame="all">
30290 <tgroup cols="4" colsep="0" rowsep="0">
30291 <colspec colwidth="8*" align="left"/>
30292 <colspec colwidth="6*" align="center"/>
30293 <colspec colwidth="6*" align="center"/>
30294 <colspec colwidth="6*" align="right"/>
30295 <tbody>
30296 <row>
30297 <entry><option>trusted_users</option></entry>
30298 <entry>Use: <emphasis>main</emphasis></entry>
30299 <entry>Type: <emphasis>string list</emphasis>&dagger;<emphasis></emphasis></entry>
30300 <entry>Default: <emphasis>unset</emphasis></entry>
30301 </row>
30302 </tbody>
30303 </tgroup>
30304 </informaltable>
30305 <para>
30306 <indexterm role="concept">
30307 <primary>trusted users</primary>
30308 </indexterm>
30309 <indexterm role="concept">
30310 <primary>user</primary>
30311 <secondary>trusted</secondary>
30312 </indexterm>
30313 This option is expanded just once, at the start of Exim&#x2019;s processing. If this
30314 option is set, any process that is running as one of the listed users is
30315 trusted. The users can be specified numerically or by name. See section
30316 <xref linkend="SECTtrustedadmin"/> for details of what trusted callers are permitted to do.
30317 If neither <option>trusted_groups</option> nor <option>trusted_users</option> is set, only root and the
30318 Exim user are trusted.
30319 </para>
30320 <para>
30321 <indexterm role="option">
30322 <primary><option>unknown_login</option></primary>
30323 </indexterm>
30324 </para>
30325 <informaltable frame="all">
30326 <tgroup cols="4" colsep="0" rowsep="0">
30327 <colspec colwidth="8*" align="left"/>
30328 <colspec colwidth="6*" align="center"/>
30329 <colspec colwidth="6*" align="center"/>
30330 <colspec colwidth="6*" align="right"/>
30331 <tbody>
30332 <row>
30333 <entry><option>unknown_login</option></entry>
30334 <entry>Use: <emphasis>main</emphasis></entry>
30335 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
30336 <entry>Default: <emphasis>unset</emphasis></entry>
30337 </row>
30338 </tbody>
30339 </tgroup>
30340 </informaltable>
30341 <para>
30342 <indexterm role="concept">
30343 <primary>uid (user id)</primary>
30344 <secondary>unknown caller</secondary>
30345 </indexterm>
30346 <indexterm role="variable">
30347 <primary><varname>$caller_uid</varname></primary>
30348 </indexterm>
30349 This is a specialized feature for use in unusual configurations. By default, if
30350 the uid of the caller of Exim cannot be looked up using <function>getpwuid()</function>, Exim
30351 gives up. The <option>unknown_login</option> option can be used to set a login name to be
30352 used in this circumstance. It is expanded, so values like <option>user$caller_uid</option>
30353 can be set. When <option>unknown_login</option> is used, the value of <option>unknown_username</option>
30354 is used for the user&#x2019;s real name (gecos field), unless this has been set by the
30355 <option>-F</option> option.
30356 </para>
30357 <para>
30358 <indexterm role="option">
30359 <primary><option>unknown_username</option></primary>
30360 </indexterm>
30361 </para>
30362 <informaltable frame="all">
30363 <tgroup cols="4" colsep="0" rowsep="0">
30364 <colspec colwidth="8*" align="left"/>
30365 <colspec colwidth="6*" align="center"/>
30366 <colspec colwidth="6*" align="center"/>
30367 <colspec colwidth="6*" align="right"/>
30368 <tbody>
30369 <row>
30370 <entry><option>unknown_username</option></entry>
30371 <entry>Use: <emphasis>main</emphasis></entry>
30372 <entry>Type: <emphasis>string</emphasis></entry>
30373 <entry>Default: <emphasis>unset</emphasis></entry>
30374 </row>
30375 </tbody>
30376 </tgroup>
30377 </informaltable>
30378 <para>
30379 See <option>unknown_login</option>.
30380 </para>
30381 <para>
30382 <indexterm role="option">
30383 <primary><option>untrusted_set_sender</option></primary>
30384 </indexterm>
30385 </para>
30386 <informaltable frame="all">
30387 <tgroup cols="4" colsep="0" rowsep="0">
30388 <colspec colwidth="8*" align="left"/>
30389 <colspec colwidth="6*" align="center"/>
30390 <colspec colwidth="6*" align="center"/>
30391 <colspec colwidth="6*" align="right"/>
30392 <tbody>
30393 <row>
30394 <entry><option>untrusted_set_sender</option></entry>
30395 <entry>Use: <emphasis>main</emphasis></entry>
30396 <entry>Type: <emphasis>address list</emphasis>&dagger;<emphasis></emphasis></entry>
30397 <entry>Default: <emphasis>unset</emphasis></entry>
30398 </row>
30399 </tbody>
30400 </tgroup>
30401 </informaltable>
30402 <para>
30403 <indexterm role="concept">
30404 <primary>trusted users</primary>
30405 </indexterm>
30406 <indexterm role="concept">
30407 <primary>sender</primary>
30408 <secondary>setting by untrusted user</secondary>
30409 </indexterm>
30410 <indexterm role="concept">
30411 <primary>untrusted user setting sender</primary>
30412 </indexterm>
30413 <indexterm role="concept">
30414 <primary>user</primary>
30415 <secondary>untrusted setting sender</secondary>
30416 </indexterm>
30417 <indexterm role="concept">
30418 <primary>envelope sender</primary>
30419 </indexterm>
30420 When an untrusted user submits a message to Exim using the standard input, Exim
30421 normally creates an envelope sender address from the user&#x2019;s login and the
30422 default qualification domain. Data from the <option>-f</option> option (for setting envelope
30423 senders on non-SMTP messages) or the SMTP MAIL command (if <option>-bs</option> or <option>-bS</option>
30424 is used) is ignored.
30425 </para>
30426 <para>
30427 However, untrusted users are permitted to set an empty envelope sender address,
30428 to declare that a message should never generate any bounces. For example:
30429 </para>
30430 <literallayout class="monospaced">
30431 exim -f '&lt;&gt;' user@domain.example
30432 </literallayout>
30433 <para>
30434 <indexterm role="variable">
30435 <primary><varname>$sender_ident</varname></primary>
30436 </indexterm>
30437 The <option>untrusted_set_sender</option> option allows you to permit untrusted users to set
30438 other envelope sender addresses in a controlled way. When it is set, untrusted
30439 users are allowed to set envelope sender addresses that match any of the
30440 patterns in the list. Like all address lists, the string is expanded. The
30441 identity of the user is in <varname>$sender_ident</varname>, so you can, for example, restrict
30442 users to setting senders that start with their login ids
30443 followed by a hyphen
30444 by a setting like this:
30445 </para>
30446 <literallayout class="monospaced">
30447 untrusted_set_sender = ^$sender_ident-
30448 </literallayout>
30449 <para>
30450 If you want to allow untrusted users to set envelope sender addresses without
30451 restriction, you can use
30452 </para>
30453 <literallayout class="monospaced">
30454 untrusted_set_sender = *
30455 </literallayout>
30456 <para>
30457 The <option>untrusted_set_sender</option> option applies to all forms of local input, but
30458 only to the setting of the envelope sender. It does not permit untrusted users
30459 to use the other options which trusted user can use to override message
30460 parameters. Furthermore, it does not stop Exim from removing an existing
30461 <emphasis>Sender:</emphasis> header in the message, or from adding a <emphasis>Sender:</emphasis> header if
30462 necessary. See <option>local_sender_retain</option> and <option>local_from_check</option> for ways of
30463 overriding these actions. The handling of the <emphasis>Sender:</emphasis> header is also
30464 described in section <xref linkend="SECTthesenhea"/>.
30465 </para>
30466 <para>
30467 The log line for a message&#x2019;s arrival shows the envelope sender following
30468 <quote>&lt;=</quote>. For local messages, the user&#x2019;s login always follows, after <quote>U=</quote>. In
30469 <option>-bp</option> displays, and in the Exim monitor, if an untrusted user sets an
30470 envelope sender address, the user&#x2019;s login is shown in parentheses after the
30471 sender address.
30472 </para>
30473 <para>
30474 <indexterm role="option">
30475 <primary><option>uucp_from_pattern</option></primary>
30476 </indexterm>
30477 </para>
30478 <informaltable frame="all">
30479 <tgroup cols="4" colsep="0" rowsep="0">
30480 <colspec colwidth="8*" align="left"/>
30481 <colspec colwidth="6*" align="center"/>
30482 <colspec colwidth="6*" align="center"/>
30483 <colspec colwidth="6*" align="right"/>
30484 <tbody>
30485 <row>
30486 <entry><option>uucp_from_pattern</option></entry>
30487 <entry>Use: <emphasis>main</emphasis></entry>
30488 <entry>Type: <emphasis>string</emphasis></entry>
30489 <entry>Default: <emphasis>see below</emphasis></entry>
30490 </row>
30491 </tbody>
30492 </tgroup>
30493 </informaltable>
30494 <para>
30495 <indexterm role="concept">
30496 <primary><quote>From</quote> line</primary>
30497 </indexterm>
30498 <indexterm role="concept">
30499 <primary>UUCP</primary>
30500 <secondary><quote>From</quote> line</secondary>
30501 </indexterm>
30502 Some applications that pass messages to an MTA via a command line interface use
30503 an initial line starting with <quote>From&nbsp;</quote> to pass the envelope sender. In
30504 particular, this is used by UUCP software. Exim recognizes such a line by means
30505 of a regular expression that is set in <option>uucp_from_pattern</option>. When the pattern
30506 matches, the sender address is constructed by expanding the contents of
30507 <option>uucp_from_sender</option>, provided that the caller of Exim is a trusted user. The
30508 default pattern recognizes lines in the following two forms:
30509 </para>
30510 <literallayout class="monospaced">
30511 From ph10 Fri Jan  5 12:35 GMT 1996
30512 From ph10 Fri, 7 Jan 97 14:00:00 GMT
30513 </literallayout>
30514 <para>
30515 The pattern can be seen by running
30516 </para>
30517 <literallayout class="monospaced">
30518 exim -bP uucp_from_pattern
30519 </literallayout>
30520 <para>
30521 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
30522 year in the second case. The first word after <quote>From&nbsp;</quote> is matched in the
30523 regular expression by a parenthesized subpattern. The default value for
30524 <option>uucp_from_sender</option> is <quote>$1</quote>, which therefore just uses this first word
30525 (<quote>ph10</quote> in the example above) as the message&#x2019;s sender. See also
30526 <option>ignore_fromline_hosts</option>.
30527 </para>
30528 <para>
30529 <indexterm role="option">
30530 <primary><option>uucp_from_sender</option></primary>
30531 </indexterm>
30532 </para>
30533 <informaltable frame="all">
30534 <tgroup cols="4" colsep="0" rowsep="0">
30535 <colspec colwidth="8*" align="left"/>
30536 <colspec colwidth="6*" align="center"/>
30537 <colspec colwidth="6*" align="center"/>
30538 <colspec colwidth="6*" align="right"/>
30539 <tbody>
30540 <row>
30541 <entry><option>uucp_from_sender</option></entry>
30542 <entry>Use: <emphasis>main</emphasis></entry>
30543 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
30544 <entry>Default: <emphasis><literal>$1</literal></emphasis></entry>
30545 </row>
30546 </tbody>
30547 </tgroup>
30548 </informaltable>
30549 <para>
30550 See <option>uucp_from_pattern</option> above.
30551 </para>
30552 <para>
30553 <indexterm role="option">
30554 <primary><option>warn_message_file</option></primary>
30555 </indexterm>
30556 </para>
30557 <informaltable frame="all">
30558 <tgroup cols="4" colsep="0" rowsep="0">
30559 <colspec colwidth="8*" align="left"/>
30560 <colspec colwidth="6*" align="center"/>
30561 <colspec colwidth="6*" align="center"/>
30562 <colspec colwidth="6*" align="right"/>
30563 <tbody>
30564 <row>
30565 <entry><option>warn_message_file</option></entry>
30566 <entry>Use: <emphasis>main</emphasis></entry>
30567 <entry>Type: <emphasis>string</emphasis></entry>
30568 <entry>Default: <emphasis>unset</emphasis></entry>
30569 </row>
30570 </tbody>
30571 </tgroup>
30572 </informaltable>
30573 <para>
30574 <indexterm role="concept">
30575 <primary>warning of delay</primary>
30576 <secondary>customizing the message</secondary>
30577 </indexterm>
30578 <indexterm role="concept">
30579 <primary>customizing</primary>
30580 <secondary>warning message</secondary>
30581 </indexterm>
30582 This option defines a template file containing paragraphs of text to be used
30583 for constructing the warning message which is sent by Exim when a message has
30584 been on the queue for a specified amount of time, as specified by
30585 <option>delay_warning</option>. Details of the file&#x2019;s contents are given in chapter
30586 <xref linkend="CHAPemsgcust"/>. See also <option>bounce_message_file</option>.
30587 </para>
30588 <para>
30589 <indexterm role="option">
30590 <primary><option>write_rejectlog</option></primary>
30591 </indexterm>
30592 </para>
30593 <informaltable frame="all">
30594 <tgroup cols="4" colsep="0" rowsep="0">
30595 <colspec colwidth="8*" align="left"/>
30596 <colspec colwidth="6*" align="center"/>
30597 <colspec colwidth="6*" align="center"/>
30598 <colspec colwidth="6*" align="right"/>
30599 <tbody>
30600 <row>
30601 <entry><option>write_rejectlog</option></entry>
30602 <entry>Use: <emphasis>main</emphasis></entry>
30603 <entry>Type: <emphasis>boolean</emphasis></entry>
30604 <entry>Default: <emphasis>true</emphasis></entry>
30605 </row>
30606 </tbody>
30607 </tgroup>
30608 </informaltable>
30609 <para>
30610 <indexterm role="concept">
30611 <primary>reject log</primary>
30612 <secondary>disabling</secondary>
30613 </indexterm>
30614 If this option is set false, Exim no longer writes anything to the reject log.
30615 See chapter <xref linkend="CHAPlog"/> for details of what Exim writes to its logs.
30616 <indexterm role="concept" startref="IIDconfima" class="endofrange"/>
30617 <indexterm role="concept" startref="IIDmaiconf" class="endofrange"/>
30618 </para>
30619 </section>
30620 </chapter>
30621
30622 <chapter id="CHAProutergeneric">
30623 <title>Generic options for routers</title>
30624 <para>
30625 <indexterm role="concept" id="IIDgenoprou1" class="startofrange">
30626 <primary>options</primary>
30627 <secondary>generic; for routers</secondary>
30628 </indexterm>
30629 <indexterm role="concept" id="IIDgenoprou2" class="startofrange">
30630 <primary>generic options</primary>
30631 <secondary>router</secondary>
30632 </indexterm>
30633 This chapter describes the generic options that apply to all routers.
30634 Those that are preconditions are marked with &Dagger; in the <quote>use</quote> field.
30635 </para>
30636 <para>
30637 For a general description of how a router operates, see sections
30638 <xref linkend="SECTrunindrou"/> and <xref linkend="SECTrouprecon"/>. The latter specifies the order in
30639 which the preconditions are tested. The order of expansion of the options that
30640 provide data for a transport is: <option>errors_to</option>, <option>headers_add</option>,
30641 <option>headers_remove</option>, <option>transport</option>.
30642 </para>
30643 <para>
30644 <indexterm role="option">
30645 <primary><option>address_data</option></primary>
30646 </indexterm>
30647 </para>
30648 <informaltable frame="all">
30649 <tgroup cols="4" colsep="0" rowsep="0">
30650 <colspec colwidth="8*" align="left"/>
30651 <colspec colwidth="6*" align="center"/>
30652 <colspec colwidth="6*" align="center"/>
30653 <colspec colwidth="6*" align="right"/>
30654 <tbody>
30655 <row>
30656 <entry><option>address_data</option></entry>
30657 <entry>Use: <emphasis>routers</emphasis></entry>
30658 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
30659 <entry>Default: <emphasis>unset</emphasis></entry>
30660 </row>
30661 </tbody>
30662 </tgroup>
30663 </informaltable>
30664 <para>
30665 <indexterm role="concept">
30666 <primary>router</primary>
30667 <secondary>data attached to address</secondary>
30668 </indexterm>
30669 The string is expanded just before the router is run, that is, after all the
30670 precondition tests have succeeded. If the expansion is forced to fail, the
30671 router declines, the value of <option>address_data</option> remains unchanged, and the
30672 <option>more</option> option controls what happens next. Other expansion failures cause
30673 delivery of the address to be deferred.
30674 </para>
30675 <para>
30676 <indexterm role="variable">
30677 <primary><varname>$address_data</varname></primary>
30678 </indexterm>
30679 When the expansion succeeds, the value is retained with the address, and can be
30680 accessed using the variable <varname>$address_data</varname> in the current router, subsequent
30681 routers, and the eventual transport.
30682 </para>
30683 <para>
30684 <emphasis role="bold">Warning</emphasis>: If the current or any subsequent router is a <command>redirect</command> router
30685 that runs a user&#x2019;s filter file, the contents of <varname>$address_data</varname> are accessible
30686 in the filter. This is not normally a problem, because such data is usually
30687 either not confidential or it <quote>belongs</quote> to the current user, but if you do
30688 put confidential data into <varname>$address_data</varname> you need to remember this point.
30689 </para>
30690 <para>
30691 Even if the router declines or passes, the value of <varname>$address_data</varname> remains
30692 with the address, though it can be changed by another <option>address_data</option> setting
30693 on a subsequent router. If a router generates child addresses, the value of
30694 <varname>$address_data</varname> propagates to them. This also applies to the special kind of
30695 <quote>child</quote> that is generated by a router with the <option>unseen</option> option.
30696 </para>
30697 <para>
30698 The idea of <option>address_data</option> is that you can use it to look up a lot of data
30699 for the address once, and then pick out parts of the data later. For example,
30700 you could use a single LDAP lookup to return a string of the form
30701 </para>
30702 <literallayout class="monospaced">
30703 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
30704 </literallayout>
30705 <para>
30706 In the transport you could pick out the mailbox by a setting such as
30707 </para>
30708 <literallayout class="monospaced">
30709 file = ${extract{mailbox}{$address_data}}
30710 </literallayout>
30711 <para>
30712 This makes the configuration file less messy, and also reduces the number of
30713 lookups (though Exim does cache lookups).
30714 </para>
30715 <para>
30716 <indexterm role="variable">
30717 <primary><varname>$sender_address_data</varname></primary>
30718 </indexterm>
30719 <indexterm role="variable">
30720 <primary><varname>$address_data</varname></primary>
30721 </indexterm>
30722 The <option>address_data</option> facility is also useful as a means of passing information
30723 from one router to another, and from a router to a transport. In addition, if
30724 <varname>$address_data</varname> is set by a router when verifying a recipient address from an
30725 ACL, it remains available for use in the rest of the ACL statement. After
30726 verifying a sender, the value is transferred to <varname>$sender_address_data</varname>.
30727 </para>
30728 <para>
30729 <indexterm role="option">
30730 <primary><option>address_test</option></primary>
30731 </indexterm>
30732 </para>
30733 <informaltable frame="all">
30734 <tgroup cols="4" colsep="0" rowsep="0">
30735 <colspec colwidth="8*" align="left"/>
30736 <colspec colwidth="6*" align="center"/>
30737 <colspec colwidth="6*" align="center"/>
30738 <colspec colwidth="6*" align="right"/>
30739 <tbody>
30740 <row>
30741 <entry><option>address_test</option></entry>
30742 <entry>Use: <emphasis>routers</emphasis>&Dagger;<emphasis></emphasis></entry>
30743 <entry>Type: <emphasis>boolean</emphasis></entry>
30744 <entry>Default: <emphasis>true</emphasis></entry>
30745 </row>
30746 </tbody>
30747 </tgroup>
30748 </informaltable>
30749 <para>
30750 <indexterm role="option">
30751 <primary><option>-bt</option></primary>
30752 </indexterm>
30753 <indexterm role="concept">
30754 <primary>router</primary>
30755 <secondary>skipping when address testing</secondary>
30756 </indexterm>
30757 If this option is set false, the router is skipped when routing is being tested
30758 by means of the <option>-bt</option> command line option. This can be a convenience when
30759 your first router sends messages to an external scanner, because it saves you
30760 having to set the <quote>already scanned</quote> indicator when testing real address
30761 routing.
30762 </para>
30763 <para>
30764 <indexterm role="option">
30765 <primary><option>cannot_route_message</option></primary>
30766 </indexterm>
30767 </para>
30768 <informaltable frame="all">
30769 <tgroup cols="4" colsep="0" rowsep="0">
30770 <colspec colwidth="8*" align="left"/>
30771 <colspec colwidth="6*" align="center"/>
30772 <colspec colwidth="6*" align="center"/>
30773 <colspec colwidth="6*" align="right"/>
30774 <tbody>
30775 <row>
30776 <entry><option>cannot_route_message</option></entry>
30777 <entry>Use: <emphasis>routers</emphasis></entry>
30778 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
30779 <entry>Default: <emphasis>unset</emphasis></entry>
30780 </row>
30781 </tbody>
30782 </tgroup>
30783 </informaltable>
30784 <para>
30785 <indexterm role="concept">
30786 <primary>router</primary>
30787 <secondary>customizing <quote>cannot route</quote> message</secondary>
30788 </indexterm>
30789 <indexterm role="concept">
30790 <primary>customizing</primary>
30791 <secondary><quote>cannot route</quote> message</secondary>
30792 </indexterm>
30793 This option specifies a text message that is used when an address cannot be
30794 routed because Exim has run out of routers. The default message is
30795 <quote>Unrouteable address</quote>. This option is useful only on routers that have
30796 <option>more</option> set false, or on the very last router in a configuration, because the
30797 value that is used is taken from the last router that is considered. This
30798 includes a router that is skipped because its preconditions are not met, as
30799 well as a router that declines. For example, using the default configuration,
30800 you could put:
30801 </para>
30802 <literallayout class="monospaced">
30803 cannot_route_message = Remote domain not found in DNS
30804 </literallayout>
30805 <para>
30806 on the first router, which is a <command>dnslookup</command> router with <option>more</option> set false,
30807 and
30808 </para>
30809 <literallayout class="monospaced">
30810 cannot_route_message = Unknown local user
30811 </literallayout>
30812 <para>
30813 on the final router that checks for local users. If string expansion fails for
30814 this option, the default message is used. Unless the expansion failure was
30815 explicitly forced, a message about the failure is written to the main and panic
30816 logs, in addition to the normal message about the routing failure.
30817 </para>
30818 <para>
30819 <indexterm role="option">
30820 <primary><option>caseful_local_part</option></primary>
30821 </indexterm>
30822 </para>
30823 <informaltable frame="all">
30824 <tgroup cols="4" colsep="0" rowsep="0">
30825 <colspec colwidth="8*" align="left"/>
30826 <colspec colwidth="6*" align="center"/>
30827 <colspec colwidth="6*" align="center"/>
30828 <colspec colwidth="6*" align="right"/>
30829 <tbody>
30830 <row>
30831 <entry><option>caseful_local_part</option></entry>
30832 <entry>Use: <emphasis>routers</emphasis></entry>
30833 <entry>Type: <emphasis>boolean</emphasis></entry>
30834 <entry>Default: <emphasis>false</emphasis></entry>
30835 </row>
30836 </tbody>
30837 </tgroup>
30838 </informaltable>
30839 <para>
30840 <indexterm role="concept">
30841 <primary>case of local parts</primary>
30842 </indexterm>
30843 <indexterm role="concept">
30844 <primary>router</primary>
30845 <secondary>case of local parts</secondary>
30846 </indexterm>
30847 By default, routers handle the local parts of addresses in a case-insensitive
30848 manner, though the actual case is preserved for transmission with the message.
30849 If you want the case of letters to be significant in a router, you must set
30850 this option true. For individual router options that contain address or local
30851 part lists (for example, <option>local_parts</option>), case-sensitive matching can be
30852 turned on by <quote>+caseful</quote> as a list item. See section <xref linkend="SECTcasletadd"/> for
30853 more details.
30854 </para>
30855 <para>
30856 <indexterm role="variable">
30857 <primary><varname>$local_part</varname></primary>
30858 </indexterm>
30859 <indexterm role="variable">
30860 <primary><varname>$original_local_part</varname></primary>
30861 </indexterm>
30862 <indexterm role="variable">
30863 <primary><varname>$parent_local_part</varname></primary>
30864 </indexterm>
30865 The value of the <varname>$local_part</varname> variable is forced to lower case while a
30866 router is running unless <option>caseful_local_part</option> is set. When a router assigns
30867 an address to a transport, the value of <varname>$local_part</varname> when the transport runs
30868 is the same as it was in the router. Similarly, when a router generates child
30869 addresses by aliasing or forwarding, the values of <varname>$original_local_part</varname>
30870 and <varname>$parent_local_part</varname> are those that were used by the redirecting router.
30871 </para>
30872 <para>
30873 This option applies to the processing of an address by a router. When a
30874 recipient address is being processed in an ACL, there is a separate <option>control</option>
30875 modifier that can be used to specify case-sensitive processing within the ACL
30876 (see section <xref linkend="SECTcontrols"/>).
30877 </para>
30878 <para>
30879 <indexterm role="option">
30880 <primary><option>check_local_user</option></primary>
30881 </indexterm>
30882 </para>
30883 <informaltable frame="all">
30884 <tgroup cols="4" colsep="0" rowsep="0">
30885 <colspec colwidth="8*" align="left"/>
30886 <colspec colwidth="6*" align="center"/>
30887 <colspec colwidth="6*" align="center"/>
30888 <colspec colwidth="6*" align="right"/>
30889 <tbody>
30890 <row>
30891 <entry><option>check_local_user</option></entry>
30892 <entry>Use: <emphasis>routers</emphasis>&Dagger;<emphasis></emphasis></entry>
30893 <entry>Type: <emphasis>boolean</emphasis></entry>
30894 <entry>Default: <emphasis>false</emphasis></entry>
30895 </row>
30896 </tbody>
30897 </tgroup>
30898 </informaltable>
30899 <para>
30900 <indexterm role="concept">
30901 <primary>local user, checking in router</primary>
30902 </indexterm>
30903 <indexterm role="concept">
30904 <primary>router</primary>
30905 <secondary>checking for local user</secondary>
30906 </indexterm>
30907 <indexterm role="concept">
30908 <primary><filename>/etc/passwd</filename></primary>
30909 </indexterm>
30910 <indexterm role="variable">
30911 <primary><varname>$home</varname></primary>
30912 </indexterm>
30913 When this option is true, Exim checks that the local part of the recipient
30914 address (with affixes removed if relevant) is the name of an account on the
30915 local system. The check is done by calling the <function>getpwnam()</function> function rather
30916 than trying to read <filename>/etc/passwd</filename> directly. This means that other methods of
30917 holding password data (such as NIS) are supported. If the local part is a local
30918 user, <varname>$home</varname> is set from the password data, and can be tested in other
30919 preconditions that are evaluated after this one (the order of evaluation is
30920 given in section <xref linkend="SECTrouprecon"/>). However, the value of <varname>$home</varname> can be
30921 overridden by <option>router_home_directory</option>. If the local part is not a local user,
30922 the router is skipped.
30923 </para>
30924 <para>
30925 If you want to check that the local part is either the name of a local user
30926 or matches something else, you cannot combine <option>check_local_user</option> with a
30927 setting of <option>local_parts</option>, because that specifies the logical <emphasis>and</emphasis> of the
30928 two conditions. However, you can use a <command>passwd</command> lookup in a <option>local_parts</option>
30929 setting to achieve this. For example:
30930 </para>
30931 <literallayout class="monospaced">
30932 local_parts = passwd;$local_part : lsearch;/etc/other/users
30933 </literallayout>
30934 <para>
30935 Note, however, that the side effects of <option>check_local_user</option> (such as setting
30936 up a home directory) do not occur when a <command>passwd</command> lookup is used in a
30937 <option>local_parts</option> (or any other) precondition.
30938 </para>
30939 <para>
30940 <indexterm role="option">
30941 <primary><option>condition</option></primary>
30942 </indexterm>
30943 </para>
30944 <informaltable frame="all">
30945 <tgroup cols="4" colsep="0" rowsep="0">
30946 <colspec colwidth="8*" align="left"/>
30947 <colspec colwidth="6*" align="center"/>
30948 <colspec colwidth="6*" align="center"/>
30949 <colspec colwidth="6*" align="right"/>
30950 <tbody>
30951 <row>
30952 <entry><option>condition</option></entry>
30953 <entry>Use: <emphasis>routers</emphasis>&Dagger;<emphasis></emphasis></entry>
30954 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
30955 <entry>Default: <emphasis>unset</emphasis></entry>
30956 </row>
30957 </tbody>
30958 </tgroup>
30959 </informaltable>
30960 <para>
30961 <indexterm role="concept">
30962 <primary>router</primary>
30963 <secondary>customized precondition</secondary>
30964 </indexterm>
30965 This option specifies a general precondition test that has to succeed for the
30966 router to be called. The <option>condition</option> option is the last precondition to be
30967 evaluated (see section <xref linkend="SECTrouprecon"/>). The string is expanded, and if the
30968 result is a forced failure, or an empty string, or one of the strings <quote>0</quote> or
30969 <quote>no</quote> or <quote>false</quote> (checked without regard to the case of the letters), the
30970 router is skipped, and the address is offered to the next one.
30971 </para>
30972 <para>
30973 If the result is any other value, the router is run (as this is the last
30974 precondition to be evaluated, all the other preconditions must be true).
30975 </para>
30976 <para>
30977 This option is unusual in that multiple <option>condition</option> options may be present.
30978 All <option>condition</option> options must succeed.
30979 </para>
30980 <para>
30981 The <option>condition</option> option provides a means of applying custom conditions to the
30982 running of routers. Note that in the case of a simple conditional expansion,
30983 the default expansion values are exactly what is wanted. For example:
30984 </para>
30985 <literallayout class="monospaced">
30986 condition = ${if &gt;{$message_age}{600}}
30987 </literallayout>
30988 <para>
30989 Because of the default behaviour of the string expansion, this is equivalent to
30990 </para>
30991 <literallayout class="monospaced">
30992 condition = ${if &gt;{$message_age}{600}{true}{}}
30993 </literallayout>
30994 <para>
30995 A multiple condition example, which succeeds:
30996 </para>
30997 <literallayout class="monospaced">
30998 condition = ${if &gt;{$message_age}{600}}
30999 condition = ${if !eq{${lc:$local_part}}{postmaster}}
31000 condition = foobar
31001 </literallayout>
31002 <para>
31003 If the expansion fails (other than forced failure) delivery is deferred. Some
31004 of the other precondition options are common special cases that could in fact
31005 be specified using <option>condition</option>.
31006 </para>
31007 <para>
31008 <indexterm role="option">
31009 <primary><option>debug_print</option></primary>
31010 </indexterm>
31011 </para>
31012 <informaltable frame="all">
31013 <tgroup cols="4" colsep="0" rowsep="0">
31014 <colspec colwidth="8*" align="left"/>
31015 <colspec colwidth="6*" align="center"/>
31016 <colspec colwidth="6*" align="center"/>
31017 <colspec colwidth="6*" align="right"/>
31018 <tbody>
31019 <row>
31020 <entry><option>debug_print</option></entry>
31021 <entry>Use: <emphasis>routers</emphasis></entry>
31022 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
31023 <entry>Default: <emphasis>unset</emphasis></entry>
31024 </row>
31025 </tbody>
31026 </tgroup>
31027 </informaltable>
31028 <para>
31029 <indexterm role="concept">
31030 <primary>testing</primary>
31031 <secondary>variables in drivers</secondary>
31032 </indexterm>
31033 If this option is set and debugging is enabled (see the <option>-d</option> command line
31034 option) or in address-testing mode (see the <option>-bt</option> command line option),
31035 the string is expanded and included in the debugging output.
31036 If expansion of the string fails, the error message is written to the debugging
31037 output, and Exim carries on processing.
31038 This option is provided to help with checking out the values of variables and
31039 so on when debugging router configurations. For example, if a <option>condition</option>
31040 option appears not to be working, <option>debug_print</option> can be used to output the
31041 variables it references. The output happens after checks for <option>domains</option>,
31042 <option>local_parts</option>, and <option>check_local_user</option> but before any other preconditions
31043 are tested. A newline is added to the text if it does not end with one.
31044 The variable <varname>$router_name</varname> contains the name of the router.
31045 </para>
31046 <para>
31047 <indexterm role="option">
31048 <primary><option>disable_logging</option></primary>
31049 </indexterm>
31050 </para>
31051 <informaltable frame="all">
31052 <tgroup cols="4" colsep="0" rowsep="0">
31053 <colspec colwidth="8*" align="left"/>
31054 <colspec colwidth="6*" align="center"/>
31055 <colspec colwidth="6*" align="center"/>
31056 <colspec colwidth="6*" align="right"/>
31057 <tbody>
31058 <row>
31059 <entry><option>disable_logging</option></entry>
31060 <entry>Use: <emphasis>routers</emphasis></entry>
31061 <entry>Type: <emphasis>boolean</emphasis></entry>
31062 <entry>Default: <emphasis>false</emphasis></entry>
31063 </row>
31064 </tbody>
31065 </tgroup>
31066 </informaltable>
31067 <para>
31068 If this option is set true, nothing is logged for any routing errors
31069 or for any deliveries caused by this router. You should not set this option
31070 unless you really, really know what you are doing. See also the generic
31071 transport option of the same name.
31072 </para>
31073 <para>
31074 <indexterm role="option">
31075 <primary><option>domains</option></primary>
31076 </indexterm>
31077 </para>
31078 <informaltable frame="all">
31079 <tgroup cols="4" colsep="0" rowsep="0">
31080 <colspec colwidth="8*" align="left"/>
31081 <colspec colwidth="6*" align="center"/>
31082 <colspec colwidth="6*" align="center"/>
31083 <colspec colwidth="6*" align="right"/>
31084 <tbody>
31085 <row>
31086 <entry><option>domains</option></entry>
31087 <entry>Use: <emphasis>routers</emphasis>&Dagger;<emphasis></emphasis></entry>
31088 <entry>Type: <emphasis>domain list</emphasis>&dagger;<emphasis></emphasis></entry>
31089 <entry>Default: <emphasis>unset</emphasis></entry>
31090 </row>
31091 </tbody>
31092 </tgroup>
31093 </informaltable>
31094 <para>
31095 <indexterm role="concept">
31096 <primary>router</primary>
31097 <secondary>restricting to specific domains</secondary>
31098 </indexterm>
31099 <indexterm role="variable">
31100 <primary><varname>$domain_data</varname></primary>
31101 </indexterm>
31102 If this option is set, the router is skipped unless the current domain matches
31103 the list. If the match is achieved by means of a file lookup, the data that the
31104 lookup returned for the domain is placed in <varname>$domain_data</varname> for use in string
31105 expansions of the driver&#x2019;s private options. See section <xref linkend="SECTrouprecon"/> for
31106 a list of the order in which preconditions are evaluated.
31107 </para>
31108 <para>
31109 <indexterm role="option">
31110 <primary><option>driver</option></primary>
31111 </indexterm>
31112 </para>
31113 <informaltable frame="all">
31114 <tgroup cols="4" colsep="0" rowsep="0">
31115 <colspec colwidth="8*" align="left"/>
31116 <colspec colwidth="6*" align="center"/>
31117 <colspec colwidth="6*" align="center"/>
31118 <colspec colwidth="6*" align="right"/>
31119 <tbody>
31120 <row>
31121 <entry><option>driver</option></entry>
31122 <entry>Use: <emphasis>routers</emphasis></entry>
31123 <entry>Type: <emphasis>string</emphasis></entry>
31124 <entry>Default: <emphasis>unset</emphasis></entry>
31125 </row>
31126 </tbody>
31127 </tgroup>
31128 </informaltable>
31129 <para>
31130 This option must always be set. It specifies which of the available routers is
31131 to be used.
31132 </para>
31133 <para>
31134 <indexterm role="option">
31135 <primary><option>errors_to</option></primary>
31136 </indexterm>
31137 </para>
31138 <informaltable frame="all">
31139 <tgroup cols="4" colsep="0" rowsep="0">
31140 <colspec colwidth="8*" align="left"/>
31141 <colspec colwidth="6*" align="center"/>
31142 <colspec colwidth="6*" align="center"/>
31143 <colspec colwidth="6*" align="right"/>
31144 <tbody>
31145 <row>
31146 <entry><option>errors_to</option></entry>
31147 <entry>Use: <emphasis>routers</emphasis></entry>
31148 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
31149 <entry>Default: <emphasis>unset</emphasis></entry>
31150 </row>
31151 </tbody>
31152 </tgroup>
31153 </informaltable>
31154 <para>
31155 <indexterm role="concept">
31156 <primary>envelope sender</primary>
31157 </indexterm>
31158 <indexterm role="concept">
31159 <primary>router</primary>
31160 <secondary>changing address for errors</secondary>
31161 </indexterm>
31162 If a router successfully handles an address, it may assign the address to a
31163 transport for delivery or it may generate child addresses. In both cases, if
31164 there is a delivery problem during later processing, the resulting bounce
31165 message is sent to the address that results from expanding this string,
31166 provided that the address verifies successfully. The <option>errors_to</option> option is
31167 expanded before <option>headers_add</option>, <option>headers_remove</option>, and <option>transport</option>.
31168 </para>
31169 <para>
31170 The <option>errors_to</option> setting associated with an address can be overridden if it
31171 subsequently passes through other routers that have their own <option>errors_to</option>
31172 settings, or if the message is delivered by a transport with a <option>return_path</option>
31173 setting.
31174 </para>
31175 <para>
31176 If <option>errors_to</option> is unset, or the expansion is forced to fail, or the result of
31177 the expansion fails to verify, the errors address associated with the incoming
31178 address is used. At top level, this is the envelope sender. A non-forced
31179 expansion failure causes delivery to be deferred.
31180 </para>
31181 <para>
31182 If an address for which <option>errors_to</option> has been set ends up being delivered over
31183 SMTP, the envelope sender for that delivery is the <option>errors_to</option> value, so that
31184 any bounces that are generated by other MTAs on the delivery route are also
31185 sent there. You can set <option>errors_to</option> to the empty string by either of these
31186 settings:
31187 </para>
31188 <literallayout class="monospaced">
31189 errors_to =
31190 errors_to = ""
31191 </literallayout>
31192 <para>
31193 An expansion item that yields an empty string has the same effect. If you do
31194 this, a locally detected delivery error for addresses processed by this router
31195 no longer gives rise to a bounce message; the error is discarded. If the
31196 address is delivered to a remote host, the return path is set to <literal>&lt;&gt;</literal>, unless
31197 overridden by the <option>return_path</option> option on the transport.
31198 </para>
31199 <para>
31200 <indexterm role="variable">
31201 <primary><varname>$address_data</varname></primary>
31202 </indexterm>
31203 If for some reason you want to discard local errors, but use a non-empty
31204 MAIL command for remote delivery, you can preserve the original return
31205 path in <varname>$address_data</varname> in the router, and reinstate it in the transport by
31206 setting <option>return_path</option>.
31207 </para>
31208 <para>
31209 The most common use of <option>errors_to</option> is to direct mailing list bounces to the
31210 manager of the list, as described in section <xref linkend="SECTmailinglists"/>, or to
31211 implement VERP (Variable Envelope Return Paths) (see section <xref linkend="SECTverp"/>).
31212 </para>
31213 <para>
31214 <indexterm role="option">
31215 <primary><option>expn</option></primary>
31216 </indexterm>
31217 </para>
31218 <informaltable frame="all">
31219 <tgroup cols="4" colsep="0" rowsep="0">
31220 <colspec colwidth="8*" align="left"/>
31221 <colspec colwidth="6*" align="center"/>
31222 <colspec colwidth="6*" align="center"/>
31223 <colspec colwidth="6*" align="right"/>
31224 <tbody>
31225 <row>
31226 <entry><option>expn</option></entry>
31227 <entry>Use: <emphasis>routers</emphasis>&Dagger;<emphasis></emphasis></entry>
31228 <entry>Type: <emphasis>boolean</emphasis></entry>
31229 <entry>Default: <emphasis>true</emphasis></entry>
31230 </row>
31231 </tbody>
31232 </tgroup>
31233 </informaltable>
31234 <para>
31235 <indexterm role="concept">
31236 <primary>address</primary>
31237 <secondary>testing</secondary>
31238 </indexterm>
31239 <indexterm role="concept">
31240 <primary>testing</primary>
31241 <secondary>addresses</secondary>
31242 </indexterm>
31243 <indexterm role="concept">
31244 <primary>EXPN</primary>
31245 <secondary>router skipping</secondary>
31246 </indexterm>
31247 <indexterm role="concept">
31248 <primary>router</primary>
31249 <secondary>skipping for EXPN</secondary>
31250 </indexterm>
31251 If this option is turned off, the router is skipped when testing an address
31252 as a result of processing an SMTP EXPN command. You might, for example,
31253 want to turn it off on a router for users&#x2019; <filename>.forward</filename> files, while leaving it
31254 on for the system alias file.
31255 See section <xref linkend="SECTrouprecon"/> for a list of the order in which preconditions
31256 are evaluated.
31257 </para>
31258 <para>
31259 The use of the SMTP EXPN command is controlled by an ACL (see chapter
31260 <xref linkend="CHAPACL"/>). When Exim is running an EXPN command, it is similar to testing
31261 an address with <option>-bt</option>. Compare VRFY, whose counterpart is <option>-bv</option>.
31262 </para>
31263 <para>
31264 <indexterm role="option">
31265 <primary><option>fail_verify</option></primary>
31266 </indexterm>
31267 </para>
31268 <informaltable frame="all">
31269 <tgroup cols="4" colsep="0" rowsep="0">
31270 <colspec colwidth="8*" align="left"/>
31271 <colspec colwidth="6*" align="center"/>
31272 <colspec colwidth="6*" align="center"/>
31273 <colspec colwidth="6*" align="right"/>
31274 <tbody>
31275 <row>
31276 <entry><option>fail_verify</option></entry>
31277 <entry>Use: <emphasis>routers</emphasis></entry>
31278 <entry>Type: <emphasis>boolean</emphasis></entry>
31279 <entry>Default: <emphasis>false</emphasis></entry>
31280 </row>
31281 </tbody>
31282 </tgroup>
31283 </informaltable>
31284 <para>
31285 <indexterm role="concept">
31286 <primary>router</primary>
31287 <secondary>forcing verification failure</secondary>
31288 </indexterm>
31289 Setting this option has the effect of setting both <option>fail_verify_sender</option> and
31290 <option>fail_verify_recipient</option> to the same value.
31291 </para>
31292 <para>
31293 <indexterm role="option">
31294 <primary><option>fail_verify_recipient</option></primary>
31295 </indexterm>
31296 </para>
31297 <informaltable frame="all">
31298 <tgroup cols="4" colsep="0" rowsep="0">
31299 <colspec colwidth="8*" align="left"/>
31300 <colspec colwidth="6*" align="center"/>
31301 <colspec colwidth="6*" align="center"/>
31302 <colspec colwidth="6*" align="right"/>
31303 <tbody>
31304 <row>
31305 <entry><option>fail_verify_recipient</option></entry>
31306 <entry>Use: <emphasis>routers</emphasis></entry>
31307 <entry>Type: <emphasis>boolean</emphasis></entry>
31308 <entry>Default: <emphasis>false</emphasis></entry>
31309 </row>
31310 </tbody>
31311 </tgroup>
31312 </informaltable>
31313 <para>
31314 If this option is true and an address is accepted by this router when
31315 verifying a recipient, verification fails.
31316 </para>
31317 <para>
31318 <indexterm role="option">
31319 <primary><option>fail_verify_sender</option></primary>
31320 </indexterm>
31321 </para>
31322 <informaltable frame="all">
31323 <tgroup cols="4" colsep="0" rowsep="0">
31324 <colspec colwidth="8*" align="left"/>
31325 <colspec colwidth="6*" align="center"/>
31326 <colspec colwidth="6*" align="center"/>
31327 <colspec colwidth="6*" align="right"/>
31328 <tbody>
31329 <row>
31330 <entry><option>fail_verify_sender</option></entry>
31331 <entry>Use: <emphasis>routers</emphasis></entry>
31332 <entry>Type: <emphasis>boolean</emphasis></entry>
31333 <entry>Default: <emphasis>false</emphasis></entry>
31334 </row>
31335 </tbody>
31336 </tgroup>
31337 </informaltable>
31338 <para>
31339 If this option is true and an address is accepted by this router when
31340 verifying a sender, verification fails.
31341 </para>
31342 <para>
31343 <indexterm role="option">
31344 <primary><option>fallback_hosts</option></primary>
31345 </indexterm>
31346 </para>
31347 <informaltable frame="all">
31348 <tgroup cols="4" colsep="0" rowsep="0">
31349 <colspec colwidth="8*" align="left"/>
31350 <colspec colwidth="6*" align="center"/>
31351 <colspec colwidth="6*" align="center"/>
31352 <colspec colwidth="6*" align="right"/>
31353 <tbody>
31354 <row>
31355 <entry><option>fallback_hosts</option></entry>
31356 <entry>Use: <emphasis>routers</emphasis></entry>
31357 <entry>Type: <emphasis>string list</emphasis></entry>
31358 <entry>Default: <emphasis>unset</emphasis></entry>
31359 </row>
31360 </tbody>
31361 </tgroup>
31362 </informaltable>
31363 <para>
31364 <indexterm role="concept">
31365 <primary>router</primary>
31366 <secondary>fallback hosts</secondary>
31367 </indexterm>
31368 <indexterm role="concept">
31369 <primary>fallback</primary>
31370 <secondary>hosts specified on router</secondary>
31371 </indexterm>
31372 String expansion is not applied to this option. The argument must be a
31373 colon-separated list of host names or IP addresses. The list separator can be
31374 changed (see section <xref linkend="SECTlistconstruct"/>), and a port can be specified with
31375 each name or address. In fact, the format of each item is exactly the same as
31376 defined for the list of hosts in a <command>manualroute</command> router (see section
31377 <xref linkend="SECTformatonehostitem"/>).
31378 </para>
31379 <para>
31380 If a router queues an address for a remote transport, this host list is
31381 associated with the address, and used instead of the transport&#x2019;s fallback host
31382 list. If <option>hosts_randomize</option> is set on the transport, the order of the list is
31383 randomized for each use. See the <option>fallback_hosts</option> option of the <command>smtp</command>
31384 transport for further details.
31385 </para>
31386 <para>
31387 <indexterm role="option">
31388 <primary><option>group</option></primary>
31389 </indexterm>
31390 </para>
31391 <informaltable frame="all">
31392 <tgroup cols="4" colsep="0" rowsep="0">
31393 <colspec colwidth="8*" align="left"/>
31394 <colspec colwidth="6*" align="center"/>
31395 <colspec colwidth="6*" align="center"/>
31396 <colspec colwidth="6*" align="right"/>
31397 <tbody>
31398 <row>
31399 <entry><option>group</option></entry>
31400 <entry>Use: <emphasis>routers</emphasis></entry>
31401 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
31402 <entry>Default: <emphasis>see below</emphasis></entry>
31403 </row>
31404 </tbody>
31405 </tgroup>
31406 </informaltable>
31407 <para>
31408 <indexterm role="concept">
31409 <primary>gid (group id)</primary>
31410 <secondary>local delivery</secondary>
31411 </indexterm>
31412 <indexterm role="concept">
31413 <primary>local transports</primary>
31414 <secondary>uid and gid</secondary>
31415 </indexterm>
31416 <indexterm role="concept">
31417 <primary>transport</primary>
31418 <secondary>local</secondary>
31419 </indexterm>
31420 <indexterm role="concept">
31421 <primary>router</primary>
31422 <secondary>setting group</secondary>
31423 </indexterm>
31424 When a router queues an address for a transport, and the transport does not
31425 specify a group, the group given here is used when running the delivery
31426 process.
31427 The group may be specified numerically or by name. If expansion fails, the
31428 error is logged and delivery is deferred.
31429 The default is unset, unless <option>check_local_user</option> is set, when the default
31430 is taken from the password information. See also <option>initgroups</option> and <option>user</option>
31431 and the discussion in chapter <xref linkend="CHAPenvironment"/>.
31432 </para>
31433 <para>
31434 <indexterm role="option">
31435 <primary><option>headers_add</option></primary>
31436 </indexterm>
31437 </para>
31438 <informaltable frame="all">
31439 <tgroup cols="4" colsep="0" rowsep="0">
31440 <colspec colwidth="8*" align="left"/>
31441 <colspec colwidth="6*" align="center"/>
31442 <colspec colwidth="6*" align="center"/>
31443 <colspec colwidth="6*" align="right"/>
31444 <tbody>
31445 <row>
31446 <entry><option>headers_add</option></entry>
31447 <entry>Use: <emphasis>routers</emphasis></entry>
31448 <entry>Type: <emphasis>list</emphasis>&dagger;<emphasis></emphasis></entry>
31449 <entry>Default: <emphasis>unset</emphasis></entry>
31450 </row>
31451 </tbody>
31452 </tgroup>
31453 </informaltable>
31454 <para>
31455 <indexterm role="concept">
31456 <primary>header lines</primary>
31457 <secondary>adding</secondary>
31458 </indexterm>
31459 <indexterm role="concept">
31460 <primary>router</primary>
31461 <secondary>adding header lines</secondary>
31462 </indexterm>
31463 This option specifies a list of text headers, newline-separated,
31464 that is associated with any addresses that are accepted by the router.
31465 Each item is separately expanded, at routing time.  However, this
31466 option has no effect when an address is just being verified. The way in which
31467 the text is used to add header lines at transport time is described in section
31468 <xref linkend="SECTheadersaddrem"/>. New header lines are not actually added until the
31469 message is in the process of being transported. This means that references to
31470 header lines in string expansions in the transport&#x2019;s configuration do not
31471 <quote>see</quote> the added header lines.
31472 </para>
31473 <para>
31474 The <option>headers_add</option> option is expanded after <option>errors_to</option>, but before
31475 <option>headers_remove</option> and <option>transport</option>. If an item is empty, or if
31476 an item expansion is forced to fail, the item has no effect. Other expansion
31477 failures are treated as configuration errors.
31478 </para>
31479 <para>
31480 Unlike most options, <option>headers_add</option> can be specified multiple times
31481 for a router; all listed headers are added.
31482 </para>
31483 <para>
31484 <emphasis role="bold">Warning 1</emphasis>: The <option>headers_add</option> option cannot be used for a <command>redirect</command>
31485 router that has the <option>one_time</option> option set.
31486 </para>
31487 <para>
31488 <indexterm role="concept">
31489 <primary>duplicate addresses</primary>
31490 </indexterm>
31491 <indexterm role="option">
31492 <primary><option>unseen</option></primary>
31493 </indexterm>
31494 <emphasis role="bold">Warning 2</emphasis>: If the <option>unseen</option> option is set on the router, all header
31495 additions are deleted when the address is passed on to subsequent routers.
31496 For a <option>redirect</option> router, if a generated address is the same as the incoming
31497 address, this can lead to duplicate addresses with different header
31498 modifications. Exim does not do duplicate deliveries (except, in certain
31499 circumstances, to pipes -- see section <xref linkend="SECTdupaddr"/>), but it is undefined
31500 which of the duplicates is discarded, so this ambiguous situation should be
31501 avoided. The <option>repeat_use</option> option of the <option>redirect</option> router may be of help.
31502 </para>
31503 <para>
31504 <indexterm role="option">
31505 <primary><option>headers_remove</option></primary>
31506 </indexterm>
31507 </para>
31508 <informaltable frame="all">
31509 <tgroup cols="4" colsep="0" rowsep="0">
31510 <colspec colwidth="8*" align="left"/>
31511 <colspec colwidth="6*" align="center"/>
31512 <colspec colwidth="6*" align="center"/>
31513 <colspec colwidth="6*" align="right"/>
31514 <tbody>
31515 <row>
31516 <entry><option>headers_remove</option></entry>
31517 <entry>Use: <emphasis>routers</emphasis></entry>
31518 <entry>Type: <emphasis>list</emphasis>&dagger;<emphasis></emphasis></entry>
31519 <entry>Default: <emphasis>unset</emphasis></entry>
31520 </row>
31521 </tbody>
31522 </tgroup>
31523 </informaltable>
31524 <para>
31525 <indexterm role="concept">
31526 <primary>header lines</primary>
31527 <secondary>removing</secondary>
31528 </indexterm>
31529 <indexterm role="concept">
31530 <primary>router</primary>
31531 <secondary>removing header lines</secondary>
31532 </indexterm>
31533 This option specifies a list of text headers, colon-separated,
31534 that is associated with any addresses that are accepted by the router.
31535 Each item is separately expanded, at routing time.  However, this
31536 option has no effect when an address is just being verified. The way in which
31537 the text is used to remove header lines at transport time is described in
31538 section <xref linkend="SECTheadersaddrem"/>. Header lines are not actually removed until
31539 the message is in the process of being transported. This means that references
31540 to header lines in string expansions in the transport&#x2019;s configuration still
31541 <quote>see</quote> the original header lines.
31542 </para>
31543 <para>
31544 The <option>headers_remove</option> option is expanded after <option>errors_to</option> and
31545 <option>headers_add</option>, but before <option>transport</option>. If an item expansion is forced to fail,
31546 the item has no effect. Other expansion failures are treated as configuration
31547 errors.
31548 </para>
31549 <para>
31550 Unlike most options, <option>headers_remove</option> can be specified multiple times
31551 for a router; all listed headers are removed.
31552 </para>
31553 <para>
31554 <emphasis role="bold">Warning 1</emphasis>: The <option>headers_remove</option> option cannot be used for a <command>redirect</command>
31555 router that has the <option>one_time</option> option set.
31556 </para>
31557 <para>
31558 <emphasis role="bold">Warning 2</emphasis>: If the <option>unseen</option> option is set on the router, all header
31559 removal requests are deleted when the address is passed on to subsequent
31560 routers, and this can lead to problems with duplicates -- see the similar
31561 warning for <option>headers_add</option> above.
31562 </para>
31563 <para>
31564 <indexterm role="option">
31565 <primary><option>ignore_target_hosts</option></primary>
31566 </indexterm>
31567 </para>
31568 <informaltable frame="all">
31569 <tgroup cols="4" colsep="0" rowsep="0">
31570 <colspec colwidth="8*" align="left"/>
31571 <colspec colwidth="6*" align="center"/>
31572 <colspec colwidth="6*" align="center"/>
31573 <colspec colwidth="6*" align="right"/>
31574 <tbody>
31575 <row>
31576 <entry><option>ignore_target_hosts</option></entry>
31577 <entry>Use: <emphasis>routers</emphasis></entry>
31578 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
31579 <entry>Default: <emphasis>unset</emphasis></entry>
31580 </row>
31581 </tbody>
31582 </tgroup>
31583 </informaltable>
31584 <para>
31585 <indexterm role="concept">
31586 <primary>IP address</primary>
31587 <secondary>discarding</secondary>
31588 </indexterm>
31589 <indexterm role="concept">
31590 <primary>router</primary>
31591 <secondary>discarding IP addresses</secondary>
31592 </indexterm>
31593 Although this option is a host list, it should normally contain IP address
31594 entries rather than names. If any host that is looked up by the router has an
31595 IP address that matches an item in this list, Exim behaves as if that IP
31596 address did not exist. This option allows you to cope with rogue DNS entries
31597 like
31598 </para>
31599 <literallayout class="monospaced">
31600 remote.domain.example.  A  127.0.0.1
31601 </literallayout>
31602 <para>
31603 by setting
31604 </para>
31605 <literallayout class="monospaced">
31606 ignore_target_hosts = 127.0.0.1
31607 </literallayout>
31608 <para>
31609 on the relevant router. If all the hosts found by a <command>dnslookup</command> router are
31610 discarded in this way, the router declines. In a conventional configuration, an
31611 attempt to mail to such a domain would normally provoke the <quote>unrouteable
31612 domain</quote> error, and an attempt to verify an address in the domain would fail.
31613 Similarly, if <option>ignore_target_hosts</option> is set on an <command>ipliteral</command> router, the
31614 router declines if presented with one of the listed addresses.
31615 </para>
31616 <para>
31617 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
31618 means of the first or the second of the following settings, respectively:
31619 </para>
31620 <literallayout class="monospaced">
31621 ignore_target_hosts = 0.0.0.0/0
31622 ignore_target_hosts = &lt;; 0::0/0
31623 </literallayout>
31624 <para>
31625 The pattern in the first line matches all IPv4 addresses, whereas the pattern
31626 in the second line matches all IPv6 addresses.
31627 </para>
31628 <para>
31629 This option may also be useful for ignoring link-local and site-local IPv6
31630 addresses. Because, like all host lists, the value of <option>ignore_target_hosts</option>
31631 is expanded before use as a list, it is possible to make it dependent on the
31632 domain that is being routed.
31633 </para>
31634 <para>
31635 <indexterm role="variable">
31636 <primary><varname>$host_address</varname></primary>
31637 </indexterm>
31638 During its expansion, <varname>$host_address</varname> is set to the IP address that is being
31639 checked.
31640 </para>
31641 <para>
31642 <indexterm role="option">
31643 <primary><option>initgroups</option></primary>
31644 </indexterm>
31645 </para>
31646 <informaltable frame="all">
31647 <tgroup cols="4" colsep="0" rowsep="0">
31648 <colspec colwidth="8*" align="left"/>
31649 <colspec colwidth="6*" align="center"/>
31650 <colspec colwidth="6*" align="center"/>
31651 <colspec colwidth="6*" align="right"/>
31652 <tbody>
31653 <row>
31654 <entry><option>initgroups</option></entry>
31655 <entry>Use: <emphasis>routers</emphasis></entry>
31656 <entry>Type: <emphasis>boolean</emphasis></entry>
31657 <entry>Default: <emphasis>false</emphasis></entry>
31658 </row>
31659 </tbody>
31660 </tgroup>
31661 </informaltable>
31662 <para>
31663 <indexterm role="concept">
31664 <primary>additional groups</primary>
31665 </indexterm>
31666 <indexterm role="concept">
31667 <primary>groups</primary>
31668 <secondary>additional</secondary>
31669 </indexterm>
31670 <indexterm role="concept">
31671 <primary>local transports</primary>
31672 <secondary>uid and gid</secondary>
31673 </indexterm>
31674 <indexterm role="concept">
31675 <primary>transport</primary>
31676 <secondary>local</secondary>
31677 </indexterm>
31678 If the router queues an address for a transport, and this option is true, and
31679 the uid supplied by the router is not overridden by the transport, the
31680 <function>initgroups()</function> function is called when running the transport to ensure that
31681 any additional groups associated with the uid are set up. See also <option>group</option>
31682 and <option>user</option> and the discussion in chapter <xref linkend="CHAPenvironment"/>.
31683 </para>
31684 <para>
31685 <indexterm role="option">
31686 <primary><option>local_part_prefix</option></primary>
31687 </indexterm>
31688 </para>
31689 <informaltable frame="all">
31690 <tgroup cols="4" colsep="0" rowsep="0">
31691 <colspec colwidth="8*" align="left"/>
31692 <colspec colwidth="6*" align="center"/>
31693 <colspec colwidth="6*" align="center"/>
31694 <colspec colwidth="6*" align="right"/>
31695 <tbody>
31696 <row>
31697 <entry><option>local_part_prefix</option></entry>
31698 <entry>Use: <emphasis>routers</emphasis>&Dagger;<emphasis></emphasis></entry>
31699 <entry>Type: <emphasis>string list</emphasis></entry>
31700 <entry>Default: <emphasis>unset</emphasis></entry>
31701 </row>
31702 </tbody>
31703 </tgroup>
31704 </informaltable>
31705 <para>
31706 <indexterm role="concept">
31707 <primary>router</primary>
31708 <secondary>prefix for local part</secondary>
31709 </indexterm>
31710 <indexterm role="concept">
31711 <primary>prefix</primary>
31712 <secondary>for local part, used in router</secondary>
31713 </indexterm>
31714 If this option is set, the router is skipped unless the local part starts with
31715 one of the given strings, or <option>local_part_prefix_optional</option> is true. See
31716 section <xref linkend="SECTrouprecon"/> for a list of the order in which preconditions are
31717 evaluated.
31718 </para>
31719 <para>
31720 The list is scanned from left to right, and the first prefix that matches is
31721 used. A limited form of wildcard is available; if the prefix begins with an
31722 asterisk, it matches the longest possible sequence of arbitrary characters at
31723 the start of the local part. An asterisk should therefore always be followed by
31724 some character that does not occur in normal local parts.
31725 <indexterm role="concept">
31726 <primary>multiple mailboxes</primary>
31727 </indexterm>
31728 <indexterm role="concept">
31729 <primary>mailbox</primary>
31730 <secondary>multiple</secondary>
31731 </indexterm>
31732 Wildcarding can be used to set up multiple user mailboxes, as described in
31733 section <xref linkend="SECTmulbox"/>.
31734 </para>
31735 <para>
31736 <indexterm role="variable">
31737 <primary><varname>$local_part</varname></primary>
31738 </indexterm>
31739 <indexterm role="variable">
31740 <primary><varname>$local_part_prefix</varname></primary>
31741 </indexterm>
31742 During the testing of the <option>local_parts</option> option, and while the router is
31743 running, the prefix is removed from the local part, and is available in the
31744 expansion variable <varname>$local_part_prefix</varname>. When a message is being delivered, if
31745 the router accepts the address, this remains true during subsequent delivery by
31746 a transport. In particular, the local part that is transmitted in the RCPT
31747 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
31748 This behaviour can be overridden by setting <option>rcpt_include_affixes</option> true on
31749 the relevant transport.
31750 </para>
31751 <para>
31752 When an address is being verified, <option>local_part_prefix</option> affects only the
31753 behaviour of the router. If the callout feature of verification is in use, this
31754 means that the full address, including the prefix, will be used during the
31755 callout.
31756 </para>
31757 <para>
31758 The prefix facility is commonly used to handle local parts of the form
31759 <option>owner-something</option>. Another common use is to support local parts of the form
31760 <option>real-username</option> to bypass a user&#x2019;s <filename>.forward</filename> file &ndash; helpful when trying
31761 to tell a user their forwarding is broken &ndash; by placing a router like this one
31762 immediately before the router that handles <filename>.forward</filename> files:
31763 </para>
31764 <literallayout class="monospaced">
31765 real_localuser:
31766   driver = accept
31767   local_part_prefix = real-
31768   check_local_user
31769   transport = local_delivery
31770 </literallayout>
31771 <para>
31772 For security, it would probably be a good idea to restrict the use of this
31773 router to locally-generated messages, using a condition such as this:
31774 </para>
31775 <literallayout class="monospaced">
31776   condition = ${if match {$sender_host_address}\
31777                          {\N^(|127\.0\.0\.1)$\N}}
31778 </literallayout>
31779 <para>
31780 If both <option>local_part_prefix</option> and <option>local_part_suffix</option> are set for a router,
31781 both conditions must be met if not optional. Care must be taken if wildcards
31782 are used in both a prefix and a suffix on the same router. Different
31783 separator characters must be used to avoid ambiguity.
31784 </para>
31785 <para>
31786 <indexterm role="option">
31787 <primary><option>local_part_prefix_optional</option></primary>
31788 </indexterm>
31789 </para>
31790 <informaltable frame="all">
31791 <tgroup cols="4" colsep="0" rowsep="0">
31792 <colspec colwidth="8*" align="left"/>
31793 <colspec colwidth="6*" align="center"/>
31794 <colspec colwidth="6*" align="center"/>
31795 <colspec colwidth="6*" align="right"/>
31796 <tbody>
31797 <row>
31798 <entry><option>local_part_prefix_optional</option></entry>
31799 <entry>Use: <emphasis>routers</emphasis></entry>
31800 <entry>Type: <emphasis>boolean</emphasis></entry>
31801 <entry>Default: <emphasis>false</emphasis></entry>
31802 </row>
31803 </tbody>
31804 </tgroup>
31805 </informaltable>
31806 <para>
31807 See <option>local_part_prefix</option> above.
31808 </para>
31809 <para>
31810 <indexterm role="option">
31811 <primary><option>local_part_suffix</option></primary>
31812 </indexterm>
31813 </para>
31814 <informaltable frame="all">
31815 <tgroup cols="4" colsep="0" rowsep="0">
31816 <colspec colwidth="8*" align="left"/>
31817 <colspec colwidth="6*" align="center"/>
31818 <colspec colwidth="6*" align="center"/>
31819 <colspec colwidth="6*" align="right"/>
31820 <tbody>
31821 <row>
31822 <entry><option>local_part_suffix</option></entry>
31823 <entry>Use: <emphasis>routers</emphasis>&Dagger;<emphasis></emphasis></entry>
31824 <entry>Type: <emphasis>string list</emphasis></entry>
31825 <entry>Default: <emphasis>unset</emphasis></entry>
31826 </row>
31827 </tbody>
31828 </tgroup>
31829 </informaltable>
31830 <para>
31831 <indexterm role="concept">
31832 <primary>router</primary>
31833 <secondary>suffix for local part</secondary>
31834 </indexterm>
31835 <indexterm role="concept">
31836 <primary>suffix for local part</primary>
31837 <secondary>used in router</secondary>
31838 </indexterm>
31839 This option operates in the same way as <option>local_part_prefix</option>, except that the
31840 local part must end (rather than start) with the given string, the
31841 <option>local_part_suffix_optional</option> option determines whether the suffix is
31842 mandatory, and the wildcard * character, if present, must be the last
31843 character of the suffix. This option facility is commonly used to handle local
31844 parts of the form <option>something-request</option> and multiple user mailboxes of the form
31845 <option>username-foo</option>.
31846 </para>
31847 <para>
31848 <indexterm role="option">
31849 <primary><option>local_part_suffix_optional</option></primary>
31850 </indexterm>
31851 </para>
31852 <informaltable frame="all">
31853 <tgroup cols="4" colsep="0" rowsep="0">
31854 <colspec colwidth="8*" align="left"/>
31855 <colspec colwidth="6*" align="center"/>
31856 <colspec colwidth="6*" align="center"/>
31857 <colspec colwidth="6*" align="right"/>
31858 <tbody>
31859 <row>
31860 <entry><option>local_part_suffix_optional</option></entry>
31861 <entry>Use: <emphasis>routers</emphasis></entry>
31862 <entry>Type: <emphasis>boolean</emphasis></entry>
31863 <entry>Default: <emphasis>false</emphasis></entry>
31864 </row>
31865 </tbody>
31866 </tgroup>
31867 </informaltable>
31868 <para>
31869 See <option>local_part_suffix</option> above.
31870 </para>
31871 <para>
31872 <indexterm role="option">
31873 <primary><option>local_parts</option></primary>
31874 </indexterm>
31875 </para>
31876 <informaltable frame="all">
31877 <tgroup cols="4" colsep="0" rowsep="0">
31878 <colspec colwidth="8*" align="left"/>
31879 <colspec colwidth="6*" align="center"/>
31880 <colspec colwidth="6*" align="center"/>
31881 <colspec colwidth="6*" align="right"/>
31882 <tbody>
31883 <row>
31884 <entry><option>local_parts</option></entry>
31885 <entry>Use: <emphasis>routers</emphasis>&Dagger;<emphasis></emphasis></entry>
31886 <entry>Type: <emphasis>local part list</emphasis>&dagger;<emphasis></emphasis></entry>
31887 <entry>Default: <emphasis>unset</emphasis></entry>
31888 </row>
31889 </tbody>
31890 </tgroup>
31891 </informaltable>
31892 <para>
31893 <indexterm role="concept">
31894 <primary>router</primary>
31895 <secondary>restricting to specific local parts</secondary>
31896 </indexterm>
31897 <indexterm role="concept">
31898 <primary>local part</primary>
31899 <secondary>checking in router</secondary>
31900 </indexterm>
31901 The router is run only if the local part of the address matches the list.
31902 See section <xref linkend="SECTrouprecon"/> for a list of the order in which preconditions
31903 are evaluated, and
31904 section <xref linkend="SECTlocparlis"/> for a discussion of local part lists. Because the
31905 string is expanded, it is possible to make it depend on the domain, for
31906 example:
31907 </para>
31908 <literallayout class="monospaced">
31909 local_parts = dbm;/usr/local/specials/$domain
31910 </literallayout>
31911 <para>
31912 <indexterm role="variable">
31913 <primary><varname>$local_part_data</varname></primary>
31914 </indexterm>
31915 If the match is achieved by a lookup, the data that the lookup returned
31916 for the local part is placed in the variable <varname>$local_part_data</varname> for use in
31917 expansions of the router&#x2019;s private options. You might use this option, for
31918 example, if you have a large number of local virtual domains, and you want to
31919 send all postmaster mail to the same place without having to set up an alias in
31920 each virtual domain:
31921 </para>
31922 <literallayout class="monospaced">
31923 postmaster:
31924   driver = redirect
31925   local_parts = postmaster
31926   data = postmaster@real.domain.example
31927 </literallayout>
31928 <para>
31929 <indexterm role="option">
31930 <primary><option>log_as_local</option></primary>
31931 </indexterm>
31932 </para>
31933 <informaltable frame="all">
31934 <tgroup cols="4" colsep="0" rowsep="0">
31935 <colspec colwidth="8*" align="left"/>
31936 <colspec colwidth="6*" align="center"/>
31937 <colspec colwidth="6*" align="center"/>
31938 <colspec colwidth="6*" align="right"/>
31939 <tbody>
31940 <row>
31941 <entry><option>log_as_local</option></entry>
31942 <entry>Use: <emphasis>routers</emphasis></entry>
31943 <entry>Type: <emphasis>boolean</emphasis></entry>
31944 <entry>Default: <emphasis>see below</emphasis></entry>
31945 </row>
31946 </tbody>
31947 </tgroup>
31948 </informaltable>
31949 <para>
31950 <indexterm role="concept">
31951 <primary>log</primary>
31952 <secondary>delivery line</secondary>
31953 </indexterm>
31954 <indexterm role="concept">
31955 <primary>delivery</primary>
31956 <secondary>log line format</secondary>
31957 </indexterm>
31958 Exim has two logging styles for delivery, the idea being to make local
31959 deliveries stand out more visibly from remote ones. In the <quote>local</quote> style, the
31960 recipient address is given just as the local part, without a domain. The use of
31961 this style is controlled by this option. It defaults to true for the <command>accept</command>
31962 router, and false for all the others. This option applies only when a
31963 router assigns an address to a transport. It has no effect on routers that
31964 redirect addresses.
31965 </para>
31966 <para>
31967 <indexterm role="option">
31968 <primary><option>more</option></primary>
31969 </indexterm>
31970 </para>
31971 <informaltable frame="all">
31972 <tgroup cols="4" colsep="0" rowsep="0">
31973 <colspec colwidth="8*" align="left"/>
31974 <colspec colwidth="6*" align="center"/>
31975 <colspec colwidth="6*" align="center"/>
31976 <colspec colwidth="6*" align="right"/>
31977 <tbody>
31978 <row>
31979 <entry><option>more</option></entry>
31980 <entry>Use: <emphasis>routers</emphasis></entry>
31981 <entry>Type: <emphasis>boolean</emphasis>&dagger;<emphasis></emphasis></entry>
31982 <entry>Default: <emphasis>true</emphasis></entry>
31983 </row>
31984 </tbody>
31985 </tgroup>
31986 </informaltable>
31987 <para>
31988 The result of string expansion for this option must be a valid boolean value,
31989 that is, one of the strings <quote>yes</quote>, <quote>no</quote>, <quote>true</quote>, or <quote>false</quote>. Any other
31990 result causes an error, and delivery is deferred. If the expansion is forced to
31991 fail, the default value for the option (true) is used. Other failures cause
31992 delivery to be deferred.
31993 </para>
31994 <para>
31995 If this option is set false, and the router declines to handle the address, no
31996 further routers are tried, routing fails, and the address is bounced.
31997 <indexterm role="option">
31998 <primary><option>self</option></primary>
31999 </indexterm>
32000 However, if the router explicitly passes an address to the following router by
32001 means of the setting
32002 </para>
32003 <literallayout class="monospaced">
32004 self = pass
32005 </literallayout>
32006 <para>
32007 or otherwise, the setting of <option>more</option> is ignored. Also, the setting of <option>more</option>
32008 does not affect the behaviour if one of the precondition tests fails. In that
32009 case, the address is always passed to the next router.
32010 </para>
32011 <para>
32012 Note that <option>address_data</option> is not considered to be a precondition. If its
32013 expansion is forced to fail, the router declines, and the value of <option>more</option>
32014 controls what happens next.
32015 </para>
32016 <para>
32017 <indexterm role="option">
32018 <primary><option>pass_on_timeout</option></primary>
32019 </indexterm>
32020 </para>
32021 <informaltable frame="all">
32022 <tgroup cols="4" colsep="0" rowsep="0">
32023 <colspec colwidth="8*" align="left"/>
32024 <colspec colwidth="6*" align="center"/>
32025 <colspec colwidth="6*" align="center"/>
32026 <colspec colwidth="6*" align="right"/>
32027 <tbody>
32028 <row>
32029 <entry><option>pass_on_timeout</option></entry>
32030 <entry>Use: <emphasis>routers</emphasis></entry>
32031 <entry>Type: <emphasis>boolean</emphasis></entry>
32032 <entry>Default: <emphasis>false</emphasis></entry>
32033 </row>
32034 </tbody>
32035 </tgroup>
32036 </informaltable>
32037 <para>
32038 <indexterm role="concept">
32039 <primary>timeout</primary>
32040 <secondary>of router</secondary>
32041 </indexterm>
32042 <indexterm role="concept">
32043 <primary>router</primary>
32044 <secondary>timeout</secondary>
32045 </indexterm>
32046 If a router times out during a host lookup, it normally causes deferral of the
32047 address. If <option>pass_on_timeout</option> is set, the address is passed on to the next
32048 router, overriding <option>no_more</option>. This may be helpful for systems that are
32049 intermittently connected to the Internet, or those that want to pass to a smart
32050 host any messages that cannot immediately be delivered.
32051 </para>
32052 <para>
32053 There are occasional other temporary errors that can occur while doing DNS
32054 lookups. They are treated in the same way as a timeout, and this option
32055 applies to all of them.
32056 </para>
32057 <para>
32058 <indexterm role="option">
32059 <primary><option>pass_router</option></primary>
32060 </indexterm>
32061 </para>
32062 <informaltable frame="all">
32063 <tgroup cols="4" colsep="0" rowsep="0">
32064 <colspec colwidth="8*" align="left"/>
32065 <colspec colwidth="6*" align="center"/>
32066 <colspec colwidth="6*" align="center"/>
32067 <colspec colwidth="6*" align="right"/>
32068 <tbody>
32069 <row>
32070 <entry><option>pass_router</option></entry>
32071 <entry>Use: <emphasis>routers</emphasis></entry>
32072 <entry>Type: <emphasis>string</emphasis></entry>
32073 <entry>Default: <emphasis>unset</emphasis></entry>
32074 </row>
32075 </tbody>
32076 </tgroup>
32077 </informaltable>
32078 <para>
32079 <indexterm role="concept">
32080 <primary>router</primary>
32081 <secondary>go to after <quote>pass</quote></secondary>
32082 </indexterm>
32083 Routers that recognize the generic <option>self</option> option (<command>dnslookup</command>,
32084 <command>ipliteral</command>, and <command>manualroute</command>) are able to return <quote>pass</quote>, forcing
32085 routing to continue, and overriding a false setting of <option>more</option>. When one of
32086 these routers returns <quote>pass</quote>, the address is normally handed on to the next
32087 router in sequence. This can be changed by setting <option>pass_router</option> to the name
32088 of another router. However (unlike <option>redirect_router</option>) the named router must
32089 be below the current router, to avoid loops. Note that this option applies only
32090 to the special case of <quote>pass</quote>. It does not apply when a router returns
32091 <quote>decline</quote> because it cannot handle an address.
32092 </para>
32093 <para>
32094 <indexterm role="option">
32095 <primary><option>redirect_router</option></primary>
32096 </indexterm>
32097 </para>
32098 <informaltable frame="all">
32099 <tgroup cols="4" colsep="0" rowsep="0">
32100 <colspec colwidth="8*" align="left"/>
32101 <colspec colwidth="6*" align="center"/>
32102 <colspec colwidth="6*" align="center"/>
32103 <colspec colwidth="6*" align="right"/>
32104 <tbody>
32105 <row>
32106 <entry><option>redirect_router</option></entry>
32107 <entry>Use: <emphasis>routers</emphasis></entry>
32108 <entry>Type: <emphasis>string</emphasis></entry>
32109 <entry>Default: <emphasis>unset</emphasis></entry>
32110 </row>
32111 </tbody>
32112 </tgroup>
32113 </informaltable>
32114 <para>
32115 <indexterm role="concept">
32116 <primary>router</primary>
32117 <secondary>start at after redirection</secondary>
32118 </indexterm>
32119 Sometimes an administrator knows that it is pointless to reprocess addresses
32120 generated from alias or forward files with the same router again. For
32121 example, if an alias file translates real names into login ids there is no
32122 point searching the alias file a second time, especially if it is a large file.
32123 </para>
32124 <para>
32125 The <option>redirect_router</option> option can be set to the name of any router instance.
32126 It causes the routing of any generated addresses to start at the named router
32127 instead of at the first router. This option has no effect if the router in
32128 which it is set does not generate new addresses.
32129 </para>
32130 <para>
32131 <indexterm role="option">
32132 <primary><option>require_files</option></primary>
32133 </indexterm>
32134 </para>
32135 <informaltable frame="all">
32136 <tgroup cols="4" colsep="0" rowsep="0">
32137 <colspec colwidth="8*" align="left"/>
32138 <colspec colwidth="6*" align="center"/>
32139 <colspec colwidth="6*" align="center"/>
32140 <colspec colwidth="6*" align="right"/>
32141 <tbody>
32142 <row>
32143 <entry><option>require_files</option></entry>
32144 <entry>Use: <emphasis>routers</emphasis>&Dagger;<emphasis></emphasis></entry>
32145 <entry>Type: <emphasis>string list</emphasis>&dagger;<emphasis></emphasis></entry>
32146 <entry>Default: <emphasis>unset</emphasis></entry>
32147 </row>
32148 </tbody>
32149 </tgroup>
32150 </informaltable>
32151 <para>
32152 <indexterm role="concept">
32153 <primary>file</primary>
32154 <secondary>requiring for router</secondary>
32155 </indexterm>
32156 <indexterm role="concept">
32157 <primary>router</primary>
32158 <secondary>requiring file existence</secondary>
32159 </indexterm>
32160 This option provides a general mechanism for predicating the running of a
32161 router on the existence or non-existence of certain files or directories.
32162 Before running a router, as one of its precondition tests, Exim works its way
32163 through the <option>require_files</option> list, expanding each item separately.
32164 </para>
32165 <para>
32166 Because the list is split before expansion, any colons in expansion items must
32167 be doubled, or the facility for using a different list separator must be used.
32168 If any expansion is forced to fail, the item is ignored. Other expansion
32169 failures cause routing of the address to be deferred.
32170 </para>
32171 <para>
32172 If any expanded string is empty, it is ignored. Otherwise, except as described
32173 below, each string must be a fully qualified file path, optionally preceded by
32174 <quote>!</quote>. The paths are passed to the <function>stat()</function> function to test for the
32175 existence of the files or directories. The router is skipped if any paths not
32176 preceded by <quote>!</quote> do not exist, or if any paths preceded by <quote>!</quote> do exist.
32177 </para>
32178 <para>
32179 <indexterm role="concept">
32180 <primary>NFS</primary>
32181 </indexterm>
32182 If <function>stat()</function> cannot determine whether a file exists or not, delivery of
32183 the message is deferred. This can happen when NFS-mounted filesystems are
32184 unavailable.
32185 </para>
32186 <para>
32187 This option is checked after the <option>domains</option>, <option>local_parts</option>, and <option>senders</option>
32188 options, so you cannot use it to check for the existence of a file in which to
32189 look up a domain, local part, or sender. (See section <xref linkend="SECTrouprecon"/> for a
32190 full list of the order in which preconditions are evaluated.) However, as
32191 these options are all expanded, you can use the <option>exists</option> expansion condition
32192 to make such tests. The <option>require_files</option> option is intended for checking files
32193 that the router may be going to use internally, or which are needed by a
32194 transport (for example <filename>.procmailrc</filename>).
32195 </para>
32196 <para>
32197 During delivery, the <function>stat()</function> function is run as root, but there is a
32198 facility for some checking of the accessibility of a file by another user.
32199 This is not a proper permissions check, but just a <quote>rough</quote> check that
32200 operates as follows:
32201 </para>
32202 <para>
32203 If an item in a <option>require_files</option> list does not contain any forward slash
32204 characters, it is taken to be the user (and optional group, separated by a
32205 comma) to be checked for subsequent files in the list. If no group is specified
32206 but the user is specified symbolically, the gid associated with the uid is
32207 used. For example:
32208 </para>
32209 <literallayout class="monospaced">
32210 require_files = mail:/some/file
32211 require_files = $local_part:$home/.procmailrc
32212 </literallayout>
32213 <para>
32214 If a user or group name in a <option>require_files</option> list does not exist, the
32215 <option>require_files</option> condition fails.
32216 </para>
32217 <para>
32218 Exim performs the check by scanning along the components of the file path, and
32219 checking the access for the given uid and gid. It checks for <quote>x</quote> access on
32220 directories, and <quote>r</quote> access on the final file. Note that this means that file
32221 access control lists, if the operating system has them, are ignored.
32222 </para>
32223 <para>
32224 <emphasis role="bold">Warning 1</emphasis>: When the router is being run to verify addresses for an
32225 incoming SMTP message, Exim is not running as root, but under its own uid. This
32226 may affect the result of a <option>require_files</option> check. In particular, <function>stat()</function>
32227 may yield the error EACCES (<quote>Permission denied</quote>). This means that the Exim
32228 user is not permitted to read one of the directories on the file&#x2019;s path.
32229 </para>
32230 <para>
32231 <emphasis role="bold">Warning 2</emphasis>: Even when Exim is running as root while delivering a message,
32232 <function>stat()</function> can yield EACCES for a file in an NFS directory that is mounted
32233 without root access. In this case, if a check for access by a particular user
32234 is requested, Exim creates a subprocess that runs as that user, and tries the
32235 check again in that process.
32236 </para>
32237 <para>
32238 The default action for handling an unresolved EACCES is to consider it to
32239 be caused by a configuration error, and routing is deferred because the
32240 existence or non-existence of the file cannot be determined. However, in some
32241 circumstances it may be desirable to treat this condition as if the file did
32242 not exist. If the file name (or the exclamation mark that precedes the file
32243 name for non-existence) is preceded by a plus sign, the EACCES error is treated
32244 as if the file did not exist. For example:
32245 </para>
32246 <literallayout class="monospaced">
32247 require_files = +/some/file
32248 </literallayout>
32249 <para>
32250 If the router is not an essential part of verification (for example, it
32251 handles users&#x2019; <filename>.forward</filename> files), another solution is to set the <option>verify</option>
32252 option false so that the router is skipped when verifying.
32253 </para>
32254 <para>
32255 <indexterm role="option">
32256 <primary><option>retry_use_local_part</option></primary>
32257 </indexterm>
32258 </para>
32259 <informaltable frame="all">
32260 <tgroup cols="4" colsep="0" rowsep="0">
32261 <colspec colwidth="8*" align="left"/>
32262 <colspec colwidth="6*" align="center"/>
32263 <colspec colwidth="6*" align="center"/>
32264 <colspec colwidth="6*" align="right"/>
32265 <tbody>
32266 <row>
32267 <entry><option>retry_use_local_part</option></entry>
32268 <entry>Use: <emphasis>routers</emphasis></entry>
32269 <entry>Type: <emphasis>boolean</emphasis></entry>
32270 <entry>Default: <emphasis>see below</emphasis></entry>
32271 </row>
32272 </tbody>
32273 </tgroup>
32274 </informaltable>
32275 <para>
32276 <indexterm role="concept">
32277 <primary>hints database</primary>
32278 <secondary>retry keys</secondary>
32279 </indexterm>
32280 <indexterm role="concept">
32281 <primary>local part</primary>
32282 <secondary>in retry keys</secondary>
32283 </indexterm>
32284 When a delivery suffers a temporary routing failure, a retry record is created
32285 in Exim&#x2019;s hints database. For addresses whose routing depends only on the
32286 domain, the key for the retry record should not involve the local part, but for
32287 other addresses, both the domain and the local part should be included.
32288 Usually, remote routing is of the former kind, and local routing is of the
32289 latter kind.
32290 </para>
32291 <para>
32292 This option controls whether the local part is used to form the key for retry
32293 hints for addresses that suffer temporary errors while being handled by this
32294 router. The default value is true for any router that has <option>check_local_user</option>
32295 set, and false otherwise. Note that this option does not apply to hints keys
32296 for transport delays; they are controlled by a generic transport option of the
32297 same name.
32298 </para>
32299 <para>
32300 The setting of <option>retry_use_local_part</option> applies only to the router on which it
32301 appears. If the router generates child addresses, they are routed
32302 independently; this setting does not become attached to them.
32303 </para>
32304 <para>
32305 <indexterm role="option">
32306 <primary><option>router_home_directory</option></primary>
32307 </indexterm>
32308 </para>
32309 <informaltable frame="all">
32310 <tgroup cols="4" colsep="0" rowsep="0">
32311 <colspec colwidth="8*" align="left"/>
32312 <colspec colwidth="6*" align="center"/>
32313 <colspec colwidth="6*" align="center"/>
32314 <colspec colwidth="6*" align="right"/>
32315 <tbody>
32316 <row>
32317 <entry><option>router_home_directory</option></entry>
32318 <entry>Use: <emphasis>routers</emphasis></entry>
32319 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
32320 <entry>Default: <emphasis>unset</emphasis></entry>
32321 </row>
32322 </tbody>
32323 </tgroup>
32324 </informaltable>
32325 <para>
32326 <indexterm role="concept">
32327 <primary>router</primary>
32328 <secondary>home directory for</secondary>
32329 </indexterm>
32330 <indexterm role="concept">
32331 <primary>home directory</primary>
32332 <secondary>for router</secondary>
32333 </indexterm>
32334 <indexterm role="variable">
32335 <primary><varname>$home</varname></primary>
32336 </indexterm>
32337 This option sets a home directory for use while the router is running. (Compare
32338 <option>transport_home_directory</option>, which sets a home directory for later
32339 transporting.) In particular, if used on a <command>redirect</command> router, this option
32340 sets a value for <varname>$home</varname> while a filter is running. The value is expanded;
32341 forced expansion failure causes the option to be ignored &ndash; other failures
32342 cause the router to defer.
32343 </para>
32344 <para>
32345 Expansion of <option>router_home_directory</option> happens immediately after the
32346 <option>check_local_user</option> test (if configured), before any further expansions take
32347 place.
32348 (See section <xref linkend="SECTrouprecon"/> for a list of the order in which preconditions
32349 are evaluated.)
32350 While the router is running, <option>router_home_directory</option> overrides the value of
32351 <varname>$home</varname> that came from <option>check_local_user</option>.
32352 </para>
32353 <para>
32354 When a router accepts an address and assigns it to a local transport (including
32355 the cases when a <command>redirect</command> router generates a pipe, file, or autoreply
32356 delivery), the home directory setting for the transport is taken from the first
32357 of these values that is set:
32358 </para>
32359 <itemizedlist>
32360 <listitem>
32361 <para>
32362 The <option>home_directory</option> option on the transport;
32363 </para>
32364 </listitem>
32365 <listitem>
32366 <para>
32367 The <option>transport_home_directory</option> option on the router;
32368 </para>
32369 </listitem>
32370 <listitem>
32371 <para>
32372 The password data if <option>check_local_user</option> is set on the router;
32373 </para>
32374 </listitem>
32375 <listitem>
32376 <para>
32377 The <option>router_home_directory</option> option on the router.
32378 </para>
32379 </listitem>
32380 </itemizedlist>
32381 <para>
32382 In other words, <option>router_home_directory</option> overrides the password data for the
32383 router, but not for the transport.
32384 </para>
32385 <para>
32386 <indexterm role="option">
32387 <primary><option>self</option></primary>
32388 </indexterm>
32389 </para>
32390 <informaltable frame="all">
32391 <tgroup cols="4" colsep="0" rowsep="0">
32392 <colspec colwidth="8*" align="left"/>
32393 <colspec colwidth="6*" align="center"/>
32394 <colspec colwidth="6*" align="center"/>
32395 <colspec colwidth="6*" align="right"/>
32396 <tbody>
32397 <row>
32398 <entry><option>self</option></entry>
32399 <entry>Use: <emphasis>routers</emphasis></entry>
32400 <entry>Type: <emphasis>string</emphasis></entry>
32401 <entry>Default: <emphasis>freeze</emphasis></entry>
32402 </row>
32403 </tbody>
32404 </tgroup>
32405 </informaltable>
32406 <para>
32407 <indexterm role="concept">
32408 <primary>MX record</primary>
32409 <secondary>pointing to local host</secondary>
32410 </indexterm>
32411 <indexterm role="concept">
32412 <primary>local host</primary>
32413 <secondary>MX pointing to</secondary>
32414 </indexterm>
32415 This option applies to those routers that use a recipient address to find a
32416 list of remote hosts. Currently, these are the <command>dnslookup</command>, <command>ipliteral</command>,
32417 and <command>manualroute</command> routers.
32418 Certain configurations of the <command>queryprogram</command> router can also specify a list
32419 of remote hosts.
32420 Usually such routers are configured to send the message to a remote host via an
32421 <command>smtp</command> transport. The <option>self</option> option specifies what happens when the first
32422 host on the list turns out to be the local host.
32423 The way in which Exim checks for the local host is described in section
32424 <xref linkend="SECTreclocipadd"/>.
32425 </para>
32426 <para>
32427 Normally this situation indicates either an error in Exim&#x2019;s configuration (for
32428 example, the router should be configured not to process this domain), or an
32429 error in the DNS (for example, the MX should not point to this host). For this
32430 reason, the default action is to log the incident, defer the address, and
32431 freeze the message. The following alternatives are provided for use in special
32432 cases:
32433 </para>
32434 <variablelist>
32435 <varlistentry>
32436 <term><option>defer</option></term>
32437 <listitem>
32438 <para>
32439 Delivery of the message is tried again later, but the message is not frozen.
32440 </para>
32441 </listitem></varlistentry>
32442 <varlistentry>
32443 <term><option>reroute</option>: &lt;<emphasis>domain</emphasis>&gt;</term>
32444 <listitem>
32445 <para>
32446 The domain is changed to the given domain, and the address is passed back to
32447 be reprocessed by the routers. No rewriting of headers takes place. This
32448 behaviour is essentially a redirection.
32449 </para>
32450 </listitem></varlistentry>
32451 <varlistentry>
32452 <term><option>reroute: rewrite:</option> &lt;<emphasis>domain</emphasis>&gt;</term>
32453 <listitem>
32454 <para>
32455 The domain is changed to the given domain, and the address is passed back to be
32456 reprocessed by the routers. Any headers that contain the original domain are
32457 rewritten.
32458 </para>
32459 </listitem></varlistentry>
32460 <varlistentry>
32461 <term><option>pass</option></term>
32462 <listitem>
32463 <para>
32464 <indexterm role="option">
32465 <primary><option>more</option></primary>
32466 </indexterm>
32467 <indexterm role="variable">
32468 <primary><varname>$self_hostname</varname></primary>
32469 </indexterm>
32470 The router passes the address to the next router, or to the router named in the
32471 <option>pass_router</option> option if it is set. This overrides <option>no_more</option>. During
32472 subsequent routing and delivery, the variable <varname>$self_hostname</varname> contains the
32473 name of the local host that the router encountered. This can be used to
32474 distinguish between different cases for hosts with multiple names. The
32475 combination
32476 </para>
32477 <literallayout class="monospaced">
32478 self = pass
32479 no_more
32480 </literallayout>
32481 <para>
32482 ensures that only those addresses that routed to the local host are passed on.
32483 Without <option>no_more</option>, addresses that were declined for other reasons would also
32484 be passed to the next router.
32485 </para>
32486 </listitem></varlistentry>
32487 <varlistentry>
32488 <term><option>fail</option></term>
32489 <listitem>
32490 <para>
32491 Delivery fails and an error report is generated.
32492 </para>
32493 </listitem></varlistentry>
32494 <varlistentry>
32495 <term><option>send</option></term>
32496 <listitem>
32497 <para>
32498 <indexterm role="concept">
32499 <primary>local host</primary>
32500 <secondary>sending to</secondary>
32501 </indexterm>
32502 The anomaly is ignored and the address is queued for the transport. This
32503 setting should be used with extreme caution. For an <command>smtp</command> transport, it
32504 makes sense only in cases where the program that is listening on the SMTP port
32505 is not this version of Exim. That is, it must be some other MTA, or Exim with a
32506 different configuration file that handles the domain in another way.
32507 </para>
32508 </listitem></varlistentry>
32509 </variablelist>
32510 <para>
32511 <indexterm role="option">
32512 <primary><option>senders</option></primary>
32513 </indexterm>
32514 </para>
32515 <informaltable frame="all">
32516 <tgroup cols="4" colsep="0" rowsep="0">
32517 <colspec colwidth="8*" align="left"/>
32518 <colspec colwidth="6*" align="center"/>
32519 <colspec colwidth="6*" align="center"/>
32520 <colspec colwidth="6*" align="right"/>
32521 <tbody>
32522 <row>
32523 <entry><option>senders</option></entry>
32524 <entry>Use: <emphasis>routers</emphasis>&Dagger;<emphasis></emphasis></entry>
32525 <entry>Type: <emphasis>address list</emphasis>&dagger;<emphasis></emphasis></entry>
32526 <entry>Default: <emphasis>unset</emphasis></entry>
32527 </row>
32528 </tbody>
32529 </tgroup>
32530 </informaltable>
32531 <para>
32532 <indexterm role="concept">
32533 <primary>router</primary>
32534 <secondary>checking senders</secondary>
32535 </indexterm>
32536 If this option is set, the router is skipped unless the message&#x2019;s sender
32537 address matches something on the list.
32538 See section <xref linkend="SECTrouprecon"/> for a list of the order in which preconditions
32539 are evaluated.
32540 </para>
32541 <para>
32542 There are issues concerning verification when the running of routers is
32543 dependent on the sender. When Exim is verifying the address in an <option>errors_to</option>
32544 setting, it sets the sender to the null string. When using the <option>-bt</option> option
32545 to check a configuration file, it is necessary also to use the <option>-f</option> option to
32546 set an appropriate sender. For incoming mail, the sender is unset when
32547 verifying the sender, but is available when verifying any recipients. If the
32548 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
32549 matters.
32550 </para>
32551 <para>
32552 <indexterm role="option">
32553 <primary><option>translate_ip_address</option></primary>
32554 </indexterm>
32555 </para>
32556 <informaltable frame="all">
32557 <tgroup cols="4" colsep="0" rowsep="0">
32558 <colspec colwidth="8*" align="left"/>
32559 <colspec colwidth="6*" align="center"/>
32560 <colspec colwidth="6*" align="center"/>
32561 <colspec colwidth="6*" align="right"/>
32562 <tbody>
32563 <row>
32564 <entry><option>translate_ip_address</option></entry>
32565 <entry>Use: <emphasis>routers</emphasis></entry>
32566 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
32567 <entry>Default: <emphasis>unset</emphasis></entry>
32568 </row>
32569 </tbody>
32570 </tgroup>
32571 </informaltable>
32572 <para>
32573 <indexterm role="concept">
32574 <primary>IP address</primary>
32575 <secondary>translating</secondary>
32576 </indexterm>
32577 <indexterm role="concept">
32578 <primary>packet radio</primary>
32579 </indexterm>
32580 <indexterm role="concept">
32581 <primary>router</primary>
32582 <secondary>IP address translation</secondary>
32583 </indexterm>
32584 There exist some rare networking situations (for example, packet radio) where
32585 it is helpful to be able to translate IP addresses generated by normal routing
32586 mechanisms into other IP addresses, thus performing a kind of manual IP
32587 routing. This should be done only if the normal IP routing of the TCP/IP stack
32588 is inadequate or broken. Because this is an extremely uncommon requirement, the
32589 code to support this option is not included in the Exim binary unless
32590 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in <filename>Local/Makefile</filename>.
32591 </para>
32592 <para>
32593 <indexterm role="variable">
32594 <primary><varname>$host_address</varname></primary>
32595 </indexterm>
32596 The <option>translate_ip_address</option> string is expanded for every IP address generated
32597 by the router, with the generated address set in <varname>$host_address</varname>. If the
32598 expansion is forced to fail, no action is taken.
32599 For any other expansion error, delivery of the message is deferred.
32600 If the result of the expansion is an IP address, that replaces the original
32601 address; otherwise the result is assumed to be a host name &ndash; this is looked
32602 up using <function>gethostbyname()</function> (or <function>getipnodebyname()</function> when available) to
32603 produce one or more replacement IP addresses. For example, to subvert all IP
32604 addresses in some specific networks, this could be added to a router:
32605 </para>
32606 <literallayout class="monospaced">
32607 translate_ip_address = \
32608   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
32609     {$value}fail}}
32610 </literallayout>
32611 <para>
32612 The file would contain lines like
32613 </para>
32614 <literallayout class="monospaced">
32615 10.2.3.128/26    some.host
32616 10.8.4.34/26     10.44.8.15
32617 </literallayout>
32618 <para>
32619 You should not make use of this facility unless you really understand what you
32620 are doing.
32621 </para>
32622 <para>
32623 <indexterm role="option">
32624 <primary><option>transport</option></primary>
32625 </indexterm>
32626 </para>
32627 <informaltable frame="all">
32628 <tgroup cols="4" colsep="0" rowsep="0">
32629 <colspec colwidth="8*" align="left"/>
32630 <colspec colwidth="6*" align="center"/>
32631 <colspec colwidth="6*" align="center"/>
32632 <colspec colwidth="6*" align="right"/>
32633 <tbody>
32634 <row>
32635 <entry><option>transport</option></entry>
32636 <entry>Use: <emphasis>routers</emphasis></entry>
32637 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
32638 <entry>Default: <emphasis>unset</emphasis></entry>
32639 </row>
32640 </tbody>
32641 </tgroup>
32642 </informaltable>
32643 <para>
32644 This option specifies the transport to be used when a router accepts an address
32645 and sets it up for delivery. A transport is never needed if a router is used
32646 only for verification. The value of the option is expanded at routing time,
32647 after the expansion of <option>errors_to</option>, <option>headers_add</option>, and <option>headers_remove</option>,
32648 and result must be the name of one of the configured transports. If it is not,
32649 delivery is deferred.
32650 </para>
32651 <para>
32652 The <option>transport</option> option is not used by the <command>redirect</command> router, but it does
32653 have some private options that set up transports for pipe and file deliveries
32654 (see chapter <xref linkend="CHAPredirect"/>).
32655 </para>
32656 <para>
32657 <indexterm role="option">
32658 <primary><option>transport_current_directory</option></primary>
32659 </indexterm>
32660 </para>
32661 <informaltable frame="all">
32662 <tgroup cols="4" colsep="0" rowsep="0">
32663 <colspec colwidth="8*" align="left"/>
32664 <colspec colwidth="6*" align="center"/>
32665 <colspec colwidth="6*" align="center"/>
32666 <colspec colwidth="6*" align="right"/>
32667 <tbody>
32668 <row>
32669 <entry><option>transport_current_directory</option></entry>
32670 <entry>Use: <emphasis>routers</emphasis></entry>
32671 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
32672 <entry>Default: <emphasis>unset</emphasis></entry>
32673 </row>
32674 </tbody>
32675 </tgroup>
32676 </informaltable>
32677 <para>
32678 <indexterm role="concept">
32679 <primary>current directory for local transport</primary>
32680 </indexterm>
32681 This option associates a current directory with any address that is routed
32682 to a local transport. This can happen either because a transport is
32683 explicitly configured for the router, or because it generates a delivery to a
32684 file or a pipe. During the delivery process (that is, at transport time), this
32685 option string is expanded and is set as the current directory, unless
32686 overridden by a setting on the transport.
32687 If the expansion fails for any reason, including forced failure, an error is
32688 logged, and delivery is deferred.
32689 See chapter <xref linkend="CHAPenvironment"/> for details of the local delivery
32690 environment.
32691 </para>
32692 <para>
32693 <indexterm role="option">
32694 <primary><option>transport_home_directory</option></primary>
32695 </indexterm>
32696 </para>
32697 <informaltable frame="all">
32698 <tgroup cols="4" colsep="0" rowsep="0">
32699 <colspec colwidth="8*" align="left"/>
32700 <colspec colwidth="6*" align="center"/>
32701 <colspec colwidth="6*" align="center"/>
32702 <colspec colwidth="6*" align="right"/>
32703 <tbody>
32704 <row>
32705 <entry><option>transport_home_directory</option></entry>
32706 <entry>Use: <emphasis>routers</emphasis></entry>
32707 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
32708 <entry>Default: <emphasis>see below</emphasis></entry>
32709 </row>
32710 </tbody>
32711 </tgroup>
32712 </informaltable>
32713 <para>
32714 <indexterm role="concept">
32715 <primary>home directory</primary>
32716 <secondary>for local transport</secondary>
32717 </indexterm>
32718 This option associates a home directory with any address that is routed to a
32719 local transport. This can happen either because a transport is explicitly
32720 configured for the router, or because it generates a delivery to a file or a
32721 pipe. During the delivery process (that is, at transport time), the option
32722 string is expanded and is set as the home directory, unless overridden by a
32723 setting of <option>home_directory</option> on the transport.
32724 If the expansion fails for any reason, including forced failure, an error is
32725 logged, and delivery is deferred.
32726 </para>
32727 <para>
32728 If the transport does not specify a home directory, and
32729 <option>transport_home_directory</option> is not set for the router, the home directory for
32730 the transport is taken from the password data if <option>check_local_user</option> is set for
32731 the router. Otherwise it is taken from <option>router_home_directory</option> if that option
32732 is set; if not, no home directory is set for the transport.
32733 </para>
32734 <para>
32735 See chapter <xref linkend="CHAPenvironment"/> for further details of the local delivery
32736 environment.
32737 </para>
32738 <para>
32739 <indexterm role="option">
32740 <primary><option>unseen</option></primary>
32741 </indexterm>
32742 </para>
32743 <informaltable frame="all">
32744 <tgroup cols="4" colsep="0" rowsep="0">
32745 <colspec colwidth="8*" align="left"/>
32746 <colspec colwidth="6*" align="center"/>
32747 <colspec colwidth="6*" align="center"/>
32748 <colspec colwidth="6*" align="right"/>
32749 <tbody>
32750 <row>
32751 <entry><option>unseen</option></entry>
32752 <entry>Use: <emphasis>routers</emphasis></entry>
32753 <entry>Type: <emphasis>boolean</emphasis>&dagger;<emphasis></emphasis></entry>
32754 <entry>Default: <emphasis>false</emphasis></entry>
32755 </row>
32756 </tbody>
32757 </tgroup>
32758 </informaltable>
32759 <para>
32760 <indexterm role="concept">
32761 <primary>router</primary>
32762 <secondary>carrying on after success</secondary>
32763 </indexterm>
32764 The result of string expansion for this option must be a valid boolean value,
32765 that is, one of the strings <quote>yes</quote>, <quote>no</quote>, <quote>true</quote>, or <quote>false</quote>. Any other
32766 result causes an error, and delivery is deferred. If the expansion is forced to
32767 fail, the default value for the option (false) is used. Other failures cause
32768 delivery to be deferred.
32769 </para>
32770 <para>
32771 When this option is set true, routing does not cease if the router accepts the
32772 address. Instead, a copy of the incoming address is passed to the next router,
32773 overriding a false setting of <option>more</option>. There is little point in setting
32774 <option>more</option> false if <option>unseen</option> is always true, but it may be useful in cases when
32775 the value of <option>unseen</option> contains expansion items (and therefore, presumably, is
32776 sometimes true and sometimes false).
32777 </para>
32778 <para>
32779 <indexterm role="concept">
32780 <primary>copy of message (<option>unseen</option> option)</primary>
32781 </indexterm>
32782 Setting the <option>unseen</option> option has a similar effect to the <option>unseen</option> command
32783 qualifier in filter files. It can be used to cause copies of messages to be
32784 delivered to some other destination, while also carrying out a normal delivery.
32785 In effect, the current address is made into a <quote>parent</quote> that has two children
32786 &ndash; one that is delivered as specified by this router, and a clone that goes on
32787 to be routed further. For this reason, <option>unseen</option> may not be combined with the
32788 <option>one_time</option> option in a <command>redirect</command> router.
32789 </para>
32790 <para>
32791 <emphasis role="bold">Warning</emphasis>: Header lines added to the address (or specified for removal) by
32792 this router or by previous routers affect the <quote>unseen</quote> copy of the message
32793 only. The clone that continues to be processed by further routers starts with
32794 no added headers and none specified for removal. For a <option>redirect</option> router, if
32795 a generated address is the same as the incoming address, this can lead to
32796 duplicate addresses with different header modifications. Exim does not do
32797 duplicate deliveries (except, in certain circumstances, to pipes -- see section
32798 <xref linkend="SECTdupaddr"/>), but it is undefined which of the duplicates is discarded,
32799 so this ambiguous situation should be avoided. The <option>repeat_use</option> option of the
32800 <option>redirect</option> router may be of help.
32801 </para>
32802 <para>
32803 Unlike the handling of header modifications, any data that was set by the
32804 <option>address_data</option> option in the current or previous routers <emphasis>is</emphasis> passed on to
32805 subsequent routers.
32806 </para>
32807 <para>
32808 <indexterm role="option">
32809 <primary><option>user</option></primary>
32810 </indexterm>
32811 </para>
32812 <informaltable frame="all">
32813 <tgroup cols="4" colsep="0" rowsep="0">
32814 <colspec colwidth="8*" align="left"/>
32815 <colspec colwidth="6*" align="center"/>
32816 <colspec colwidth="6*" align="center"/>
32817 <colspec colwidth="6*" align="right"/>
32818 <tbody>
32819 <row>
32820 <entry><option>user</option></entry>
32821 <entry>Use: <emphasis>routers</emphasis></entry>
32822 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
32823 <entry>Default: <emphasis>see below</emphasis></entry>
32824 </row>
32825 </tbody>
32826 </tgroup>
32827 </informaltable>
32828 <para>
32829 <indexterm role="concept">
32830 <primary>uid (user id)</primary>
32831 <secondary>local delivery</secondary>
32832 </indexterm>
32833 <indexterm role="concept">
32834 <primary>local transports</primary>
32835 <secondary>uid and gid</secondary>
32836 </indexterm>
32837 <indexterm role="concept">
32838 <primary>transport</primary>
32839 <secondary>local</secondary>
32840 </indexterm>
32841 <indexterm role="concept">
32842 <primary>router</primary>
32843 <secondary>user for filter processing</secondary>
32844 </indexterm>
32845 <indexterm role="concept">
32846 <primary>filter</primary>
32847 <secondary>user for processing</secondary>
32848 </indexterm>
32849 When a router queues an address for a transport, and the transport does not
32850 specify a user, the user given here is used when running the delivery process.
32851 The user may be specified numerically or by name. If expansion fails, the
32852 error is logged and delivery is deferred.
32853 This user is also used by the <command>redirect</command> router when running a filter file.
32854 The default is unset, except when <option>check_local_user</option> is set. In this case,
32855 the default is taken from the password information. If the user is specified as
32856 a name, and <option>group</option> is not set, the group associated with the user is used.
32857 See also <option>initgroups</option> and <option>group</option> and the discussion in chapter
32858 <xref linkend="CHAPenvironment"/>.
32859 </para>
32860 <para>
32861 <indexterm role="option">
32862 <primary><option>verify</option></primary>
32863 </indexterm>
32864 </para>
32865 <informaltable frame="all">
32866 <tgroup cols="4" colsep="0" rowsep="0">
32867 <colspec colwidth="8*" align="left"/>
32868 <colspec colwidth="6*" align="center"/>
32869 <colspec colwidth="6*" align="center"/>
32870 <colspec colwidth="6*" align="right"/>
32871 <tbody>
32872 <row>
32873 <entry><option>verify</option></entry>
32874 <entry>Use: <emphasis>routers</emphasis>&Dagger;<emphasis></emphasis></entry>
32875 <entry>Type: <emphasis>boolean</emphasis></entry>
32876 <entry>Default: <emphasis>true</emphasis></entry>
32877 </row>
32878 </tbody>
32879 </tgroup>
32880 </informaltable>
32881 <para>
32882 Setting this option has the effect of setting <option>verify_sender</option> and
32883 <option>verify_recipient</option> to the same value.
32884 </para>
32885 <para>
32886 <indexterm role="option">
32887 <primary><option>verify_only</option></primary>
32888 </indexterm>
32889 </para>
32890 <informaltable frame="all">
32891 <tgroup cols="4" colsep="0" rowsep="0">
32892 <colspec colwidth="8*" align="left"/>
32893 <colspec colwidth="6*" align="center"/>
32894 <colspec colwidth="6*" align="center"/>
32895 <colspec colwidth="6*" align="right"/>
32896 <tbody>
32897 <row>
32898 <entry><option>verify_only</option></entry>
32899 <entry>Use: <emphasis>routers</emphasis>&Dagger;<emphasis></emphasis></entry>
32900 <entry>Type: <emphasis>boolean</emphasis></entry>
32901 <entry>Default: <emphasis>false</emphasis></entry>
32902 </row>
32903 </tbody>
32904 </tgroup>
32905 </informaltable>
32906 <para>
32907 <indexterm role="concept">
32908 <primary>EXPN</primary>
32909 <secondary>with <option>verify_only</option></secondary>
32910 </indexterm>
32911 <indexterm role="option">
32912 <primary><option>-bv</option></primary>
32913 </indexterm>
32914 <indexterm role="concept">
32915 <primary>router</primary>
32916 <secondary>used only when verifying</secondary>
32917 </indexterm>
32918 If this option is set, the router is used only when verifying an address,
32919 delivering in cutthrough mode or
32920 testing with the <option>-bv</option> option, not when actually doing a delivery, testing
32921 with the <option>-bt</option> option, or running the SMTP EXPN command. It can be further
32922 restricted to verifying only senders or recipients by means of
32923 <option>verify_sender</option> and <option>verify_recipient</option>.
32924 </para>
32925 <para>
32926 <emphasis role="bold">Warning</emphasis>: When the router is being run to verify addresses for an incoming
32927 SMTP message, Exim is not running as root, but under its own uid. If the router
32928 accesses any files, you need to make sure that they are accessible to the Exim
32929 user or group.
32930 </para>
32931 <para>
32932 <indexterm role="option">
32933 <primary><option>verify_recipient</option></primary>
32934 </indexterm>
32935 </para>
32936 <informaltable frame="all">
32937 <tgroup cols="4" colsep="0" rowsep="0">
32938 <colspec colwidth="8*" align="left"/>
32939 <colspec colwidth="6*" align="center"/>
32940 <colspec colwidth="6*" align="center"/>
32941 <colspec colwidth="6*" align="right"/>
32942 <tbody>
32943 <row>
32944 <entry><option>verify_recipient</option></entry>
32945 <entry>Use: <emphasis>routers</emphasis>&Dagger;<emphasis></emphasis></entry>
32946 <entry>Type: <emphasis>boolean</emphasis></entry>
32947 <entry>Default: <emphasis>true</emphasis></entry>
32948 </row>
32949 </tbody>
32950 </tgroup>
32951 </informaltable>
32952 <para>
32953 If this option is false, the router is skipped when verifying recipient
32954 addresses,
32955 delivering in cutthrough mode
32956 or testing recipient verification using <option>-bv</option>.
32957 See section <xref linkend="SECTrouprecon"/> for a list of the order in which preconditions
32958 are evaluated.
32959 </para>
32960 <para>
32961 <indexterm role="option">
32962 <primary><option>verify_sender</option></primary>
32963 </indexterm>
32964 </para>
32965 <informaltable frame="all">
32966 <tgroup cols="4" colsep="0" rowsep="0">
32967 <colspec colwidth="8*" align="left"/>
32968 <colspec colwidth="6*" align="center"/>
32969 <colspec colwidth="6*" align="center"/>
32970 <colspec colwidth="6*" align="right"/>
32971 <tbody>
32972 <row>
32973 <entry><option>verify_sender</option></entry>
32974 <entry>Use: <emphasis>routers</emphasis>&Dagger;<emphasis></emphasis></entry>
32975 <entry>Type: <emphasis>boolean</emphasis></entry>
32976 <entry>Default: <emphasis>true</emphasis></entry>
32977 </row>
32978 </tbody>
32979 </tgroup>
32980 </informaltable>
32981 <para>
32982 If this option is false, the router is skipped when verifying sender addresses
32983 or testing sender verification using <option>-bvs</option>.
32984 See section <xref linkend="SECTrouprecon"/> for a list of the order in which preconditions
32985 are evaluated.
32986 <indexterm role="concept" startref="IIDgenoprou1" class="endofrange"/>
32987 <indexterm role="concept" startref="IIDgenoprou2" class="endofrange"/>
32988 </para>
32989 </chapter>
32990
32991 <chapter id="CHID4">
32992 <title>The accept router</title>
32993 <para>
32994 <indexterm role="concept">
32995 <primary><command>accept</command> router</primary>
32996 </indexterm>
32997 <indexterm role="concept">
32998 <primary>routers</primary>
32999 <secondary><command>accept</command></secondary>
33000 </indexterm>
33001 The <command>accept</command> router has no private options of its own. Unless it is being
33002 used purely for verification (see <option>verify_only</option>) a transport is required to
33003 be defined by the generic <option>transport</option> option. If the preconditions that are
33004 specified by generic options are met, the router accepts the address and queues
33005 it for the given transport. The most common use of this router is for setting
33006 up deliveries to local mailboxes. For example:
33007 </para>
33008 <literallayout class="monospaced">
33009 localusers:
33010   driver = accept
33011   domains = mydomain.example
33012   check_local_user
33013   transport = local_delivery
33014 </literallayout>
33015 <para>
33016 The <option>domains</option> condition in this example checks the domain of the address, and
33017 <option>check_local_user</option> checks that the local part is the login of a local user.
33018 When both preconditions are met, the <command>accept</command> router runs, and queues the
33019 address for the <command>local_delivery</command> transport.
33020 </para>
33021 </chapter>
33022
33023 <chapter id="CHAPdnslookup">
33024 <title>The dnslookup router</title>
33025 <para>
33026 <indexterm role="concept" id="IIDdnsrou1" class="startofrange">
33027 <primary><command>dnslookup</command> router</primary>
33028 </indexterm>
33029 <indexterm role="concept" id="IIDdnsrou2" class="startofrange">
33030 <primary>routers</primary>
33031 <secondary><command>dnslookup</command></secondary>
33032 </indexterm>
33033 The <command>dnslookup</command> router looks up the hosts that handle mail for the
33034 recipient&#x2019;s domain in the DNS. A transport must always be set for this router,
33035 unless <option>verify_only</option> is set.
33036 </para>
33037 <para>
33038 If SRV support is configured (see <option>check_srv</option> below), Exim first searches for
33039 SRV records. If none are found, or if SRV support is not configured,
33040 MX records are looked up. If no MX records exist, address records are sought.
33041 However, <option>mx_domains</option> can be set to disable the direct use of address
33042 records.
33043 </para>
33044 <para>
33045 MX records of equal priority are sorted by Exim into a random order. Exim then
33046 looks for address records for the host names obtained from MX or SRV records.
33047 When a host has more than one IP address, they are sorted into a random order,
33048 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
33049 IP addresses found are discarded by a setting of the <option>ignore_target_hosts</option>
33050 generic option, the router declines.
33051 </para>
33052 <para>
33053 Unless they have the highest priority (lowest MX value), MX records that point
33054 to the local host, or to any host name that matches <option>hosts_treat_as_local</option>,
33055 are discarded, together with any other MX records of equal or lower priority.
33056 </para>
33057 <para>
33058 <indexterm role="concept">
33059 <primary>MX record</primary>
33060 <secondary>pointing to local host</secondary>
33061 </indexterm>
33062 <indexterm role="concept">
33063 <primary>local host</primary>
33064 <secondary>MX pointing to</secondary>
33065 </indexterm>
33066 <indexterm role="option">
33067 <primary><option>self</option></primary>
33068 <secondary>in <command>dnslookup</command> router</secondary>
33069 </indexterm>
33070 If the host pointed to by the highest priority MX record, or looked up as an
33071 address record, is the local host, or matches <option>hosts_treat_as_local</option>, what
33072 happens is controlled by the generic <option>self</option> option.
33073 </para>
33074 <section id="SECTprowitdnsloo">
33075 <title>Problems with DNS lookups</title>
33076 <para>
33077 There have been problems with DNS servers when SRV records are looked up.
33078 Some mis-behaving servers return a DNS error or timeout when a non-existent
33079 SRV record is sought. Similar problems have in the past been reported for
33080 MX records. The global <option>dns_again_means_nonexist</option> option can help with this
33081 problem, but it is heavy-handed because it is a global option.
33082 </para>
33083 <para>
33084 For this reason, there are two options, <option>srv_fail_domains</option> and
33085 <option>mx_fail_domains</option>, that control what happens when a DNS lookup in a
33086 <command>dnslookup</command> router results in a DNS failure or a <quote>try again</quote> response. If
33087 an attempt to look up an SRV or MX record causes one of these results, and the
33088 domain matches the relevant list, Exim behaves as if the DNS had responded <quote>no
33089 such record</quote>. In the case of an SRV lookup, this means that the router
33090 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
33091 look for A or AAAA records, unless the domain matches <option>mx_domains</option>, in which
33092 case routing fails.
33093 </para>
33094 </section>
33095 <section id="SECTdnslookupdecline">
33096 <title>Declining addresses by dnslookup</title>
33097 <para>
33098 <indexterm role="concept">
33099 <primary><command>dnslookup</command> router</primary>
33100 <secondary>declines</secondary>
33101 </indexterm>
33102 There are a few cases where a <command>dnslookup</command> router will decline to accept
33103 an address; if such a router is expected to handle "all remaining non-local
33104 domains", then it is important to set <option>no_more</option>.
33105 </para>
33106 <para>
33107 Reasons for a <command>dnslookup</command> router to decline currently include:
33108 </para>
33109 <itemizedlist>
33110 <listitem>
33111 <para>
33112 The domain does not exist in DNS
33113 </para>
33114 </listitem>
33115 <listitem>
33116 <para>
33117 The domain exists but the MX record&#x2019;s host part is just "."; this is a common
33118 convention (borrowed from SRV) used to indicate that there is no such service
33119 for this domain and to not fall back to trying A/AAAA records.
33120 </para>
33121 </listitem>
33122 <listitem>
33123 <para>
33124 Ditto, but for SRV records, when <option>check_srv</option> is set on this router.
33125 </para>
33126 </listitem>
33127 <listitem>
33128 <para>
33129 MX record points to a non-existent host.
33130 </para>
33131 </listitem>
33132 <listitem>
33133 <para>
33134 MX record points to an IP address and the main section option
33135 <option>allow_mx_to_ip</option> is not set.
33136 </para>
33137 </listitem>
33138 <listitem>
33139 <para>
33140 MX records exist and point to valid hosts, but all hosts resolve only to
33141 addresses blocked by the <option>ignore_target_hosts</option> generic option on this router.
33142 </para>
33143 </listitem>
33144 <listitem>
33145 <para>
33146 The domain is not syntactically valid (see also <option>allow_utf8_domains</option> and
33147 <option>dns_check_names_pattern</option> for handling one variant of this)
33148 </para>
33149 </listitem>
33150 <listitem>
33151 <para>
33152 <option>check_secondary_mx</option> is set on this router but the local host can
33153 not be found in the MX records (see below)
33154 </para>
33155 </listitem>
33156 </itemizedlist>
33157 </section>
33158 <section id="SECID118">
33159 <title>Private options for dnslookup</title>
33160 <para>
33161 <indexterm role="concept">
33162 <primary>options</primary>
33163 <secondary><command>dnslookup</command> router</secondary>
33164 </indexterm>
33165 The private options for the <command>dnslookup</command> router are as follows:
33166 </para>
33167 <para>
33168 <indexterm role="option">
33169 <primary><option>check_secondary_mx</option></primary>
33170 </indexterm>
33171 </para>
33172 <informaltable frame="all">
33173 <tgroup cols="4" colsep="0" rowsep="0">
33174 <colspec colwidth="8*" align="left"/>
33175 <colspec colwidth="6*" align="center"/>
33176 <colspec colwidth="6*" align="center"/>
33177 <colspec colwidth="6*" align="right"/>
33178 <tbody>
33179 <row>
33180 <entry><option>check_secondary_mx</option></entry>
33181 <entry>Use: <emphasis>dnslookup</emphasis></entry>
33182 <entry>Type: <emphasis>boolean</emphasis></entry>
33183 <entry>Default: <emphasis>false</emphasis></entry>
33184 </row>
33185 </tbody>
33186 </tgroup>
33187 </informaltable>
33188 <para>
33189 <indexterm role="concept">
33190 <primary>MX record</primary>
33191 <secondary>checking for secondary</secondary>
33192 </indexterm>
33193 If this option is set, the router declines unless the local host is found in
33194 (and removed from) the list of hosts obtained by MX lookup. This can be used to
33195 process domains for which the local host is a secondary mail exchanger
33196 differently to other domains. The way in which Exim decides whether a host is
33197 the local host is described in section <xref linkend="SECTreclocipadd"/>.
33198 </para>
33199 <para>
33200 <indexterm role="option">
33201 <primary><option>check_srv</option></primary>
33202 </indexterm>
33203 </para>
33204 <informaltable frame="all">
33205 <tgroup cols="4" colsep="0" rowsep="0">
33206 <colspec colwidth="8*" align="left"/>
33207 <colspec colwidth="6*" align="center"/>
33208 <colspec colwidth="6*" align="center"/>
33209 <colspec colwidth="6*" align="right"/>
33210 <tbody>
33211 <row>
33212 <entry><option>check_srv</option></entry>
33213 <entry>Use: <emphasis>dnslookup</emphasis></entry>
33214 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
33215 <entry>Default: <emphasis>unset</emphasis></entry>
33216 </row>
33217 </tbody>
33218 </tgroup>
33219 </informaltable>
33220 <para>
33221 <indexterm role="concept">
33222 <primary>SRV record</primary>
33223 <secondary>enabling use of</secondary>
33224 </indexterm>
33225 The <command>dnslookup</command> router supports the use of SRV records (see RFC 2782) in
33226 addition to MX and address records. The support is disabled by default. To
33227 enable SRV support, set the <option>check_srv</option> option to the name of the service
33228 required. For example,
33229 </para>
33230 <literallayout class="monospaced">
33231 check_srv = smtp
33232 </literallayout>
33233 <para>
33234 looks for SRV records that refer to the normal smtp service. The option is
33235 expanded, so the service name can vary from message to message or address
33236 to address. This might be helpful if SRV records are being used for a
33237 submission service. If the expansion is forced to fail, the <option>check_srv</option>
33238 option is ignored, and the router proceeds to look for MX records in the
33239 normal way.
33240 </para>
33241 <para>
33242 When the expansion succeeds, the router searches first for SRV records for
33243 the given service (it assumes TCP protocol). A single SRV record with a
33244 host name that consists of just a single dot indicates <quote>no such service for
33245 this domain</quote>; if this is encountered, the router declines. If other kinds of
33246 SRV record are found, they are used to construct a host list for delivery
33247 according to the rules of RFC 2782. MX records are not sought in this case.
33248 </para>
33249 <para>
33250 When no SRV records are found, MX records (and address records) are sought in
33251 the traditional way. In other words, SRV records take precedence over MX
33252 records, just as MX records take precedence over address records. Note that
33253 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
33254 defined it. It is apparently believed that MX records are sufficient for email
33255 and that SRV records should not be used for this purpose. However, SRV records
33256 have an additional <quote>weight</quote> feature which some people might find useful when
33257 trying to split an SMTP load between hosts of different power.
33258 </para>
33259 <para>
33260 See section <xref linkend="SECTprowitdnsloo"/> above for a discussion of Exim&#x2019;s behaviour
33261 when there is a DNS lookup error.
33262 </para>
33263 <para revisionflag="changed">
33264 <indexterm role="option">
33265 <primary><option>dnssec_request_domains</option></primary>
33266 </indexterm>
33267 </para>
33268 <informaltable frame="all" revisionflag="changed">
33269 <tgroup cols="4" colsep="0" rowsep="0">
33270 <colspec colwidth="8*" align="left"/>
33271 <colspec colwidth="6*" align="center"/>
33272 <colspec colwidth="6*" align="center"/>
33273 <colspec colwidth="6*" align="right"/>
33274 <tbody>
33275 <row>
33276 <entry><option>dnssec_request_domains</option></entry>
33277 <entry>Use: <emphasis>dnslookup</emphasis></entry>
33278 <entry>Type: <emphasis>domain list</emphasis>&dagger;<emphasis></emphasis></entry>
33279 <entry>Default: <emphasis>unset</emphasis></entry>
33280 </row>
33281 </tbody>
33282 </tgroup>
33283 </informaltable>
33284 <para revisionflag="changed">
33285 <indexterm role="concept">
33286 <primary>MX record</primary>
33287 <secondary>security</secondary>
33288 </indexterm>
33289 <indexterm role="concept">
33290 <primary>DNSSEC</primary>
33291 <secondary>MX lookup</secondary>
33292 </indexterm>
33293 <indexterm role="concept">
33294 <primary>security</primary>
33295 <secondary>MX lookup</secondary>
33296 </indexterm>
33297 <indexterm role="concept">
33298 <primary>DNS</primary>
33299 <secondary>DNSSEC</secondary>
33300 </indexterm>
33301 DNS lookups for domains matching <option>dnssec_request_domains</option> will be done with
33302 the dnssec request bit set.
33303 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
33304 </para>
33305 <para revisionflag="changed">
33306 <indexterm role="option">
33307 <primary><option>dnssec_require_domains</option></primary>
33308 </indexterm>
33309 </para>
33310 <informaltable frame="all" revisionflag="changed">
33311 <tgroup cols="4" colsep="0" rowsep="0">
33312 <colspec colwidth="8*" align="left"/>
33313 <colspec colwidth="6*" align="center"/>
33314 <colspec colwidth="6*" align="center"/>
33315 <colspec colwidth="6*" align="right"/>
33316 <tbody>
33317 <row>
33318 <entry><option>dnssec_require_domains</option></entry>
33319 <entry>Use: <emphasis>dnslookup</emphasis></entry>
33320 <entry>Type: <emphasis>domain list</emphasis>&dagger;<emphasis></emphasis></entry>
33321 <entry>Default: <emphasis>unset</emphasis></entry>
33322 </row>
33323 </tbody>
33324 </tgroup>
33325 </informaltable>
33326 <para revisionflag="changed">
33327 <indexterm role="concept">
33328 <primary>MX record</primary>
33329 <secondary>security</secondary>
33330 </indexterm>
33331 <indexterm role="concept">
33332 <primary>DNSSEC</primary>
33333 <secondary>MX lookup</secondary>
33334 </indexterm>
33335 <indexterm role="concept">
33336 <primary>security</primary>
33337 <secondary>MX lookup</secondary>
33338 </indexterm>
33339 <indexterm role="concept">
33340 <primary>DNS</primary>
33341 <secondary>DNSSEC</secondary>
33342 </indexterm>
33343 DNS lookups for domains matching <option>dnssec_request_domains</option> will be done with
33344 the dnssec request bit set.  Any returns not having the Authenticated Data bit
33345 (AD bit) set wil be ignored and logged as a host-lookup failure.
33346 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
33347 </para>
33348 <para>
33349 <indexterm role="option">
33350 <primary><option>mx_domains</option></primary>
33351 </indexterm>
33352 </para>
33353 <informaltable frame="all">
33354 <tgroup cols="4" colsep="0" rowsep="0">
33355 <colspec colwidth="8*" align="left"/>
33356 <colspec colwidth="6*" align="center"/>
33357 <colspec colwidth="6*" align="center"/>
33358 <colspec colwidth="6*" align="right"/>
33359 <tbody>
33360 <row>
33361 <entry><option>mx_domains</option></entry>
33362 <entry>Use: <emphasis>dnslookup</emphasis></entry>
33363 <entry>Type: <emphasis>domain list</emphasis>&dagger;<emphasis></emphasis></entry>
33364 <entry>Default: <emphasis>unset</emphasis></entry>
33365 </row>
33366 </tbody>
33367 </tgroup>
33368 </informaltable>
33369 <para>
33370 <indexterm role="concept">
33371 <primary>MX record</primary>
33372 <secondary>required to exist</secondary>
33373 </indexterm>
33374 <indexterm role="concept">
33375 <primary>SRV record</primary>
33376 <secondary>required to exist</secondary>
33377 </indexterm>
33378 A domain that matches <option>mx_domains</option> is required to have either an MX or an SRV
33379 record in order to be recognized. (The name of this option could be improved.)
33380 For example, if all the mail hosts in <emphasis>fict.example</emphasis> are known to have MX
33381 records, except for those in <emphasis>discworld.fict.example</emphasis>, you could use this
33382 setting:
33383 </para>
33384 <literallayout class="monospaced">
33385 mx_domains = ! *.discworld.fict.example : *.fict.example
33386 </literallayout>
33387 <para>
33388 This specifies that messages addressed to a domain that matches the list but
33389 has no MX record should be bounced immediately instead of being routed using
33390 the address record.
33391 </para>
33392 <para>
33393 <indexterm role="option">
33394 <primary><option>mx_fail_domains</option></primary>
33395 </indexterm>
33396 </para>
33397 <informaltable frame="all">
33398 <tgroup cols="4" colsep="0" rowsep="0">
33399 <colspec colwidth="8*" align="left"/>
33400 <colspec colwidth="6*" align="center"/>
33401 <colspec colwidth="6*" align="center"/>
33402 <colspec colwidth="6*" align="right"/>
33403 <tbody>
33404 <row>
33405 <entry><option>mx_fail_domains</option></entry>
33406 <entry>Use: <emphasis>dnslookup</emphasis></entry>
33407 <entry>Type: <emphasis>domain list</emphasis>&dagger;<emphasis></emphasis></entry>
33408 <entry>Default: <emphasis>unset</emphasis></entry>
33409 </row>
33410 </tbody>
33411 </tgroup>
33412 </informaltable>
33413 <para>
33414 If the DNS lookup for MX records for one of the domains in this list causes a
33415 DNS lookup error, Exim behaves as if no MX records were found. See section
33416 <xref linkend="SECTprowitdnsloo"/> for more discussion.
33417 </para>
33418 <para>
33419 <indexterm role="option">
33420 <primary><option>qualify_single</option></primary>
33421 </indexterm>
33422 </para>
33423 <informaltable frame="all">
33424 <tgroup cols="4" colsep="0" rowsep="0">
33425 <colspec colwidth="8*" align="left"/>
33426 <colspec colwidth="6*" align="center"/>
33427 <colspec colwidth="6*" align="center"/>
33428 <colspec colwidth="6*" align="right"/>
33429 <tbody>
33430 <row>
33431 <entry><option>qualify_single</option></entry>
33432 <entry>Use: <emphasis>dnslookup</emphasis></entry>
33433 <entry>Type: <emphasis>boolean</emphasis></entry>
33434 <entry>Default: <emphasis>true</emphasis></entry>
33435 </row>
33436 </tbody>
33437 </tgroup>
33438 </informaltable>
33439 <para>
33440 <indexterm role="concept">
33441 <primary>DNS</primary>
33442 <secondary>resolver options</secondary>
33443 </indexterm>
33444 <indexterm role="concept">
33445 <primary>DNS</primary>
33446 <secondary>qualifying single-component names</secondary>
33447 </indexterm>
33448 When this option is true, the resolver option RES_DEFNAMES is set for DNS
33449 lookups. Typically, but not standardly, this causes the resolver to qualify
33450 single-component names with the default domain. For example, on a machine
33451 called <emphasis>dictionary.ref.example</emphasis>, the domain <emphasis>thesaurus</emphasis> would be changed to
33452 <emphasis>thesaurus.ref.example</emphasis> inside the resolver. For details of what your
33453 resolver actually does, consult your man pages for <emphasis>resolver</emphasis> and
33454 <emphasis>resolv.conf</emphasis>.
33455 </para>
33456 <para>
33457 <indexterm role="option">
33458 <primary><option>rewrite_headers</option></primary>
33459 </indexterm>
33460 </para>
33461 <informaltable frame="all">
33462 <tgroup cols="4" colsep="0" rowsep="0">
33463 <colspec colwidth="8*" align="left"/>
33464 <colspec colwidth="6*" align="center"/>
33465 <colspec colwidth="6*" align="center"/>
33466 <colspec colwidth="6*" align="right"/>
33467 <tbody>
33468 <row>
33469 <entry><option>rewrite_headers</option></entry>
33470 <entry>Use: <emphasis>dnslookup</emphasis></entry>
33471 <entry>Type: <emphasis>boolean</emphasis></entry>
33472 <entry>Default: <emphasis>true</emphasis></entry>
33473 </row>
33474 </tbody>
33475 </tgroup>
33476 </informaltable>
33477 <para>
33478 <indexterm role="concept">
33479 <primary>rewriting</primary>
33480 <secondary>header lines</secondary>
33481 </indexterm>
33482 <indexterm role="concept">
33483 <primary>header lines</primary>
33484 <secondary>rewriting</secondary>
33485 </indexterm>
33486 If the domain name in the address that is being processed is not fully
33487 qualified, it may be expanded to its full form by a DNS lookup. For example, if
33488 an address is specified as <emphasis>dormouse@teaparty</emphasis>, the domain might be
33489 expanded to <emphasis>teaparty.wonderland.fict.example</emphasis>. Domain expansion can also
33490 occur as a result of setting the <option>widen_domains</option> option. If
33491 <option>rewrite_headers</option> is true, all occurrences of the abbreviated domain name in
33492 any <emphasis>Bcc:</emphasis>, <emphasis>Cc:</emphasis>, <emphasis>From:</emphasis>, <emphasis>Reply-to:</emphasis>, <emphasis>Sender:</emphasis>, and <emphasis>To:</emphasis>
33493 header lines of the message are rewritten with the full domain name.
33494 </para>
33495 <para>
33496 This option should be turned off only when it is known that no message is
33497 ever going to be sent outside an environment where the abbreviation makes
33498 sense.
33499 </para>
33500 <para>
33501 When an MX record is looked up in the DNS and matches a wildcard record, name
33502 servers normally return a record containing the name that has been looked up,
33503 making it impossible to detect whether a wildcard was present or not. However,
33504 some name servers have recently been seen to return the wildcard entry. If the
33505 name returned by a DNS lookup begins with an asterisk, it is not used for
33506 header rewriting.
33507 </para>
33508 <para>
33509 <indexterm role="option">
33510 <primary><option>same_domain_copy_routing</option></primary>
33511 </indexterm>
33512 </para>
33513 <informaltable frame="all">
33514 <tgroup cols="4" colsep="0" rowsep="0">
33515 <colspec colwidth="8*" align="left"/>
33516 <colspec colwidth="6*" align="center"/>
33517 <colspec colwidth="6*" align="center"/>
33518 <colspec colwidth="6*" align="right"/>
33519 <tbody>
33520 <row>
33521 <entry><option>same_domain_copy_routing</option></entry>
33522 <entry>Use: <emphasis>dnslookup</emphasis></entry>
33523 <entry>Type: <emphasis>boolean</emphasis></entry>
33524 <entry>Default: <emphasis>false</emphasis></entry>
33525 </row>
33526 </tbody>
33527 </tgroup>
33528 </informaltable>
33529 <para>
33530 <indexterm role="concept">
33531 <primary>address</primary>
33532 <secondary>copying routing</secondary>
33533 </indexterm>
33534 Addresses with the same domain are normally routed by the <command>dnslookup</command> router
33535 to the same list of hosts. However, this cannot be presumed, because the router
33536 options and preconditions may refer to the local part of the address. By
33537 default, therefore, Exim routes each address in a message independently. DNS
33538 servers run caches, so repeated DNS lookups are not normally expensive, and in
33539 any case, personal messages rarely have more than a few recipients.
33540 </para>
33541 <para>
33542 If you are running mailing lists with large numbers of subscribers at the same
33543 domain, and you are using a <command>dnslookup</command> router which is independent of the
33544 local part, you can set <option>same_domain_copy_routing</option> to bypass repeated DNS
33545 lookups for identical domains in one message. In this case, when <command>dnslookup</command>
33546 routes an address to a remote transport, any other unrouted addresses in the
33547 message that have the same domain are automatically given the same routing
33548 without processing them independently,
33549 provided the following conditions are met:
33550 </para>
33551 <itemizedlist>
33552 <listitem>
33553 <para>
33554 No router that processed the address specified <option>headers_add</option> or
33555 <option>headers_remove</option>.
33556 </para>
33557 </listitem>
33558 <listitem>
33559 <para>
33560 The router did not change the address in any way, for example, by <quote>widening</quote>
33561 the domain.
33562 </para>
33563 </listitem>
33564 </itemizedlist>
33565 <para>
33566 <indexterm role="option">
33567 <primary><option>search_parents</option></primary>
33568 </indexterm>
33569 </para>
33570 <informaltable frame="all">
33571 <tgroup cols="4" colsep="0" rowsep="0">
33572 <colspec colwidth="8*" align="left"/>
33573 <colspec colwidth="6*" align="center"/>
33574 <colspec colwidth="6*" align="center"/>
33575 <colspec colwidth="6*" align="right"/>
33576 <tbody>
33577 <row>
33578 <entry><option>search_parents</option></entry>
33579 <entry>Use: <emphasis>dnslookup</emphasis></entry>
33580 <entry>Type: <emphasis>boolean</emphasis></entry>
33581 <entry>Default: <emphasis>false</emphasis></entry>
33582 </row>
33583 </tbody>
33584 </tgroup>
33585 </informaltable>
33586 <para>
33587 <indexterm role="concept">
33588 <primary>DNS</primary>
33589 <secondary>resolver options</secondary>
33590 </indexterm>
33591 When this option is true, the resolver option RES_DNSRCH is set for DNS
33592 lookups. This is different from the <option>qualify_single</option> option in that it
33593 applies to domains containing dots. Typically, but not standardly, it causes
33594 the resolver to search for the name in the current domain and in parent
33595 domains. For example, on a machine in the <emphasis>fict.example</emphasis> domain, if looking
33596 up <emphasis>teaparty.wonderland</emphasis> failed, the resolver would try
33597 <emphasis>teaparty.wonderland.fict.example</emphasis>. For details of what your resolver
33598 actually does, consult your man pages for <emphasis>resolver</emphasis> and <emphasis>resolv.conf</emphasis>.
33599 </para>
33600 <para>
33601 Setting this option true can cause problems in domains that have a wildcard MX
33602 record, because any domain that does not have its own MX record matches the
33603 local wildcard.
33604 </para>
33605 <para>
33606 <indexterm role="option">
33607 <primary><option>srv_fail_domains</option></primary>
33608 </indexterm>
33609 </para>
33610 <informaltable frame="all">
33611 <tgroup cols="4" colsep="0" rowsep="0">
33612 <colspec colwidth="8*" align="left"/>
33613 <colspec colwidth="6*" align="center"/>
33614 <colspec colwidth="6*" align="center"/>
33615 <colspec colwidth="6*" align="right"/>
33616 <tbody>
33617 <row>
33618 <entry><option>srv_fail_domains</option></entry>
33619 <entry>Use: <emphasis>dnslookup</emphasis></entry>
33620 <entry>Type: <emphasis>domain list</emphasis>&dagger;<emphasis></emphasis></entry>
33621 <entry>Default: <emphasis>unset</emphasis></entry>
33622 </row>
33623 </tbody>
33624 </tgroup>
33625 </informaltable>
33626 <para>
33627 If the DNS lookup for SRV records for one of the domains in this list causes a
33628 DNS lookup error, Exim behaves as if no SRV records were found. See section
33629 <xref linkend="SECTprowitdnsloo"/> for more discussion.
33630 </para>
33631 <para>
33632 <indexterm role="option">
33633 <primary><option>widen_domains</option></primary>
33634 </indexterm>
33635 </para>
33636 <informaltable frame="all">
33637 <tgroup cols="4" colsep="0" rowsep="0">
33638 <colspec colwidth="8*" align="left"/>
33639 <colspec colwidth="6*" align="center"/>
33640 <colspec colwidth="6*" align="center"/>
33641 <colspec colwidth="6*" align="right"/>
33642 <tbody>
33643 <row>
33644 <entry><option>widen_domains</option></entry>
33645 <entry>Use: <emphasis>dnslookup</emphasis></entry>
33646 <entry>Type: <emphasis>string list</emphasis></entry>
33647 <entry>Default: <emphasis>unset</emphasis></entry>
33648 </row>
33649 </tbody>
33650 </tgroup>
33651 </informaltable>
33652 <para>
33653 <indexterm role="concept">
33654 <primary>domain</primary>
33655 <secondary>partial; widening</secondary>
33656 </indexterm>
33657 If a DNS lookup fails and this option is set, each of its strings in turn is
33658 added onto the end of the domain, and the lookup is tried again. For example,
33659 if
33660 </para>
33661 <literallayout class="monospaced">
33662 widen_domains = fict.example:ref.example
33663 </literallayout>
33664 <para>
33665 is set and a lookup of <emphasis>klingon.dictionary</emphasis> fails,
33666 <emphasis>klingon.dictionary.fict.example</emphasis> is looked up, and if this fails,
33667 <emphasis>klingon.dictionary.ref.example</emphasis> is tried. Note that the <option>qualify_single</option>
33668 and <option>search_parents</option> options can cause some widening to be undertaken inside
33669 the DNS resolver. <option>widen_domains</option> is not applied to sender addresses
33670 when verifying, unless <option>rewrite_headers</option> is false (not the default).
33671 </para>
33672 </section>
33673 <section id="SECID119">
33674 <title>Effect of qualify_single and search_parents</title>
33675 <para>
33676 When a domain from an envelope recipient is changed by the resolver as a result
33677 of the <option>qualify_single</option> or <option>search_parents</option> options, Exim rewrites the
33678 corresponding address in the message&#x2019;s header lines unless <option>rewrite_headers</option>
33679 is set false. Exim then re-routes the address, using the full domain.
33680 </para>
33681 <para>
33682 These two options affect only the DNS lookup that takes place inside the router
33683 for the domain of the address that is being routed. They do not affect lookups
33684 such as that implied by
33685 </para>
33686 <literallayout class="monospaced">
33687 domains = @mx_any
33688 </literallayout>
33689 <para>
33690 that may happen while processing a router precondition before the router is
33691 entered. No widening ever takes place for these lookups.
33692 <indexterm role="concept" startref="IIDdnsrou1" class="endofrange"/>
33693 <indexterm role="concept" startref="IIDdnsrou2" class="endofrange"/>
33694 </para>
33695 </section>
33696 </chapter>
33697
33698 <chapter id="CHID5">
33699 <title>The ipliteral router</title>
33700 <para>
33701 <indexterm role="concept">
33702 <primary><command>ipliteral</command> router</primary>
33703 </indexterm>
33704 <indexterm role="concept">
33705 <primary>domain literal</primary>
33706 <secondary>routing</secondary>
33707 </indexterm>
33708 <indexterm role="concept">
33709 <primary>routers</primary>
33710 <secondary><command>ipliteral</command></secondary>
33711 </indexterm>
33712 This router has no private options. Unless it is being used purely for
33713 verification (see <option>verify_only</option>) a transport is required to be defined by the
33714 generic <option>transport</option> option. The router accepts the address if its domain part
33715 takes the form of an RFC 2822 domain literal. For example, the <command>ipliteral</command>
33716 router handles the address
33717 </para>
33718 <literallayout class="monospaced">
33719 root@[192.168.1.1]
33720 </literallayout>
33721 <para>
33722 by setting up delivery to the host with that IP address. IPv4 domain literals
33723 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
33724 are similar, but the address is preceded by <literal>ipv6:</literal>. For example:
33725 </para>
33726 <literallayout class="monospaced">
33727 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
33728 </literallayout>
33729 <para>
33730 Exim allows <literal>ipv4:</literal> before IPv4 addresses, for consistency, and on the
33731 grounds that sooner or later somebody will try it.
33732 </para>
33733 <para>
33734 <indexterm role="option">
33735 <primary><option>self</option></primary>
33736 <secondary>in <command>ipliteral</command> router</secondary>
33737 </indexterm>
33738 If the IP address matches something in <option>ignore_target_hosts</option>, the router
33739 declines. If an IP literal turns out to refer to the local host, the generic
33740 <option>self</option> option determines what happens.
33741 </para>
33742 <para>
33743 The RFCs require support for domain literals; however, their use is
33744 controversial in today&#x2019;s Internet. If you want to use this router, you must
33745 also set the main configuration option <option>allow_domain_literals</option>. Otherwise,
33746 Exim will not recognize the domain literal syntax in addresses.
33747 </para>
33748 </chapter>
33749
33750 <chapter id="CHID6">
33751 <title>The iplookup router</title>
33752 <para>
33753 <indexterm role="concept">
33754 <primary><command>iplookup</command> router</primary>
33755 </indexterm>
33756 <indexterm role="concept">
33757 <primary>routers</primary>
33758 <secondary><command>iplookup</command></secondary>
33759 </indexterm>
33760 The <command>iplookup</command> router was written to fulfil a specific requirement in
33761 Cambridge University (which in fact no longer exists). For this reason, it is
33762 not included in the binary of Exim by default. If you want to include it, you
33763 must set
33764 </para>
33765 <literallayout class="monospaced">
33766 ROUTER_IPLOOKUP=yes
33767 </literallayout>
33768 <para>
33769 in your <filename>Local/Makefile</filename> configuration file.
33770 </para>
33771 <para>
33772 The <command>iplookup</command> router routes an address by sending it over a TCP or UDP
33773 connection to one or more specific hosts. The host can then return the same or
33774 a different address &ndash; in effect rewriting the recipient address in the
33775 message&#x2019;s envelope. The new address is then passed on to subsequent routers. If
33776 this process fails, the address can be passed on to other routers, or delivery
33777 can be deferred. Since <command>iplookup</command> is just a rewriting router, a transport
33778 must not be specified for it.
33779 </para>
33780 <para>
33781 <indexterm role="concept">
33782 <primary>options</primary>
33783 <secondary><command>iplookup</command> router</secondary>
33784 </indexterm>
33785 <indexterm role="option">
33786 <primary><option>hosts</option></primary>
33787 </indexterm>
33788 </para>
33789 <informaltable frame="all">
33790 <tgroup cols="4" colsep="0" rowsep="0">
33791 <colspec colwidth="8*" align="left"/>
33792 <colspec colwidth="6*" align="center"/>
33793 <colspec colwidth="6*" align="center"/>
33794 <colspec colwidth="6*" align="right"/>
33795 <tbody>
33796 <row>
33797 <entry><option>hosts</option></entry>
33798 <entry>Use: <emphasis>iplookup</emphasis></entry>
33799 <entry>Type: <emphasis>string</emphasis></entry>
33800 <entry>Default: <emphasis>unset</emphasis></entry>
33801 </row>
33802 </tbody>
33803 </tgroup>
33804 </informaltable>
33805 <para>
33806 This option must be supplied. Its value is a colon-separated list of host
33807 names. The hosts are looked up using <function>gethostbyname()</function>
33808 (or <function>getipnodebyname()</function> when available)
33809 and are tried in order until one responds to the query. If none respond, what
33810 happens is controlled by <option>optional</option>.
33811 </para>
33812 <para>
33813 <indexterm role="option">
33814 <primary><option>optional</option></primary>
33815 </indexterm>
33816 </para>
33817 <informaltable frame="all">
33818 <tgroup cols="4" colsep="0" rowsep="0">
33819 <colspec colwidth="8*" align="left"/>
33820 <colspec colwidth="6*" align="center"/>
33821 <colspec colwidth="6*" align="center"/>
33822 <colspec colwidth="6*" align="right"/>
33823 <tbody>
33824 <row>
33825 <entry><option>optional</option></entry>
33826 <entry>Use: <emphasis>iplookup</emphasis></entry>
33827 <entry>Type: <emphasis>boolean</emphasis></entry>
33828 <entry>Default: <emphasis>false</emphasis></entry>
33829 </row>
33830 </tbody>
33831 </tgroup>
33832 </informaltable>
33833 <para>
33834 If <option>optional</option> is true, if no response is obtained from any host, the address
33835 is passed to the next router, overriding <option>no_more</option>. If <option>optional</option> is false,
33836 delivery to the address is deferred.
33837 </para>
33838 <para>
33839 <indexterm role="option">
33840 <primary><option>port</option></primary>
33841 </indexterm>
33842 </para>
33843 <informaltable frame="all">
33844 <tgroup cols="4" colsep="0" rowsep="0">
33845 <colspec colwidth="8*" align="left"/>
33846 <colspec colwidth="6*" align="center"/>
33847 <colspec colwidth="6*" align="center"/>
33848 <colspec colwidth="6*" align="right"/>
33849 <tbody>
33850 <row>
33851 <entry><option>port</option></entry>
33852 <entry>Use: <emphasis>iplookup</emphasis></entry>
33853 <entry>Type: <emphasis>integer</emphasis></entry>
33854 <entry>Default: <emphasis>0</emphasis></entry>
33855 </row>
33856 </tbody>
33857 </tgroup>
33858 </informaltable>
33859 <para>
33860 <indexterm role="concept">
33861 <primary>port</primary>
33862 <secondary><command>iplookup</command> router</secondary>
33863 </indexterm>
33864 This option must be supplied. It specifies the port number for the TCP or UDP
33865 call.
33866 </para>
33867 <para>
33868 <indexterm role="option">
33869 <primary><option>protocol</option></primary>
33870 </indexterm>
33871 </para>
33872 <informaltable frame="all">
33873 <tgroup cols="4" colsep="0" rowsep="0">
33874 <colspec colwidth="8*" align="left"/>
33875 <colspec colwidth="6*" align="center"/>
33876 <colspec colwidth="6*" align="center"/>
33877 <colspec colwidth="6*" align="right"/>
33878 <tbody>
33879 <row>
33880 <entry><option>protocol</option></entry>
33881 <entry>Use: <emphasis>iplookup</emphasis></entry>
33882 <entry>Type: <emphasis>string</emphasis></entry>
33883 <entry>Default: <emphasis>udp</emphasis></entry>
33884 </row>
33885 </tbody>
33886 </tgroup>
33887 </informaltable>
33888 <para>
33889 This option can be set to <quote>udp</quote> or <quote>tcp</quote> to specify which of the two
33890 protocols is to be used.
33891 </para>
33892 <para>
33893 <indexterm role="option">
33894 <primary><option>query</option></primary>
33895 </indexterm>
33896 </para>
33897 <informaltable frame="all">
33898 <tgroup cols="4" colsep="0" rowsep="0">
33899 <colspec colwidth="8*" align="left"/>
33900 <colspec colwidth="6*" align="center"/>
33901 <colspec colwidth="6*" align="center"/>
33902 <colspec colwidth="6*" align="right"/>
33903 <tbody>
33904 <row>
33905 <entry><option>query</option></entry>
33906 <entry>Use: <emphasis>iplookup</emphasis></entry>
33907 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
33908 <entry>Default: <emphasis>see below</emphasis></entry>
33909 </row>
33910 </tbody>
33911 </tgroup>
33912 </informaltable>
33913 <para>
33914 This defines the content of the query that is sent to the remote hosts. The
33915 default value is:
33916 </para>
33917 <literallayout class="monospaced">
33918 $local_part@$domain $local_part@$domain
33919 </literallayout>
33920 <para>
33921 The repetition serves as a way of checking that a response is to the correct
33922 query in the default case (see <option>response_pattern</option> below).
33923 </para>
33924 <para>
33925 <indexterm role="option">
33926 <primary><option>reroute</option></primary>
33927 </indexterm>
33928 </para>
33929 <informaltable frame="all">
33930 <tgroup cols="4" colsep="0" rowsep="0">
33931 <colspec colwidth="8*" align="left"/>
33932 <colspec colwidth="6*" align="center"/>
33933 <colspec colwidth="6*" align="center"/>
33934 <colspec colwidth="6*" align="right"/>
33935 <tbody>
33936 <row>
33937 <entry><option>reroute</option></entry>
33938 <entry>Use: <emphasis>iplookup</emphasis></entry>
33939 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
33940 <entry>Default: <emphasis>unset</emphasis></entry>
33941 </row>
33942 </tbody>
33943 </tgroup>
33944 </informaltable>
33945 <para>
33946 If this option is not set, the rerouted address is precisely the byte string
33947 returned by the remote host, up to the first white space, if any. If set, the
33948 string is expanded to form the rerouted address. It can include parts matched
33949 in the response by <option>response_pattern</option> by means of numeric variables such as
33950 <varname>$1</varname>, <varname>$2</varname>, etc. The variable <varname>$0</varname> refers to the entire input string,
33951 whether or not a pattern is in use. In all cases, the rerouted address must end
33952 up in the form <emphasis>local_part@domain</emphasis>.
33953 </para>
33954 <para>
33955 <indexterm role="option">
33956 <primary><option>response_pattern</option></primary>
33957 </indexterm>
33958 </para>
33959 <informaltable frame="all">
33960 <tgroup cols="4" colsep="0" rowsep="0">
33961 <colspec colwidth="8*" align="left"/>
33962 <colspec colwidth="6*" align="center"/>
33963 <colspec colwidth="6*" align="center"/>
33964 <colspec colwidth="6*" align="right"/>
33965 <tbody>
33966 <row>
33967 <entry><option>response_pattern</option></entry>
33968 <entry>Use: <emphasis>iplookup</emphasis></entry>
33969 <entry>Type: <emphasis>string</emphasis></entry>
33970 <entry>Default: <emphasis>unset</emphasis></entry>
33971 </row>
33972 </tbody>
33973 </tgroup>
33974 </informaltable>
33975 <para>
33976 This option can be set to a regular expression that is applied to the string
33977 returned from the remote host. If the pattern does not match the response, the
33978 router declines. If <option>response_pattern</option> is not set, no checking of the
33979 response is done, unless the query was defaulted, in which case there is a
33980 check that the text returned after the first white space is the original
33981 address. This checks that the answer that has been received is in response to
33982 the correct question. For example, if the response is just a new domain, the
33983 following could be used:
33984 </para>
33985 <literallayout class="monospaced">
33986 response_pattern = ^([^@]+)$
33987 reroute = $local_part@$1
33988 </literallayout>
33989 <para>
33990 <indexterm role="option">
33991 <primary><option>timeout</option></primary>
33992 </indexterm>
33993 </para>
33994 <informaltable frame="all">
33995 <tgroup cols="4" colsep="0" rowsep="0">
33996 <colspec colwidth="8*" align="left"/>
33997 <colspec colwidth="6*" align="center"/>
33998 <colspec colwidth="6*" align="center"/>
33999 <colspec colwidth="6*" align="right"/>
34000 <tbody>
34001 <row>
34002 <entry><option>timeout</option></entry>
34003 <entry>Use: <emphasis>iplookup</emphasis></entry>
34004 <entry>Type: <emphasis>time</emphasis></entry>
34005 <entry>Default: <emphasis>5s</emphasis></entry>
34006 </row>
34007 </tbody>
34008 </tgroup>
34009 </informaltable>
34010 <para>
34011 This specifies the amount of time to wait for a response from the remote
34012 machine. The same timeout is used for the <function>connect()</function> function for a TCP
34013 call. It does not apply to UDP.
34014 </para>
34015 </chapter>
34016
34017 <chapter id="CHID7">
34018 <title>The manualroute router</title>
34019 <para>
34020 <indexterm role="concept" id="IIDmanrou1" class="startofrange">
34021 <primary><command>manualroute</command> router</primary>
34022 </indexterm>
34023 <indexterm role="concept" id="IIDmanrou2" class="startofrange">
34024 <primary>routers</primary>
34025 <secondary><command>manualroute</command></secondary>
34026 </indexterm>
34027 <indexterm role="concept">
34028 <primary>domain</primary>
34029 <secondary>manually routing</secondary>
34030 </indexterm>
34031 The <command>manualroute</command> router is so-called because it provides a way of manually
34032 routing an address according to its domain. It is mainly used when you want to
34033 route addresses to remote hosts according to your own rules, bypassing the
34034 normal DNS routing that looks up MX records. However, <command>manualroute</command> can also
34035 route to local transports, a facility that may be useful if you want to save
34036 messages for dial-in hosts in local files.
34037 </para>
34038 <para>
34039 The <command>manualroute</command> router compares a list of domain patterns with the domain
34040 it is trying to route. If there is no match, the router declines. Each pattern
34041 has associated with it a list of hosts and some other optional data, which may
34042 include a transport. The combination of a pattern and its data is called a
34043 <quote>routing rule</quote>. For patterns that do not have an associated transport, the
34044 generic <option>transport</option> option must specify a transport, unless the router is
34045 being used purely for verification (see <option>verify_only</option>).
34046 </para>
34047 <para>
34048 <indexterm role="variable">
34049 <primary><varname>$host</varname></primary>
34050 </indexterm>
34051 In the case of verification, matching the domain pattern is sufficient for the
34052 router to accept the address. When actually routing an address for delivery,
34053 an address that matches a domain pattern is queued for the associated
34054 transport. If the transport is not a local one, a host list must be associated
34055 with the pattern; IP addresses are looked up for the hosts, and these are
34056 passed to the transport along with the mail address. For local transports, a
34057 host list is optional. If it is present, it is passed in <varname>$host</varname> as a single
34058 text string.
34059 </para>
34060 <para>
34061 The list of routing rules can be provided as an inline string in
34062 <option>route_list</option>, or the data can be obtained by looking up the domain in a file
34063 or database by setting <option>route_data</option>. Only one of these settings may appear in
34064 any one instance of <command>manualroute</command>. The format of routing rules is described
34065 below, following the list of private options.
34066 </para>
34067 <section id="SECTprioptman">
34068 <title>Private options for manualroute</title>
34069 <para>
34070 <indexterm role="concept">
34071 <primary>options</primary>
34072 <secondary><command>manualroute</command> router</secondary>
34073 </indexterm>
34074 The private options for the <command>manualroute</command> router are as follows:
34075 </para>
34076 <para>
34077 <indexterm role="option">
34078 <primary><option>host_all_ignored</option></primary>
34079 </indexterm>
34080 </para>
34081 <informaltable frame="all">
34082 <tgroup cols="4" colsep="0" rowsep="0">
34083 <colspec colwidth="8*" align="left"/>
34084 <colspec colwidth="6*" align="center"/>
34085 <colspec colwidth="6*" align="center"/>
34086 <colspec colwidth="6*" align="right"/>
34087 <tbody>
34088 <row>
34089 <entry><option>host_all_ignored</option></entry>
34090 <entry>Use: <emphasis>manualroute</emphasis></entry>
34091 <entry>Type: <emphasis>string</emphasis></entry>
34092 <entry>Default: <emphasis>defer</emphasis></entry>
34093 </row>
34094 </tbody>
34095 </tgroup>
34096 </informaltable>
34097 <para>
34098 See <option>host_find_failed</option>.
34099 </para>
34100 <para>
34101 <indexterm role="option">
34102 <primary><option>host_find_failed</option></primary>
34103 </indexterm>
34104 </para>
34105 <informaltable frame="all">
34106 <tgroup cols="4" colsep="0" rowsep="0">
34107 <colspec colwidth="8*" align="left"/>
34108 <colspec colwidth="6*" align="center"/>
34109 <colspec colwidth="6*" align="center"/>
34110 <colspec colwidth="6*" align="right"/>
34111 <tbody>
34112 <row>
34113 <entry><option>host_find_failed</option></entry>
34114 <entry>Use: <emphasis>manualroute</emphasis></entry>
34115 <entry>Type: <emphasis>string</emphasis></entry>
34116 <entry>Default: <emphasis>freeze</emphasis></entry>
34117 </row>
34118 </tbody>
34119 </tgroup>
34120 </informaltable>
34121 <para>
34122 This option controls what happens when <command>manualroute</command> tries to find an IP
34123 address for a host, and the host does not exist. The option can be set to one
34124 of the following values:
34125 </para>
34126 <literallayout class="monospaced">
34127 decline
34128 defer
34129 fail
34130 freeze
34131 ignore
34132 pass
34133 </literallayout>
34134 <para>
34135 The default (<quote>freeze</quote>) assumes that this state is a serious configuration
34136 error. The difference between <quote>pass</quote> and <quote>decline</quote> is that the former
34137 forces the address to be passed to the next router (or the router defined by
34138 <option>pass_router</option>),
34139 <indexterm role="option">
34140 <primary><option>more</option></primary>
34141 </indexterm>
34142 overriding <option>no_more</option>, whereas the latter passes the address to the next
34143 router only if <option>more</option> is true.
34144 </para>
34145 <para>
34146 The value <quote>ignore</quote> causes Exim to completely ignore a host whose IP address
34147 cannot be found. If all the hosts in the list are ignored, the behaviour is
34148 controlled by the <option>host_all_ignored</option> option. This takes the same values
34149 as <option>host_find_failed</option>, except that it cannot be set to <quote>ignore</quote>.
34150 </para>
34151 <para>
34152 The <option>host_find_failed</option> option applies only to a definite <quote>does not exist</quote>
34153 state; if a host lookup gets a temporary error, delivery is deferred unless the
34154 generic <option>pass_on_timeout</option> option is set.
34155 </para>
34156 <para>
34157 <indexterm role="option">
34158 <primary><option>hosts_randomize</option></primary>
34159 </indexterm>
34160 </para>
34161 <informaltable frame="all">
34162 <tgroup cols="4" colsep="0" rowsep="0">
34163 <colspec colwidth="8*" align="left"/>
34164 <colspec colwidth="6*" align="center"/>
34165 <colspec colwidth="6*" align="center"/>
34166 <colspec colwidth="6*" align="right"/>
34167 <tbody>
34168 <row>
34169 <entry><option>hosts_randomize</option></entry>
34170 <entry>Use: <emphasis>manualroute</emphasis></entry>
34171 <entry>Type: <emphasis>boolean</emphasis></entry>
34172 <entry>Default: <emphasis>false</emphasis></entry>
34173 </row>
34174 </tbody>
34175 </tgroup>
34176 </informaltable>
34177 <para>
34178 <indexterm role="concept">
34179 <primary>randomized host list</primary>
34180 </indexterm>
34181 <indexterm role="concept">
34182 <primary>host</primary>
34183 <secondary>list of; randomized</secondary>
34184 </indexterm>
34185 If this option is set, the order of the items in a host list in a routing rule
34186 is randomized each time the list is used, unless an option in the routing rule
34187 overrides (see below). Randomizing the order of a host list can be used to do
34188 crude load sharing. However, if more than one mail address is routed by the
34189 same router to the same host list, the host lists are considered to be the same
34190 (even though they may be randomized into different orders) for the purpose of
34191 deciding whether to batch the deliveries into a single SMTP transaction.
34192 </para>
34193 <para>
34194 When <option>hosts_randomize</option> is true, a host list may be split
34195 into groups whose order is separately randomized. This makes it possible to
34196 set up MX-like behaviour. The boundaries between groups are indicated by an
34197 item that is just <literal>+</literal> in the host list. For example:
34198 </para>
34199 <literallayout class="monospaced">
34200 route_list = * host1:host2:host3:+:host4:host5
34201 </literallayout>
34202 <para>
34203 The order of the first three hosts and the order of the last two hosts is
34204 randomized for each use, but the first three always end up before the last two.
34205 If <option>hosts_randomize</option> is not set, a <literal>+</literal> item in the list is ignored. If a
34206 randomized host list is passed to an <command>smtp</command> transport that also has
34207 <option>hosts_randomize set</option>, the list is not re-randomized.
34208 </para>
34209 <para>
34210 <indexterm role="option">
34211 <primary><option>route_data</option></primary>
34212 </indexterm>
34213 </para>
34214 <informaltable frame="all">
34215 <tgroup cols="4" colsep="0" rowsep="0">
34216 <colspec colwidth="8*" align="left"/>
34217 <colspec colwidth="6*" align="center"/>
34218 <colspec colwidth="6*" align="center"/>
34219 <colspec colwidth="6*" align="right"/>
34220 <tbody>
34221 <row>
34222 <entry><option>route_data</option></entry>
34223 <entry>Use: <emphasis>manualroute</emphasis></entry>
34224 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
34225 <entry>Default: <emphasis>unset</emphasis></entry>
34226 </row>
34227 </tbody>
34228 </tgroup>
34229 </informaltable>
34230 <para>
34231 If this option is set, it must expand to yield the data part of a routing rule.
34232 Typically, the expansion string includes a lookup based on the domain. For
34233 example:
34234 </para>
34235 <literallayout class="monospaced">
34236 route_data = ${lookup{$domain}dbm{/etc/routes}}
34237 </literallayout>
34238 <para>
34239 If the expansion is forced to fail, or the result is an empty string, the
34240 router declines. Other kinds of expansion failure cause delivery to be
34241 deferred.
34242 </para>
34243 <para>
34244 <indexterm role="option">
34245 <primary><option>route_list</option></primary>
34246 </indexterm>
34247 </para>
34248 <informaltable frame="all">
34249 <tgroup cols="4" colsep="0" rowsep="0">
34250 <colspec colwidth="8*" align="left"/>
34251 <colspec colwidth="6*" align="center"/>
34252 <colspec colwidth="6*" align="center"/>
34253 <colspec colwidth="6*" align="right"/>
34254 <tbody>
34255 <row>
34256 <entry><option>route_list</option></entry>
34257 <entry>Use: <emphasis>manualroute</emphasis></entry>
34258 <entry>Type: <emphasis>string list</emphasis></entry>
34259 <entry>Default: <emphasis>unset</emphasis></entry>
34260 </row>
34261 </tbody>
34262 </tgroup>
34263 </informaltable>
34264 <para>
34265 This string is a list of routing rules, in the form defined below. Note that,
34266 unlike most string lists, the items are separated by semicolons. This is so
34267 that they may contain colon-separated host lists.
34268 </para>
34269 <para>
34270 <indexterm role="option">
34271 <primary><option>same_domain_copy_routing</option></primary>
34272 </indexterm>
34273 </para>
34274 <informaltable frame="all">
34275 <tgroup cols="4" colsep="0" rowsep="0">
34276 <colspec colwidth="8*" align="left"/>
34277 <colspec colwidth="6*" align="center"/>
34278 <colspec colwidth="6*" align="center"/>
34279 <colspec colwidth="6*" align="right"/>
34280 <tbody>
34281 <row>
34282 <entry><option>same_domain_copy_routing</option></entry>
34283 <entry>Use: <emphasis>manualroute</emphasis></entry>
34284 <entry>Type: <emphasis>boolean</emphasis></entry>
34285 <entry>Default: <emphasis>false</emphasis></entry>
34286 </row>
34287 </tbody>
34288 </tgroup>
34289 </informaltable>
34290 <para>
34291 <indexterm role="concept">
34292 <primary>address</primary>
34293 <secondary>copying routing</secondary>
34294 </indexterm>
34295 Addresses with the same domain are normally routed by the <command>manualroute</command>
34296 router to the same list of hosts. However, this cannot be presumed, because the
34297 router options and preconditions may refer to the local part of the address. By
34298 default, therefore, Exim routes each address in a message independently. DNS
34299 servers run caches, so repeated DNS lookups are not normally expensive, and in
34300 any case, personal messages rarely have more than a few recipients.
34301 </para>
34302 <para>
34303 If you are running mailing lists with large numbers of subscribers at the same
34304 domain, and you are using a <command>manualroute</command> router which is independent of the
34305 local part, you can set <option>same_domain_copy_routing</option> to bypass repeated DNS
34306 lookups for identical domains in one message. In this case, when
34307 <command>manualroute</command> routes an address to a remote transport, any other unrouted
34308 addresses in the message that have the same domain are automatically given the
34309 same routing without processing them independently. However, this is only done
34310 if <option>headers_add</option> and <option>headers_remove</option> are unset.
34311 </para>
34312 </section>
34313 <section id="SECID120">
34314 <title>Routing rules in route_list</title>
34315 <para>
34316 The value of <option>route_list</option> is a string consisting of a sequence of routing
34317 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
34318 entered as two semicolons. Alternatively, the list separator can be changed as
34319 described (for colon-separated lists) in section <xref linkend="SECTlistconstruct"/>.
34320 Empty rules are ignored. The format of each rule is
34321 </para>
34322 <literallayout>
34323 &lt;<emphasis>domain pattern</emphasis>&gt;  &lt;<emphasis>list of hosts</emphasis>&gt;  &lt;<emphasis>options</emphasis>&gt;
34324 </literallayout>
34325 <para>
34326 The following example contains two rules, each with a simple domain pattern and
34327 no options:
34328 </para>
34329 <literallayout class="monospaced">
34330 route_list = \
34331   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
34332   thes.ref.example  mail-3.ref.example:mail-4.ref.example
34333 </literallayout>
34334 <para>
34335 The three parts of a rule are separated by white space. The pattern and the
34336 list of hosts can be enclosed in quotes if necessary, and if they are, the
34337 usual quoting rules apply. Each rule in a <option>route_list</option> must start with a
34338 single domain pattern, which is the only mandatory item in the rule. The
34339 pattern is in the same format as one item in a domain list (see section
34340 <xref linkend="SECTdomainlist"/>),
34341 except that it may not be the name of an interpolated file.
34342 That is, it may be wildcarded, or a regular expression, or a file or database
34343 lookup (with semicolons doubled, because of the use of semicolon as a separator
34344 in a <option>route_list</option>).
34345 </para>
34346 <para>
34347 The rules in <option>route_list</option> are searched in order until one of the patterns
34348 matches the domain that is being routed. The list of hosts and then options are
34349 then used as described below. If there is no match, the router declines. When
34350 <option>route_list</option> is set, <option>route_data</option> must not be set.
34351 </para>
34352 </section>
34353 <section id="SECID121">
34354 <title>Routing rules in route_data</title>
34355 <para>
34356 The use of <option>route_list</option> is convenient when there are only a small number of
34357 routing rules. For larger numbers, it is easier to use a file or database to
34358 hold the routing information, and use the <option>route_data</option> option instead.
34359 The value of <option>route_data</option> is a list of hosts, followed by (optional) options.
34360 Most commonly, <option>route_data</option> is set as a string that contains an
34361 expansion lookup. For example, suppose we place two routing rules in a file
34362 like this:
34363 </para>
34364 <literallayout class="monospaced">
34365 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
34366 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
34367 </literallayout>
34368 <para>
34369 This data can be accessed by setting
34370 </para>
34371 <literallayout class="monospaced">
34372 route_data = ${lookup{$domain}lsearch{/the/file/name}}
34373 </literallayout>
34374 <para>
34375 Failure of the lookup results in an empty string, causing the router to
34376 decline. However, you do not have to use a lookup in <option>route_data</option>. The only
34377 requirement is that the result of expanding the string is a list of hosts,
34378 possibly followed by options, separated by white space. The list of hosts must
34379 be enclosed in quotes if it contains white space.
34380 </para>
34381 </section>
34382 <section id="SECID122">
34383 <title>Format of the list of hosts</title>
34384 <para>
34385 A list of hosts, whether obtained via <option>route_data</option> or <option>route_list</option>, is
34386 always separately expanded before use. If the expansion fails, the router
34387 declines. The result of the expansion must be a colon-separated list of names
34388 and/or IP addresses, optionally also including ports. The format of each item
34389 in the list is described in the next section. The list separator can be changed
34390 as described in section <xref linkend="SECTlistconstruct"/>.
34391 </para>
34392 <para>
34393 If the list of hosts was obtained from a <option>route_list</option> item, the following
34394 variables are set during its expansion:
34395 </para>
34396 <itemizedlist>
34397 <listitem>
34398 <para>
34399 <indexterm role="concept">
34400 <primary>numerical variables (<varname>$1</varname> <varname>$2</varname>  etc)</primary>
34401 <secondary>in <command>manualroute</command> router</secondary>
34402 </indexterm>
34403 If the domain was matched against a regular expression, the numeric variables
34404 <varname>$1</varname>, <varname>$2</varname>, etc. may be set. For example:
34405 </para>
34406 <literallayout class="monospaced">
34407 route_list = ^domain(\d+)   host-$1.text.example
34408 </literallayout>
34409 </listitem>
34410 <listitem>
34411 <para>
34412 <varname>$0</varname> is always set to the entire domain.
34413 </para>
34414 </listitem>
34415 <listitem>
34416 <para>
34417 <varname>$1</varname> is also set when partial matching is done in a file lookup.
34418 </para>
34419 </listitem>
34420 <listitem>
34421 <para>
34422 <indexterm role="variable">
34423 <primary><varname>$value</varname></primary>
34424 </indexterm>
34425 If the pattern that matched the domain was a lookup item, the data that was
34426 looked up is available in the expansion variable <varname>$value</varname>. For example:
34427 </para>
34428 <literallayout class="monospaced">
34429 route_list = lsearch;;/some/file.routes  $value
34430 </literallayout>
34431 </listitem>
34432 </itemizedlist>
34433 <para>
34434 Note the doubling of the semicolon in the pattern that is necessary because
34435 semicolon is the default route list separator.
34436 </para>
34437 </section>
34438 <section id="SECTformatonehostitem">
34439 <title>Format of one host item</title>
34440 <para>
34441 Each item in the list of hosts is either a host name or an IP address,
34442 optionally with an attached port number. When no port is given, an IP address
34443 is not enclosed in brackets. When a port is specified, it overrides the port
34444 specification on the transport. The port is separated from the name or address
34445 by a colon. This leads to some complications:
34446 </para>
34447 <itemizedlist>
34448 <listitem>
34449 <para>
34450 Because colon is the default separator for the list of hosts, either
34451 the colon that specifies a port must be doubled, or the list separator must
34452 be changed. The following two examples have the same effect:
34453 </para>
34454 <literallayout class="monospaced">
34455 route_list = * "host1.tld::1225 : host2.tld::1226"
34456 route_list = * "&lt;+ host1.tld:1225 + host2.tld:1226"
34457 </literallayout>
34458 </listitem>
34459 <listitem>
34460 <para>
34461 When IPv6 addresses are involved, it gets worse, because they contain
34462 colons of their own. To make this case easier, it is permitted to
34463 enclose an IP address (either v4 or v6) in square brackets if a port
34464 number follows. For example:
34465 </para>
34466 <literallayout class="monospaced">
34467 route_list = * "&lt;/ [10.1.1.1]:1225 / [::1]:1226"
34468 </literallayout>
34469 </listitem>
34470 </itemizedlist>
34471 </section>
34472 <section id="SECThostshowused">
34473 <title>How the list of hosts is used</title>
34474 <para>
34475 When an address is routed to an <command>smtp</command> transport by <command>manualroute</command>, each of
34476 the hosts is tried, in the order specified, when carrying out the SMTP
34477 delivery. However, the order can be changed by setting the <option>hosts_randomize</option>
34478 option, either on the router (see section <xref linkend="SECTprioptman"/> above), or on the
34479 transport.
34480 </para>
34481 <para>
34482 Hosts may be listed by name or by IP address. An unadorned name in the list of
34483 hosts is interpreted as a host name. A name that is followed by <literal>/MX</literal> is
34484 interpreted as an indirection to a sublist of hosts obtained by looking up MX
34485 records in the DNS. For example:
34486 </para>
34487 <literallayout class="monospaced">
34488 route_list = *  x.y.z:p.q.r/MX:e.f.g
34489 </literallayout>
34490 <para>
34491 If this feature is used with a port specifier, the port must come last. For
34492 example:
34493 </para>
34494 <literallayout class="monospaced">
34495 route_list = *  dom1.tld/mx::1225
34496 </literallayout>
34497 <para>
34498 If the <option>hosts_randomize</option> option is set, the order of the items in the list is
34499 randomized before any lookups are done. Exim then scans the list; for any name
34500 that is not followed by <literal>/MX</literal> it looks up an IP address. If this turns out to
34501 be an interface on the local host and the item is not the first in the list,
34502 Exim discards it and any subsequent items. If it is the first item, what
34503 happens is controlled by the
34504 <indexterm role="option">
34505 <primary><option>self</option></primary>
34506 <secondary>in <command>manualroute</command> router</secondary>
34507 </indexterm>
34508 <option>self</option> option of the router.
34509 </para>
34510 <para>
34511 A name on the list that is followed by <literal>/MX</literal> is replaced with the list of
34512 hosts obtained by looking up MX records for the name. This is always a DNS
34513 lookup; the <option>bydns</option> and <option>byname</option> options (see section <xref linkend="SECThowoptused"/>
34514 below) are not relevant here. The order of these hosts is determined by the
34515 preference values in the MX records, according to the usual rules. Because
34516 randomizing happens before the MX lookup, it does not affect the order that is
34517 defined by MX preferences.
34518 </para>
34519 <para>
34520 If the local host is present in the sublist obtained from MX records, but is
34521 not the most preferred host in that list, it and any equally or less
34522 preferred hosts are removed before the sublist is inserted into the main list.
34523 </para>
34524 <para>
34525 If the local host is the most preferred host in the MX list, what happens
34526 depends on where in the original list of hosts the <literal>/MX</literal> item appears. If it
34527 is not the first item (that is, there are previous hosts in the main list),
34528 Exim discards this name and any subsequent items in the main list.
34529 </para>
34530 <para>
34531 If the MX item is first in the list of hosts, and the local host is the
34532 most preferred host, what happens is controlled by the <option>self</option> option of the
34533 router.
34534 </para>
34535 <para>
34536 DNS failures when lookup up the MX records are treated in the same way as DNS
34537 failures when looking up IP addresses: <option>pass_on_timeout</option> and
34538 <option>host_find_failed</option> are used when relevant.
34539 </para>
34540 <para>
34541 The generic <option>ignore_target_hosts</option> option applies to all hosts in the list,
34542 whether obtained from an MX lookup or not.
34543 </para>
34544 </section>
34545 <section id="SECThowoptused">
34546 <title>How the options are used</title>
34547 <para>
34548 The options are a sequence of words; in practice no more than three are ever
34549 present. One of the words can be the name of a transport; this overrides the
34550 <option>transport</option> option on the router for this particular routing rule only. The
34551 other words (if present) control randomization of the list of hosts on a
34552 per-rule basis, and how the IP addresses of the hosts are to be found when
34553 routing to a remote transport. These options are as follows:
34554 </para>
34555 <itemizedlist>
34556 <listitem>
34557 <para>
34558 <option>randomize</option>: randomize the order of the hosts in this list, overriding the
34559 setting of <option>hosts_randomize</option> for this routing rule only.
34560 </para>
34561 </listitem>
34562 <listitem>
34563 <para>
34564 <option>no_randomize</option>: do not randomize the order of the hosts in this list,
34565 overriding the setting of <option>hosts_randomize</option> for this routing rule only.
34566 </para>
34567 </listitem>
34568 <listitem>
34569 <para>
34570 <option>byname</option>: use <function>getipnodebyname()</function> (<function>gethostbyname()</function> on older systems) to
34571 find IP addresses. This function may ultimately cause a DNS lookup, but it may
34572 also look in <filename>/etc/hosts</filename> or other sources of information.
34573 </para>
34574 </listitem>
34575 <listitem>
34576 <para>
34577 <option>bydns</option>: look up address records for the hosts directly in the DNS; fail if
34578 no address records are found. If there is a temporary DNS error (such as a
34579 timeout), delivery is deferred.
34580 </para>
34581 </listitem>
34582 </itemizedlist>
34583 <para>
34584 For example:
34585 </para>
34586 <literallayout class="monospaced">
34587 route_list = domain1  host1:host2:host3  randomize bydns;\
34588              domain2  host4:host5
34589 </literallayout>
34590 <para>
34591 If neither <option>byname</option> nor <option>bydns</option> is given, Exim behaves as follows: First, a
34592 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
34593 result is used. Otherwise, Exim goes on to try a call to <function>getipnodebyname()</function>
34594 or <function>gethostbyname()</function>, and the result of the lookup is the result of that
34595 call.
34596 </para>
34597 <para>
34598 <emphasis role="bold">Warning</emphasis>: It has been discovered that on some systems, if a DNS lookup
34599 called via <function>getipnodebyname()</function> times out, HOST_NOT_FOUND is returned
34600 instead of TRY_AGAIN. That is why the default action is to try a DNS
34601 lookup first. Only if that gives a definite <quote>no such host</quote> is the local
34602 function called.
34603 </para>
34604 <para>
34605 If no IP address for a host can be found, what happens is controlled by the
34606 <option>host_find_failed</option> option.
34607 </para>
34608 <para>
34609 <indexterm role="variable">
34610 <primary><varname>$host</varname></primary>
34611 </indexterm>
34612 When an address is routed to a local transport, IP addresses are not looked up.
34613 The host list is passed to the transport in the <varname>$host</varname> variable.
34614 </para>
34615 </section>
34616 <section id="SECID123">
34617 <title>Manualroute examples</title>
34618 <para>
34619 In some of the examples that follow, the presence of the <option>remote_smtp</option>
34620 transport, as defined in the default configuration file, is assumed:
34621 </para>
34622 <itemizedlist>
34623 <listitem>
34624 <para>
34625 <indexterm role="concept">
34626 <primary>smart host</primary>
34627 <secondary>example router</secondary>
34628 </indexterm>
34629 The <command>manualroute</command> router can be used to forward all external mail to a
34630 <emphasis>smart host</emphasis>. If you have set up, in the main part of the configuration, a
34631 named domain list that contains your local domains, for example:
34632 </para>
34633 <literallayout class="monospaced">
34634 domainlist local_domains = my.domain.example
34635 </literallayout>
34636 <para>
34637 You can arrange for all other domains to be routed to a smart host by making
34638 your first router something like this:
34639 </para>
34640 <literallayout class="monospaced">
34641 smart_route:
34642   driver = manualroute
34643   domains = !+local_domains
34644   transport = remote_smtp
34645   route_list = * smarthost.ref.example
34646 </literallayout>
34647 <para>
34648 This causes all non-local addresses to be sent to the single host
34649 <emphasis>smarthost.ref.example</emphasis>. If a colon-separated list of smart hosts is given,
34650 they are tried in order
34651 (but you can use <option>hosts_randomize</option> to vary the order each time).
34652 Another way of configuring the same thing is this:
34653 </para>
34654 <literallayout class="monospaced">
34655 smart_route:
34656   driver = manualroute
34657   transport = remote_smtp
34658   route_list = !+local_domains  smarthost.ref.example
34659 </literallayout>
34660 <para>
34661 There is no difference in behaviour between these two routers as they stand.
34662 However, they behave differently if <option>no_more</option> is added to them. In the first
34663 example, the router is skipped if the domain does not match the <option>domains</option>
34664 precondition; the following router is always tried. If the router runs, it
34665 always matches the domain and so can never decline. Therefore, <option>no_more</option>
34666 would have no effect. In the second case, the router is never skipped; it
34667 always runs. However, if it doesn&#x2019;t match the domain, it declines. In this case
34668 <option>no_more</option> would prevent subsequent routers from running.
34669 </para>
34670 </listitem>
34671 <listitem>
34672 <para>
34673 <indexterm role="concept">
34674 <primary>mail hub example</primary>
34675 </indexterm>
34676 A <emphasis>mail hub</emphasis> is a host which receives mail for a number of domains via MX
34677 records in the DNS and delivers it via its own private routing mechanism. Often
34678 the final destinations are behind a firewall, with the mail hub being the one
34679 machine that can connect to machines both inside and outside the firewall. The
34680 <command>manualroute</command> router is usually used on a mail hub to route incoming messages
34681 to the correct hosts. For a small number of domains, the routing can be inline,
34682 using the <option>route_list</option> option, but for a larger number a file or database
34683 lookup is easier to manage.
34684 </para>
34685 <para>
34686 If the domain names are in fact the names of the machines to which the mail is
34687 to be sent by the mail hub, the configuration can be quite simple. For
34688 example:
34689 </para>
34690 <literallayout class="monospaced">
34691 hub_route:
34692   driver = manualroute
34693   transport = remote_smtp
34694   route_list = *.rhodes.tvs.example  $domain
34695 </literallayout>
34696 <para>
34697 This configuration routes domains that match <literal>*.rhodes.tvs.example</literal> to hosts
34698 whose names are the same as the mail domains. A similar approach can be taken
34699 if the host name can be obtained from the domain name by a string manipulation
34700 that the expansion facilities can handle. Otherwise, a lookup based on the
34701 domain can be used to find the host:
34702 </para>
34703 <literallayout class="monospaced">
34704 through_firewall:
34705   driver = manualroute
34706   transport = remote_smtp
34707   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
34708 </literallayout>
34709 <para>
34710 The result of the lookup must be the name or IP address of the host (or
34711 hosts) to which the address is to be routed. If the lookup fails, the route
34712 data is empty, causing the router to decline. The address then passes to the
34713 next router.
34714 </para>
34715 </listitem>
34716 <listitem>
34717 <para>
34718 <indexterm role="concept">
34719 <primary>batched SMTP output example</primary>
34720 </indexterm>
34721 <indexterm role="concept">
34722 <primary>SMTP</primary>
34723 <secondary>batched outgoing; example</secondary>
34724 </indexterm>
34725 You can use <command>manualroute</command> to deliver messages to pipes or files in batched
34726 SMTP format for onward transportation by some other means. This is one way of
34727 storing mail for a dial-up host when it is not connected. The route list entry
34728 can be as simple as a single domain name in a configuration like this:
34729 </para>
34730 <literallayout class="monospaced">
34731 save_in_file:
34732   driver = manualroute
34733   transport = batchsmtp_appendfile
34734   route_list = saved.domain.example
34735 </literallayout>
34736 <para>
34737 though often a pattern is used to pick up more than one domain. If there are
34738 several domains or groups of domains with different transport requirements,
34739 different transports can be listed in the routing information:
34740 </para>
34741 <literallayout class="monospaced">
34742 save_in_file:
34743   driver = manualroute
34744   route_list = \
34745     *.saved.domain1.example  $domain  batch_appendfile; \
34746     *.saved.domain2.example  \
34747       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
34748       batch_pipe
34749 </literallayout>
34750 <para>
34751 <indexterm role="variable">
34752 <primary><varname>$domain</varname></primary>
34753 </indexterm>
34754 <indexterm role="variable">
34755 <primary><varname>$host</varname></primary>
34756 </indexterm>
34757 The first of these just passes the domain in the <varname>$host</varname> variable, which
34758 doesn&#x2019;t achieve much (since it is also in <varname>$domain</varname>), but the second does a
34759 file lookup to find a value to pass, causing the router to decline to handle
34760 the address if the lookup fails.
34761 </para>
34762 </listitem>
34763 <listitem>
34764 <para>
34765 <indexterm role="concept">
34766 <primary>UUCP</primary>
34767 <secondary>example of router for</secondary>
34768 </indexterm>
34769 Routing mail directly to UUCP software is a specific case of the use of
34770 <command>manualroute</command> in a gateway to another mail environment. This is an example of
34771 one way it can be done:
34772 </para>
34773 <literallayout class="monospaced">
34774 # Transport
34775 uucp:
34776   driver = pipe
34777   user = nobody
34778   command = /usr/local/bin/uux -r - \
34779     ${substr_-5:$host}!rmail ${local_part}
34780   return_fail_output = true
34781
34782 # Router
34783 uucphost:
34784   transport = uucp
34785   driver = manualroute
34786   route_data = \
34787     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
34788 </literallayout>
34789 <para>
34790 The file <filename>/usr/local/exim/uucphosts</filename> contains entries like
34791 </para>
34792 <literallayout class="monospaced">
34793 darksite.ethereal.example:           darksite.UUCP
34794 </literallayout>
34795 <para>
34796 It can be set up more simply without adding and removing <quote>.UUCP</quote> but this way
34797 makes clear the distinction between the domain name
34798 <emphasis>darksite.ethereal.example</emphasis> and the UUCP host name <emphasis>darksite</emphasis>.
34799 </para>
34800 </listitem>
34801 </itemizedlist>
34802 <para>
34803 <indexterm role="concept" startref="IIDmanrou1" class="endofrange"/>
34804 <indexterm role="concept" startref="IIDmanrou2" class="endofrange"/>
34805 </para>
34806 </section>
34807 </chapter>
34808
34809 <chapter id="CHAPdriverlast">
34810 <title>The queryprogram router</title>
34811 <para>
34812 <indexterm role="concept" id="IIDquerou1" class="startofrange">
34813 <primary><command>queryprogram</command> router</primary>
34814 </indexterm>
34815 <indexterm role="concept" id="IIDquerou2" class="startofrange">
34816 <primary>routers</primary>
34817 <secondary><command>queryprogram</command></secondary>
34818 </indexterm>
34819 <indexterm role="concept">
34820 <primary>routing</primary>
34821 <secondary>by external program</secondary>
34822 </indexterm>
34823 The <command>queryprogram</command> router routes an address by running an external command
34824 and acting on its output. This is an expensive way to route, and is intended
34825 mainly for use in lightly-loaded systems, or for performing experiments.
34826 However, if it is possible to use the precondition options (<option>domains</option>,
34827 <option>local_parts</option>, etc) to skip this router for most addresses, it could sensibly
34828 be used in special cases, even on a busy host. There are the following private
34829 options:
34830 <indexterm role="concept">
34831 <primary>options</primary>
34832 <secondary><command>queryprogram</command> router</secondary>
34833 </indexterm>
34834 </para>
34835 <para>
34836 <indexterm role="option">
34837 <primary><option>command</option></primary>
34838 </indexterm>
34839 </para>
34840 <informaltable frame="all">
34841 <tgroup cols="4" colsep="0" rowsep="0">
34842 <colspec colwidth="8*" align="left"/>
34843 <colspec colwidth="6*" align="center"/>
34844 <colspec colwidth="6*" align="center"/>
34845 <colspec colwidth="6*" align="right"/>
34846 <tbody>
34847 <row>
34848 <entry><option>command</option></entry>
34849 <entry>Use: <emphasis>queryprogram</emphasis></entry>
34850 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
34851 <entry>Default: <emphasis>unset</emphasis></entry>
34852 </row>
34853 </tbody>
34854 </tgroup>
34855 </informaltable>
34856 <para>
34857 This option must be set. It specifies the command that is to be run. The
34858 command is split up into a command name and arguments, and then each is
34859 expanded separately (exactly as for a <command>pipe</command> transport, described in chapter
34860 <xref linkend="CHAPpipetransport"/>).
34861 </para>
34862 <para>
34863 <indexterm role="option">
34864 <primary><option>command_group</option></primary>
34865 </indexterm>
34866 </para>
34867 <informaltable frame="all">
34868 <tgroup cols="4" colsep="0" rowsep="0">
34869 <colspec colwidth="8*" align="left"/>
34870 <colspec colwidth="6*" align="center"/>
34871 <colspec colwidth="6*" align="center"/>
34872 <colspec colwidth="6*" align="right"/>
34873 <tbody>
34874 <row>
34875 <entry><option>command_group</option></entry>
34876 <entry>Use: <emphasis>queryprogram</emphasis></entry>
34877 <entry>Type: <emphasis>string</emphasis></entry>
34878 <entry>Default: <emphasis>unset</emphasis></entry>
34879 </row>
34880 </tbody>
34881 </tgroup>
34882 </informaltable>
34883 <para>
34884 <indexterm role="concept">
34885 <primary>gid (group id)</primary>
34886 <secondary>in <command>queryprogram</command> router</secondary>
34887 </indexterm>
34888 This option specifies a gid to be set when running the command while routing an
34889 address for deliver. It must be set if <option>command_user</option> specifies a numerical
34890 uid. If it begins with a digit, it is interpreted as the numerical value of the
34891 gid. Otherwise it is looked up using <function>getgrnam()</function>.
34892 </para>
34893 <para>
34894 <indexterm role="option">
34895 <primary><option>command_user</option></primary>
34896 </indexterm>
34897 </para>
34898 <informaltable frame="all">
34899 <tgroup cols="4" colsep="0" rowsep="0">
34900 <colspec colwidth="8*" align="left"/>
34901 <colspec colwidth="6*" align="center"/>
34902 <colspec colwidth="6*" align="center"/>
34903 <colspec colwidth="6*" align="right"/>
34904 <tbody>
34905 <row>
34906 <entry><option>command_user</option></entry>
34907 <entry>Use: <emphasis>queryprogram</emphasis></entry>
34908 <entry>Type: <emphasis>string</emphasis></entry>
34909 <entry>Default: <emphasis>unset</emphasis></entry>
34910 </row>
34911 </tbody>
34912 </tgroup>
34913 </informaltable>
34914 <para>
34915 <indexterm role="concept">
34916 <primary>uid (user id)</primary>
34917 <secondary>for <command>queryprogram</command></secondary>
34918 </indexterm>
34919 This option must be set. It specifies the uid which is set when running the
34920 command while routing an address for delivery. If the value begins with a digit,
34921 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
34922 using <function>getpwnam()</function> to obtain a value for the uid and, if <option>command_group</option> is
34923 not set, a value for the gid also.
34924 </para>
34925 <para>
34926 <emphasis role="bold">Warning:</emphasis> Changing uid and gid is possible only when Exim is running as
34927 root, which it does during a normal delivery in a conventional configuration.
34928 However, when an address is being verified during message reception, Exim is
34929 usually running as the Exim user, not as root. If the <command>queryprogram</command> router
34930 is called from a non-root process, Exim cannot change uid or gid before running
34931 the command. In this circumstance the command runs under the current uid and
34932 gid.
34933 </para>
34934 <para>
34935 <indexterm role="option">
34936 <primary><option>current_directory</option></primary>
34937 </indexterm>
34938 </para>
34939 <informaltable frame="all">
34940 <tgroup cols="4" colsep="0" rowsep="0">
34941 <colspec colwidth="8*" align="left"/>
34942 <colspec colwidth="6*" align="center"/>
34943 <colspec colwidth="6*" align="center"/>
34944 <colspec colwidth="6*" align="right"/>
34945 <tbody>
34946 <row>
34947 <entry><option>current_directory</option></entry>
34948 <entry>Use: <emphasis>queryprogram</emphasis></entry>
34949 <entry>Type: <emphasis>string</emphasis></entry>
34950 <entry>Default: <emphasis>/</emphasis></entry>
34951 </row>
34952 </tbody>
34953 </tgroup>
34954 </informaltable>
34955 <para>
34956 This option specifies an absolute path which is made the current directory
34957 before running the command.
34958 </para>
34959 <para>
34960 <indexterm role="option">
34961 <primary><option>timeout</option></primary>
34962 </indexterm>
34963 </para>
34964 <informaltable frame="all">
34965 <tgroup cols="4" colsep="0" rowsep="0">
34966 <colspec colwidth="8*" align="left"/>
34967 <colspec colwidth="6*" align="center"/>
34968 <colspec colwidth="6*" align="center"/>
34969 <colspec colwidth="6*" align="right"/>
34970 <tbody>
34971 <row>
34972 <entry><option>timeout</option></entry>
34973 <entry>Use: <emphasis>queryprogram</emphasis></entry>
34974 <entry>Type: <emphasis>time</emphasis></entry>
34975 <entry>Default: <emphasis>1h</emphasis></entry>
34976 </row>
34977 </tbody>
34978 </tgroup>
34979 </informaltable>
34980 <para>
34981 If the command does not complete within the timeout period, its process group
34982 is killed and the message is frozen. A value of zero time specifies no
34983 timeout.
34984 </para>
34985 <para>
34986 The standard output of the command is connected to a pipe, which is read when
34987 the command terminates. It should consist of a single line of output,
34988 containing up to five fields, separated by white space. The maximum length of
34989 the line is 1023 characters. Longer lines are silently truncated. The first
34990 field is one of the following words (case-insensitive):
34991 </para>
34992 <itemizedlist>
34993 <listitem>
34994 <para>
34995 <emphasis>Accept</emphasis>: routing succeeded; the remaining fields specify what to do (see
34996 below).
34997 </para>
34998 </listitem>
34999 <listitem>
35000 <para>
35001 <emphasis>Decline</emphasis>: the router declines; pass the address to the next router, unless
35002 <option>no_more</option> is set.
35003 </para>
35004 </listitem>
35005 <listitem>
35006 <para>
35007 <emphasis>Fail</emphasis>: routing failed; do not pass the address to any more routers. Any
35008 subsequent text on the line is an error message. If the router is run as part
35009 of address verification during an incoming SMTP message, the message is
35010 included in the SMTP response.
35011 </para>
35012 </listitem>
35013 <listitem>
35014 <para>
35015 <emphasis>Defer</emphasis>: routing could not be completed at this time; try again later. Any
35016 subsequent text on the line is an error message which is logged. It is not
35017 included in any SMTP response.
35018 </para>
35019 </listitem>
35020 <listitem>
35021 <para>
35022 <emphasis>Freeze</emphasis>: the same as <emphasis>defer</emphasis>, except that the message is frozen.
35023 </para>
35024 </listitem>
35025 <listitem>
35026 <para>
35027 <emphasis>Pass</emphasis>: pass the address to the next router (or the router specified by
35028 <option>pass_router</option>), overriding <option>no_more</option>.
35029 </para>
35030 </listitem>
35031 <listitem>
35032 <para>
35033 <emphasis>Redirect</emphasis>: the message is redirected. The remainder of the line is a list of
35034 new addresses, which are routed independently, starting with the first router,
35035 or the router specified by <option>redirect_router</option>, if set.
35036 </para>
35037 </listitem>
35038 </itemizedlist>
35039 <para>
35040 When the first word is <emphasis>accept</emphasis>, the remainder of the line consists of a
35041 number of keyed data values, as follows (split into two lines here, to fit on
35042 the page):
35043 </para>
35044 <literallayout class="monospaced">
35045 ACCEPT TRANSPORT=&lt;transport&gt; HOSTS=&lt;list of hosts&gt;
35046 LOOKUP=byname|bydns DATA=&lt;text&gt;
35047 </literallayout>
35048 <para>
35049 The data items can be given in any order, and all are optional. If no transport
35050 is included, the transport specified by the generic <option>transport</option> option is
35051 used. The list of hosts and the lookup type are needed only if the transport is
35052 an <command>smtp</command> transport that does not itself supply a list of hosts.
35053 </para>
35054 <para>
35055 The format of the list of hosts is the same as for the <command>manualroute</command> router.
35056 As well as host names and IP addresses with optional port numbers, as described
35057 in section <xref linkend="SECTformatonehostitem"/>, it may contain names followed by
35058 <literal>/MX</literal> to specify sublists of hosts that are obtained by looking up MX records
35059 (see section <xref linkend="SECThostshowused"/>).
35060 </para>
35061 <para>
35062 If the lookup type is not specified, Exim behaves as follows when trying to
35063 find an IP address for each host: First, a DNS lookup is done. If this yields
35064 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
35065 goes on to try a call to <function>getipnodebyname()</function> or <function>gethostbyname()</function>, and the
35066 result of the lookup is the result of that call.
35067 </para>
35068 <para>
35069 <indexterm role="variable">
35070 <primary><varname>$address_data</varname></primary>
35071 </indexterm>
35072 If the DATA field is set, its value is placed in the <varname>$address_data</varname>
35073 variable. For example, this return line
35074 </para>
35075 <literallayout class="monospaced">
35076 accept hosts=x1.y.example:x2.y.example data="rule1"
35077 </literallayout>
35078 <para>
35079 routes the address to the default transport, passing a list of two hosts. When
35080 the transport runs, the string <quote>rule1</quote> is in <varname>$address_data</varname>.
35081 <indexterm role="concept" startref="IIDquerou1" class="endofrange"/>
35082 <indexterm role="concept" startref="IIDquerou2" class="endofrange"/>
35083 </para>
35084 </chapter>
35085
35086 <chapter id="CHAPredirect">
35087 <title>The redirect router</title>
35088 <para>
35089 <indexterm role="concept" id="IIDredrou1" class="startofrange">
35090 <primary><command>redirect</command> router</primary>
35091 </indexterm>
35092 <indexterm role="concept" id="IIDredrou2" class="startofrange">
35093 <primary>routers</primary>
35094 <secondary><command>redirect</command></secondary>
35095 </indexterm>
35096 <indexterm role="concept">
35097 <primary>alias file</primary>
35098 <secondary>in a <command>redirect</command> router</secondary>
35099 </indexterm>
35100 <indexterm role="concept">
35101 <primary>address redirection</primary>
35102 <secondary><command>redirect</command> router</secondary>
35103 </indexterm>
35104 The <command>redirect</command> router handles several kinds of address redirection. Its most
35105 common uses are for resolving local part aliases from a central alias file
35106 (usually called <filename>/etc/aliases</filename>) and for handling users&#x2019; personal <filename>.forward</filename>
35107 files, but it has many other potential uses. The incoming address can be
35108 redirected in several different ways:
35109 </para>
35110 <itemizedlist>
35111 <listitem>
35112 <para>
35113 It can be replaced by one or more new addresses which are themselves routed
35114 independently.
35115 </para>
35116 </listitem>
35117 <listitem>
35118 <para>
35119 It can be routed to be delivered to a given file or directory.
35120 </para>
35121 </listitem>
35122 <listitem>
35123 <para>
35124 It can be routed to be delivered to a specified pipe command.
35125 </para>
35126 </listitem>
35127 <listitem>
35128 <para>
35129 It can cause an automatic reply to be generated.
35130 </para>
35131 </listitem>
35132 <listitem>
35133 <para>
35134 It can be forced to fail, optionally with a custom error message.
35135 </para>
35136 </listitem>
35137 <listitem>
35138 <para>
35139 It can be temporarily deferred, optionally with a custom message.
35140 </para>
35141 </listitem>
35142 <listitem>
35143 <para>
35144 It can be discarded.
35145 </para>
35146 </listitem>
35147 </itemizedlist>
35148 <para>
35149 The generic <option>transport</option> option must not be set for <command>redirect</command> routers.
35150 However, there are some private options which define transports for delivery to
35151 files and pipes, and for generating autoreplies. See the <option>file_transport</option>,
35152 <option>pipe_transport</option> and <option>reply_transport</option> descriptions below.
35153 </para>
35154 <section id="SECID124">
35155 <title>Redirection data</title>
35156 <para>
35157 The router operates by interpreting a text string which it obtains either by
35158 expanding the contents of the <option>data</option> option, or by reading the entire
35159 contents of a file whose name is given in the <option>file</option> option. These two
35160 options are mutually exclusive. The first is commonly used for handling system
35161 aliases, in a configuration like this:
35162 </para>
35163 <literallayout class="monospaced">
35164 system_aliases:
35165   driver = redirect
35166   data = ${lookup{$local_part}lsearch{/etc/aliases}}
35167 </literallayout>
35168 <para>
35169 If the lookup fails, the expanded string in this example is empty. When the
35170 expansion of <option>data</option> results in an empty string, the router declines. A forced
35171 expansion failure also causes the router to decline; other expansion failures
35172 cause delivery to be deferred.
35173 </para>
35174 <para>
35175 A configuration using <option>file</option> is commonly used for handling users&#x2019;
35176 <filename>.forward</filename> files, like this:
35177 </para>
35178 <literallayout class="monospaced">
35179 userforward:
35180   driver = redirect
35181   check_local_user
35182   file = $home/.forward
35183   no_verify
35184 </literallayout>
35185 <para>
35186 If the file does not exist, or causes no action to be taken (for example, it is
35187 empty or consists only of comments), the router declines. <emphasis role="bold">Warning</emphasis>: This
35188 is not the case when the file contains syntactically valid items that happen to
35189 yield empty addresses, for example, items containing only RFC 2822 address
35190 comments.
35191 </para>
35192 </section>
35193 <section id="SECID125">
35194 <title>Forward files and address verification</title>
35195 <para>
35196 <indexterm role="concept">
35197 <primary>address redirection</primary>
35198 <secondary>while verifying</secondary>
35199 </indexterm>
35200 It is usual to set <option>no_verify</option> on <command>redirect</command> routers which handle users&#x2019;
35201 <filename>.forward</filename> files, as in the example above. There are two reasons for this:
35202 </para>
35203 <itemizedlist>
35204 <listitem>
35205 <para>
35206 When Exim is receiving an incoming SMTP message from a remote host, it is
35207 running under the Exim uid, not as root. Exim is unable to change uid to read
35208 the file as the user, and it may not be able to read it as the Exim user. So in
35209 practice the router may not be able to operate.
35210 </para>
35211 </listitem>
35212 <listitem>
35213 <para>
35214 However, even when the router can operate, the existence of a <filename>.forward</filename> file
35215 is unimportant when verifying an address. What should be checked is whether the
35216 local part is a valid user name or not. Cutting out the redirection processing
35217 saves some resources.
35218 </para>
35219 </listitem>
35220 </itemizedlist>
35221 </section>
35222 <section id="SECID126">
35223 <title>Interpreting redirection data</title>
35224 <para>
35225 <indexterm role="concept">
35226 <primary>Sieve filter</primary>
35227 <secondary>specifying in redirection data</secondary>
35228 </indexterm>
35229 <indexterm role="concept">
35230 <primary>filter</primary>
35231 <secondary>specifying in redirection data</secondary>
35232 </indexterm>
35233 The contents of the data string, whether obtained from <option>data</option> or <option>file</option>,
35234 can be interpreted in two different ways:
35235 </para>
35236 <itemizedlist>
35237 <listitem>
35238 <para>
35239 If the <option>allow_filter</option> option is set true, and the data begins with the text
35240 <quote>#Exim filter</quote> or <quote>#Sieve filter</quote>, it is interpreted as a list of
35241 <emphasis>filtering</emphasis> instructions in the form of an Exim or Sieve filter file,
35242 respectively. Details of the syntax and semantics of filter files are described
35243 in a separate document entitled <emphasis>Exim&#x2019;s interfaces to mail filtering</emphasis>; this
35244 document is intended for use by end users.
35245 </para>
35246 </listitem>
35247 <listitem>
35248 <para>
35249 Otherwise, the data must be a comma-separated list of redirection items, as
35250 described in the next section.
35251 </para>
35252 </listitem>
35253 </itemizedlist>
35254 <para>
35255 When a message is redirected to a file (a <quote>mail folder</quote>), the file name given
35256 in a non-filter redirection list must always be an absolute path. A filter may
35257 generate a relative path &ndash; how this is handled depends on the transport&#x2019;s
35258 configuration. See section <xref linkend="SECTfildiropt"/> for a discussion of this issue
35259 for the <command>appendfile</command> transport.
35260 </para>
35261 </section>
35262 <section id="SECTitenonfilred">
35263 <title>Items in a non-filter redirection list</title>
35264 <para>
35265 <indexterm role="concept">
35266 <primary>address redirection</primary>
35267 <secondary>non-filter list items</secondary>
35268 </indexterm>
35269 When the redirection data is not an Exim or Sieve filter, for example, if it
35270 comes from a conventional alias or forward file, it consists of a list of
35271 addresses, file names, pipe commands, or certain special items (see section
35272 <xref linkend="SECTspecitredli"/> below). The special items can be individually enabled or
35273 disabled by means of options whose names begin with <option>allow_</option> or <option>forbid_</option>,
35274 depending on their default values. The items in the list are separated by
35275 commas or newlines.
35276 If a comma is required in an item, the entire item must be enclosed in double
35277 quotes.
35278 </para>
35279 <para>
35280 Lines starting with a # character are comments, and are ignored, and # may
35281 also appear following a comma, in which case everything between the # and the
35282 next newline character is ignored.
35283 </para>
35284 <para>
35285 If an item is entirely enclosed in double quotes, these are removed. Otherwise
35286 double quotes are retained because some forms of mail address require their use
35287 (but never to enclose the entire address). In the following description,
35288 <quote>item</quote> refers to what remains after any surrounding double quotes have been
35289 removed.
35290 </para>
35291 <para>
35292 <indexterm role="variable">
35293 <primary><varname>$local_part</varname></primary>
35294 </indexterm>
35295 <emphasis role="bold">Warning</emphasis>: If you use an Exim expansion to construct a redirection address,
35296 and the expansion contains a reference to <varname>$local_part</varname>, you should make use
35297 of the <option>quote_local_part</option> expansion operator, in case the local part contains
35298 special characters. For example, to redirect all mail for the domain
35299 <emphasis>obsolete.example</emphasis>, retaining the existing local part, you could use this
35300 setting:
35301 </para>
35302 <literallayout class="monospaced">
35303 data = ${quote_local_part:$local_part}@newdomain.example
35304 </literallayout>
35305 </section>
35306 <section id="SECTredlocmai">
35307 <title>Redirecting to a local mailbox</title>
35308 <para>
35309 <indexterm role="concept">
35310 <primary>routing</primary>
35311 <secondary>loops in</secondary>
35312 </indexterm>
35313 <indexterm role="concept">
35314 <primary>loop</primary>
35315 <secondary>while routing, avoidance of</secondary>
35316 </indexterm>
35317 <indexterm role="concept">
35318 <primary>address redirection</primary>
35319 <secondary>to local mailbox</secondary>
35320 </indexterm>
35321 A redirection item may safely be the same as the address currently under
35322 consideration. This does not cause a routing loop, because a router is
35323 automatically skipped if any ancestor of the address that is being processed
35324 is the same as the current address and was processed by the current router.
35325 Such an address is therefore passed to the following routers, so it is handled
35326 as if there were no redirection. When making this loop-avoidance test, the
35327 complete local part, including any prefix or suffix, is used.
35328 </para>
35329 <para>
35330 <indexterm role="concept">
35331 <primary>address redirection</primary>
35332 <secondary>local part without domain</secondary>
35333 </indexterm>
35334 Specifying the same local part without a domain is a common usage in personal
35335 filter files when the user wants to have messages delivered to the local
35336 mailbox and also forwarded elsewhere. For example, the user whose login is
35337 <emphasis>cleo</emphasis> might have a <filename>.forward</filename> file containing this:
35338 </para>
35339 <literallayout class="monospaced">
35340 cleo, cleopatra@egypt.example
35341 </literallayout>
35342 <para>
35343 <indexterm role="concept">
35344 <primary>backslash in alias file</primary>
35345 </indexterm>
35346 <indexterm role="concept">
35347 <primary>alias file</primary>
35348 <secondary>backslash in</secondary>
35349 </indexterm>
35350 For compatibility with other MTAs, such unqualified local parts may be
35351 preceded by <quote>\</quote>, but this is not a requirement for loop prevention. However,
35352 it does make a difference if more than one domain is being handled
35353 synonymously.
35354 </para>
35355 <para>
35356 If an item begins with <quote>\</quote> and the rest of the item parses as a valid RFC
35357 2822 address that does not include a domain, the item is qualified using the
35358 domain of the incoming address. In the absence of a leading <quote>\</quote>, unqualified
35359 addresses are qualified using the value in <option>qualify_recipient</option>, but you can
35360 force the incoming domain to be used by setting <option>qualify_preserve_domain</option>.
35361 </para>
35362 <para>
35363 Care must be taken if there are alias names for local users.
35364 Consider an MTA handling a single local domain where the system alias file
35365 contains:
35366 </para>
35367 <literallayout class="monospaced">
35368 Sam.Reman: spqr
35369 </literallayout>
35370 <para>
35371 Now suppose that Sam (whose login id is <emphasis>spqr</emphasis>) wants to save copies of
35372 messages in the local mailbox, and also forward copies elsewhere. He creates
35373 this forward file:
35374 </para>
35375 <literallayout class="monospaced">
35376 Sam.Reman, spqr@reme.elsewhere.example
35377 </literallayout>
35378 <para>
35379 With these settings, an incoming message addressed to <emphasis>Sam.Reman</emphasis> fails. The
35380 <command>redirect</command> router for system aliases does not process <emphasis>Sam.Reman</emphasis> the
35381 second time round, because it has previously routed it,
35382 and the following routers presumably cannot handle the alias. The forward file
35383 should really contain
35384 </para>
35385 <literallayout class="monospaced">
35386 spqr, spqr@reme.elsewhere.example
35387 </literallayout>
35388 <para>
35389 but because this is such a common error, the <option>check_ancestor</option> option (see
35390 below) exists to provide a way to get round it. This is normally set on a
35391 <command>redirect</command> router that is handling users&#x2019; <filename>.forward</filename> files.
35392 </para>
35393 </section>
35394 <section id="SECTspecitredli">
35395 <title>Special items in redirection lists</title>
35396 <para>
35397 In addition to addresses, the following types of item may appear in redirection
35398 lists (that is, in non-filter redirection data):
35399 </para>
35400 <itemizedlist>
35401 <listitem>
35402 <para>
35403 <indexterm role="concept">
35404 <primary>pipe</primary>
35405 <secondary>in redirection list</secondary>
35406 </indexterm>
35407 <indexterm role="concept">
35408 <primary>address redirection</primary>
35409 <secondary>to pipe</secondary>
35410 </indexterm>
35411 An item is treated as a pipe command if it begins with <quote>|</quote> and does not parse
35412 as a valid RFC 2822 address that includes a domain. A transport for running the
35413 command must be specified by the <option>pipe_transport</option> option.
35414 Normally, either the router or the transport specifies a user and a group under
35415 which to run the delivery. The default is to use the Exim user and group.
35416 </para>
35417 <para>
35418 Single or double quotes can be used for enclosing the individual arguments of
35419 the pipe command; no interpretation of escapes is done for single quotes. If
35420 the command contains a comma character, it is necessary to put the whole item
35421 in double quotes, for example:
35422 </para>
35423 <literallayout class="monospaced">
35424 "|/some/command ready,steady,go"
35425 </literallayout>
35426 <para>
35427 since items in redirection lists are terminated by commas. Do not, however,
35428 quote just the command. An item such as
35429 </para>
35430 <literallayout class="monospaced">
35431 |"/some/command ready,steady,go"
35432 </literallayout>
35433 <para>
35434 is interpreted as a pipe with a rather strange command name, and no arguments.
35435 </para>
35436 <para>
35437 Note that the above example assumes that the text comes from a lookup source
35438 of some sort, so that the quotes are part of the data.  If composing a
35439 redirect router with a <option>data</option> option directly specifying this command, the
35440 quotes will be used by the configuration parser to define the extent of one
35441 string, but will not be passed down into the redirect router itself.  There
35442 are two main approaches to get around this: escape quotes to be part of the
35443 data itself, or avoid using this mechanism and instead create a custom
35444 transport with the <option>command</option> option set and reference that transport from
35445 an <option>accept</option> router.
35446 </para>
35447 </listitem>
35448 <listitem>
35449 <para>
35450 <indexterm role="concept">
35451 <primary>file</primary>
35452 <secondary>in redirection list</secondary>
35453 </indexterm>
35454 <indexterm role="concept">
35455 <primary>address redirection</primary>
35456 <secondary>to file</secondary>
35457 </indexterm>
35458 An item is interpreted as a path name if it begins with <quote>/</quote> and does not
35459 parse as a valid RFC 2822 address that includes a domain. For example,
35460 </para>
35461 <literallayout class="monospaced">
35462 /home/world/minbari
35463 </literallayout>
35464 <para>
35465 is treated as a file name, but
35466 </para>
35467 <literallayout class="monospaced">
35468 /s=molari/o=babylon/@x400gate.way
35469 </literallayout>
35470 <para>
35471 is treated as an address. For a file name, a transport must be specified using
35472 the <option>file_transport</option> option. However, if the generated path name ends with a
35473 forward slash character, it is interpreted as a directory name rather than a
35474 file name, and <option>directory_transport</option> is used instead.
35475 </para>
35476 <para>
35477 Normally, either the router or the transport specifies a user and a group under
35478 which to run the delivery. The default is to use the Exim user and group.
35479 </para>
35480 <para>
35481 <indexterm role="concept">
35482 <primary><filename>/dev/null</filename></primary>
35483 </indexterm>
35484 However, if a redirection item is the path <filename>/dev/null</filename>, delivery to it is
35485 bypassed at a high level, and the log entry shows <quote>**bypassed**</quote>
35486 instead of a transport name. In this case the user and group are not used.
35487 </para>
35488 </listitem>
35489 <listitem>
35490 <para>
35491 <indexterm role="concept">
35492 <primary>included address list</primary>
35493 </indexterm>
35494 <indexterm role="concept">
35495 <primary>address redirection</primary>
35496 <secondary>included external list</secondary>
35497 </indexterm>
35498 If an item is of the form
35499 </para>
35500 <literallayout class="monospaced">
35501 :include:&lt;path name&gt;
35502 </literallayout>
35503 <para>
35504 a list of further items is taken from the given file and included at that
35505 point. <emphasis role="bold">Note</emphasis>: Such a file can not be a filter file; it is just an
35506 out-of-line addition to the list. The items in the included list are separated
35507 by commas or newlines and are not subject to expansion. If this is the first
35508 item in an alias list in an <command>lsearch</command> file, a colon must be used to terminate
35509 the alias name. This example is incorrect:
35510 </para>
35511 <literallayout class="monospaced">
35512 list1    :include:/opt/lists/list1
35513 </literallayout>
35514 <para>
35515 It must be given as
35516 </para>
35517 <literallayout class="monospaced">
35518 list1:   :include:/opt/lists/list1
35519 </literallayout>
35520 </listitem>
35521 <listitem>
35522 <para>
35523 <indexterm role="concept">
35524 <primary>address redirection</primary>
35525 <secondary>to black hole</secondary>
35526 </indexterm>
35527 Sometimes you want to throw away mail to a particular local part. Making the
35528 <option>data</option> option expand to an empty string does not work, because that causes
35529 the router to decline. Instead, the alias item
35530 <indexterm role="concept">
35531 <primary>black hole</primary>
35532 </indexterm>
35533 <indexterm role="concept">
35534 <primary>abandoning mail</primary>
35535 </indexterm>
35536 <emphasis>:blackhole:</emphasis> can be used. It does what its name implies. No delivery is
35537 done, and no error message is generated. This has the same effect as specifing
35538 <filename>/dev/null</filename> as a destination, but it can be independently disabled.
35539 </para>
35540 <para>
35541 <emphasis role="bold">Warning</emphasis>: If <emphasis>:blackhole:</emphasis> appears anywhere in a redirection list, no
35542 delivery is done for the original local part, even if other redirection items
35543 are present. If you are generating a multi-item list (for example, by reading a
35544 database) and need the ability to provide a no-op item, you must use
35545 <filename>/dev/null</filename>.
35546 </para>
35547 </listitem>
35548 <listitem>
35549 <para>
35550 <indexterm role="concept">
35551 <primary>delivery</primary>
35552 <secondary>forcing failure</secondary>
35553 </indexterm>
35554 <indexterm role="concept">
35555 <primary>delivery</primary>
35556 <secondary>forcing deferral</secondary>
35557 </indexterm>
35558 <indexterm role="concept">
35559 <primary>failing delivery</primary>
35560 <secondary>forcing</secondary>
35561 </indexterm>
35562 <indexterm role="concept">
35563 <primary>deferred delivery, forcing</primary>
35564 </indexterm>
35565 <indexterm role="concept">
35566 <primary>customizing</primary>
35567 <secondary>failure message</secondary>
35568 </indexterm>
35569 An attempt to deliver a particular address can be deferred or forced to fail by
35570 redirection items of the form
35571 </para>
35572 <literallayout class="monospaced">
35573 :defer:
35574 :fail:
35575 </literallayout>
35576 <para>
35577 respectively. When a redirection list contains such an item, it applies
35578 to the entire redirection; any other items in the list are ignored. Any
35579 text following <emphasis>:fail:</emphasis> or <emphasis>:defer:</emphasis> is placed in the error text
35580 associated with the failure. For example, an alias file might contain:
35581 </para>
35582 <literallayout class="monospaced">
35583 X.Employee:  :fail: Gone away, no forwarding address
35584 </literallayout>
35585 <para>
35586 In the case of an address that is being verified from an ACL or as the subject
35587 of a
35588 <indexterm role="concept">
35589 <primary>VRFY</primary>
35590 <secondary>error text, display of</secondary>
35591 </indexterm>
35592 VRFY command, the text is included in the SMTP error response by
35593 default.
35594 <indexterm role="concept">
35595 <primary>EXPN</primary>
35596 <secondary>error text, display of</secondary>
35597 </indexterm>
35598 The text is not included in the response to an EXPN command. In non-SMTP cases
35599 the text is included in the error message that Exim generates.
35600 </para>
35601 <para>
35602 <indexterm role="concept">
35603 <primary>SMTP</primary>
35604 <secondary>error codes</secondary>
35605 </indexterm>
35606 By default, Exim sends a 451 SMTP code for a <emphasis>:defer:</emphasis>, and 550 for
35607 <emphasis>:fail:</emphasis>. However, if the message starts with three digits followed by a
35608 space, optionally followed by an extended code of the form <emphasis>n.n.n</emphasis>, also
35609 followed by a space, and the very first digit is the same as the default error
35610 code, the code from the message is used instead. If the very first digit is
35611 incorrect, a panic error is logged, and the default code is used. You can
35612 suppress the use of the supplied code in a redirect router by setting the
35613 <option>forbid_smtp_code</option> option true. In this case, any SMTP code is quietly
35614 ignored.
35615 </para>
35616 <para>
35617 <indexterm role="variable">
35618 <primary><varname>$acl_verify_message</varname></primary>
35619 </indexterm>
35620 In an ACL, an explicitly provided message overrides the default, but the
35621 default message is available in the variable <varname>$acl_verify_message</varname> and can
35622 therefore be included in a custom message if this is desired.
35623 </para>
35624 <para>
35625 Normally the error text is the rest of the redirection list &ndash; a comma does
35626 not terminate it &ndash; but a newline does act as a terminator. Newlines are not
35627 normally present in alias expansions. In <command>lsearch</command> lookups they are removed
35628 as part of the continuation process, but they may exist in other kinds of
35629 lookup and in <emphasis>:include:</emphasis> files.
35630 </para>
35631 <para>
35632 During routing for message delivery (as opposed to verification), a redirection
35633 containing <emphasis>:fail:</emphasis> causes an immediate failure of the incoming address,
35634 whereas <emphasis>:defer:</emphasis> causes the message to remain on the queue so that a
35635 subsequent delivery attempt can happen at a later time. If an address is
35636 deferred for too long, it will ultimately fail, because the normal retry
35637 rules still apply.
35638 </para>
35639 </listitem>
35640 <listitem>
35641 <para>
35642 <indexterm role="concept">
35643 <primary>alias file</primary>
35644 <secondary>exception to default</secondary>
35645 </indexterm>
35646 Sometimes it is useful to use a single-key search type with a default (see
35647 chapter <xref linkend="CHAPfdlookup"/>) to look up aliases. However, there may be a need
35648 for exceptions to the default. These can be handled by aliasing them to
35649 <emphasis>:unknown:</emphasis>. This differs from <emphasis>:fail:</emphasis> in that it causes the <command>redirect</command>
35650 router to decline, whereas <emphasis>:fail:</emphasis> forces routing to fail. A lookup which
35651 results in an empty redirection list has the same effect.
35652 </para>
35653 </listitem>
35654 </itemizedlist>
35655 </section>
35656 <section id="SECTdupaddr">
35657 <title>Duplicate addresses</title>
35658 <para>
35659 <indexterm role="concept">
35660 <primary>duplicate addresses</primary>
35661 </indexterm>
35662 <indexterm role="concept">
35663 <primary>address duplicate, discarding</primary>
35664 </indexterm>
35665 <indexterm role="concept">
35666 <primary>pipe</primary>
35667 <secondary>duplicated</secondary>
35668 </indexterm>
35669 Exim removes duplicate addresses from the list to which it is delivering, so as
35670 to deliver just one copy to each address. This does not apply to deliveries
35671 routed to pipes by different immediate parent addresses, but an indirect
35672 aliasing scheme of the type
35673 </para>
35674 <literallayout class="monospaced">
35675 pipe:       |/some/command $local_part
35676 localpart1: pipe
35677 localpart2: pipe
35678 </literallayout>
35679 <para>
35680 does not work with a message that is addressed to both local parts, because
35681 when the second is aliased to the intermediate local part <quote>pipe</quote> it gets
35682 discarded as being the same as a previously handled address. However, a scheme
35683 such as
35684 </para>
35685 <literallayout class="monospaced">
35686 localpart1: |/some/command $local_part
35687 localpart2: |/some/command $local_part
35688 </literallayout>
35689 <para>
35690 does result in two different pipe deliveries, because the immediate parents of
35691 the pipes are distinct.
35692 </para>
35693 </section>
35694 <section id="SECID128">
35695 <title>Repeated redirection expansion</title>
35696 <para>
35697 <indexterm role="concept">
35698 <primary>repeated redirection expansion</primary>
35699 </indexterm>
35700 <indexterm role="concept">
35701 <primary>address redirection</primary>
35702 <secondary>repeated for each delivery attempt</secondary>
35703 </indexterm>
35704 When a message cannot be delivered to all of its recipients immediately,
35705 leading to two or more delivery attempts, redirection expansion is carried out
35706 afresh each time for those addresses whose children were not all previously
35707 delivered. If redirection is being used as a mailing list, this can lead to new
35708 members of the list receiving copies of old messages. The <option>one_time</option> option
35709 can be used to avoid this.
35710 </para>
35711 </section>
35712 <section id="SECID129">
35713 <title>Errors in redirection lists</title>
35714 <para>
35715 <indexterm role="concept">
35716 <primary>address redirection</primary>
35717 <secondary>errors</secondary>
35718 </indexterm>
35719 If <option>skip_syntax_errors</option> is set, a malformed address that causes a parsing
35720 error is skipped, and an entry is written to the main log. This may be useful
35721 for mailing lists that are automatically managed. Otherwise, if an error is
35722 detected while generating the list of new addresses, the original address is
35723 deferred. See also <option>syntax_errors_to</option>.
35724 </para>
35725 </section>
35726 <section id="SECID130">
35727 <title>Private options for the redirect router</title>
35728 <para>
35729 <indexterm role="concept">
35730 <primary>options</primary>
35731 <secondary><command>redirect</command> router</secondary>
35732 </indexterm>
35733 The private options for the <command>redirect</command> router are as follows:
35734 </para>
35735 <para>
35736 <indexterm role="option">
35737 <primary><option>allow_defer</option></primary>
35738 </indexterm>
35739 </para>
35740 <informaltable frame="all">
35741 <tgroup cols="4" colsep="0" rowsep="0">
35742 <colspec colwidth="8*" align="left"/>
35743 <colspec colwidth="6*" align="center"/>
35744 <colspec colwidth="6*" align="center"/>
35745 <colspec colwidth="6*" align="right"/>
35746 <tbody>
35747 <row>
35748 <entry><option>allow_defer</option></entry>
35749 <entry>Use: <emphasis>redirect</emphasis></entry>
35750 <entry>Type: <emphasis>boolean</emphasis></entry>
35751 <entry>Default: <emphasis>false</emphasis></entry>
35752 </row>
35753 </tbody>
35754 </tgroup>
35755 </informaltable>
35756 <para>
35757 Setting this option allows the use of <emphasis>:defer:</emphasis> in non-filter redirection
35758 data, or the <option>defer</option> command in an Exim filter file.
35759 </para>
35760 <para>
35761 <indexterm role="option">
35762 <primary><option>allow_fail</option></primary>
35763 </indexterm>
35764 </para>
35765 <informaltable frame="all">
35766 <tgroup cols="4" colsep="0" rowsep="0">
35767 <colspec colwidth="8*" align="left"/>
35768 <colspec colwidth="6*" align="center"/>
35769 <colspec colwidth="6*" align="center"/>
35770 <colspec colwidth="6*" align="right"/>
35771 <tbody>
35772 <row>
35773 <entry><option>allow_fail</option></entry>
35774 <entry>Use: <emphasis>redirect</emphasis></entry>
35775 <entry>Type: <emphasis>boolean</emphasis></entry>
35776 <entry>Default: <emphasis>false</emphasis></entry>
35777 </row>
35778 </tbody>
35779 </tgroup>
35780 </informaltable>
35781 <para>
35782 <indexterm role="concept">
35783 <primary>failing delivery</primary>
35784 <secondary>from filter</secondary>
35785 </indexterm>
35786 If this option is true, the <emphasis>:fail:</emphasis> item can be used in a redirection list,
35787 and the <option>fail</option> command may be used in an Exim filter file.
35788 </para>
35789 <para>
35790 <indexterm role="option">
35791 <primary><option>allow_filter</option></primary>
35792 </indexterm>
35793 </para>
35794 <informaltable frame="all">
35795 <tgroup cols="4" colsep="0" rowsep="0">
35796 <colspec colwidth="8*" align="left"/>
35797 <colspec colwidth="6*" align="center"/>
35798 <colspec colwidth="6*" align="center"/>
35799 <colspec colwidth="6*" align="right"/>
35800 <tbody>
35801 <row>
35802 <entry><option>allow_filter</option></entry>
35803 <entry>Use: <emphasis>redirect</emphasis></entry>
35804 <entry>Type: <emphasis>boolean</emphasis></entry>
35805 <entry>Default: <emphasis>false</emphasis></entry>
35806 </row>
35807 </tbody>
35808 </tgroup>
35809 </informaltable>
35810 <para>
35811 <indexterm role="concept">
35812 <primary>filter</primary>
35813 <secondary>enabling use of</secondary>
35814 </indexterm>
35815 <indexterm role="concept">
35816 <primary>Sieve filter</primary>
35817 <secondary>enabling use of</secondary>
35818 </indexterm>
35819 Setting this option allows Exim to interpret redirection data that starts with
35820 <quote>#Exim filter</quote> or <quote>#Sieve filter</quote> as a set of filtering instructions. There
35821 are some features of Exim filter files that some administrators may wish to
35822 lock out; see the <option>forbid_filter_</option><emphasis>xxx</emphasis> options below.
35823 </para>
35824 <para>
35825 It is also possible to lock out Exim filters or Sieve filters while allowing
35826 the other type; see <option>forbid_exim_filter</option> and <option>forbid_sieve_filter</option>.
35827 </para>
35828 <para>
35829 The filter is run using the uid and gid set by the generic <option>user</option> and
35830 <option>group</option> options. These take their defaults from the password data if
35831 <option>check_local_user</option> is set, so in the normal case of users&#x2019; personal filter
35832 files, the filter is run as the relevant user. When <option>allow_filter</option> is set
35833 true, Exim insists that either <option>check_local_user</option> or <option>user</option> is set.
35834 </para>
35835 <para>
35836 <indexterm role="option">
35837 <primary><option>allow_freeze</option></primary>
35838 </indexterm>
35839 </para>
35840 <informaltable frame="all">
35841 <tgroup cols="4" colsep="0" rowsep="0">
35842 <colspec colwidth="8*" align="left"/>
35843 <colspec colwidth="6*" align="center"/>
35844 <colspec colwidth="6*" align="center"/>
35845 <colspec colwidth="6*" align="right"/>
35846 <tbody>
35847 <row>
35848 <entry><option>allow_freeze</option></entry>
35849 <entry>Use: <emphasis>redirect</emphasis></entry>
35850 <entry>Type: <emphasis>boolean</emphasis></entry>
35851 <entry>Default: <emphasis>false</emphasis></entry>
35852 </row>
35853 </tbody>
35854 </tgroup>
35855 </informaltable>
35856 <para>
35857 <indexterm role="concept">
35858 <primary>freezing messages</primary>
35859 <secondary>allowing in filter</secondary>
35860 </indexterm>
35861 Setting this option allows the use of the <option>freeze</option> command in an Exim filter.
35862 This command is more normally encountered in system filters, and is disabled by
35863 default for redirection filters because it isn&#x2019;t something you usually want to
35864 let ordinary users do.
35865 </para>
35866 <para>
35867 <indexterm role="option">
35868 <primary><option>check_ancestor</option></primary>
35869 </indexterm>
35870 </para>
35871 <informaltable frame="all">
35872 <tgroup cols="4" colsep="0" rowsep="0">
35873 <colspec colwidth="8*" align="left"/>
35874 <colspec colwidth="6*" align="center"/>
35875 <colspec colwidth="6*" align="center"/>
35876 <colspec colwidth="6*" align="right"/>
35877 <tbody>
35878 <row>
35879 <entry><option>check_ancestor</option></entry>
35880 <entry>Use: <emphasis>redirect</emphasis></entry>
35881 <entry>Type: <emphasis>boolean</emphasis></entry>
35882 <entry>Default: <emphasis>false</emphasis></entry>
35883 </row>
35884 </tbody>
35885 </tgroup>
35886 </informaltable>
35887 <para>
35888 This option is concerned with handling generated addresses that are the same
35889 as some address in the list of redirection ancestors of the current address.
35890 Although it is turned off by default in the code, it is set in the default
35891 configuration file for handling users&#x2019; <filename>.forward</filename> files. It is recommended
35892 for this use of the <command>redirect</command> router.
35893 </para>
35894 <para>
35895 When <option>check_ancestor</option> is set, if a generated address (including the domain)
35896 is the same as any ancestor of the current address, it is replaced by a copy of
35897 the current address. This helps in the case where local part A is aliased to B,
35898 and B has a <filename>.forward</filename> file pointing back to A. For example, within a single
35899 domain, the local part <quote>Joe.Bloggs</quote> is aliased to <quote>jb</quote> and
35900 <filename>&nbsp;jb/.forward</filename> contains:
35901 </para>
35902 <literallayout class="monospaced">
35903 \Joe.Bloggs, &lt;other item(s)&gt;
35904 </literallayout>
35905 <para>
35906 Without the <option>check_ancestor</option> setting, either local part (<quote>jb</quote> or
35907 <quote>joe.bloggs</quote>) gets processed once by each router and so ends up as it was
35908 originally. If <quote>jb</quote> is the real mailbox name, mail to <quote>jb</quote> gets delivered
35909 (having been turned into <quote>joe.bloggs</quote> by the <filename>.forward</filename> file and back to
35910 <quote>jb</quote> by the alias), but mail to <quote>joe.bloggs</quote> fails. Setting
35911 <option>check_ancestor</option> on the <command>redirect</command> router that handles the <filename>.forward</filename>
35912 file prevents it from turning <quote>jb</quote> back into <quote>joe.bloggs</quote> when that was the
35913 original address. See also the <option>repeat_use</option> option below.
35914 </para>
35915 <para>
35916 <indexterm role="option">
35917 <primary><option>check_group</option></primary>
35918 </indexterm>
35919 </para>
35920 <informaltable frame="all">
35921 <tgroup cols="4" colsep="0" rowsep="0">
35922 <colspec colwidth="8*" align="left"/>
35923 <colspec colwidth="6*" align="center"/>
35924 <colspec colwidth="6*" align="center"/>
35925 <colspec colwidth="6*" align="right"/>
35926 <tbody>
35927 <row>
35928 <entry><option>check_group</option></entry>
35929 <entry>Use: <emphasis>redirect</emphasis></entry>
35930 <entry>Type: <emphasis>boolean</emphasis></entry>
35931 <entry>Default: <emphasis>see below</emphasis></entry>
35932 </row>
35933 </tbody>
35934 </tgroup>
35935 </informaltable>
35936 <para>
35937 When the <option>file</option> option is used, the group owner of the file is checked only
35938 when this option is set. The permitted groups are those listed in the
35939 <option>owngroups</option> option, together with the user&#x2019;s default group if
35940 <option>check_local_user</option> is set. If the file has the wrong group, routing is
35941 deferred. The default setting for this option is true if <option>check_local_user</option>
35942 is set and the <option>modemask</option> option permits the group write bit, or if the
35943 <option>owngroups</option> option is set. Otherwise it is false, and no group check occurs.
35944 </para>
35945 <para>
35946 <indexterm role="option">
35947 <primary><option>check_owner</option></primary>
35948 </indexterm>
35949 </para>
35950 <informaltable frame="all">
35951 <tgroup cols="4" colsep="0" rowsep="0">
35952 <colspec colwidth="8*" align="left"/>
35953 <colspec colwidth="6*" align="center"/>
35954 <colspec colwidth="6*" align="center"/>
35955 <colspec colwidth="6*" align="right"/>
35956 <tbody>
35957 <row>
35958 <entry><option>check_owner</option></entry>
35959 <entry>Use: <emphasis>redirect</emphasis></entry>
35960 <entry>Type: <emphasis>boolean</emphasis></entry>
35961 <entry>Default: <emphasis>see below</emphasis></entry>
35962 </row>
35963 </tbody>
35964 </tgroup>
35965 </informaltable>
35966 <para>
35967 When the <option>file</option> option is used, the owner of the file is checked only when
35968 this option is set. If <option>check_local_user</option> is set, the local user is
35969 permitted; otherwise the owner must be one of those listed in the <option>owners</option>
35970 option. The default value for this option is true if <option>check_local_user</option> or
35971 <option>owners</option> is set. Otherwise the default is false, and no owner check occurs.
35972 </para>
35973 <para>
35974 <indexterm role="option">
35975 <primary><option>data</option></primary>
35976 </indexterm>
35977 </para>
35978 <informaltable frame="all">
35979 <tgroup cols="4" colsep="0" rowsep="0">
35980 <colspec colwidth="8*" align="left"/>
35981 <colspec colwidth="6*" align="center"/>
35982 <colspec colwidth="6*" align="center"/>
35983 <colspec colwidth="6*" align="right"/>
35984 <tbody>
35985 <row>
35986 <entry><option>data</option></entry>
35987 <entry>Use: <emphasis>redirect</emphasis></entry>
35988 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
35989 <entry>Default: <emphasis>unset</emphasis></entry>
35990 </row>
35991 </tbody>
35992 </tgroup>
35993 </informaltable>
35994 <para>
35995 This option is mutually exclusive with <option>file</option>. One or other of them must be
35996 set, but not both. The contents of <option>data</option> are expanded, and then used as the
35997 list of forwarding items, or as a set of filtering instructions. If the
35998 expansion is forced to fail, or the result is an empty string or a string that
35999 has no effect (consists entirely of comments), the router declines.
36000 </para>
36001 <para>
36002 When filtering instructions are used, the string must begin with <quote>#Exim
36003 filter</quote>, and all comments in the string, including this initial one, must be
36004 terminated with newline characters. For example:
36005 </para>
36006 <literallayout class="monospaced">
36007 data = #Exim filter\n\
36008        if $h_to: contains Exim then save $home/mail/exim endif
36009 </literallayout>
36010 <para>
36011 If you are reading the data from a database where newlines cannot be included,
36012 you can use the <varname>${sg}</varname> expansion item to turn the escape string of your
36013 choice into a newline.
36014 </para>
36015 <para>
36016 <indexterm role="option">
36017 <primary><option>directory_transport</option></primary>
36018 </indexterm>
36019 </para>
36020 <informaltable frame="all">
36021 <tgroup cols="4" colsep="0" rowsep="0">
36022 <colspec colwidth="8*" align="left"/>
36023 <colspec colwidth="6*" align="center"/>
36024 <colspec colwidth="6*" align="center"/>
36025 <colspec colwidth="6*" align="right"/>
36026 <tbody>
36027 <row>
36028 <entry><option>directory_transport</option></entry>
36029 <entry>Use: <emphasis>redirect</emphasis></entry>
36030 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
36031 <entry>Default: <emphasis>unset</emphasis></entry>
36032 </row>
36033 </tbody>
36034 </tgroup>
36035 </informaltable>
36036 <para>
36037 A <command>redirect</command> router sets up a direct delivery to a directory when a path name
36038 ending with a slash is specified as a new <quote>address</quote>. The transport used is
36039 specified by this option, which, after expansion, must be the name of a
36040 configured transport. This should normally be an <command>appendfile</command> transport.
36041 </para>
36042 <para>
36043 <indexterm role="option">
36044 <primary><option>file</option></primary>
36045 </indexterm>
36046 </para>
36047 <informaltable frame="all">
36048 <tgroup cols="4" colsep="0" rowsep="0">
36049 <colspec colwidth="8*" align="left"/>
36050 <colspec colwidth="6*" align="center"/>
36051 <colspec colwidth="6*" align="center"/>
36052 <colspec colwidth="6*" align="right"/>
36053 <tbody>
36054 <row>
36055 <entry><option>file</option></entry>
36056 <entry>Use: <emphasis>redirect</emphasis></entry>
36057 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
36058 <entry>Default: <emphasis>unset</emphasis></entry>
36059 </row>
36060 </tbody>
36061 </tgroup>
36062 </informaltable>
36063 <para>
36064 This option specifies the name of a file that contains the redirection data. It
36065 is mutually exclusive with the <option>data</option> option. The string is expanded before
36066 use; if the expansion is forced to fail, the router declines. Other expansion
36067 failures cause delivery to be deferred. The result of a successful expansion
36068 must be an absolute path. The entire file is read and used as the redirection
36069 data. If the data is an empty string or a string that has no effect (consists
36070 entirely of comments), the router declines.
36071 </para>
36072 <para>
36073 <indexterm role="concept">
36074 <primary>NFS</primary>
36075 <secondary>checking for file existence</secondary>
36076 </indexterm>
36077 If the attempt to open the file fails with a <quote>does not exist</quote> error, Exim
36078 runs a check on the containing directory,
36079 unless <option>ignore_enotdir</option> is true (see below).
36080 If the directory does not appear to exist, delivery is deferred. This can
36081 happen when users&#x2019; <filename>.forward</filename> files are in NFS-mounted directories, and there
36082 is a mount problem. If the containing directory does exist, but the file does
36083 not, the router declines.
36084 </para>
36085 <para>
36086 <indexterm role="option">
36087 <primary><option>file_transport</option></primary>
36088 </indexterm>
36089 </para>
36090 <informaltable frame="all">
36091 <tgroup cols="4" colsep="0" rowsep="0">
36092 <colspec colwidth="8*" align="left"/>
36093 <colspec colwidth="6*" align="center"/>
36094 <colspec colwidth="6*" align="center"/>
36095 <colspec colwidth="6*" align="right"/>
36096 <tbody>
36097 <row>
36098 <entry><option>file_transport</option></entry>
36099 <entry>Use: <emphasis>redirect</emphasis></entry>
36100 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
36101 <entry>Default: <emphasis>unset</emphasis></entry>
36102 </row>
36103 </tbody>
36104 </tgroup>
36105 </informaltable>
36106 <para>
36107 <indexterm role="variable">
36108 <primary><varname>$address_file</varname></primary>
36109 </indexterm>
36110 A <command>redirect</command> router sets up a direct delivery to a file when a path name not
36111 ending in a slash is specified as a new <quote>address</quote>. The transport used is
36112 specified by this option, which, after expansion, must be the name of a
36113 configured transport. This should normally be an <command>appendfile</command> transport. When
36114 it is running, the file name is in <varname>$address_file</varname>.
36115 </para>
36116 <para>
36117 <indexterm role="option">
36118 <primary><option>filter_prepend_home</option></primary>
36119 </indexterm>
36120 </para>
36121 <informaltable frame="all">
36122 <tgroup cols="4" colsep="0" rowsep="0">
36123 <colspec colwidth="8*" align="left"/>
36124 <colspec colwidth="6*" align="center"/>
36125 <colspec colwidth="6*" align="center"/>
36126 <colspec colwidth="6*" align="right"/>
36127 <tbody>
36128 <row>
36129 <entry><option>filter_prepend_home</option></entry>
36130 <entry>Use: <emphasis>redirect</emphasis></entry>
36131 <entry>Type: <emphasis>boolean</emphasis></entry>
36132 <entry>Default: <emphasis>true</emphasis></entry>
36133 </row>
36134 </tbody>
36135 </tgroup>
36136 </informaltable>
36137 <para>
36138 When this option is true, if a <command>save</command> command in an Exim filter specifies a
36139 relative path, and <varname>$home</varname> is defined, it is automatically prepended to the
36140 relative path. If this option is set false, this action does not happen. The
36141 relative path is then passed to the transport unmodified.
36142 </para>
36143 <para>
36144 <indexterm role="option">
36145 <primary><option>forbid_blackhole</option></primary>
36146 </indexterm>
36147 </para>
36148 <informaltable frame="all">
36149 <tgroup cols="4" colsep="0" rowsep="0">
36150 <colspec colwidth="8*" align="left"/>
36151 <colspec colwidth="6*" align="center"/>
36152 <colspec colwidth="6*" align="center"/>
36153 <colspec colwidth="6*" align="right"/>
36154 <tbody>
36155 <row>
36156 <entry><option>forbid_blackhole</option></entry>
36157 <entry>Use: <emphasis>redirect</emphasis></entry>
36158 <entry>Type: <emphasis>boolean</emphasis></entry>
36159 <entry>Default: <emphasis>false</emphasis></entry>
36160 </row>
36161 </tbody>
36162 </tgroup>
36163 </informaltable>
36164 <para>
36165 If this option is true, the <emphasis>:blackhole:</emphasis> item may not appear in a
36166 redirection list.
36167 </para>
36168 <para>
36169 <indexterm role="option">
36170 <primary><option>forbid_exim_filter</option></primary>
36171 </indexterm>
36172 </para>
36173 <informaltable frame="all">
36174 <tgroup cols="4" colsep="0" rowsep="0">
36175 <colspec colwidth="8*" align="left"/>
36176 <colspec colwidth="6*" align="center"/>
36177 <colspec colwidth="6*" align="center"/>
36178 <colspec colwidth="6*" align="right"/>
36179 <tbody>
36180 <row>
36181 <entry><option>forbid_exim_filter</option></entry>
36182 <entry>Use: <emphasis>redirect</emphasis></entry>
36183 <entry>Type: <emphasis>boolean</emphasis></entry>
36184 <entry>Default: <emphasis>false</emphasis></entry>
36185 </row>
36186 </tbody>
36187 </tgroup>
36188 </informaltable>
36189 <para>
36190 If this option is set true, only Sieve filters are permitted when
36191 <option>allow_filter</option> is true.
36192 </para>
36193 <para>
36194 <indexterm role="option">
36195 <primary><option>forbid_file</option></primary>
36196 </indexterm>
36197 </para>
36198 <informaltable frame="all">
36199 <tgroup cols="4" colsep="0" rowsep="0">
36200 <colspec colwidth="8*" align="left"/>
36201 <colspec colwidth="6*" align="center"/>
36202 <colspec colwidth="6*" align="center"/>
36203 <colspec colwidth="6*" align="right"/>
36204 <tbody>
36205 <row>
36206 <entry><option>forbid_file</option></entry>
36207 <entry>Use: <emphasis>redirect</emphasis></entry>
36208 <entry>Type: <emphasis>boolean</emphasis></entry>
36209 <entry>Default: <emphasis>false</emphasis></entry>
36210 </row>
36211 </tbody>
36212 </tgroup>
36213 </informaltable>
36214 <para>
36215 <indexterm role="concept">
36216 <primary>delivery</primary>
36217 <secondary>to file; forbidding</secondary>
36218 </indexterm>
36219 <indexterm role="concept">
36220 <primary>Sieve filter</primary>
36221 <secondary>forbidding delivery to a file</secondary>
36222 </indexterm>
36223 <indexterm role="concept">
36224 <primary>Sieve filter</primary>
36225 <secondary><quote>keep</quote> facility; disabling</secondary>
36226 </indexterm>
36227 If this option is true, this router may not generate a new address that
36228 specifies delivery to a local file or directory, either from a filter or from a
36229 conventional forward file. This option is forced to be true if <option>one_time</option> is
36230 set. It applies to Sieve filters as well as to Exim filters, but if true, it
36231 locks out the Sieve&#x2019;s <quote>keep</quote> facility.
36232 </para>
36233 <para>
36234 <indexterm role="option">
36235 <primary><option>forbid_filter_dlfunc</option></primary>
36236 </indexterm>
36237 </para>
36238 <informaltable frame="all">
36239 <tgroup cols="4" colsep="0" rowsep="0">
36240 <colspec colwidth="8*" align="left"/>
36241 <colspec colwidth="6*" align="center"/>
36242 <colspec colwidth="6*" align="center"/>
36243 <colspec colwidth="6*" align="right"/>
36244 <tbody>
36245 <row>
36246 <entry><option>forbid_filter_dlfunc</option></entry>
36247 <entry>Use: <emphasis>redirect</emphasis></entry>
36248 <entry>Type: <emphasis>boolean</emphasis></entry>
36249 <entry>Default: <emphasis>false</emphasis></entry>
36250 </row>
36251 </tbody>
36252 </tgroup>
36253 </informaltable>
36254 <para>
36255 <indexterm role="concept">
36256 <primary>filter</primary>
36257 <secondary>locking out certain features</secondary>
36258 </indexterm>
36259 If this option is true, string expansions in Exim filters are not allowed to
36260 make use of the <option>dlfunc</option> expansion facility to run dynamically loaded
36261 functions.
36262 </para>
36263 <para>
36264 <indexterm role="option">
36265 <primary><option>forbid_filter_existstest</option></primary>
36266 </indexterm>
36267 </para>
36268 <informaltable frame="all">
36269 <tgroup cols="4" colsep="0" rowsep="0">
36270 <colspec colwidth="8*" align="left"/>
36271 <colspec colwidth="6*" align="center"/>
36272 <colspec colwidth="6*" align="center"/>
36273 <colspec colwidth="6*" align="right"/>
36274 <tbody>
36275 <row>
36276 <entry><option>forbid_filter_existstest</option></entry>
36277 <entry>Use: <emphasis>redirect</emphasis></entry>
36278 <entry>Type: <emphasis>boolean</emphasis></entry>
36279 <entry>Default: <emphasis>false</emphasis></entry>
36280 </row>
36281 </tbody>
36282 </tgroup>
36283 </informaltable>
36284 <para>
36285 <indexterm role="concept">
36286 <primary>expansion</primary>
36287 <secondary>statting a file</secondary>
36288 </indexterm>
36289 If this option is true, string expansions in Exim filters are not allowed to
36290 make use of the <option>exists</option> condition or the <option>stat</option> expansion item.
36291 </para>
36292 <para>
36293 <indexterm role="option">
36294 <primary><option>forbid_filter_logwrite</option></primary>
36295 </indexterm>
36296 </para>
36297 <informaltable frame="all">
36298 <tgroup cols="4" colsep="0" rowsep="0">
36299 <colspec colwidth="8*" align="left"/>
36300 <colspec colwidth="6*" align="center"/>
36301 <colspec colwidth="6*" align="center"/>
36302 <colspec colwidth="6*" align="right"/>
36303 <tbody>
36304 <row>
36305 <entry><option>forbid_filter_logwrite</option></entry>
36306 <entry>Use: <emphasis>redirect</emphasis></entry>
36307 <entry>Type: <emphasis>boolean</emphasis></entry>
36308 <entry>Default: <emphasis>false</emphasis></entry>
36309 </row>
36310 </tbody>
36311 </tgroup>
36312 </informaltable>
36313 <para>
36314 If this option is true, use of the logging facility in Exim filters is not
36315 permitted. Logging is in any case available only if the filter is being run
36316 under some unprivileged uid (which is normally the case for ordinary users&#x2019;
36317 <filename>.forward</filename> files).
36318 </para>
36319 <para>
36320 <indexterm role="option">
36321 <primary><option>forbid_filter_lookup</option></primary>
36322 </indexterm>
36323 </para>
36324 <informaltable frame="all">
36325 <tgroup cols="4" colsep="0" rowsep="0">
36326 <colspec colwidth="8*" align="left"/>
36327 <colspec colwidth="6*" align="center"/>
36328 <colspec colwidth="6*" align="center"/>
36329 <colspec colwidth="6*" align="right"/>
36330 <tbody>
36331 <row>
36332 <entry><option>forbid_filter_lookup</option></entry>
36333 <entry>Use: <emphasis>redirect</emphasis></entry>
36334 <entry>Type: <emphasis>boolean</emphasis></entry>
36335 <entry>Default: <emphasis>false</emphasis></entry>
36336 </row>
36337 </tbody>
36338 </tgroup>
36339 </informaltable>
36340 <para>
36341 If this option is true, string expansions in Exim filter files are not allowed
36342 to make use of <option>lookup</option> items.
36343 </para>
36344 <para>
36345 <indexterm role="option">
36346 <primary><option>forbid_filter_perl</option></primary>
36347 </indexterm>
36348 </para>
36349 <informaltable frame="all">
36350 <tgroup cols="4" colsep="0" rowsep="0">
36351 <colspec colwidth="8*" align="left"/>
36352 <colspec colwidth="6*" align="center"/>
36353 <colspec colwidth="6*" align="center"/>
36354 <colspec colwidth="6*" align="right"/>
36355 <tbody>
36356 <row>
36357 <entry><option>forbid_filter_perl</option></entry>
36358 <entry>Use: <emphasis>redirect</emphasis></entry>
36359 <entry>Type: <emphasis>boolean</emphasis></entry>
36360 <entry>Default: <emphasis>false</emphasis></entry>
36361 </row>
36362 </tbody>
36363 </tgroup>
36364 </informaltable>
36365 <para>
36366 This option has an effect only if Exim is built with embedded Perl support. If
36367 it is true, string expansions in Exim filter files are not allowed to make use
36368 of the embedded Perl support.
36369 </para>
36370 <para>
36371 <indexterm role="option">
36372 <primary><option>forbid_filter_readfile</option></primary>
36373 </indexterm>
36374 </para>
36375 <informaltable frame="all">
36376 <tgroup cols="4" colsep="0" rowsep="0">
36377 <colspec colwidth="8*" align="left"/>
36378 <colspec colwidth="6*" align="center"/>
36379 <colspec colwidth="6*" align="center"/>
36380 <colspec colwidth="6*" align="right"/>
36381 <tbody>
36382 <row>
36383 <entry><option>forbid_filter_readfile</option></entry>
36384 <entry>Use: <emphasis>redirect</emphasis></entry>
36385 <entry>Type: <emphasis>boolean</emphasis></entry>
36386 <entry>Default: <emphasis>false</emphasis></entry>
36387 </row>
36388 </tbody>
36389 </tgroup>
36390 </informaltable>
36391 <para>
36392 If this option is true, string expansions in Exim filter files are not allowed
36393 to make use of <option>readfile</option> items.
36394 </para>
36395 <para>
36396 <indexterm role="option">
36397 <primary><option>forbid_filter_readsocket</option></primary>
36398 </indexterm>
36399 </para>
36400 <informaltable frame="all">
36401 <tgroup cols="4" colsep="0" rowsep="0">
36402 <colspec colwidth="8*" align="left"/>
36403 <colspec colwidth="6*" align="center"/>
36404 <colspec colwidth="6*" align="center"/>
36405 <colspec colwidth="6*" align="right"/>
36406 <tbody>
36407 <row>
36408 <entry><option>forbid_filter_readsocket</option></entry>
36409 <entry>Use: <emphasis>redirect</emphasis></entry>
36410 <entry>Type: <emphasis>boolean</emphasis></entry>
36411 <entry>Default: <emphasis>false</emphasis></entry>
36412 </row>
36413 </tbody>
36414 </tgroup>
36415 </informaltable>
36416 <para>
36417 If this option is true, string expansions in Exim filter files are not allowed
36418 to make use of <option>readsocket</option> items.
36419 </para>
36420 <para>
36421 <indexterm role="option">
36422 <primary><option>forbid_filter_reply</option></primary>
36423 </indexterm>
36424 </para>
36425 <informaltable frame="all">
36426 <tgroup cols="4" colsep="0" rowsep="0">
36427 <colspec colwidth="8*" align="left"/>
36428 <colspec colwidth="6*" align="center"/>
36429 <colspec colwidth="6*" align="center"/>
36430 <colspec colwidth="6*" align="right"/>
36431 <tbody>
36432 <row>
36433 <entry><option>forbid_filter_reply</option></entry>
36434 <entry>Use: <emphasis>redirect</emphasis></entry>
36435 <entry>Type: <emphasis>boolean</emphasis></entry>
36436 <entry>Default: <emphasis>false</emphasis></entry>
36437 </row>
36438 </tbody>
36439 </tgroup>
36440 </informaltable>
36441 <para>
36442 If this option is true, this router may not generate an automatic reply
36443 message. Automatic replies can be generated only from Exim or Sieve filter
36444 files, not from traditional forward files. This option is forced to be true if
36445 <option>one_time</option> is set.
36446 </para>
36447 <para>
36448 <indexterm role="option">
36449 <primary><option>forbid_filter_run</option></primary>
36450 </indexterm>
36451 </para>
36452 <informaltable frame="all">
36453 <tgroup cols="4" colsep="0" rowsep="0">
36454 <colspec colwidth="8*" align="left"/>
36455 <colspec colwidth="6*" align="center"/>
36456 <colspec colwidth="6*" align="center"/>
36457 <colspec colwidth="6*" align="right"/>
36458 <tbody>
36459 <row>
36460 <entry><option>forbid_filter_run</option></entry>
36461 <entry>Use: <emphasis>redirect</emphasis></entry>
36462 <entry>Type: <emphasis>boolean</emphasis></entry>
36463 <entry>Default: <emphasis>false</emphasis></entry>
36464 </row>
36465 </tbody>
36466 </tgroup>
36467 </informaltable>
36468 <para>
36469 If this option is true, string expansions in Exim filter files are not allowed
36470 to make use of <option>run</option> items.
36471 </para>
36472 <para>
36473 <indexterm role="option">
36474 <primary><option>forbid_include</option></primary>
36475 </indexterm>
36476 </para>
36477 <informaltable frame="all">
36478 <tgroup cols="4" colsep="0" rowsep="0">
36479 <colspec colwidth="8*" align="left"/>
36480 <colspec colwidth="6*" align="center"/>
36481 <colspec colwidth="6*" align="center"/>
36482 <colspec colwidth="6*" align="right"/>
36483 <tbody>
36484 <row>
36485 <entry><option>forbid_include</option></entry>
36486 <entry>Use: <emphasis>redirect</emphasis></entry>
36487 <entry>Type: <emphasis>boolean</emphasis></entry>
36488 <entry>Default: <emphasis>false</emphasis></entry>
36489 </row>
36490 </tbody>
36491 </tgroup>
36492 </informaltable>
36493 <para>
36494 If this option is true, items of the form
36495 </para>
36496 <literallayout class="monospaced">
36497 :include:&lt;path name&gt;
36498 </literallayout>
36499 <para>
36500 are not permitted in non-filter redirection lists.
36501 </para>
36502 <para>
36503 <indexterm role="option">
36504 <primary><option>forbid_pipe</option></primary>
36505 </indexterm>
36506 </para>
36507 <informaltable frame="all">
36508 <tgroup cols="4" colsep="0" rowsep="0">
36509 <colspec colwidth="8*" align="left"/>
36510 <colspec colwidth="6*" align="center"/>
36511 <colspec colwidth="6*" align="center"/>
36512 <colspec colwidth="6*" align="right"/>
36513 <tbody>
36514 <row>
36515 <entry><option>forbid_pipe</option></entry>
36516 <entry>Use: <emphasis>redirect</emphasis></entry>
36517 <entry>Type: <emphasis>boolean</emphasis></entry>
36518 <entry>Default: <emphasis>false</emphasis></entry>
36519 </row>
36520 </tbody>
36521 </tgroup>
36522 </informaltable>
36523 <para>
36524 <indexterm role="concept">
36525 <primary>delivery</primary>
36526 <secondary>to pipe; forbidding</secondary>
36527 </indexterm>
36528 If this option is true, this router may not generate a new address which
36529 specifies delivery to a pipe, either from an Exim filter or from a conventional
36530 forward file. This option is forced to be true if <option>one_time</option> is set.
36531 </para>
36532 <para>
36533 <indexterm role="option">
36534 <primary><option>forbid_sieve_filter</option></primary>
36535 </indexterm>
36536 </para>
36537 <informaltable frame="all">
36538 <tgroup cols="4" colsep="0" rowsep="0">
36539 <colspec colwidth="8*" align="left"/>
36540 <colspec colwidth="6*" align="center"/>
36541 <colspec colwidth="6*" align="center"/>
36542 <colspec colwidth="6*" align="right"/>
36543 <tbody>
36544 <row>
36545 <entry><option>forbid_sieve_filter</option></entry>
36546 <entry>Use: <emphasis>redirect</emphasis></entry>
36547 <entry>Type: <emphasis>boolean</emphasis></entry>
36548 <entry>Default: <emphasis>false</emphasis></entry>
36549 </row>
36550 </tbody>
36551 </tgroup>
36552 </informaltable>
36553 <para>
36554 If this option is set true, only Exim filters are permitted when
36555 <option>allow_filter</option> is true.
36556 </para>
36557 <para>
36558 <indexterm role="concept">
36559 <primary>SMTP</primary>
36560 <secondary>error codes</secondary>
36561 </indexterm>
36562 <indexterm role="option">
36563 <primary><option>forbid_smtp_code</option></primary>
36564 </indexterm>
36565 </para>
36566 <informaltable frame="all">
36567 <tgroup cols="4" colsep="0" rowsep="0">
36568 <colspec colwidth="8*" align="left"/>
36569 <colspec colwidth="6*" align="center"/>
36570 <colspec colwidth="6*" align="center"/>
36571 <colspec colwidth="6*" align="right"/>
36572 <tbody>
36573 <row>
36574 <entry><option>forbid_smtp_code</option></entry>
36575 <entry>Use: <emphasis>redirect</emphasis></entry>
36576 <entry>Type: <emphasis>boolean</emphasis></entry>
36577 <entry>Default: <emphasis>false</emphasis></entry>
36578 </row>
36579 </tbody>
36580 </tgroup>
36581 </informaltable>
36582 <para>
36583 If this option is set true, any SMTP error codes that are present at the start
36584 of messages specified for <literal>:defer:</literal> or <literal>:fail:</literal> are quietly ignored, and
36585 the default codes (451 and 550, respectively) are always used.
36586 </para>
36587 <para>
36588 <indexterm role="option">
36589 <primary><option>hide_child_in_errmsg</option></primary>
36590 </indexterm>
36591 </para>
36592 <informaltable frame="all">
36593 <tgroup cols="4" colsep="0" rowsep="0">
36594 <colspec colwidth="8*" align="left"/>
36595 <colspec colwidth="6*" align="center"/>
36596 <colspec colwidth="6*" align="center"/>
36597 <colspec colwidth="6*" align="right"/>
36598 <tbody>
36599 <row>
36600 <entry><option>hide_child_in_errmsg</option></entry>
36601 <entry>Use: <emphasis>redirect</emphasis></entry>
36602 <entry>Type: <emphasis>boolean</emphasis></entry>
36603 <entry>Default: <emphasis>false</emphasis></entry>
36604 </row>
36605 </tbody>
36606 </tgroup>
36607 </informaltable>
36608 <para>
36609 <indexterm role="concept">
36610 <primary>bounce message</primary>
36611 <secondary>redirection details; suppressing</secondary>
36612 </indexterm>
36613 If this option is true, it prevents Exim from quoting a child address if it
36614 generates a bounce or delay message for it. Instead it says <quote>an address
36615 generated from &lt;<emphasis>the top level address</emphasis>&gt;</quote>. Of course, this applies only to
36616 bounces generated locally. If a message is forwarded to another host, <emphasis>its</emphasis>
36617 bounce may well quote the generated address.
36618 </para>
36619 <para>
36620 <indexterm role="option">
36621 <primary><option>ignore_eacces</option></primary>
36622 </indexterm>
36623 </para>
36624 <informaltable frame="all">
36625 <tgroup cols="4" colsep="0" rowsep="0">
36626 <colspec colwidth="8*" align="left"/>
36627 <colspec colwidth="6*" align="center"/>
36628 <colspec colwidth="6*" align="center"/>
36629 <colspec colwidth="6*" align="right"/>
36630 <tbody>
36631 <row>
36632 <entry><option>ignore_eacces</option></entry>
36633 <entry>Use: <emphasis>redirect</emphasis></entry>
36634 <entry>Type: <emphasis>boolean</emphasis></entry>
36635 <entry>Default: <emphasis>false</emphasis></entry>
36636 </row>
36637 </tbody>
36638 </tgroup>
36639 </informaltable>
36640 <para>
36641 <indexterm role="concept">
36642 <primary>EACCES</primary>
36643 </indexterm>
36644 If this option is set and an attempt to open a redirection file yields the
36645 EACCES error (permission denied), the <command>redirect</command> router behaves as if the
36646 file did not exist.
36647 </para>
36648 <para>
36649 <indexterm role="option">
36650 <primary><option>ignore_enotdir</option></primary>
36651 </indexterm>
36652 </para>
36653 <informaltable frame="all">
36654 <tgroup cols="4" colsep="0" rowsep="0">
36655 <colspec colwidth="8*" align="left"/>
36656 <colspec colwidth="6*" align="center"/>
36657 <colspec colwidth="6*" align="center"/>
36658 <colspec colwidth="6*" align="right"/>
36659 <tbody>
36660 <row>
36661 <entry><option>ignore_enotdir</option></entry>
36662 <entry>Use: <emphasis>redirect</emphasis></entry>
36663 <entry>Type: <emphasis>boolean</emphasis></entry>
36664 <entry>Default: <emphasis>false</emphasis></entry>
36665 </row>
36666 </tbody>
36667 </tgroup>
36668 </informaltable>
36669 <para>
36670 <indexterm role="concept">
36671 <primary>ENOTDIR</primary>
36672 </indexterm>
36673 If this option is set and an attempt to open a redirection file yields the
36674 ENOTDIR error (something on the path is not a directory), the <command>redirect</command>
36675 router behaves as if the file did not exist.
36676 </para>
36677 <para>
36678 Setting <option>ignore_enotdir</option> has another effect as well: When a <command>redirect</command>
36679 router that has the <option>file</option> option set discovers that the file does not exist
36680 (the ENOENT error), it tries to <function>stat()</function> the parent directory, as a check
36681 against unmounted NFS directories. If the parent can not be statted, delivery
36682 is deferred. However, it seems wrong to do this check when <option>ignore_enotdir</option>
36683 is set, because that option tells Exim to ignore <quote>something on the path is not
36684 a directory</quote> (the ENOTDIR error). This is a confusing area, because it seems
36685 that some operating systems give ENOENT where others give ENOTDIR.
36686 </para>
36687 <para>
36688 <indexterm role="option">
36689 <primary><option>include_directory</option></primary>
36690 </indexterm>
36691 </para>
36692 <informaltable frame="all">
36693 <tgroup cols="4" colsep="0" rowsep="0">
36694 <colspec colwidth="8*" align="left"/>
36695 <colspec colwidth="6*" align="center"/>
36696 <colspec colwidth="6*" align="center"/>
36697 <colspec colwidth="6*" align="right"/>
36698 <tbody>
36699 <row>
36700 <entry><option>include_directory</option></entry>
36701 <entry>Use: <emphasis>redirect</emphasis></entry>
36702 <entry>Type: <emphasis>string</emphasis></entry>
36703 <entry>Default: <emphasis>unset</emphasis></entry>
36704 </row>
36705 </tbody>
36706 </tgroup>
36707 </informaltable>
36708 <para>
36709 If this option is set, the path names of any <emphasis>:include:</emphasis> items in a
36710 redirection list must start with this directory.
36711 </para>
36712 <para>
36713 <indexterm role="option">
36714 <primary><option>modemask</option></primary>
36715 </indexterm>
36716 </para>
36717 <informaltable frame="all">
36718 <tgroup cols="4" colsep="0" rowsep="0">
36719 <colspec colwidth="8*" align="left"/>
36720 <colspec colwidth="6*" align="center"/>
36721 <colspec colwidth="6*" align="center"/>
36722 <colspec colwidth="6*" align="right"/>
36723 <tbody>
36724 <row>
36725 <entry><option>modemask</option></entry>
36726 <entry>Use: <emphasis>redirect</emphasis></entry>
36727 <entry>Type: <emphasis>octal integer</emphasis></entry>
36728 <entry>Default: <emphasis>022</emphasis></entry>
36729 </row>
36730 </tbody>
36731 </tgroup>
36732 </informaltable>
36733 <para>
36734 This specifies mode bits which must not be set for a file specified by the
36735 <option>file</option> option. If any of the forbidden bits are set, delivery is deferred.
36736 </para>
36737 <para>
36738 <indexterm role="option">
36739 <primary><option>one_time</option></primary>
36740 </indexterm>
36741 </para>
36742 <informaltable frame="all">
36743 <tgroup cols="4" colsep="0" rowsep="0">
36744 <colspec colwidth="8*" align="left"/>
36745 <colspec colwidth="6*" align="center"/>
36746 <colspec colwidth="6*" align="center"/>
36747 <colspec colwidth="6*" align="right"/>
36748 <tbody>
36749 <row>
36750 <entry><option>one_time</option></entry>
36751 <entry>Use: <emphasis>redirect</emphasis></entry>
36752 <entry>Type: <emphasis>boolean</emphasis></entry>
36753 <entry>Default: <emphasis>false</emphasis></entry>
36754 </row>
36755 </tbody>
36756 </tgroup>
36757 </informaltable>
36758 <para>
36759 <indexterm role="concept">
36760 <primary>one-time aliasing/forwarding expansion</primary>
36761 </indexterm>
36762 <indexterm role="concept">
36763 <primary>alias file</primary>
36764 <secondary>one-time expansion</secondary>
36765 </indexterm>
36766 <indexterm role="concept">
36767 <primary>forward file</primary>
36768 <secondary>one-time expansion</secondary>
36769 </indexterm>
36770 <indexterm role="concept">
36771 <primary>mailing lists</primary>
36772 <secondary>one-time expansion</secondary>
36773 </indexterm>
36774 <indexterm role="concept">
36775 <primary>address redirection</primary>
36776 <secondary>one-time expansion</secondary>
36777 </indexterm>
36778 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
36779 files each time it tries to deliver a message causes a problem when one or more
36780 of the generated addresses fails be delivered at the first attempt. The problem
36781 is not one of duplicate delivery &ndash; Exim is clever enough to handle that &ndash;
36782 but of what happens when the redirection list changes during the time that the
36783 message is on Exim&#x2019;s queue. This is particularly true in the case of mailing
36784 lists, where new subscribers might receive copies of messages that were posted
36785 before they subscribed.
36786 </para>
36787 <para>
36788 If <option>one_time</option> is set and any addresses generated by the router fail to
36789 deliver at the first attempt, the failing addresses are added to the message as
36790 <quote>top level</quote> addresses, and the parent address that generated them is marked
36791 <quote>delivered</quote>. Thus, redirection does not happen again at the next delivery
36792 attempt.
36793 </para>
36794 <para>
36795 <emphasis role="bold">Warning 1</emphasis>: Any header line addition or removal that is specified by this
36796 router would be lost if delivery did not succeed at the first attempt. For this
36797 reason, the <option>headers_add</option> and <option>headers_remove</option> generic options are not
36798 permitted when <option>one_time</option> is set.
36799 </para>
36800 <para>
36801 <emphasis role="bold">Warning 2</emphasis>: To ensure that the router generates only addresses (as opposed
36802 to pipe or file deliveries or auto-replies) <option>forbid_file</option>, <option>forbid_pipe</option>,
36803 and <option>forbid_filter_reply</option> are forced to be true when <option>one_time</option> is set.
36804 </para>
36805 <para>
36806 <emphasis role="bold">Warning 3</emphasis>: The <option>unseen</option> generic router option may not be set with
36807 <option>one_time</option>.
36808 </para>
36809 <para>
36810 The original top-level address is remembered with each of the generated
36811 addresses, and is output in any log messages. However, any intermediate parent
36812 addresses are not recorded. This makes a difference to the log only if
36813 <option>all_parents</option> log selector is set. It is expected that <option>one_time</option> will
36814 typically be used for mailing lists, where there is normally just one level of
36815 expansion.
36816 </para>
36817 <para>
36818 <indexterm role="option">
36819 <primary><option>owners</option></primary>
36820 </indexterm>
36821 </para>
36822 <informaltable frame="all">
36823 <tgroup cols="4" colsep="0" rowsep="0">
36824 <colspec colwidth="8*" align="left"/>
36825 <colspec colwidth="6*" align="center"/>
36826 <colspec colwidth="6*" align="center"/>
36827 <colspec colwidth="6*" align="right"/>
36828 <tbody>
36829 <row>
36830 <entry><option>owners</option></entry>
36831 <entry>Use: <emphasis>redirect</emphasis></entry>
36832 <entry>Type: <emphasis>string list</emphasis></entry>
36833 <entry>Default: <emphasis>unset</emphasis></entry>
36834 </row>
36835 </tbody>
36836 </tgroup>
36837 </informaltable>
36838 <para>
36839 <indexterm role="concept">
36840 <primary>ownership</primary>
36841 <secondary>alias file</secondary>
36842 </indexterm>
36843 <indexterm role="concept">
36844 <primary>ownership</primary>
36845 <secondary>forward file</secondary>
36846 </indexterm>
36847 <indexterm role="concept">
36848 <primary>alias file</primary>
36849 <secondary>ownership</secondary>
36850 </indexterm>
36851 <indexterm role="concept">
36852 <primary>forward file</primary>
36853 <secondary>ownership</secondary>
36854 </indexterm>
36855 This specifies a list of permitted owners for the file specified by <option>file</option>.
36856 This list is in addition to the local user when <option>check_local_user</option> is set.
36857 See <option>check_owner</option> above.
36858 </para>
36859 <para>
36860 <indexterm role="option">
36861 <primary><option>owngroups</option></primary>
36862 </indexterm>
36863 </para>
36864 <informaltable frame="all">
36865 <tgroup cols="4" colsep="0" rowsep="0">
36866 <colspec colwidth="8*" align="left"/>
36867 <colspec colwidth="6*" align="center"/>
36868 <colspec colwidth="6*" align="center"/>
36869 <colspec colwidth="6*" align="right"/>
36870 <tbody>
36871 <row>
36872 <entry><option>owngroups</option></entry>
36873 <entry>Use: <emphasis>redirect</emphasis></entry>
36874 <entry>Type: <emphasis>string list</emphasis></entry>
36875 <entry>Default: <emphasis>unset</emphasis></entry>
36876 </row>
36877 </tbody>
36878 </tgroup>
36879 </informaltable>
36880 <para>
36881 This specifies a list of permitted groups for the file specified by <option>file</option>.
36882 The list is in addition to the local user&#x2019;s primary group when
36883 <option>check_local_user</option> is set. See <option>check_group</option> above.
36884 </para>
36885 <para>
36886 <indexterm role="option">
36887 <primary><option>pipe_transport</option></primary>
36888 </indexterm>
36889 </para>
36890 <informaltable frame="all">
36891 <tgroup cols="4" colsep="0" rowsep="0">
36892 <colspec colwidth="8*" align="left"/>
36893 <colspec colwidth="6*" align="center"/>
36894 <colspec colwidth="6*" align="center"/>
36895 <colspec colwidth="6*" align="right"/>
36896 <tbody>
36897 <row>
36898 <entry><option>pipe_transport</option></entry>
36899 <entry>Use: <emphasis>redirect</emphasis></entry>
36900 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
36901 <entry>Default: <emphasis>unset</emphasis></entry>
36902 </row>
36903 </tbody>
36904 </tgroup>
36905 </informaltable>
36906 <para>
36907 <indexterm role="variable">
36908 <primary><varname>$address_pipe</varname></primary>
36909 </indexterm>
36910 A <command>redirect</command> router sets up a direct delivery to a pipe when a string
36911 starting with a vertical bar character is specified as a new <quote>address</quote>. The
36912 transport used is specified by this option, which, after expansion, must be the
36913 name of a configured transport. This should normally be a <command>pipe</command> transport.
36914 When the transport is run, the pipe command is in <varname>$address_pipe</varname>.
36915 </para>
36916 <para>
36917 <indexterm role="option">
36918 <primary><option>qualify_domain</option></primary>
36919 </indexterm>
36920 </para>
36921 <informaltable frame="all">
36922 <tgroup cols="4" colsep="0" rowsep="0">
36923 <colspec colwidth="8*" align="left"/>
36924 <colspec colwidth="6*" align="center"/>
36925 <colspec colwidth="6*" align="center"/>
36926 <colspec colwidth="6*" align="right"/>
36927 <tbody>
36928 <row>
36929 <entry><option>qualify_domain</option></entry>
36930 <entry>Use: <emphasis>redirect</emphasis></entry>
36931 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
36932 <entry>Default: <emphasis>unset</emphasis></entry>
36933 </row>
36934 </tbody>
36935 </tgroup>
36936 </informaltable>
36937 <para>
36938 <indexterm role="variable">
36939 <primary><varname>$qualify_recipient</varname></primary>
36940 </indexterm>
36941 If this option is set, and an unqualified address (one without a domain) is
36942 generated, and that address would normally be qualified by the global setting
36943 in <option>qualify_recipient</option>, it is instead qualified with the domain specified by
36944 expanding this string. If the expansion fails, the router declines. If you want
36945 to revert to the default, you can have the expansion generate
36946 <varname>$qualify_recipient</varname>.
36947 </para>
36948 <para>
36949 This option applies to all unqualified addresses generated by Exim filters,
36950 but for traditional <filename>.forward</filename> files, it applies only to addresses that are
36951 not preceded by a backslash. Sieve filters cannot generate unqualified
36952 addresses.
36953 </para>
36954 <para>
36955 <indexterm role="option">
36956 <primary><option>qualify_preserve_domain</option></primary>
36957 </indexterm>
36958 </para>
36959 <informaltable frame="all">
36960 <tgroup cols="4" colsep="0" rowsep="0">
36961 <colspec colwidth="8*" align="left"/>
36962 <colspec colwidth="6*" align="center"/>
36963 <colspec colwidth="6*" align="center"/>
36964 <colspec colwidth="6*" align="right"/>
36965 <tbody>
36966 <row>
36967 <entry><option>qualify_preserve_domain</option></entry>
36968 <entry>Use: <emphasis>redirect</emphasis></entry>
36969 <entry>Type: <emphasis>boolean</emphasis></entry>
36970 <entry>Default: <emphasis>false</emphasis></entry>
36971 </row>
36972 </tbody>
36973 </tgroup>
36974 </informaltable>
36975 <para>
36976 <indexterm role="concept">
36977 <primary>domain</primary>
36978 <secondary>in redirection; preserving</secondary>
36979 </indexterm>
36980 <indexterm role="concept">
36981 <primary>preserving domain in redirection</primary>
36982 </indexterm>
36983 <indexterm role="concept">
36984 <primary>address redirection</primary>
36985 <secondary>domain; preserving</secondary>
36986 </indexterm>
36987 If this option is set, the router&#x2019;s local <option>qualify_domain</option> option must not be
36988 set (a configuration error occurs if it is). If an unqualified address (one
36989 without a domain) is generated, it is qualified with the domain of the parent
36990 address (the immediately preceding ancestor) instead of the global
36991 <option>qualify_recipient</option> value. In the case of a traditional <filename>.forward</filename> file,
36992 this applies whether or not the address is preceded by a backslash.
36993 </para>
36994 <para>
36995 <indexterm role="option">
36996 <primary><option>repeat_use</option></primary>
36997 </indexterm>
36998 </para>
36999 <informaltable frame="all">
37000 <tgroup cols="4" colsep="0" rowsep="0">
37001 <colspec colwidth="8*" align="left"/>
37002 <colspec colwidth="6*" align="center"/>
37003 <colspec colwidth="6*" align="center"/>
37004 <colspec colwidth="6*" align="right"/>
37005 <tbody>
37006 <row>
37007 <entry><option>repeat_use</option></entry>
37008 <entry>Use: <emphasis>redirect</emphasis></entry>
37009 <entry>Type: <emphasis>boolean</emphasis></entry>
37010 <entry>Default: <emphasis>true</emphasis></entry>
37011 </row>
37012 </tbody>
37013 </tgroup>
37014 </informaltable>
37015 <para>
37016 If this option is set false, the router is skipped for a child address that has
37017 any ancestor that was routed by this router. This test happens before any of
37018 the other preconditions are tested. Exim&#x2019;s default anti-looping rules skip
37019 only when the ancestor is the same as the current address. See also
37020 <option>check_ancestor</option> above and the generic <option>redirect_router</option> option.
37021 </para>
37022 <para>
37023 <indexterm role="option">
37024 <primary><option>reply_transport</option></primary>
37025 </indexterm>
37026 </para>
37027 <informaltable frame="all">
37028 <tgroup cols="4" colsep="0" rowsep="0">
37029 <colspec colwidth="8*" align="left"/>
37030 <colspec colwidth="6*" align="center"/>
37031 <colspec colwidth="6*" align="center"/>
37032 <colspec colwidth="6*" align="right"/>
37033 <tbody>
37034 <row>
37035 <entry><option>reply_transport</option></entry>
37036 <entry>Use: <emphasis>redirect</emphasis></entry>
37037 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
37038 <entry>Default: <emphasis>unset</emphasis></entry>
37039 </row>
37040 </tbody>
37041 </tgroup>
37042 </informaltable>
37043 <para>
37044 A <command>redirect</command> router sets up an automatic reply when a <option>mail</option> or
37045 <option>vacation</option> command is used in a filter file. The transport used is specified
37046 by this option, which, after expansion, must be the name of a configured
37047 transport. This should normally be an <command>autoreply</command> transport. Other transports
37048 are unlikely to do anything sensible or useful.
37049 </para>
37050 <para>
37051 <indexterm role="option">
37052 <primary><option>rewrite</option></primary>
37053 </indexterm>
37054 </para>
37055 <informaltable frame="all">
37056 <tgroup cols="4" colsep="0" rowsep="0">
37057 <colspec colwidth="8*" align="left"/>
37058 <colspec colwidth="6*" align="center"/>
37059 <colspec colwidth="6*" align="center"/>
37060 <colspec colwidth="6*" align="right"/>
37061 <tbody>
37062 <row>
37063 <entry><option>rewrite</option></entry>
37064 <entry>Use: <emphasis>redirect</emphasis></entry>
37065 <entry>Type: <emphasis>boolean</emphasis></entry>
37066 <entry>Default: <emphasis>true</emphasis></entry>
37067 </row>
37068 </tbody>
37069 </tgroup>
37070 </informaltable>
37071 <para>
37072 <indexterm role="concept">
37073 <primary>address redirection</primary>
37074 <secondary>disabling rewriting</secondary>
37075 </indexterm>
37076 If this option is set false, addresses generated by the router are not
37077 subject to address rewriting. Otherwise, they are treated like new addresses
37078 and are rewritten according to the global rewriting rules.
37079 </para>
37080 <para>
37081 <indexterm role="option">
37082 <primary><option>sieve_subaddress</option></primary>
37083 </indexterm>
37084 </para>
37085 <informaltable frame="all">
37086 <tgroup cols="4" colsep="0" rowsep="0">
37087 <colspec colwidth="8*" align="left"/>
37088 <colspec colwidth="6*" align="center"/>
37089 <colspec colwidth="6*" align="center"/>
37090 <colspec colwidth="6*" align="right"/>
37091 <tbody>
37092 <row>
37093 <entry><option>sieve_subaddress</option></entry>
37094 <entry>Use: <emphasis>redirect</emphasis></entry>
37095 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
37096 <entry>Default: <emphasis>unset</emphasis></entry>
37097 </row>
37098 </tbody>
37099 </tgroup>
37100 </informaltable>
37101 <para>
37102 The value of this option is passed to a Sieve filter to specify the
37103 :subaddress part of an address.
37104 </para>
37105 <para>
37106 <indexterm role="option">
37107 <primary><option>sieve_useraddress</option></primary>
37108 </indexterm>
37109 </para>
37110 <informaltable frame="all">
37111 <tgroup cols="4" colsep="0" rowsep="0">
37112 <colspec colwidth="8*" align="left"/>
37113 <colspec colwidth="6*" align="center"/>
37114 <colspec colwidth="6*" align="center"/>
37115 <colspec colwidth="6*" align="right"/>
37116 <tbody>
37117 <row>
37118 <entry><option>sieve_useraddress</option></entry>
37119 <entry>Use: <emphasis>redirect</emphasis></entry>
37120 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
37121 <entry>Default: <emphasis>unset</emphasis></entry>
37122 </row>
37123 </tbody>
37124 </tgroup>
37125 </informaltable>
37126 <para>
37127 The value of this option is passed to a Sieve filter to specify the :user part
37128 of an address. However, if it is unset, the entire original local part
37129 (including any prefix or suffix) is used for :user.
37130 </para>
37131 <para>
37132 <indexterm role="option">
37133 <primary><option>sieve_vacation_directory</option></primary>
37134 </indexterm>
37135 </para>
37136 <informaltable frame="all">
37137 <tgroup cols="4" colsep="0" rowsep="0">
37138 <colspec colwidth="8*" align="left"/>
37139 <colspec colwidth="6*" align="center"/>
37140 <colspec colwidth="6*" align="center"/>
37141 <colspec colwidth="6*" align="right"/>
37142 <tbody>
37143 <row>
37144 <entry><option>sieve_vacation_directory</option></entry>
37145 <entry>Use: <emphasis>redirect</emphasis></entry>
37146 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
37147 <entry>Default: <emphasis>unset</emphasis></entry>
37148 </row>
37149 </tbody>
37150 </tgroup>
37151 </informaltable>
37152 <para>
37153 <indexterm role="concept">
37154 <primary>Sieve filter</primary>
37155 <secondary>vacation directory</secondary>
37156 </indexterm>
37157 To enable the <quote>vacation</quote> extension for Sieve filters, you must set
37158 <option>sieve_vacation_directory</option> to the directory where vacation databases are held
37159 (do not put anything else in that directory), and ensure that the
37160 <option>reply_transport</option> option refers to an <command>autoreply</command> transport. Each user
37161 needs their own directory; Exim will create it if necessary.
37162 </para>
37163 <para>
37164 <indexterm role="option">
37165 <primary><option>skip_syntax_errors</option></primary>
37166 </indexterm>
37167 </para>
37168 <informaltable frame="all">
37169 <tgroup cols="4" colsep="0" rowsep="0">
37170 <colspec colwidth="8*" align="left"/>
37171 <colspec colwidth="6*" align="center"/>
37172 <colspec colwidth="6*" align="center"/>
37173 <colspec colwidth="6*" align="right"/>
37174 <tbody>
37175 <row>
37176 <entry><option>skip_syntax_errors</option></entry>
37177 <entry>Use: <emphasis>redirect</emphasis></entry>
37178 <entry>Type: <emphasis>boolean</emphasis></entry>
37179 <entry>Default: <emphasis>false</emphasis></entry>
37180 </row>
37181 </tbody>
37182 </tgroup>
37183 </informaltable>
37184 <para>
37185 <indexterm role="concept">
37186 <primary>forward file</primary>
37187 <secondary>broken</secondary>
37188 </indexterm>
37189 <indexterm role="concept">
37190 <primary>address redirection</primary>
37191 <secondary>broken files</secondary>
37192 </indexterm>
37193 <indexterm role="concept">
37194 <primary>alias file</primary>
37195 <secondary>broken</secondary>
37196 </indexterm>
37197 <indexterm role="concept">
37198 <primary>broken alias or forward files</primary>
37199 </indexterm>
37200 <indexterm role="concept">
37201 <primary>ignoring faulty addresses</primary>
37202 </indexterm>
37203 <indexterm role="concept">
37204 <primary>skipping faulty addresses</primary>
37205 </indexterm>
37206 <indexterm role="concept">
37207 <primary>error</primary>
37208 <secondary>skipping bad syntax</secondary>
37209 </indexterm>
37210 If <option>skip_syntax_errors</option> is set, syntactically malformed addresses in
37211 non-filter redirection data are skipped, and each failing address is logged. If
37212 <option>syntax_errors_to</option> is set, a message is sent to the address it defines,
37213 giving details of the failures. If <option>syntax_errors_text</option> is set, its contents
37214 are expanded and placed at the head of the error message generated by
37215 <option>syntax_errors_to</option>. Usually it is appropriate to set <option>syntax_errors_to</option> to
37216 be the same address as the generic <option>errors_to</option> option. The
37217 <option>skip_syntax_errors</option> option is often used when handling mailing lists.
37218 </para>
37219 <para>
37220 If all the addresses in a redirection list are skipped because of syntax
37221 errors, the router declines to handle the original address, and it is passed to
37222 the following routers.
37223 </para>
37224 <para>
37225 If <option>skip_syntax_errors</option> is set when an Exim filter is interpreted, any syntax
37226 error in the filter causes filtering to be abandoned without any action being
37227 taken. The incident is logged, and the router declines to handle the address,
37228 so it is passed to the following routers.
37229 </para>
37230 <para>
37231 <indexterm role="concept">
37232 <primary>Sieve filter</primary>
37233 <secondary>syntax errors in</secondary>
37234 </indexterm>
37235 Syntax errors in a Sieve filter file cause the <quote>keep</quote> action to occur. This
37236 action is specified by RFC 3028. The values of <option>skip_syntax_errors</option>,
37237 <option>syntax_errors_to</option>, and <option>syntax_errors_text</option> are not used.
37238 </para>
37239 <para>
37240 <option>skip_syntax_errors</option> can be used to specify that errors in users&#x2019; forward
37241 lists or filter files should not prevent delivery. The <option>syntax_errors_to</option>
37242 option, used with an address that does not get redirected, can be used to
37243 notify users of these errors, by means of a router like this:
37244 </para>
37245 <literallayout class="monospaced">
37246 userforward:
37247   driver = redirect
37248   allow_filter
37249   check_local_user
37250   file = $home/.forward
37251   file_transport = address_file
37252   pipe_transport = address_pipe
37253   reply_transport = address_reply
37254   no_verify
37255   skip_syntax_errors
37256   syntax_errors_to = real-$local_part@$domain
37257   syntax_errors_text = \
37258    This is an automatically generated message. An error has\n\
37259    been found in your .forward file. Details of the error are\n\
37260    reported below. While this error persists, you will receive\n\
37261    a copy of this message for every message that is addressed\n\
37262    to you. If your .forward file is a filter file, or if it is\n\
37263    a non-filter file containing no valid forwarding addresses,\n\
37264    a copy of each incoming message will be put in your normal\n\
37265    mailbox. If a non-filter file contains at least one valid\n\
37266    forwarding address, forwarding to the valid addresses will\n\
37267    happen, and those will be the only deliveries that occur.
37268 </literallayout>
37269 <para>
37270 You also need a router to ensure that local addresses that are prefixed by
37271 <literal>real-</literal> are recognized, but not forwarded or filtered. For example, you could
37272 put this immediately before the <command>userforward</command> router:
37273 </para>
37274 <literallayout class="monospaced">
37275 real_localuser:
37276   driver = accept
37277   check_local_user
37278   local_part_prefix = real-
37279   transport = local_delivery
37280 </literallayout>
37281 <para>
37282 For security, it would probably be a good idea to restrict the use of this
37283 router to locally-generated messages, using a condition such as this:
37284 </para>
37285 <literallayout class="monospaced">
37286   condition = ${if match {$sender_host_address}\
37287                          {\N^(|127\.0\.0\.1)$\N}}
37288 </literallayout>
37289 <para>
37290 <indexterm role="option">
37291 <primary><option>syntax_errors_text</option></primary>
37292 </indexterm>
37293 </para>
37294 <informaltable frame="all">
37295 <tgroup cols="4" colsep="0" rowsep="0">
37296 <colspec colwidth="8*" align="left"/>
37297 <colspec colwidth="6*" align="center"/>
37298 <colspec colwidth="6*" align="center"/>
37299 <colspec colwidth="6*" align="right"/>
37300 <tbody>
37301 <row>
37302 <entry><option>syntax_errors_text</option></entry>
37303 <entry>Use: <emphasis>redirect</emphasis></entry>
37304 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
37305 <entry>Default: <emphasis>unset</emphasis></entry>
37306 </row>
37307 </tbody>
37308 </tgroup>
37309 </informaltable>
37310 <para>
37311 See <option>skip_syntax_errors</option> above.
37312 </para>
37313 <para>
37314 <indexterm role="option">
37315 <primary><option>syntax_errors_to</option></primary>
37316 </indexterm>
37317 </para>
37318 <informaltable frame="all">
37319 <tgroup cols="4" colsep="0" rowsep="0">
37320 <colspec colwidth="8*" align="left"/>
37321 <colspec colwidth="6*" align="center"/>
37322 <colspec colwidth="6*" align="center"/>
37323 <colspec colwidth="6*" align="right"/>
37324 <tbody>
37325 <row>
37326 <entry><option>syntax_errors_to</option></entry>
37327 <entry>Use: <emphasis>redirect</emphasis></entry>
37328 <entry>Type: <emphasis>string</emphasis></entry>
37329 <entry>Default: <emphasis>unset</emphasis></entry>
37330 </row>
37331 </tbody>
37332 </tgroup>
37333 </informaltable>
37334 <para>
37335 See <option>skip_syntax_errors</option> above.
37336 <indexterm role="concept" startref="IIDredrou1" class="endofrange"/>
37337 <indexterm role="concept" startref="IIDredrou2" class="endofrange"/>
37338 </para>
37339 </section>
37340 </chapter>
37341
37342 <chapter id="CHAPenvironment">
37343 <title>Environment for running local transports</title>
37344 <titleabbrev>Environment for local transports</titleabbrev>
37345 <para>
37346 <indexterm role="concept" id="IIDenvlotra1" class="startofrange">
37347 <primary>local transports</primary>
37348 <secondary>environment for</secondary>
37349 </indexterm>
37350 <indexterm role="concept" id="IIDenvlotra2" class="startofrange">
37351 <primary>environment for local transports</primary>
37352 </indexterm>
37353 <indexterm role="concept" id="IIDenvlotra3" class="startofrange">
37354 <primary>transport</primary>
37355 <secondary>local; environment for</secondary>
37356 </indexterm>
37357 Local transports handle deliveries to files and pipes. (The <command>autoreply</command>
37358 transport can be thought of as similar to a pipe.) Exim always runs transports
37359 in subprocesses, under specified uids and gids. Typical deliveries to local
37360 mailboxes run under the uid and gid of the local user.
37361 </para>
37362 <para>
37363 Exim also sets a specific current directory while running the transport; for
37364 some transports a home directory setting is also relevant. The <command>pipe</command>
37365 transport is the only one that sets up environment variables; see section
37366 <xref linkend="SECTpipeenv"/> for details.
37367 </para>
37368 <para>
37369 The values used for the uid, gid, and the directories may come from several
37370 different places. In many cases, the router that handles the address associates
37371 settings with that address as a result of its <option>check_local_user</option>, <option>group</option>,
37372 or <option>user</option> options. However, values may also be given in the transport&#x2019;s own
37373 configuration, and these override anything that comes from the router.
37374 </para>
37375 <section id="SECID131">
37376 <title>Concurrent deliveries</title>
37377 <para>
37378 <indexterm role="concept">
37379 <primary>concurrent deliveries</primary>
37380 </indexterm>
37381 <indexterm role="concept">
37382 <primary>simultaneous deliveries</primary>
37383 </indexterm>
37384 If two different messages for the same local recipient arrive more or less
37385 simultaneously, the two delivery processes are likely to run concurrently. When
37386 the <command>appendfile</command> transport is used to write to a file, Exim applies locking
37387 rules to stop concurrent processes from writing to the same file at the same
37388 time.
37389 </para>
37390 <para>
37391 However, when you use a <command>pipe</command> transport, it is up to you to arrange any
37392 locking that is needed. Here is a silly example:
37393 </para>
37394 <literallayout class="monospaced">
37395 my_transport:
37396   driver = pipe
37397   command = /bin/sh -c 'cat &gt;&gt;/some/file'
37398 </literallayout>
37399 <para>
37400 This is supposed to write the message at the end of the file. However, if two
37401 messages arrive at the same time, the file will be scrambled. You can use the
37402 <option>exim_lock</option> utility program (see section <xref linkend="SECTmailboxmaint"/>) to lock a
37403 file using the same algorithm that Exim itself uses.
37404 </para>
37405 </section>
37406 <section id="SECTenvuidgid">
37407 <title>Uids and gids</title>
37408 <para>
37409 <indexterm role="concept">
37410 <primary>local transports</primary>
37411 <secondary>uid and gid</secondary>
37412 </indexterm>
37413 <indexterm role="concept">
37414 <primary>transport</primary>
37415 <secondary>local; uid and gid</secondary>
37416 </indexterm>
37417 All transports have the options <option>group</option> and <option>user</option>. If <option>group</option> is set, it
37418 overrides any group that the router set in the address, even if <option>user</option> is not
37419 set for the transport. This makes it possible, for example, to run local mail
37420 delivery under the uid of the recipient (set by the router), but in a special
37421 group (set by the transport). For example:
37422 </para>
37423 <literallayout class="monospaced">
37424 # Routers ...
37425 # User/group are set by check_local_user in this router
37426 local_users:
37427   driver = accept
37428   check_local_user
37429   transport = group_delivery
37430
37431 # Transports ...
37432 # This transport overrides the group
37433 group_delivery:
37434   driver = appendfile
37435   file = /var/spool/mail/$local_part
37436   group = mail
37437 </literallayout>
37438 <para>
37439 If <option>user</option> is set for a transport, its value overrides what is set in the
37440 address by the router. If <option>user</option> is non-numeric and <option>group</option> is not set, the
37441 gid associated with the user is used. If <option>user</option> is numeric, <option>group</option> must be
37442 set.
37443 </para>
37444 <para>
37445 <indexterm role="option">
37446 <primary><option>initgroups</option></primary>
37447 </indexterm>
37448 When the uid is taken from the transport&#x2019;s configuration, the <function>initgroups()</function>
37449 function is called for the groups associated with that uid if the
37450 <option>initgroups</option> option is set for the transport. When the uid is not specified
37451 by the transport, but is associated with the address by a router, the option
37452 for calling <function>initgroups()</function> is taken from the router configuration.
37453 </para>
37454 <para>
37455 <indexterm role="concept">
37456 <primary><command>pipe</command> transport</primary>
37457 <secondary>uid for</secondary>
37458 </indexterm>
37459 The <command>pipe</command> transport contains the special option <option>pipe_as_creator</option>. If this
37460 is set and <option>user</option> is not set, the uid of the process that called Exim to
37461 receive the message is used, and if <option>group</option> is not set, the corresponding
37462 original gid is also used.
37463 </para>
37464 <para>
37465 This is the detailed preference order for obtaining a gid; the first of the
37466 following that is set is used:
37467 </para>
37468 <itemizedlist>
37469 <listitem>
37470 <para>
37471 A <option>group</option> setting of the transport;
37472 </para>
37473 </listitem>
37474 <listitem>
37475 <para>
37476 A <option>group</option> setting of the router;
37477 </para>
37478 </listitem>
37479 <listitem>
37480 <para>
37481 A gid associated with a user setting of the router, either as a result of
37482 <option>check_local_user</option> or an explicit non-numeric <option>user</option> setting;
37483 </para>
37484 </listitem>
37485 <listitem>
37486 <para>
37487 The group associated with a non-numeric <option>user</option> setting of the transport;
37488 </para>
37489 </listitem>
37490 <listitem>
37491 <para>
37492 In a <command>pipe</command> transport, the creator&#x2019;s gid if <option>deliver_as_creator</option> is set and
37493 the uid is the creator&#x2019;s uid;
37494 </para>
37495 </listitem>
37496 <listitem>
37497 <para>
37498 The Exim gid if the Exim uid is being used as a default.
37499 </para>
37500 </listitem>
37501 </itemizedlist>
37502 <para>
37503 If, for example, the user is specified numerically on the router and there are
37504 no group settings, no gid is available. In this situation, an error occurs.
37505 This is different for the uid, for which there always is an ultimate default.
37506 The first of the following that is set is used:
37507 </para>
37508 <itemizedlist>
37509 <listitem>
37510 <para>
37511 A <option>user</option> setting of the transport;
37512 </para>
37513 </listitem>
37514 <listitem>
37515 <para>
37516 In a <command>pipe</command> transport, the creator&#x2019;s uid if <option>deliver_as_creator</option> is set;
37517 </para>
37518 </listitem>
37519 <listitem>
37520 <para>
37521 A <option>user</option> setting of the router;
37522 </para>
37523 </listitem>
37524 <listitem>
37525 <para>
37526 A <option>check_local_user</option> setting of the router;
37527 </para>
37528 </listitem>
37529 <listitem>
37530 <para>
37531 The Exim uid.
37532 </para>
37533 </listitem>
37534 </itemizedlist>
37535 <para>
37536 Of course, an error will still occur if the uid that is chosen is on the
37537 <option>never_users</option> list.
37538 </para>
37539 </section>
37540 <section id="SECID132">
37541 <title>Current and home directories</title>
37542 <para>
37543 <indexterm role="concept">
37544 <primary>current directory for local transport</primary>
37545 </indexterm>
37546 <indexterm role="concept">
37547 <primary>home directory</primary>
37548 <secondary>for local transport</secondary>
37549 </indexterm>
37550 <indexterm role="concept">
37551 <primary>transport</primary>
37552 <secondary>local; home directory for</secondary>
37553 </indexterm>
37554 <indexterm role="concept">
37555 <primary>transport</primary>
37556 <secondary>local; current directory for</secondary>
37557 </indexterm>
37558 Routers may set current and home directories for local transports by means of
37559 the <option>transport_current_directory</option> and <option>transport_home_directory</option> options.
37560 However, if the transport&#x2019;s <option>current_directory</option> or <option>home_directory</option> options
37561 are set, they override the router&#x2019;s values. In detail, the home directory
37562 for a local transport is taken from the first of these values that is set:
37563 </para>
37564 <itemizedlist>
37565 <listitem>
37566 <para>
37567 The <option>home_directory</option> option on the transport;
37568 </para>
37569 </listitem>
37570 <listitem>
37571 <para>
37572 The <option>transport_home_directory</option> option on the router;
37573 </para>
37574 </listitem>
37575 <listitem>
37576 <para>
37577 The password data if <option>check_local_user</option> is set on the router;
37578 </para>
37579 </listitem>
37580 <listitem>
37581 <para>
37582 The <option>router_home_directory</option> option on the router.
37583 </para>
37584 </listitem>
37585 </itemizedlist>
37586 <para>
37587 The current directory is taken from the first of these values that is set:
37588 </para>
37589 <itemizedlist>
37590 <listitem>
37591 <para>
37592 The <option>current_directory</option> option on the transport;
37593 </para>
37594 </listitem>
37595 <listitem>
37596 <para>
37597 The <option>transport_current_directory</option> option on the router.
37598 </para>
37599 </listitem>
37600 </itemizedlist>
37601 <para>
37602 If neither the router nor the transport sets a current directory, Exim uses the
37603 value of the home directory, if it is set. Otherwise it sets the current
37604 directory to <filename>/</filename> before running a local transport.
37605 </para>
37606 </section>
37607 <section id="SECID133">
37608 <title>Expansion variables derived from the address</title>
37609 <para>
37610 <indexterm role="variable">
37611 <primary><varname>$domain</varname></primary>
37612 </indexterm>
37613 <indexterm role="variable">
37614 <primary><varname>$local_part</varname></primary>
37615 </indexterm>
37616 <indexterm role="variable">
37617 <primary><varname>$original_domain</varname></primary>
37618 </indexterm>
37619 Normally a local delivery is handling a single address, and in that case the
37620 variables such as <varname>$domain</varname> and <varname>$local_part</varname> are set during local
37621 deliveries. However, in some circumstances more than one address may be handled
37622 at once (for example, while writing batch SMTP for onward transmission by some
37623 other means). In this case, the variables associated with the local part are
37624 never set, <varname>$domain</varname> is set only if all the addresses have the same domain,
37625 and <varname>$original_domain</varname> is never set.
37626 <indexterm role="concept" startref="IIDenvlotra1" class="endofrange"/>
37627 <indexterm role="concept" startref="IIDenvlotra2" class="endofrange"/>
37628 <indexterm role="concept" startref="IIDenvlotra3" class="endofrange"/>
37629 </para>
37630 </section>
37631 </chapter>
37632
37633 <chapter id="CHAPtransportgeneric">
37634 <title>Generic options for transports</title>
37635 <para>
37636 <indexterm role="concept" id="IIDgenoptra1" class="startofrange">
37637 <primary>generic options</primary>
37638 <secondary>transport</secondary>
37639 </indexterm>
37640 <indexterm role="concept" id="IIDgenoptra2" class="startofrange">
37641 <primary>options</primary>
37642 <secondary>generic; for transports</secondary>
37643 </indexterm>
37644 <indexterm role="concept" id="IIDgenoptra3" class="startofrange">
37645 <primary>transport</primary>
37646 <secondary>generic options for</secondary>
37647 </indexterm>
37648 The following generic options apply to all transports:
37649 </para>
37650 <para>
37651 <indexterm role="option">
37652 <primary><option>body_only</option></primary>
37653 </indexterm>
37654 </para>
37655 <informaltable frame="all">
37656 <tgroup cols="4" colsep="0" rowsep="0">
37657 <colspec colwidth="8*" align="left"/>
37658 <colspec colwidth="6*" align="center"/>
37659 <colspec colwidth="6*" align="center"/>
37660 <colspec colwidth="6*" align="right"/>
37661 <tbody>
37662 <row>
37663 <entry><option>body_only</option></entry>
37664 <entry>Use: <emphasis>transports</emphasis></entry>
37665 <entry>Type: <emphasis>boolean</emphasis></entry>
37666 <entry>Default: <emphasis>false</emphasis></entry>
37667 </row>
37668 </tbody>
37669 </tgroup>
37670 </informaltable>
37671 <para>
37672 <indexterm role="concept">
37673 <primary>transport</primary>
37674 <secondary>body only</secondary>
37675 </indexterm>
37676 <indexterm role="concept">
37677 <primary>message</primary>
37678 <secondary>transporting body only</secondary>
37679 </indexterm>
37680 <indexterm role="concept">
37681 <primary>body of message</primary>
37682 <secondary>transporting</secondary>
37683 </indexterm>
37684 If this option is set, the message&#x2019;s headers are not transported. It is
37685 mutually exclusive with <option>headers_only</option>. If it is used with the <command>appendfile</command>
37686 or <command>pipe</command> transports, the settings of <option>message_prefix</option> and
37687 <option>message_suffix</option> should be checked, because this option does not
37688 automatically suppress them.
37689 </para>
37690 <para>
37691 <indexterm role="option">
37692 <primary><option>current_directory</option></primary>
37693 </indexterm>
37694 </para>
37695 <informaltable frame="all">
37696 <tgroup cols="4" colsep="0" rowsep="0">
37697 <colspec colwidth="8*" align="left"/>
37698 <colspec colwidth="6*" align="center"/>
37699 <colspec colwidth="6*" align="center"/>
37700 <colspec colwidth="6*" align="right"/>
37701 <tbody>
37702 <row>
37703 <entry><option>current_directory</option></entry>
37704 <entry>Use: <emphasis>transports</emphasis></entry>
37705 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
37706 <entry>Default: <emphasis>unset</emphasis></entry>
37707 </row>
37708 </tbody>
37709 </tgroup>
37710 </informaltable>
37711 <para>
37712 <indexterm role="concept">
37713 <primary>transport</primary>
37714 <secondary>current directory for</secondary>
37715 </indexterm>
37716 This specifies the current directory that is to be set while running the
37717 transport, overriding any value that may have been set by the router.
37718 If the expansion fails for any reason, including forced failure, an error is
37719 logged, and delivery is deferred.
37720 </para>
37721 <para>
37722 <indexterm role="option">
37723 <primary><option>disable_logging</option></primary>
37724 </indexterm>
37725 </para>
37726 <informaltable frame="all">
37727 <tgroup cols="4" colsep="0" rowsep="0">
37728 <colspec colwidth="8*" align="left"/>
37729 <colspec colwidth="6*" align="center"/>
37730 <colspec colwidth="6*" align="center"/>
37731 <colspec colwidth="6*" align="right"/>
37732 <tbody>
37733 <row>
37734 <entry><option>disable_logging</option></entry>
37735 <entry>Use: <emphasis>transports</emphasis></entry>
37736 <entry>Type: <emphasis>boolean</emphasis></entry>
37737 <entry>Default: <emphasis>false</emphasis></entry>
37738 </row>
37739 </tbody>
37740 </tgroup>
37741 </informaltable>
37742 <para>
37743 If this option is set true, nothing is logged for any
37744 deliveries by the transport or for any
37745 transport errors. You should not set this option unless you really, really know
37746 what you are doing.
37747 </para>
37748 <para>
37749 <indexterm role="option">
37750 <primary><option>debug_print</option></primary>
37751 </indexterm>
37752 </para>
37753 <informaltable frame="all">
37754 <tgroup cols="4" colsep="0" rowsep="0">
37755 <colspec colwidth="8*" align="left"/>
37756 <colspec colwidth="6*" align="center"/>
37757 <colspec colwidth="6*" align="center"/>
37758 <colspec colwidth="6*" align="right"/>
37759 <tbody>
37760 <row>
37761 <entry><option>debug_print</option></entry>
37762 <entry>Use: <emphasis>transports</emphasis></entry>
37763 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
37764 <entry>Default: <emphasis>unset</emphasis></entry>
37765 </row>
37766 </tbody>
37767 </tgroup>
37768 </informaltable>
37769 <para>
37770 <indexterm role="concept">
37771 <primary>testing</primary>
37772 <secondary>variables in drivers</secondary>
37773 </indexterm>
37774 If this option is set and debugging is enabled (see the <option>-d</option> command line
37775 option), the string is expanded and included in the debugging output when the
37776 transport is run.
37777 If expansion of the string fails, the error message is written to the debugging
37778 output, and Exim carries on processing.
37779 This facility is provided to help with checking out the values of variables and
37780 so on when debugging driver configurations. For example, if a <option>headers_add</option>
37781 option is not working properly, <option>debug_print</option> could be used to output the
37782 variables it references. A newline is added to the text if it does not end with
37783 one.
37784 The variables <varname>$transport_name</varname> and <varname>$router_name</varname> contain the name of the
37785 transport and the router that called it.
37786 </para>
37787 <para>
37788 <indexterm role="option">
37789 <primary><option>delivery_date_add</option></primary>
37790 </indexterm>
37791 </para>
37792 <informaltable frame="all">
37793 <tgroup cols="4" colsep="0" rowsep="0">
37794 <colspec colwidth="8*" align="left"/>
37795 <colspec colwidth="6*" align="center"/>
37796 <colspec colwidth="6*" align="center"/>
37797 <colspec colwidth="6*" align="right"/>
37798 <tbody>
37799 <row>
37800 <entry><option>delivery_date_add</option></entry>
37801 <entry>Use: <emphasis>transports</emphasis></entry>
37802 <entry>Type: <emphasis>boolean</emphasis></entry>
37803 <entry>Default: <emphasis>false</emphasis></entry>
37804 </row>
37805 </tbody>
37806 </tgroup>
37807 </informaltable>
37808 <para>
37809 <indexterm role="concept">
37810 <primary><emphasis>Delivery-date:</emphasis> header line</primary>
37811 </indexterm>
37812 If this option is true, a <emphasis>Delivery-date:</emphasis> header is added to the message.
37813 This gives the actual time the delivery was made. As this is not a standard
37814 header, Exim has a configuration option (<option>delivery_date_remove</option>) which
37815 requests its removal from incoming messages, so that delivered messages can
37816 safely be resent to other recipients.
37817 </para>
37818 <para>
37819 <indexterm role="option">
37820 <primary><option>driver</option></primary>
37821 </indexterm>
37822 </para>
37823 <informaltable frame="all">
37824 <tgroup cols="4" colsep="0" rowsep="0">
37825 <colspec colwidth="8*" align="left"/>
37826 <colspec colwidth="6*" align="center"/>
37827 <colspec colwidth="6*" align="center"/>
37828 <colspec colwidth="6*" align="right"/>
37829 <tbody>
37830 <row>
37831 <entry><option>driver</option></entry>
37832 <entry>Use: <emphasis>transports</emphasis></entry>
37833 <entry>Type: <emphasis>string</emphasis></entry>
37834 <entry>Default: <emphasis>unset</emphasis></entry>
37835 </row>
37836 </tbody>
37837 </tgroup>
37838 </informaltable>
37839 <para>
37840 This specifies which of the available transport drivers is to be used.
37841 There is no default, and this option must be set for every transport.
37842 </para>
37843 <para>
37844 <indexterm role="option">
37845 <primary><option>envelope_to_add</option></primary>
37846 </indexterm>
37847 </para>
37848 <informaltable frame="all">
37849 <tgroup cols="4" colsep="0" rowsep="0">
37850 <colspec colwidth="8*" align="left"/>
37851 <colspec colwidth="6*" align="center"/>
37852 <colspec colwidth="6*" align="center"/>
37853 <colspec colwidth="6*" align="right"/>
37854 <tbody>
37855 <row>
37856 <entry><option>envelope_to_add</option></entry>
37857 <entry>Use: <emphasis>transports</emphasis></entry>
37858 <entry>Type: <emphasis>boolean</emphasis></entry>
37859 <entry>Default: <emphasis>false</emphasis></entry>
37860 </row>
37861 </tbody>
37862 </tgroup>
37863 </informaltable>
37864 <para>
37865 <indexterm role="concept">
37866 <primary><emphasis>Envelope-to:</emphasis> header line</primary>
37867 </indexterm>
37868 If this option is true, an <emphasis>Envelope-to:</emphasis> header is added to the message.
37869 This gives the original address(es) in the incoming envelope that caused this
37870 delivery to happen. More than one address may be present if the transport is
37871 configured to handle several addresses at once, or if more than one original
37872 address was redirected to the same final address. As this is not a standard
37873 header, Exim has a configuration option (<option>envelope_to_remove</option>) which requests
37874 its removal from incoming messages, so that delivered messages can safely be
37875 resent to other recipients.
37876 </para>
37877 <para>
37878 <indexterm role="option">
37879 <primary><option>group</option></primary>
37880 </indexterm>
37881 </para>
37882 <informaltable frame="all">
37883 <tgroup cols="4" colsep="0" rowsep="0">
37884 <colspec colwidth="8*" align="left"/>
37885 <colspec colwidth="6*" align="center"/>
37886 <colspec colwidth="6*" align="center"/>
37887 <colspec colwidth="6*" align="right"/>
37888 <tbody>
37889 <row>
37890 <entry><option>group</option></entry>
37891 <entry>Use: <emphasis>transports</emphasis></entry>
37892 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
37893 <entry>Default: <emphasis>Exim group</emphasis></entry>
37894 </row>
37895 </tbody>
37896 </tgroup>
37897 </informaltable>
37898 <para>
37899 <indexterm role="concept">
37900 <primary>transport</primary>
37901 <secondary>group; specifying</secondary>
37902 </indexterm>
37903 This option specifies a gid for running the transport process, overriding any
37904 value that the router supplies, and also overriding any value associated with
37905 <option>user</option> (see below).
37906 </para>
37907 <para>
37908 <indexterm role="option">
37909 <primary><option>headers_add</option></primary>
37910 </indexterm>
37911 </para>
37912 <informaltable frame="all">
37913 <tgroup cols="4" colsep="0" rowsep="0">
37914 <colspec colwidth="8*" align="left"/>
37915 <colspec colwidth="6*" align="center"/>
37916 <colspec colwidth="6*" align="center"/>
37917 <colspec colwidth="6*" align="right"/>
37918 <tbody>
37919 <row>
37920 <entry><option>headers_add</option></entry>
37921 <entry>Use: <emphasis>transports</emphasis></entry>
37922 <entry>Type: <emphasis>list</emphasis>&dagger;<emphasis></emphasis></entry>
37923 <entry>Default: <emphasis>unset</emphasis></entry>
37924 </row>
37925 </tbody>
37926 </tgroup>
37927 </informaltable>
37928 <para>
37929 <indexterm role="concept">
37930 <primary>header lines</primary>
37931 <secondary>adding in transport</secondary>
37932 </indexterm>
37933 <indexterm role="concept">
37934 <primary>transport</primary>
37935 <secondary>header lines; adding</secondary>
37936 </indexterm>
37937 This option specifies a list of text headers, newline-separated,
37938 which are (separately) expanded and added to the header
37939 portion of a message as it is transported, as described in section
37940 <xref linkend="SECTheadersaddrem"/>. Additional header lines can also be specified by
37941 routers. If the result of the expansion is an empty string, or if the expansion
37942 is forced to fail, no action is taken. Other expansion failures are treated as
37943 errors and cause the delivery to be deferred.
37944 </para>
37945 <para>
37946 Unlike most options, <option>headers_add</option> can be specified multiple times
37947 for a transport; all listed headers are added.
37948 </para>
37949 <para>
37950 <indexterm role="option">
37951 <primary><option>headers_only</option></primary>
37952 </indexterm>
37953 </para>
37954 <informaltable frame="all">
37955 <tgroup cols="4" colsep="0" rowsep="0">
37956 <colspec colwidth="8*" align="left"/>
37957 <colspec colwidth="6*" align="center"/>
37958 <colspec colwidth="6*" align="center"/>
37959 <colspec colwidth="6*" align="right"/>
37960 <tbody>
37961 <row>
37962 <entry><option>headers_only</option></entry>
37963 <entry>Use: <emphasis>transports</emphasis></entry>
37964 <entry>Type: <emphasis>boolean</emphasis></entry>
37965 <entry>Default: <emphasis>false</emphasis></entry>
37966 </row>
37967 </tbody>
37968 </tgroup>
37969 </informaltable>
37970 <para>
37971 <indexterm role="concept">
37972 <primary>transport</primary>
37973 <secondary>header lines only</secondary>
37974 </indexterm>
37975 <indexterm role="concept">
37976 <primary>message</primary>
37977 <secondary>transporting headers only</secondary>
37978 </indexterm>
37979 <indexterm role="concept">
37980 <primary>header lines</primary>
37981 <secondary>transporting</secondary>
37982 </indexterm>
37983 If this option is set, the message&#x2019;s body is not transported. It is mutually
37984 exclusive with <option>body_only</option>. If it is used with the <command>appendfile</command> or <command>pipe</command>
37985 transports, the settings of <option>message_prefix</option> and <option>message_suffix</option> should be
37986 checked, since this option does not automatically suppress them.
37987 </para>
37988 <para>
37989 <indexterm role="option">
37990 <primary><option>headers_remove</option></primary>
37991 </indexterm>
37992 </para>
37993 <informaltable frame="all">
37994 <tgroup cols="4" colsep="0" rowsep="0">
37995 <colspec colwidth="8*" align="left"/>
37996 <colspec colwidth="6*" align="center"/>
37997 <colspec colwidth="6*" align="center"/>
37998 <colspec colwidth="6*" align="right"/>
37999 <tbody>
38000 <row>
38001 <entry><option>headers_remove</option></entry>
38002 <entry>Use: <emphasis>transports</emphasis></entry>
38003 <entry>Type: <emphasis>list</emphasis>&dagger;<emphasis></emphasis></entry>
38004 <entry>Default: <emphasis>unset</emphasis></entry>
38005 </row>
38006 </tbody>
38007 </tgroup>
38008 </informaltable>
38009 <para>
38010 <indexterm role="concept">
38011 <primary>header lines</primary>
38012 <secondary>removing</secondary>
38013 </indexterm>
38014 <indexterm role="concept">
38015 <primary>transport</primary>
38016 <secondary>header lines; removing</secondary>
38017 </indexterm>
38018 This option specifies a list of header names, colon-separated;
38019 these headers are omitted from the message as it is transported, as described
38020 in section <xref linkend="SECTheadersaddrem"/>. Header removal can also be specified by
38021 routers.
38022 Each list item is separately expanded.
38023 If the result of the expansion is an empty string, or if the expansion
38024 is forced to fail, no action is taken. Other expansion failures are treated as
38025 errors and cause the delivery to be deferred.
38026 </para>
38027 <para>
38028 Unlike most options, <option>headers_remove</option> can be specified multiple times
38029 for a router; all listed headers are removed.
38030 </para>
38031 <para>
38032 <indexterm role="option">
38033 <primary><option>headers_rewrite</option></primary>
38034 </indexterm>
38035 </para>
38036 <informaltable frame="all">
38037 <tgroup cols="4" colsep="0" rowsep="0">
38038 <colspec colwidth="8*" align="left"/>
38039 <colspec colwidth="6*" align="center"/>
38040 <colspec colwidth="6*" align="center"/>
38041 <colspec colwidth="6*" align="right"/>
38042 <tbody>
38043 <row>
38044 <entry><option>headers_rewrite</option></entry>
38045 <entry>Use: <emphasis>transports</emphasis></entry>
38046 <entry>Type: <emphasis>string</emphasis></entry>
38047 <entry>Default: <emphasis>unset</emphasis></entry>
38048 </row>
38049 </tbody>
38050 </tgroup>
38051 </informaltable>
38052 <para>
38053 <indexterm role="concept">
38054 <primary>transport</primary>
38055 <secondary>header lines; rewriting</secondary>
38056 </indexterm>
38057 <indexterm role="concept">
38058 <primary>rewriting</primary>
38059 <secondary>at transport time</secondary>
38060 </indexterm>
38061 This option allows addresses in header lines to be rewritten at transport time,
38062 that is, as the message is being copied to its destination. The contents of the
38063 option are a colon-separated list of rewriting rules. Each rule is in exactly
38064 the same form as one of the general rewriting rules that are applied when a
38065 message is received. These are described in chapter <xref linkend="CHAPrewrite"/>. For
38066 example,
38067 </para>
38068 <literallayout class="monospaced">
38069 headers_rewrite = a@b c@d f : \
38070                   x@y w@z
38071 </literallayout>
38072 <para>
38073 changes <emphasis>a@b</emphasis> into <emphasis>c@d</emphasis> in <emphasis>From:</emphasis> header lines, and <emphasis>x@y</emphasis> into
38074 <emphasis>w@z</emphasis> in all address-bearing header lines. The rules are applied to the
38075 header lines just before they are written out at transport time, so they affect
38076 only those copies of the message that pass through the transport. However, only
38077 the message&#x2019;s original header lines, and any that were added by a system
38078 filter, are rewritten. If a router or transport adds header lines, they are not
38079 affected by this option. These rewriting rules are <emphasis>not</emphasis> applied to the
38080 envelope. You can change the return path using <option>return_path</option>, but you cannot
38081 change envelope recipients at this time.
38082 </para>
38083 <para>
38084 <indexterm role="option">
38085 <primary><option>home_directory</option></primary>
38086 </indexterm>
38087 </para>
38088 <informaltable frame="all">
38089 <tgroup cols="4" colsep="0" rowsep="0">
38090 <colspec colwidth="8*" align="left"/>
38091 <colspec colwidth="6*" align="center"/>
38092 <colspec colwidth="6*" align="center"/>
38093 <colspec colwidth="6*" align="right"/>
38094 <tbody>
38095 <row>
38096 <entry><option>home_directory</option></entry>
38097 <entry>Use: <emphasis>transports</emphasis></entry>
38098 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
38099 <entry>Default: <emphasis>unset</emphasis></entry>
38100 </row>
38101 </tbody>
38102 </tgroup>
38103 </informaltable>
38104 <para>
38105 <indexterm role="concept">
38106 <primary>transport</primary>
38107 <secondary>home directory for</secondary>
38108 </indexterm>
38109 <indexterm role="variable">
38110 <primary><varname>$home</varname></primary>
38111 </indexterm>
38112 This option specifies a home directory setting for a local transport,
38113 overriding any value that may be set by the router. The home directory is
38114 placed in <varname>$home</varname> while expanding the transport&#x2019;s private options. It is also
38115 used as the current directory if no current directory is set by the
38116 <option>current_directory</option> option on the transport or the
38117 <option>transport_current_directory</option> option on the router. If the expansion fails
38118 for any reason, including forced failure, an error is logged, and delivery is
38119 deferred.
38120 </para>
38121 <para>
38122 <indexterm role="option">
38123 <primary><option>initgroups</option></primary>
38124 </indexterm>
38125 </para>
38126 <informaltable frame="all">
38127 <tgroup cols="4" colsep="0" rowsep="0">
38128 <colspec colwidth="8*" align="left"/>
38129 <colspec colwidth="6*" align="center"/>
38130 <colspec colwidth="6*" align="center"/>
38131 <colspec colwidth="6*" align="right"/>
38132 <tbody>
38133 <row>
38134 <entry><option>initgroups</option></entry>
38135 <entry>Use: <emphasis>transports</emphasis></entry>
38136 <entry>Type: <emphasis>boolean</emphasis></entry>
38137 <entry>Default: <emphasis>false</emphasis></entry>
38138 </row>
38139 </tbody>
38140 </tgroup>
38141 </informaltable>
38142 <para>
38143 <indexterm role="concept">
38144 <primary>additional groups</primary>
38145 </indexterm>
38146 <indexterm role="concept">
38147 <primary>groups</primary>
38148 <secondary>additional</secondary>
38149 </indexterm>
38150 <indexterm role="concept">
38151 <primary>transport</primary>
38152 <secondary>group; additional</secondary>
38153 </indexterm>
38154 If this option is true and the uid for the delivery process is provided by the
38155 transport, the <function>initgroups()</function> function is called when running the transport
38156 to ensure that any additional groups associated with the uid are set up.
38157 </para>
38158 <para>
38159 <indexterm role="option">
38160 <primary><option>message_size_limit</option></primary>
38161 </indexterm>
38162 </para>
38163 <informaltable frame="all">
38164 <tgroup cols="4" colsep="0" rowsep="0">
38165 <colspec colwidth="8*" align="left"/>
38166 <colspec colwidth="6*" align="center"/>
38167 <colspec colwidth="6*" align="center"/>
38168 <colspec colwidth="6*" align="right"/>
38169 <tbody>
38170 <row>
38171 <entry><option>message_size_limit</option></entry>
38172 <entry>Use: <emphasis>transports</emphasis></entry>
38173 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
38174 <entry>Default: <emphasis>0</emphasis></entry>
38175 </row>
38176 </tbody>
38177 </tgroup>
38178 </informaltable>
38179 <para>
38180 <indexterm role="concept">
38181 <primary>limit</primary>
38182 <secondary>message size per transport</secondary>
38183 </indexterm>
38184 <indexterm role="concept">
38185 <primary>size</primary>
38186 <secondary>of message, limit</secondary>
38187 </indexterm>
38188 <indexterm role="concept">
38189 <primary>transport</primary>
38190 <secondary>message size; limiting</secondary>
38191 </indexterm>
38192 This option controls the size of messages passed through the transport. It is
38193 expanded before use; the result of the expansion must be a sequence of decimal
38194 digits, optionally followed by K or M. If the expansion fails for any reason,
38195 including forced failure, or if the result is not of the required form,
38196 delivery is deferred. If the value is greater than zero and the size of a
38197 message exceeds this limit, the address is failed. If there is any chance that
38198 the resulting bounce message could be routed to the same transport, you should
38199 ensure that <option>return_size_limit</option> is less than the transport&#x2019;s
38200 <option>message_size_limit</option>, as otherwise the bounce message will fail to get
38201 delivered.
38202 </para>
38203 <para>
38204 <indexterm role="option">
38205 <primary><option>rcpt_include_affixes</option></primary>
38206 </indexterm>
38207 </para>
38208 <informaltable frame="all">
38209 <tgroup cols="4" colsep="0" rowsep="0">
38210 <colspec colwidth="8*" align="left"/>
38211 <colspec colwidth="6*" align="center"/>
38212 <colspec colwidth="6*" align="center"/>
38213 <colspec colwidth="6*" align="right"/>
38214 <tbody>
38215 <row>
38216 <entry><option>rcpt_include_affixes</option></entry>
38217 <entry>Use: <emphasis>transports</emphasis></entry>
38218 <entry>Type: <emphasis>boolean</emphasis></entry>
38219 <entry>Default: <emphasis>false</emphasis></entry>
38220 </row>
38221 </tbody>
38222 </tgroup>
38223 </informaltable>
38224 <para>
38225 <indexterm role="concept">
38226 <primary>prefix</primary>
38227 <secondary>for local part, including in envelope</secondary>
38228 </indexterm>
38229 <indexterm role="concept">
38230 <primary>suffix for local part</primary>
38231 <secondary>including in envelope</secondary>
38232 </indexterm>
38233 <indexterm role="concept">
38234 <primary>local part</primary>
38235 <secondary>prefix</secondary>
38236 </indexterm>
38237 <indexterm role="concept">
38238 <primary>local part</primary>
38239 <secondary>suffix</secondary>
38240 </indexterm>
38241 When this option is false (the default), and an address that has had any
38242 affixes (prefixes or suffixes) removed from the local part is delivered by any
38243 form of SMTP or LMTP, the affixes are not included. For example, if a router
38244 that contains
38245 </para>
38246 <literallayout class="monospaced">
38247 local_part_prefix = *-
38248 </literallayout>
38249 <para>
38250 routes the address <emphasis>abc-xyz@some.domain</emphasis> to an SMTP transport, the envelope
38251 is delivered with
38252 </para>
38253 <literallayout class="monospaced">
38254 RCPT TO:&lt;xyz@some.domain&gt;
38255 </literallayout>
38256 <para>
38257 This is also the case when an ACL-time callout is being used to verify a
38258 recipient address. However, if <option>rcpt_include_affixes</option> is set true, the
38259 whole local part is included in the RCPT command. This option applies to BSMTP
38260 deliveries by the <command>appendfile</command> and <command>pipe</command> transports as well as to the
38261 <command>lmtp</command> and <command>smtp</command> transports.
38262 </para>
38263 <para>
38264 <indexterm role="option">
38265 <primary><option>retry_use_local_part</option></primary>
38266 </indexterm>
38267 </para>
38268 <informaltable frame="all">
38269 <tgroup cols="4" colsep="0" rowsep="0">
38270 <colspec colwidth="8*" align="left"/>
38271 <colspec colwidth="6*" align="center"/>
38272 <colspec colwidth="6*" align="center"/>
38273 <colspec colwidth="6*" align="right"/>
38274 <tbody>
38275 <row>
38276 <entry><option>retry_use_local_part</option></entry>
38277 <entry>Use: <emphasis>transports</emphasis></entry>
38278 <entry>Type: <emphasis>boolean</emphasis></entry>
38279 <entry>Default: <emphasis>see below</emphasis></entry>
38280 </row>
38281 </tbody>
38282 </tgroup>
38283 </informaltable>
38284 <para>
38285 <indexterm role="concept">
38286 <primary>hints database</primary>
38287 <secondary>retry keys</secondary>
38288 </indexterm>
38289 When a delivery suffers a temporary failure, a retry record is created
38290 in Exim&#x2019;s hints database. For remote deliveries, the key for the retry record
38291 is based on the name and/or IP address of the failing remote host. For local
38292 deliveries, the key is normally the entire address, including both the local
38293 part and the domain. This is suitable for most common cases of local delivery
38294 temporary failure &ndash; for example, exceeding a mailbox quota should delay only
38295 deliveries to that mailbox, not to the whole domain.
38296 </para>
38297 <para>
38298 However, in some special cases you may want to treat a temporary local delivery
38299 as a failure associated with the domain, and not with a particular local part.
38300 (For example, if you are storing all mail for some domain in files.) You can do
38301 this by setting <option>retry_use_local_part</option> false.
38302 </para>
38303 <para>
38304 For all the local transports, its default value is true. For remote transports,
38305 the default value is false for tidiness, but changing the value has no effect
38306 on a remote transport in the current implementation.
38307 </para>
38308 <para>
38309 <indexterm role="option">
38310 <primary><option>return_path</option></primary>
38311 </indexterm>
38312 </para>
38313 <informaltable frame="all">
38314 <tgroup cols="4" colsep="0" rowsep="0">
38315 <colspec colwidth="8*" align="left"/>
38316 <colspec colwidth="6*" align="center"/>
38317 <colspec colwidth="6*" align="center"/>
38318 <colspec colwidth="6*" align="right"/>
38319 <tbody>
38320 <row>
38321 <entry><option>return_path</option></entry>
38322 <entry>Use: <emphasis>transports</emphasis></entry>
38323 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
38324 <entry>Default: <emphasis>unset</emphasis></entry>
38325 </row>
38326 </tbody>
38327 </tgroup>
38328 </informaltable>
38329 <para>
38330 <indexterm role="concept">
38331 <primary>envelope sender</primary>
38332 </indexterm>
38333 <indexterm role="concept">
38334 <primary>transport</primary>
38335 <secondary>return path; changing</secondary>
38336 </indexterm>
38337 <indexterm role="concept">
38338 <primary>return path</primary>
38339 <secondary>changing in transport</secondary>
38340 </indexterm>
38341 If this option is set, the string is expanded at transport time and replaces
38342 the existing return path (envelope sender) value in the copy of the message
38343 that is being delivered. An empty return path is permitted. This feature is
38344 designed for remote deliveries, where the value of this option is used in the
38345 SMTP MAIL command. If you set <option>return_path</option> for a local transport, the
38346 only effect is to change the address that is placed in the <emphasis>Return-path:</emphasis>
38347 header line, if one is added to the message (see the next option).
38348 </para>
38349 <para>
38350 <emphasis role="bold">Note:</emphasis> A changed return path is not logged unless you add
38351 <option>return_path_on_delivery</option> to the log selector.
38352 </para>
38353 <para>
38354 <indexterm role="variable">
38355 <primary><varname>$return_path</varname></primary>
38356 </indexterm>
38357 The expansion can refer to the existing value via <varname>$return_path</varname>. This is
38358 either the message&#x2019;s envelope sender, or an address set by the
38359 <option>errors_to</option> option on a router. If the expansion is forced to fail, no
38360 replacement occurs; if it fails for another reason, delivery is deferred. This
38361 option can be used to support VERP (Variable Envelope Return Paths) &ndash; see
38362 section <xref linkend="SECTverp"/>.
38363 </para>
38364 <para>
38365 <emphasis role="bold">Note</emphasis>: If a delivery error is detected locally, including the case when a
38366 remote server rejects a message at SMTP time, the bounce message is not sent to
38367 the value of this option. It is sent to the previously set errors address.
38368 This defaults to the incoming sender address, but can be changed by setting
38369 <option>errors_to</option> in a router.
38370 </para>
38371 <para>
38372 <indexterm role="option">
38373 <primary><option>return_path_add</option></primary>
38374 </indexterm>
38375 </para>
38376 <informaltable frame="all">
38377 <tgroup cols="4" colsep="0" rowsep="0">
38378 <colspec colwidth="8*" align="left"/>
38379 <colspec colwidth="6*" align="center"/>
38380 <colspec colwidth="6*" align="center"/>
38381 <colspec colwidth="6*" align="right"/>
38382 <tbody>
38383 <row>
38384 <entry><option>return_path_add</option></entry>
38385 <entry>Use: <emphasis>transports</emphasis></entry>
38386 <entry>Type: <emphasis>boolean</emphasis></entry>
38387 <entry>Default: <emphasis>false</emphasis></entry>
38388 </row>
38389 </tbody>
38390 </tgroup>
38391 </informaltable>
38392 <para>
38393 <indexterm role="concept">
38394 <primary><emphasis>Return-path:</emphasis> header line</primary>
38395 </indexterm>
38396 If this option is true, a <emphasis>Return-path:</emphasis> header is added to the message.
38397 Although the return path is normally available in the prefix line of BSD
38398 mailboxes, this is commonly not displayed by MUAs, and so the user does not
38399 have easy access to it.
38400 </para>
38401 <para>
38402 RFC 2821 states that the <emphasis>Return-path:</emphasis> header is added to a message <quote>when
38403 the delivery SMTP server makes the final delivery</quote>. This implies that this
38404 header should not be present in incoming messages. Exim has a configuration
38405 option, <option>return_path_remove</option>, which requests removal of this header from
38406 incoming messages, so that delivered messages can safely be resent to other
38407 recipients.
38408 </para>
38409 <para>
38410 <indexterm role="option">
38411 <primary><option>shadow_condition</option></primary>
38412 </indexterm>
38413 </para>
38414 <informaltable frame="all">
38415 <tgroup cols="4" colsep="0" rowsep="0">
38416 <colspec colwidth="8*" align="left"/>
38417 <colspec colwidth="6*" align="center"/>
38418 <colspec colwidth="6*" align="center"/>
38419 <colspec colwidth="6*" align="right"/>
38420 <tbody>
38421 <row>
38422 <entry><option>shadow_condition</option></entry>
38423 <entry>Use: <emphasis>transports</emphasis></entry>
38424 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
38425 <entry>Default: <emphasis>unset</emphasis></entry>
38426 </row>
38427 </tbody>
38428 </tgroup>
38429 </informaltable>
38430 <para>
38431 See <option>shadow_transport</option> below.
38432 </para>
38433 <para>
38434 <indexterm role="option">
38435 <primary><option>shadow_transport</option></primary>
38436 </indexterm>
38437 </para>
38438 <informaltable frame="all">
38439 <tgroup cols="4" colsep="0" rowsep="0">
38440 <colspec colwidth="8*" align="left"/>
38441 <colspec colwidth="6*" align="center"/>
38442 <colspec colwidth="6*" align="center"/>
38443 <colspec colwidth="6*" align="right"/>
38444 <tbody>
38445 <row>
38446 <entry><option>shadow_transport</option></entry>
38447 <entry>Use: <emphasis>transports</emphasis></entry>
38448 <entry>Type: <emphasis>string</emphasis></entry>
38449 <entry>Default: <emphasis>unset</emphasis></entry>
38450 </row>
38451 </tbody>
38452 </tgroup>
38453 </informaltable>
38454 <para>
38455 <indexterm role="concept">
38456 <primary>shadow transport</primary>
38457 </indexterm>
38458 <indexterm role="concept">
38459 <primary>transport</primary>
38460 <secondary>shadow</secondary>
38461 </indexterm>
38462 A local transport may set the <option>shadow_transport</option> option to the name of
38463 another local transport. Shadow remote transports are not supported.
38464 </para>
38465 <para>
38466 Whenever a delivery to the main transport succeeds, and either
38467 <option>shadow_condition</option> is unset, or its expansion does not result in the empty
38468 string or one of the strings <quote>0</quote> or <quote>no</quote> or <quote>false</quote>, the message is also
38469 passed to the shadow transport, with the same delivery address or addresses. If
38470 expansion fails, no action is taken except that non-forced expansion failures
38471 cause a log line to be written.
38472 </para>
38473 <para>
38474 The result of the shadow transport is discarded and does not affect the
38475 subsequent processing of the message. Only a single level of shadowing is
38476 provided; the <option>shadow_transport</option> option is ignored on any transport when it
38477 is running as a shadow. Options concerned with output from pipes are also
38478 ignored. The log line for the successful delivery has an item added on the end,
38479 of the form
38480 </para>
38481 <literallayout class="monospaced">
38482 ST=&lt;shadow transport name&gt;
38483 </literallayout>
38484 <para>
38485 If the shadow transport did not succeed, the error message is put in
38486 parentheses afterwards. Shadow transports can be used for a number of different
38487 purposes, including keeping more detailed log information than Exim normally
38488 provides, and implementing automatic acknowledgment policies based on message
38489 headers that some sites insist on.
38490 </para>
38491 <para>
38492 <indexterm role="option">
38493 <primary><option>transport_filter</option></primary>
38494 </indexterm>
38495 </para>
38496 <informaltable frame="all">
38497 <tgroup cols="4" colsep="0" rowsep="0">
38498 <colspec colwidth="8*" align="left"/>
38499 <colspec colwidth="6*" align="center"/>
38500 <colspec colwidth="6*" align="center"/>
38501 <colspec colwidth="6*" align="right"/>
38502 <tbody>
38503 <row>
38504 <entry><option>transport_filter</option></entry>
38505 <entry>Use: <emphasis>transports</emphasis></entry>
38506 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
38507 <entry>Default: <emphasis>unset</emphasis></entry>
38508 </row>
38509 </tbody>
38510 </tgroup>
38511 </informaltable>
38512 <para>
38513 <indexterm role="concept">
38514 <primary>transport</primary>
38515 <secondary>filter</secondary>
38516 </indexterm>
38517 <indexterm role="concept">
38518 <primary>filter</primary>
38519 <secondary>transport filter</secondary>
38520 </indexterm>
38521 This option sets up a filtering (in the Unix shell sense) process for messages
38522 at transport time. It should not be confused with mail filtering as set up by
38523 individual users or via a system filter.
38524 </para>
38525 <para>
38526 When the message is about to be written out, the command specified by
38527 <option>transport_filter</option> is started up in a separate, parallel process, and
38528 the entire message, including the header lines, is passed to it on its standard
38529 input (this in fact is done from a third process, to avoid deadlock). The
38530 command must be specified as an absolute path.
38531 </para>
38532 <para>
38533 The lines of the message that are written to the transport filter are
38534 terminated by newline (<quote>\n</quote>). The message is passed to the filter before any
38535 SMTP-specific processing, such as turning <quote>\n</quote> into <quote>\r\n</quote> and escaping
38536 lines beginning with a dot, and also before any processing implied by the
38537 settings of <option>check_string</option> and <option>escape_string</option> in the <command>appendfile</command> or
38538 <command>pipe</command> transports.
38539 </para>
38540 <para>
38541 The standard error for the filter process is set to the same destination as its
38542 standard output; this is read and written to the message&#x2019;s ultimate
38543 destination. The process that writes the message to the filter, the
38544 filter itself, and the original process that reads the result and delivers it
38545 are all run in parallel, like a shell pipeline.
38546 </para>
38547 <para>
38548 The filter can perform any transformations it likes, but of course should take
38549 care not to break RFC 2822 syntax. Exim does not check the result, except to
38550 test for a final newline when SMTP is in use. All messages transmitted over
38551 SMTP must end with a newline, so Exim supplies one if it is missing.
38552 </para>
38553 <para>
38554 <indexterm role="concept">
38555 <primary>content scanning</primary>
38556 <secondary>per user</secondary>
38557 </indexterm>
38558 A transport filter can be used to provide content-scanning on a per-user basis
38559 at delivery time if the only required effect of the scan is to modify the
38560 message. For example, a content scan could insert a new header line containing
38561 a spam score. This could be interpreted by a filter in the user&#x2019;s MUA. It is
38562 not possible to discard a message at this stage.
38563 </para>
38564 <para>
38565 <indexterm role="concept">
38566 <primary>SMTP</primary>
38567 <secondary>SIZE</secondary>
38568 </indexterm>
38569 A problem might arise if the filter increases the size of a message that is
38570 being sent down an SMTP connection. If the receiving SMTP server has indicated
38571 support for the SIZE parameter, Exim will have sent the size of the message
38572 at the start of the SMTP session. If what is actually sent is substantially
38573 more, the server might reject the message. This can be worked round by setting
38574 the <option>size_addition</option> option on the <command>smtp</command> transport, either to allow for
38575 additions to the message, or to disable the use of SIZE altogether.
38576 </para>
38577 <para>
38578 <indexterm role="variable">
38579 <primary><varname>$pipe_addresses</varname></primary>
38580 </indexterm>
38581 The value of the <option>transport_filter</option> option is the command string for starting
38582 the filter, which is run directly from Exim, not under a shell. The string is
38583 parsed by Exim in the same way as a command string for the <command>pipe</command> transport:
38584 Exim breaks it up into arguments and then expands each argument separately (see
38585 section <xref linkend="SECThowcommandrun"/>). Any kind of expansion failure causes delivery
38586 to be deferred. The special argument <varname>$pipe_addresses</varname> is replaced by a number
38587 of arguments, one for each address that applies to this delivery. (This isn&#x2019;t
38588 an ideal name for this feature here, but as it was already implemented for the
38589 <command>pipe</command> transport, it seemed sensible not to change it.)
38590 </para>
38591 <para>
38592 <indexterm role="variable">
38593 <primary><varname>$host</varname></primary>
38594 </indexterm>
38595 <indexterm role="variable">
38596 <primary><varname>$host_address</varname></primary>
38597 </indexterm>
38598 The expansion variables <varname>$host</varname> and <varname>$host_address</varname> are available when the
38599 transport is a remote one. They contain the name and IP address of the host to
38600 which the message is being sent. For example:
38601 </para>
38602 <literallayout class="monospaced">
38603 transport_filter = /some/directory/transport-filter.pl \
38604   $host $host_address $sender_address $pipe_addresses
38605 </literallayout>
38606 <para>
38607 Two problems arise if you want to use more complicated expansion items to
38608 generate transport filter commands, both of which due to the fact that the
38609 command is split up <emphasis>before</emphasis> expansion.
38610 </para>
38611 <itemizedlist>
38612 <listitem>
38613 <para>
38614 If an expansion item contains white space, you must quote it, so that it is all
38615 part of the same command item. If the entire option setting is one such
38616 expansion item, you have to take care what kind of quoting you use. For
38617 example:
38618 </para>
38619 <literallayout class="monospaced">
38620 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
38621 </literallayout>
38622 <para>
38623 This runs the command <command>/bin/cmd1</command> if the host name is <emphasis>a.b.c</emphasis>, and
38624 <command>/bin/cmd2</command> otherwise. If double quotes had been used, they would have been
38625 stripped by Exim when it read the option&#x2019;s value. When the value is used, if
38626 the single quotes were missing, the line would be split into two items,
38627 <literal>/bin/cmd${if</literal> and <literal>eq{$host}{a.b.c}{1}{2}</literal>, and an error would occur when
38628 Exim tried to expand the first one.
38629 </para>
38630 </listitem>
38631 <listitem>
38632 <para>
38633 Except for the special case of <varname>$pipe_addresses</varname> that is mentioned above, an
38634 expansion cannot generate multiple arguments, or a command name followed by
38635 arguments. Consider this example:
38636 </para>
38637 <literallayout class="monospaced">
38638 transport_filter = ${lookup{$host}lsearch{/a/file}\
38639                     {$value}{/bin/cat}}
38640 </literallayout>
38641 <para>
38642 The result of the lookup is interpreted as the name of the command, even
38643 if it contains white space. The simplest way round this is to use a shell:
38644 </para>
38645 <literallayout class="monospaced">
38646 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
38647                                {$value}{/bin/cat}}
38648 </literallayout>
38649 </listitem>
38650 </itemizedlist>
38651 <para>
38652 The filter process is run under the same uid and gid as the normal delivery.
38653 For remote deliveries this is the Exim uid/gid by default. The command should
38654 normally yield a zero return code. Transport filters are not supposed to fail.
38655 A non-zero code is taken to mean that the transport filter encountered some
38656 serious problem. Delivery of the message is deferred; the message remains on
38657 the queue and is tried again later. It is not possible to cause a message to be
38658 bounced from a transport filter.
38659 </para>
38660 <para>
38661 If a transport filter is set on an autoreply transport, the original message is
38662 passed through the filter as it is being copied into the newly generated
38663 message, which happens if the <option>return_message</option> option is set.
38664 </para>
38665 <para>
38666 <indexterm role="option">
38667 <primary><option>transport_filter_timeout</option></primary>
38668 </indexterm>
38669 </para>
38670 <informaltable frame="all">
38671 <tgroup cols="4" colsep="0" rowsep="0">
38672 <colspec colwidth="8*" align="left"/>
38673 <colspec colwidth="6*" align="center"/>
38674 <colspec colwidth="6*" align="center"/>
38675 <colspec colwidth="6*" align="right"/>
38676 <tbody>
38677 <row>
38678 <entry><option>transport_filter_timeout</option></entry>
38679 <entry>Use: <emphasis>transports</emphasis></entry>
38680 <entry>Type: <emphasis>time</emphasis></entry>
38681 <entry>Default: <emphasis>5m</emphasis></entry>
38682 </row>
38683 </tbody>
38684 </tgroup>
38685 </informaltable>
38686 <para>
38687 <indexterm role="concept">
38688 <primary>transport</primary>
38689 <secondary>filter, timeout</secondary>
38690 </indexterm>
38691 When Exim is reading the output of a transport filter, it applies a timeout
38692 that can be set by this option. Exceeding the timeout is normally treated as a
38693 temporary delivery failure. However, if a transport filter is used with a
38694 <command>pipe</command> transport, a timeout in the transport filter is treated in the same
38695 way as a timeout in the pipe command itself. By default, a timeout is a hard
38696 error, but if the <command>pipe</command> transport&#x2019;s <option>timeout_defer</option> option is set true, it
38697 becomes a temporary error.
38698 </para>
38699 <para>
38700 <indexterm role="option">
38701 <primary><option>user</option></primary>
38702 </indexterm>
38703 </para>
38704 <informaltable frame="all">
38705 <tgroup cols="4" colsep="0" rowsep="0">
38706 <colspec colwidth="8*" align="left"/>
38707 <colspec colwidth="6*" align="center"/>
38708 <colspec colwidth="6*" align="center"/>
38709 <colspec colwidth="6*" align="right"/>
38710 <tbody>
38711 <row>
38712 <entry><option>user</option></entry>
38713 <entry>Use: <emphasis>transports</emphasis></entry>
38714 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
38715 <entry>Default: <emphasis>Exim user</emphasis></entry>
38716 </row>
38717 </tbody>
38718 </tgroup>
38719 </informaltable>
38720 <para>
38721 <indexterm role="concept">
38722 <primary>uid (user id)</primary>
38723 <secondary>local delivery</secondary>
38724 </indexterm>
38725 <indexterm role="concept">
38726 <primary>transport</primary>
38727 <secondary>user, specifying</secondary>
38728 </indexterm>
38729 This option specifies the user under whose uid the delivery process is to be
38730 run, overriding any uid that may have been set by the router. If the user is
38731 given as a name, the uid is looked up from the password data, and the
38732 associated group is taken as the value of the gid to be used if the <option>group</option>
38733 option is not set.
38734 </para>
38735 <para>
38736 For deliveries that use local transports, a user and group are normally
38737 specified explicitly or implicitly (for example, as a result of
38738 <option>check_local_user</option>) by the router or transport.
38739 </para>
38740 <para>
38741 <indexterm role="concept">
38742 <primary>hints database</primary>
38743 <secondary>access by remote transport</secondary>
38744 </indexterm>
38745 For remote transports, you should leave this option unset unless you really are
38746 sure you know what you are doing. When a remote transport is running, it needs
38747 to be able to access Exim&#x2019;s hints databases, because each host may have its own
38748 retry data.
38749 <indexterm role="concept" startref="IIDgenoptra1" class="endofrange"/>
38750 <indexterm role="concept" startref="IIDgenoptra2" class="endofrange"/>
38751 <indexterm role="concept" startref="IIDgenoptra3" class="endofrange"/>
38752 </para>
38753 </chapter>
38754
38755 <chapter id="CHAPbatching">
38756 <title>Address batching in local transports</title>
38757 <titleabbrev>Address batching</titleabbrev>
38758 <para>
38759 <indexterm role="concept">
38760 <primary>transport</primary>
38761 <secondary>local; address batching in</secondary>
38762 </indexterm>
38763 The only remote transport (<command>smtp</command>) is normally configured to handle more than
38764 one address at a time, so that when several addresses are routed to the same
38765 remote host, just one copy of the message is sent. Local transports, however,
38766 normally handle one address at a time. That is, a separate instance of the
38767 transport is run for each address that is routed to the transport. A separate
38768 copy of the message is delivered each time.
38769 </para>
38770 <para>
38771 <indexterm role="concept">
38772 <primary>batched local delivery</primary>
38773 </indexterm>
38774 <indexterm role="option">
38775 <primary><option>batch_max</option></primary>
38776 </indexterm>
38777 <indexterm role="option">
38778 <primary><option>batch_id</option></primary>
38779 </indexterm>
38780 In special cases, it may be desirable to handle several addresses at once in a
38781 local transport, for example:
38782 </para>
38783 <itemizedlist>
38784 <listitem>
38785 <para>
38786 In an <command>appendfile</command> transport, when storing messages in files for later
38787 delivery by some other means, a single copy of the message with multiple
38788 recipients saves space.
38789 </para>
38790 </listitem>
38791 <listitem>
38792 <para>
38793 In an <command>lmtp</command> transport, when delivering over <quote>local SMTP</quote> to some process,
38794 a single copy saves time, and is the normal way LMTP is expected to work.
38795 </para>
38796 </listitem>
38797 <listitem>
38798 <para>
38799 In a <command>pipe</command> transport, when passing the message
38800 to a scanner program or
38801 to some other delivery mechanism such as UUCP, multiple recipients may be
38802 acceptable.
38803 </para>
38804 </listitem>
38805 </itemizedlist>
38806 <para>
38807 These three local transports all have the same options for controlling multiple
38808 (<quote>batched</quote>) deliveries, namely <option>batch_max</option> and <option>batch_id</option>. To save
38809 repeating the information for each transport, these options are described here.
38810 </para>
38811 <para>
38812 The <option>batch_max</option> option specifies the maximum number of addresses that can be
38813 delivered together in a single run of the transport. Its default value is one
38814 (no batching). When more than one address is routed to a transport that has a
38815 <option>batch_max</option> value greater than one, the addresses are delivered in a batch
38816 (that is, in a single run of the transport with multiple recipients), subject
38817 to certain conditions:
38818 </para>
38819 <itemizedlist>
38820 <listitem>
38821 <para>
38822 <indexterm role="variable">
38823 <primary><varname>$local_part</varname></primary>
38824 </indexterm>
38825 If any of the transport&#x2019;s options contain a reference to <varname>$local_part</varname>, no
38826 batching is possible.
38827 </para>
38828 </listitem>
38829 <listitem>
38830 <para>
38831 <indexterm role="variable">
38832 <primary><varname>$domain</varname></primary>
38833 </indexterm>
38834 If any of the transport&#x2019;s options contain a reference to <varname>$domain</varname>, only
38835 addresses with the same domain are batched.
38836 </para>
38837 </listitem>
38838 <listitem>
38839 <para>
38840 <indexterm role="concept">
38841 <primary>customizing</primary>
38842 <secondary>batching condition</secondary>
38843 </indexterm>
38844 If <option>batch_id</option> is set, it is expanded for each address, and only those
38845 addresses with the same expanded value are batched. This allows you to specify
38846 customized batching conditions. Failure of the expansion for any reason,
38847 including forced failure, disables batching, but it does not stop the delivery
38848 from taking place.
38849 </para>
38850 </listitem>
38851 <listitem>
38852 <para>
38853 Batched addresses must also have the same errors address (where to send
38854 delivery errors), the same header additions and removals, the same user and
38855 group for the transport, and if a host list is present, the first host must
38856 be the same.
38857 </para>
38858 </listitem>
38859 </itemizedlist>
38860 <para>
38861 In the case of the <command>appendfile</command> and <command>pipe</command> transports, batching applies
38862 both when the file or pipe command is specified in the transport, and when it
38863 is specified by a <command>redirect</command> router, but all the batched addresses must of
38864 course be routed to the same file or pipe command. These two transports have an
38865 option called <option>use_bsmtp</option>, which causes them to deliver the message in
38866 <quote>batched SMTP</quote> format, with the envelope represented as SMTP commands. The
38867 <option>check_string</option> and <option>escape_string</option> options are forced to the values
38868 </para>
38869 <literallayout class="monospaced">
38870 check_string = "."
38871 escape_string = ".."
38872 </literallayout>
38873 <para>
38874 when batched SMTP is in use. A full description of the batch SMTP mechanism is
38875 given in section <xref linkend="SECTbatchSMTP"/>. The <command>lmtp</command> transport does not have a
38876 <option>use_bsmtp</option> option, because it always delivers using the SMTP protocol.
38877 </para>
38878 <para>
38879 <indexterm role="concept">
38880 <primary><emphasis>Envelope-to:</emphasis> header line</primary>
38881 </indexterm>
38882 If the generic <option>envelope_to_add</option> option is set for a batching transport, the
38883 <emphasis>Envelope-to:</emphasis> header that is added to the message contains all the addresses
38884 that are being processed together. If you are using a batching <command>appendfile</command>
38885 transport without <option>use_bsmtp</option>, the only way to preserve the recipient
38886 addresses is to set the <option>envelope_to_add</option> option.
38887 </para>
38888 <para>
38889 <indexterm role="concept">
38890 <primary><command>pipe</command> transport</primary>
38891 <secondary>with multiple addresses</secondary>
38892 </indexterm>
38893 <indexterm role="variable">
38894 <primary><varname>$pipe_addresses</varname></primary>
38895 </indexterm>
38896 If you are using a <command>pipe</command> transport without BSMTP, and setting the
38897 transport&#x2019;s <option>command</option> option, you can include <varname>$pipe_addresses</varname> as part of
38898 the command. This is not a true variable; it is a bit of magic that causes each
38899 of the recipient addresses to be inserted into the command as a separate
38900 argument. This provides a way of accessing all the addresses that are being
38901 delivered in the batch. <emphasis role="bold">Note:</emphasis> This is not possible for pipe commands that
38902 are specified by a <command>redirect</command> router.
38903 </para>
38904 </chapter>
38905
38906 <chapter id="CHAPappendfile">
38907 <title>The appendfile transport</title>
38908 <para>
38909 <indexterm role="concept" id="IIDapptra1" class="startofrange">
38910 <primary><command>appendfile</command> transport</primary>
38911 </indexterm>
38912 <indexterm role="concept" id="IIDapptra2" class="startofrange">
38913 <primary>transports</primary>
38914 <secondary><command>appendfile</command></secondary>
38915 </indexterm>
38916 <indexterm role="concept">
38917 <primary>directory creation</primary>
38918 </indexterm>
38919 <indexterm role="concept">
38920 <primary>creating directories</primary>
38921 </indexterm>
38922 The <command>appendfile</command> transport delivers a message by appending it to an existing
38923 file, or by creating an entirely new file in a specified directory. Single
38924 files to which messages are appended can be in the traditional Unix mailbox
38925 format, or optionally in the MBX format supported by the Pine MUA and
38926 University of Washington IMAP daemon, <emphasis>inter alia</emphasis>. When each message is
38927 being delivered as a separate file, <quote>maildir</quote> format can optionally be used
38928 to give added protection against failures that happen part-way through the
38929 delivery. A third form of separate-file delivery known as <quote>mailstore</quote> is also
38930 supported. For all file formats, Exim attempts to create as many levels of
38931 directory as necessary, provided that <option>create_directory</option> is set.
38932 </para>
38933 <para>
38934 The code for the optional formats is not included in the Exim binary by
38935 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
38936 SUPPORT_MAILSTORE in <filename>Local/Makefile</filename> to have the appropriate code
38937 included.
38938 </para>
38939 <para>
38940 <indexterm role="concept">
38941 <primary>quota</primary>
38942 <secondary>system</secondary>
38943 </indexterm>
38944 Exim recognizes system quota errors, and generates an appropriate message. Exim
38945 also supports its own quota control within the transport, for use when the
38946 system facility is unavailable or cannot be used for some reason.
38947 </para>
38948 <para>
38949 If there is an error while appending to a file (for example, quota exceeded or
38950 partition filled), Exim attempts to reset the file&#x2019;s length and last
38951 modification time back to what they were before. If there is an error while
38952 creating an entirely new file, the new file is removed.
38953 </para>
38954 <para>
38955 Before appending to a file, a number of security checks are made, and the
38956 file is locked. A detailed description is given below, after the list of
38957 private options.
38958 </para>
38959 <para>
38960 The <command>appendfile</command> transport is most commonly used for local deliveries to
38961 users&#x2019; mailboxes. However, it can also be used as a pseudo-remote transport for
38962 putting messages into files for remote delivery by some means other than Exim.
38963 <quote>Batch SMTP</quote> format is often used in this case (see the <option>use_bsmtp</option>
38964 option).
38965 </para>
38966 <section id="SECTfildiropt">
38967 <title>The file and directory options</title>
38968 <para>
38969 The <option>file</option> option specifies a single file, to which the message is appended;
38970 the <option>directory</option> option specifies a directory, in which a new file containing
38971 the message is created. Only one of these two options can be set, and for
38972 normal deliveries to mailboxes, one of them <emphasis>must</emphasis> be set.
38973 </para>
38974 <para>
38975 <indexterm role="variable">
38976 <primary><varname>$address_file</varname></primary>
38977 </indexterm>
38978 <indexterm role="variable">
38979 <primary><varname>$local_part</varname></primary>
38980 </indexterm>
38981 However, <command>appendfile</command> is also used for delivering messages to files or
38982 directories whose names (or parts of names) are obtained from alias,
38983 forwarding, or filtering operations (for example, a <option>save</option> command in a
38984 user&#x2019;s Exim filter). When such a transport is running, <varname>$local_part</varname> contains
38985 the local part that was aliased or forwarded, and <varname>$address_file</varname> contains the
38986 name (or partial name) of the file or directory generated by the redirection
38987 operation. There are two cases:
38988 </para>
38989 <itemizedlist>
38990 <listitem>
38991 <para>
38992 If neither <option>file</option> nor <option>directory</option> is set, the redirection operation
38993 must specify an absolute path (one that begins with <literal>/</literal>). This is the most
38994 common case when users with local accounts use filtering to sort mail into
38995 different folders. See for example, the <command>address_file</command> transport in the
38996 default configuration. If the path ends with a slash, it is assumed to be the
38997 name of a directory. A delivery to a directory can also be forced by setting
38998 <option>maildir_format</option> or <option>mailstore_format</option>.
38999 </para>
39000 </listitem>
39001 <listitem>
39002 <para>
39003 If <option>file</option> or <option>directory</option> is set for a delivery from a redirection, it is
39004 used to determine the file or directory name for the delivery. Normally, the
39005 contents of <varname>$address_file</varname> are used in some way in the string expansion.
39006 </para>
39007 </listitem>
39008 </itemizedlist>
39009 <para>
39010 <indexterm role="concept">
39011 <primary>Sieve filter</primary>
39012 <secondary>configuring <command>appendfile</command></secondary>
39013 </indexterm>
39014 <indexterm role="concept">
39015 <primary>Sieve filter</primary>
39016 <secondary>relative mailbox path handling</secondary>
39017 </indexterm>
39018 As an example of the second case, consider an environment where users do not
39019 have home directories. They may be permitted to use Exim filter commands of the
39020 form:
39021 </para>
39022 <literallayout class="monospaced">
39023 save folder23
39024 </literallayout>
39025 <para>
39026 or Sieve filter commands of the form:
39027 </para>
39028 <literallayout class="monospaced">
39029 require "fileinto";
39030 fileinto "folder23";
39031 </literallayout>
39032 <para>
39033 In this situation, the expansion of <option>file</option> or <option>directory</option> in the transport
39034 must transform the relative path into an appropriate absolute file name. In the
39035 case of Sieve filters, the name <emphasis>inbox</emphasis> must be handled. It is the name that
39036 is used as a result of a <quote>keep</quote> action in the filter. This example shows one
39037 way of handling this requirement:
39038 </para>
39039 <literallayout class="monospaced">
39040 file = ${if eq{$address_file}{inbox} \
39041             {/var/mail/$local_part} \
39042             {${if eq{${substr_0_1:$address_file}}{/} \
39043                   {$address_file} \
39044                   {$home/mail/$address_file} \
39045             }} \
39046        }
39047 </literallayout>
39048 <para>
39049 With this setting of <option>file</option>, <emphasis>inbox</emphasis> refers to the standard mailbox
39050 location, absolute paths are used without change, and other folders are in the
39051 <filename>mail</filename> directory within the home directory.
39052 </para>
39053 <para>
39054 <emphasis role="bold">Note 1</emphasis>: While processing an Exim filter, a relative path such as
39055 <filename>folder23</filename> is turned into an absolute path if a home directory is known to
39056 the router. In particular, this is the case if <option>check_local_user</option> is set. If
39057 you want to prevent this happening at routing time, you can set
39058 <option>router_home_directory</option> empty. This forces the router to pass the relative
39059 path to the transport.
39060 </para>
39061 <para>
39062 <emphasis role="bold">Note 2</emphasis>: An absolute path in <varname>$address_file</varname> is not treated specially;
39063 the <option>file</option> or <option>directory</option> option is still used if it is set.
39064 </para>
39065 </section>
39066 <section id="SECID134">
39067 <title>Private options for appendfile</title>
39068 <para>
39069 <indexterm role="concept">
39070 <primary>options</primary>
39071 <secondary><command>appendfile</command> transport</secondary>
39072 </indexterm>
39073 </para>
39074 <para>
39075 <indexterm role="option">
39076 <primary><option>allow_fifo</option></primary>
39077 </indexterm>
39078 </para>
39079 <informaltable frame="all">
39080 <tgroup cols="4" colsep="0" rowsep="0">
39081 <colspec colwidth="8*" align="left"/>
39082 <colspec colwidth="6*" align="center"/>
39083 <colspec colwidth="6*" align="center"/>
39084 <colspec colwidth="6*" align="right"/>
39085 <tbody>
39086 <row>
39087 <entry><option>allow_fifo</option></entry>
39088 <entry>Use: <emphasis>appendfile</emphasis></entry>
39089 <entry>Type: <emphasis>boolean</emphasis></entry>
39090 <entry>Default: <emphasis>false</emphasis></entry>
39091 </row>
39092 </tbody>
39093 </tgroup>
39094 </informaltable>
39095 <para>
39096 <indexterm role="concept">
39097 <primary>fifo (named pipe)</primary>
39098 </indexterm>
39099 <indexterm role="concept">
39100 <primary>named pipe (fifo)</primary>
39101 </indexterm>
39102 <indexterm role="concept">
39103 <primary>pipe</primary>
39104 <secondary>named (fifo)</secondary>
39105 </indexterm>
39106 Setting this option permits delivery to named pipes (FIFOs) as well as to
39107 regular files. If no process is reading the named pipe at delivery time, the
39108 delivery is deferred.
39109 </para>
39110 <para>
39111 <indexterm role="option">
39112 <primary><option>allow_symlink</option></primary>
39113 </indexterm>
39114 </para>
39115 <informaltable frame="all">
39116 <tgroup cols="4" colsep="0" rowsep="0">
39117 <colspec colwidth="8*" align="left"/>
39118 <colspec colwidth="6*" align="center"/>
39119 <colspec colwidth="6*" align="center"/>
39120 <colspec colwidth="6*" align="right"/>
39121 <tbody>
39122 <row>
39123 <entry><option>allow_symlink</option></entry>
39124 <entry>Use: <emphasis>appendfile</emphasis></entry>
39125 <entry>Type: <emphasis>boolean</emphasis></entry>
39126 <entry>Default: <emphasis>false</emphasis></entry>
39127 </row>
39128 </tbody>
39129 </tgroup>
39130 </informaltable>
39131 <para>
39132 <indexterm role="concept">
39133 <primary>symbolic link</primary>
39134 <secondary>to mailbox</secondary>
39135 </indexterm>
39136 <indexterm role="concept">
39137 <primary>mailbox</primary>
39138 <secondary>symbolic link</secondary>
39139 </indexterm>
39140 By default, <command>appendfile</command> will not deliver if the path name for the file is
39141 that of a symbolic link. Setting this option relaxes that constraint, but there
39142 are security issues involved in the use of symbolic links. Be sure you know
39143 what you are doing if you set this. Details of exactly what this option affects
39144 are included in the discussion which follows this list of options.
39145 </para>
39146 <para>
39147 <indexterm role="option">
39148 <primary><option>batch_id</option></primary>
39149 </indexterm>
39150 </para>
39151 <informaltable frame="all">
39152 <tgroup cols="4" colsep="0" rowsep="0">
39153 <colspec colwidth="8*" align="left"/>
39154 <colspec colwidth="6*" align="center"/>
39155 <colspec colwidth="6*" align="center"/>
39156 <colspec colwidth="6*" align="right"/>
39157 <tbody>
39158 <row>
39159 <entry><option>batch_id</option></entry>
39160 <entry>Use: <emphasis>appendfile</emphasis></entry>
39161 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
39162 <entry>Default: <emphasis>unset</emphasis></entry>
39163 </row>
39164 </tbody>
39165 </tgroup>
39166 </informaltable>
39167 <para>
39168 See the description of local delivery batching in chapter <xref linkend="CHAPbatching"/>.
39169 However, batching is automatically disabled for <command>appendfile</command> deliveries that
39170 happen as a result of forwarding or aliasing or other redirection directly to a
39171 file.
39172 </para>
39173 <para>
39174 <indexterm role="option">
39175 <primary><option>batch_max</option></primary>
39176 </indexterm>
39177 </para>
39178 <informaltable frame="all">
39179 <tgroup cols="4" colsep="0" rowsep="0">
39180 <colspec colwidth="8*" align="left"/>
39181 <colspec colwidth="6*" align="center"/>
39182 <colspec colwidth="6*" align="center"/>
39183 <colspec colwidth="6*" align="right"/>
39184 <tbody>
39185 <row>
39186 <entry><option>batch_max</option></entry>
39187 <entry>Use: <emphasis>appendfile</emphasis></entry>
39188 <entry>Type: <emphasis>integer</emphasis></entry>
39189 <entry>Default: <emphasis>1</emphasis></entry>
39190 </row>
39191 </tbody>
39192 </tgroup>
39193 </informaltable>
39194 <para>
39195 See the description of local delivery batching in chapter <xref linkend="CHAPbatching"/>.
39196 </para>
39197 <para>
39198 <indexterm role="option">
39199 <primary><option>check_group</option></primary>
39200 </indexterm>
39201 </para>
39202 <informaltable frame="all">
39203 <tgroup cols="4" colsep="0" rowsep="0">
39204 <colspec colwidth="8*" align="left"/>
39205 <colspec colwidth="6*" align="center"/>
39206 <colspec colwidth="6*" align="center"/>
39207 <colspec colwidth="6*" align="right"/>
39208 <tbody>
39209 <row>
39210 <entry><option>check_group</option></entry>
39211 <entry>Use: <emphasis>appendfile</emphasis></entry>
39212 <entry>Type: <emphasis>boolean</emphasis></entry>
39213 <entry>Default: <emphasis>false</emphasis></entry>
39214 </row>
39215 </tbody>
39216 </tgroup>
39217 </informaltable>
39218 <para>
39219 When this option is set, the group owner of the file defined by the <option>file</option>
39220 option is checked to see that it is the same as the group under which the
39221 delivery process is running. The default setting is false because the default
39222 file mode is 0600, which means that the group is irrelevant.
39223 </para>
39224 <para>
39225 <indexterm role="option">
39226 <primary><option>check_owner</option></primary>
39227 </indexterm>
39228 </para>
39229 <informaltable frame="all">
39230 <tgroup cols="4" colsep="0" rowsep="0">
39231 <colspec colwidth="8*" align="left"/>
39232 <colspec colwidth="6*" align="center"/>
39233 <colspec colwidth="6*" align="center"/>
39234 <colspec colwidth="6*" align="right"/>
39235 <tbody>
39236 <row>
39237 <entry><option>check_owner</option></entry>
39238 <entry>Use: <emphasis>appendfile</emphasis></entry>
39239 <entry>Type: <emphasis>boolean</emphasis></entry>
39240 <entry>Default: <emphasis>true</emphasis></entry>
39241 </row>
39242 </tbody>
39243 </tgroup>
39244 </informaltable>
39245 <para>
39246 When this option is set, the owner of the file defined by the <option>file</option> option
39247 is checked to ensure that it is the same as the user under which the delivery
39248 process is running.
39249 </para>
39250 <para>
39251 <indexterm role="option">
39252 <primary><option>check_string</option></primary>
39253 </indexterm>
39254 </para>
39255 <informaltable frame="all">
39256 <tgroup cols="4" colsep="0" rowsep="0">
39257 <colspec colwidth="8*" align="left"/>
39258 <colspec colwidth="6*" align="center"/>
39259 <colspec colwidth="6*" align="center"/>
39260 <colspec colwidth="6*" align="right"/>
39261 <tbody>
39262 <row>
39263 <entry><option>check_string</option></entry>
39264 <entry>Use: <emphasis>appendfile</emphasis></entry>
39265 <entry>Type: <emphasis>string</emphasis></entry>
39266 <entry>Default: <emphasis>see below</emphasis></entry>
39267 </row>
39268 </tbody>
39269 </tgroup>
39270 </informaltable>
39271 <para>
39272 <indexterm role="concept">
39273 <primary><quote>From</quote> line</primary>
39274 </indexterm>
39275 As <command>appendfile</command> writes the message, the start of each line is tested for
39276 matching <option>check_string</option>, and if it does, the initial matching characters are
39277 replaced by the contents of <option>escape_string</option>. The value of <option>check_string</option> is
39278 a literal string, not a regular expression, and the case of any letters it
39279 contains is significant.
39280 </para>
39281 <para>
39282 If <option>use_bsmtp</option> is set the values of <option>check_string</option> and <option>escape_string</option>
39283 are forced to <quote>.</quote> and <quote>..</quote> respectively, and any settings in the
39284 configuration are ignored. Otherwise, they default to <quote>From&nbsp;</quote> and
39285 <quote>&gt;From&nbsp;</quote> when the <option>file</option> option is set, and unset when any of the
39286 <option>directory</option>, <option>maildir</option>, or <option>mailstore</option> options are set.
39287 </para>
39288 <para>
39289 The default settings, along with <option>message_prefix</option> and <option>message_suffix</option>, are
39290 suitable for traditional <quote>BSD</quote> mailboxes, where a line beginning with
39291 <quote>From&nbsp;</quote> indicates the start of a new message. All four options need changing
39292 if another format is used. For example, to deliver to mailboxes in MMDF format:
39293 <indexterm role="concept">
39294 <primary>MMDF format mailbox</primary>
39295 </indexterm>
39296 <indexterm role="concept">
39297 <primary>mailbox</primary>
39298 <secondary>MMDF format</secondary>
39299 </indexterm>
39300 </para>
39301 <literallayout class="monospaced">
39302 check_string = "\1\1\1\1\n"
39303 escape_string = "\1\1\1\1 \n"
39304 message_prefix = "\1\1\1\1\n"
39305 message_suffix = "\1\1\1\1\n"
39306 </literallayout>
39307 <para>
39308 <indexterm role="option">
39309 <primary><option>create_directory</option></primary>
39310 </indexterm>
39311 </para>
39312 <informaltable frame="all">
39313 <tgroup cols="4" colsep="0" rowsep="0">
39314 <colspec colwidth="8*" align="left"/>
39315 <colspec colwidth="6*" align="center"/>
39316 <colspec colwidth="6*" align="center"/>
39317 <colspec colwidth="6*" align="right"/>
39318 <tbody>
39319 <row>
39320 <entry><option>create_directory</option></entry>
39321 <entry>Use: <emphasis>appendfile</emphasis></entry>
39322 <entry>Type: <emphasis>boolean</emphasis></entry>
39323 <entry>Default: <emphasis>true</emphasis></entry>
39324 </row>
39325 </tbody>
39326 </tgroup>
39327 </informaltable>
39328 <para>
39329 <indexterm role="concept">
39330 <primary>directory creation</primary>
39331 </indexterm>
39332 When this option is true, Exim attempts to create any missing superior
39333 directories for the file that it is about to write. A created directory&#x2019;s mode
39334 is given by the <option>directory_mode</option> option.
39335 </para>
39336 <para>
39337 The group ownership of a newly created directory is highly dependent on the
39338 operating system (and possibly the file system) that is being used. For
39339 example, in Solaris, if the parent directory has the setgid bit set, its group
39340 is propagated to the child; if not, the currently set group is used. However,
39341 in FreeBSD, the parent&#x2019;s group is always used.
39342 </para>
39343 <para>
39344 <indexterm role="option">
39345 <primary><option>create_file</option></primary>
39346 </indexterm>
39347 </para>
39348 <informaltable frame="all">
39349 <tgroup cols="4" colsep="0" rowsep="0">
39350 <colspec colwidth="8*" align="left"/>
39351 <colspec colwidth="6*" align="center"/>
39352 <colspec colwidth="6*" align="center"/>
39353 <colspec colwidth="6*" align="right"/>
39354 <tbody>
39355 <row>
39356 <entry><option>create_file</option></entry>
39357 <entry>Use: <emphasis>appendfile</emphasis></entry>
39358 <entry>Type: <emphasis>string</emphasis></entry>
39359 <entry>Default: <emphasis>anywhere</emphasis></entry>
39360 </row>
39361 </tbody>
39362 </tgroup>
39363 </informaltable>
39364 <para>
39365 This option constrains the location of files and directories that are created
39366 by this transport. It applies to files defined by the <option>file</option> option and
39367 directories defined by the <option>directory</option> option. In the case of maildir
39368 delivery, it applies to the top level directory, not the maildir directories
39369 beneath.
39370 </para>
39371 <para>
39372 The option must be set to one of the words <quote>anywhere</quote>, <quote>inhome</quote>, or
39373 <quote>belowhome</quote>. In the second and third cases, a home directory must have been
39374 set for the transport. This option is not useful when an explicit file name is
39375 given for normal mailbox deliveries. It is intended for the case when file
39376 names are generated from users&#x2019; <filename>.forward</filename> files. These are usually handled
39377 by an <command>appendfile</command> transport called <option>address_file</option>. See also
39378 <option>file_must_exist</option>.
39379 </para>
39380 <para>
39381 <indexterm role="option">
39382 <primary><option>directory</option></primary>
39383 </indexterm>
39384 </para>
39385 <informaltable frame="all">
39386 <tgroup cols="4" colsep="0" rowsep="0">
39387 <colspec colwidth="8*" align="left"/>
39388 <colspec colwidth="6*" align="center"/>
39389 <colspec colwidth="6*" align="center"/>
39390 <colspec colwidth="6*" align="right"/>
39391 <tbody>
39392 <row>
39393 <entry><option>directory</option></entry>
39394 <entry>Use: <emphasis>appendfile</emphasis></entry>
39395 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
39396 <entry>Default: <emphasis>unset</emphasis></entry>
39397 </row>
39398 </tbody>
39399 </tgroup>
39400 </informaltable>
39401 <para>
39402 This option is mutually exclusive with the <option>file</option> option, but one of <option>file</option>
39403 or <option>directory</option> must be set, unless the delivery is the direct result of a
39404 redirection (see section <xref linkend="SECTfildiropt"/>).
39405 </para>
39406 <para>
39407 When <option>directory</option> is set, the string is expanded, and the message is delivered
39408 into a new file or files in or below the given directory, instead of being
39409 appended to a single mailbox file. A number of different formats are provided
39410 (see <option>maildir_format</option> and <option>mailstore_format</option>), and see section
39411 <xref linkend="SECTopdir"/> for further details of this form of delivery.
39412 </para>
39413 <para>
39414 <indexterm role="option">
39415 <primary><option>directory_file</option></primary>
39416 </indexterm>
39417 </para>
39418 <informaltable frame="all">
39419 <tgroup cols="4" colsep="0" rowsep="0">
39420 <colspec colwidth="8*" align="left"/>
39421 <colspec colwidth="6*" align="center"/>
39422 <colspec colwidth="6*" align="center"/>
39423 <colspec colwidth="6*" align="right"/>
39424 <tbody>
39425 <row>
39426 <entry><option>directory_file</option></entry>
39427 <entry>Use: <emphasis>appendfile</emphasis></entry>
39428 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
39429 <entry>Default: <emphasis>see below</emphasis></entry>
39430 </row>
39431 </tbody>
39432 </tgroup>
39433 </informaltable>
39434 <para>
39435 <indexterm role="concept">
39436 <primary>base62</primary>
39437 </indexterm>
39438 <indexterm role="variable">
39439 <primary><varname>$inode</varname></primary>
39440 </indexterm>
39441 When <option>directory</option> is set, but neither <option>maildir_format</option> nor
39442 <option>mailstore_format</option> is set, <command>appendfile</command> delivers each message into a file
39443 whose name is obtained by expanding this string. The default value is:
39444 </para>
39445 <literallayout class="monospaced">
39446 q${base62:$tod_epoch}-$inode
39447 </literallayout>
39448 <para>
39449 This generates a unique name from the current time, in base 62 form, and the
39450 inode of the file. The variable <varname>$inode</varname> is available only when expanding this
39451 option.
39452 </para>
39453 <para>
39454 <indexterm role="option">
39455 <primary><option>directory_mode</option></primary>
39456 </indexterm>
39457 </para>
39458 <informaltable frame="all">
39459 <tgroup cols="4" colsep="0" rowsep="0">
39460 <colspec colwidth="8*" align="left"/>
39461 <colspec colwidth="6*" align="center"/>
39462 <colspec colwidth="6*" align="center"/>
39463 <colspec colwidth="6*" align="right"/>
39464 <tbody>
39465 <row>
39466 <entry><option>directory_mode</option></entry>
39467 <entry>Use: <emphasis>appendfile</emphasis></entry>
39468 <entry>Type: <emphasis>octal integer</emphasis></entry>
39469 <entry>Default: <emphasis>0700</emphasis></entry>
39470 </row>
39471 </tbody>
39472 </tgroup>
39473 </informaltable>
39474 <para>
39475 If <command>appendfile</command> creates any directories as a result of the
39476 <option>create_directory</option> option, their mode is specified by this option.
39477 </para>
39478 <para>
39479 <indexterm role="option">
39480 <primary><option>escape_string</option></primary>
39481 </indexterm>
39482 </para>
39483 <informaltable frame="all">
39484 <tgroup cols="4" colsep="0" rowsep="0">
39485 <colspec colwidth="8*" align="left"/>
39486 <colspec colwidth="6*" align="center"/>
39487 <colspec colwidth="6*" align="center"/>
39488 <colspec colwidth="6*" align="right"/>
39489 <tbody>
39490 <row>
39491 <entry><option>escape_string</option></entry>
39492 <entry>Use: <emphasis>appendfile</emphasis></entry>
39493 <entry>Type: <emphasis>string</emphasis></entry>
39494 <entry>Default: <emphasis>see description</emphasis></entry>
39495 </row>
39496 </tbody>
39497 </tgroup>
39498 </informaltable>
39499 <para>
39500 See <option>check_string</option> above.
39501 </para>
39502 <para>
39503 <indexterm role="option">
39504 <primary><option>file</option></primary>
39505 </indexterm>
39506 </para>
39507 <informaltable frame="all">
39508 <tgroup cols="4" colsep="0" rowsep="0">
39509 <colspec colwidth="8*" align="left"/>
39510 <colspec colwidth="6*" align="center"/>
39511 <colspec colwidth="6*" align="center"/>
39512 <colspec colwidth="6*" align="right"/>
39513 <tbody>
39514 <row>
39515 <entry><option>file</option></entry>
39516 <entry>Use: <emphasis>appendfile</emphasis></entry>
39517 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
39518 <entry>Default: <emphasis>unset</emphasis></entry>
39519 </row>
39520 </tbody>
39521 </tgroup>
39522 </informaltable>
39523 <para>
39524 This option is mutually exclusive with the <option>directory</option> option, but one of
39525 <option>file</option> or <option>directory</option> must be set, unless the delivery is the direct result
39526 of a redirection (see section <xref linkend="SECTfildiropt"/>). The <option>file</option> option
39527 specifies a single file, to which the message is appended. One or more of
39528 <option>use_fcntl_lock</option>, <option>use_flock_lock</option>, or <option>use_lockfile</option> must be set with
39529 <option>file</option>.
39530 </para>
39531 <para>
39532 <indexterm role="concept">
39533 <primary>NFS</primary>
39534 <secondary>lock file</secondary>
39535 </indexterm>
39536 <indexterm role="concept">
39537 <primary>locking files</primary>
39538 </indexterm>
39539 <indexterm role="concept">
39540 <primary>lock files</primary>
39541 </indexterm>
39542 If you are using more than one host to deliver over NFS into the same
39543 mailboxes, you should always use lock files.
39544 </para>
39545 <para>
39546 The string value is expanded for each delivery, and must yield an absolute
39547 path. The most common settings of this option are variations on one of these
39548 examples:
39549 </para>
39550 <literallayout class="monospaced">
39551 file = /var/spool/mail/$local_part
39552 file = /home/$local_part/inbox
39553 file = $home/inbox
39554 </literallayout>
39555 <para>
39556 <indexterm role="concept">
39557 <primary><quote>sticky</quote> bit</primary>
39558 </indexterm>
39559 In the first example, all deliveries are done into the same directory. If Exim
39560 is configured to use lock files (see <option>use_lockfile</option> below) it must be able to
39561 create a file in the directory, so the <quote>sticky</quote> bit must be turned on for
39562 deliveries to be possible, or alternatively the <option>group</option> option can be used to
39563 run the delivery under a group id which has write access to the directory.
39564 </para>
39565 <para>
39566 <indexterm role="option">
39567 <primary><option>file_format</option></primary>
39568 </indexterm>
39569 </para>
39570 <informaltable frame="all">
39571 <tgroup cols="4" colsep="0" rowsep="0">
39572 <colspec colwidth="8*" align="left"/>
39573 <colspec colwidth="6*" align="center"/>
39574 <colspec colwidth="6*" align="center"/>
39575 <colspec colwidth="6*" align="right"/>
39576 <tbody>
39577 <row>
39578 <entry><option>file_format</option></entry>
39579 <entry>Use: <emphasis>appendfile</emphasis></entry>
39580 <entry>Type: <emphasis>string</emphasis></entry>
39581 <entry>Default: <emphasis>unset</emphasis></entry>
39582 </row>
39583 </tbody>
39584 </tgroup>
39585 </informaltable>
39586 <para>
39587 <indexterm role="concept">
39588 <primary>file</primary>
39589 <secondary>mailbox; checking existing format</secondary>
39590 </indexterm>
39591 This option requests the transport to check the format of an existing file
39592 before adding to it. The check consists of matching a specific string at the
39593 start of the file. The value of the option consists of an even number of
39594 colon-separated strings. The first of each pair is the test string, and the
39595 second is the name of a transport. If the transport associated with a matched
39596 string is not the current transport, control is passed over to the other
39597 transport. For example, suppose the standard <command>local_delivery</command> transport has
39598 this added to it:
39599 </para>
39600 <literallayout class="monospaced">
39601 file_format = "From       : local_delivery :\
39602                \1\1\1\1\n : local_mmdf_delivery"
39603 </literallayout>
39604 <para>
39605 Mailboxes that begin with <quote>From</quote> are still handled by this transport, but if
39606 a mailbox begins with four binary ones followed by a newline, control is passed
39607 to a transport called <option>local_mmdf_delivery</option>, which presumably is configured
39608 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
39609 is assumed to match the current transport. If the start of a mailbox doesn&#x2019;t
39610 match any string, or if the transport named for a given string is not defined,
39611 delivery is deferred.
39612 </para>
39613 <para>
39614 <indexterm role="option">
39615 <primary><option>file_must_exist</option></primary>
39616 </indexterm>
39617 </para>
39618 <informaltable frame="all">
39619 <tgroup cols="4" colsep="0" rowsep="0">
39620 <colspec colwidth="8*" align="left"/>
39621 <colspec colwidth="6*" align="center"/>
39622 <colspec colwidth="6*" align="center"/>
39623 <colspec colwidth="6*" align="right"/>
39624 <tbody>
39625 <row>
39626 <entry><option>file_must_exist</option></entry>
39627 <entry>Use: <emphasis>appendfile</emphasis></entry>
39628 <entry>Type: <emphasis>boolean</emphasis></entry>
39629 <entry>Default: <emphasis>false</emphasis></entry>
39630 </row>
39631 </tbody>
39632 </tgroup>
39633 </informaltable>
39634 <para>
39635 If this option is true, the file specified by the <option>file</option> option must exist.
39636 A temporary error occurs if it does not, causing delivery to be deferred.
39637 If this option is false, the file is created if it does not exist.
39638 </para>
39639 <para>
39640 <indexterm role="option">
39641 <primary><option>lock_fcntl_timeout</option></primary>
39642 </indexterm>
39643 </para>
39644 <informaltable frame="all">
39645 <tgroup cols="4" colsep="0" rowsep="0">
39646 <colspec colwidth="8*" align="left"/>
39647 <colspec colwidth="6*" align="center"/>
39648 <colspec colwidth="6*" align="center"/>
39649 <colspec colwidth="6*" align="right"/>
39650 <tbody>
39651 <row>
39652 <entry><option>lock_fcntl_timeout</option></entry>
39653 <entry>Use: <emphasis>appendfile</emphasis></entry>
39654 <entry>Type: <emphasis>time</emphasis></entry>
39655 <entry>Default: <emphasis>0s</emphasis></entry>
39656 </row>
39657 </tbody>
39658 </tgroup>
39659 </informaltable>
39660 <para>
39661 <indexterm role="concept">
39662 <primary>timeout</primary>
39663 <secondary>mailbox locking</secondary>
39664 </indexterm>
39665 <indexterm role="concept">
39666 <primary>mailbox</primary>
39667 <secondary>locking, blocking and non-blocking</secondary>
39668 </indexterm>
39669 <indexterm role="concept">
39670 <primary>locking files</primary>
39671 </indexterm>
39672 By default, the <command>appendfile</command> transport uses non-blocking calls to <function>fcntl()</function>
39673 when locking an open mailbox file. If the call fails, the delivery process
39674 sleeps for <option>lock_interval</option> and tries again, up to <option>lock_retries</option> times.
39675 Non-blocking calls are used so that the file is not kept open during the wait
39676 for the lock; the reason for this is to make it as safe as possible for
39677 deliveries over NFS in the case when processes might be accessing an NFS
39678 mailbox without using a lock file. This should not be done, but
39679 misunderstandings and hence misconfigurations are not unknown.
39680 </para>
39681 <para>
39682 On a busy system, however, the performance of a non-blocking lock approach is
39683 not as good as using a blocking lock with a timeout. In this case, the waiting
39684 is done inside the system call, and Exim&#x2019;s delivery process acquires the lock
39685 and can proceed as soon as the previous lock holder releases it.
39686 </para>
39687 <para>
39688 If <option>lock_fcntl_timeout</option> is set to a non-zero time, blocking locks, with that
39689 timeout, are used. There may still be some retrying: the maximum number of
39690 retries is
39691 </para>
39692 <literallayout class="monospaced">
39693 (lock_retries * lock_interval) / lock_fcntl_timeout
39694 </literallayout>
39695 <para>
39696 rounded up to the next whole number. In other words, the total time during
39697 which <command>appendfile</command> is trying to get a lock is roughly the same, unless
39698 <option>lock_fcntl_timeout</option> is set very large.
39699 </para>
39700 <para>
39701 You should consider setting this option if you are getting a lot of delayed
39702 local deliveries because of errors of the form
39703 </para>
39704 <literallayout class="monospaced">
39705 failed to lock mailbox /some/file (fcntl)
39706 </literallayout>
39707 <para>
39708 <indexterm role="option">
39709 <primary><option>lock_flock_timeout</option></primary>
39710 </indexterm>
39711 </para>
39712 <informaltable frame="all">
39713 <tgroup cols="4" colsep="0" rowsep="0">
39714 <colspec colwidth="8*" align="left"/>
39715 <colspec colwidth="6*" align="center"/>
39716 <colspec colwidth="6*" align="center"/>
39717 <colspec colwidth="6*" align="right"/>
39718 <tbody>
39719 <row>
39720 <entry><option>lock_flock_timeout</option></entry>
39721 <entry>Use: <emphasis>appendfile</emphasis></entry>
39722 <entry>Type: <emphasis>time</emphasis></entry>
39723 <entry>Default: <emphasis>0s</emphasis></entry>
39724 </row>
39725 </tbody>
39726 </tgroup>
39727 </informaltable>
39728 <para>
39729 This timeout applies to file locking when using <function>flock()</function> (see
39730 <option>use_flock</option>); the timeout operates in a similar manner to
39731 <option>lock_fcntl_timeout</option>.
39732 </para>
39733 <para>
39734 <indexterm role="option">
39735 <primary><option>lock_interval</option></primary>
39736 </indexterm>
39737 </para>
39738 <informaltable frame="all">
39739 <tgroup cols="4" colsep="0" rowsep="0">
39740 <colspec colwidth="8*" align="left"/>
39741 <colspec colwidth="6*" align="center"/>
39742 <colspec colwidth="6*" align="center"/>
39743 <colspec colwidth="6*" align="right"/>
39744 <tbody>
39745 <row>
39746 <entry><option>lock_interval</option></entry>
39747 <entry>Use: <emphasis>appendfile</emphasis></entry>
39748 <entry>Type: <emphasis>time</emphasis></entry>
39749 <entry>Default: <emphasis>3s</emphasis></entry>
39750 </row>
39751 </tbody>
39752 </tgroup>
39753 </informaltable>
39754 <para>
39755 This specifies the time to wait between attempts to lock the file. See below
39756 for details of locking.
39757 </para>
39758 <para>
39759 <indexterm role="option">
39760 <primary><option>lock_retries</option></primary>
39761 </indexterm>
39762 </para>
39763 <informaltable frame="all">
39764 <tgroup cols="4" colsep="0" rowsep="0">
39765 <colspec colwidth="8*" align="left"/>
39766 <colspec colwidth="6*" align="center"/>
39767 <colspec colwidth="6*" align="center"/>
39768 <colspec colwidth="6*" align="right"/>
39769 <tbody>
39770 <row>
39771 <entry><option>lock_retries</option></entry>
39772 <entry>Use: <emphasis>appendfile</emphasis></entry>
39773 <entry>Type: <emphasis>integer</emphasis></entry>
39774 <entry>Default: <emphasis>10</emphasis></entry>
39775 </row>
39776 </tbody>
39777 </tgroup>
39778 </informaltable>
39779 <para>
39780 This specifies the maximum number of attempts to lock the file. A value of zero
39781 is treated as 1. See below for details of locking.
39782 </para>
39783 <para>
39784 <indexterm role="option">
39785 <primary><option>lockfile_mode</option></primary>
39786 </indexterm>
39787 </para>
39788 <informaltable frame="all">
39789 <tgroup cols="4" colsep="0" rowsep="0">
39790 <colspec colwidth="8*" align="left"/>
39791 <colspec colwidth="6*" align="center"/>
39792 <colspec colwidth="6*" align="center"/>
39793 <colspec colwidth="6*" align="right"/>
39794 <tbody>
39795 <row>
39796 <entry><option>lockfile_mode</option></entry>
39797 <entry>Use: <emphasis>appendfile</emphasis></entry>
39798 <entry>Type: <emphasis>octal integer</emphasis></entry>
39799 <entry>Default: <emphasis>0600</emphasis></entry>
39800 </row>
39801 </tbody>
39802 </tgroup>
39803 </informaltable>
39804 <para>
39805 This specifies the mode of the created lock file, when a lock file is being
39806 used (see <option>use_lockfile</option> and <option>use_mbx_lock</option>).
39807 </para>
39808 <para>
39809 <indexterm role="option">
39810 <primary><option>lockfile_timeout</option></primary>
39811 </indexterm>
39812 </para>
39813 <informaltable frame="all">
39814 <tgroup cols="4" colsep="0" rowsep="0">
39815 <colspec colwidth="8*" align="left"/>
39816 <colspec colwidth="6*" align="center"/>
39817 <colspec colwidth="6*" align="center"/>
39818 <colspec colwidth="6*" align="right"/>
39819 <tbody>
39820 <row>
39821 <entry><option>lockfile_timeout</option></entry>
39822 <entry>Use: <emphasis>appendfile</emphasis></entry>
39823 <entry>Type: <emphasis>time</emphasis></entry>
39824 <entry>Default: <emphasis>30m</emphasis></entry>
39825 </row>
39826 </tbody>
39827 </tgroup>
39828 </informaltable>
39829 <para>
39830 <indexterm role="concept">
39831 <primary>timeout</primary>
39832 <secondary>mailbox locking</secondary>
39833 </indexterm>
39834 When a lock file is being used (see <option>use_lockfile</option>), if a lock file already
39835 exists and is older than this value, it is assumed to have been left behind by
39836 accident, and Exim attempts to remove it.
39837 </para>
39838 <para>
39839 <indexterm role="option">
39840 <primary><option>mailbox_filecount</option></primary>
39841 </indexterm>
39842 </para>
39843 <informaltable frame="all">
39844 <tgroup cols="4" colsep="0" rowsep="0">
39845 <colspec colwidth="8*" align="left"/>
39846 <colspec colwidth="6*" align="center"/>
39847 <colspec colwidth="6*" align="center"/>
39848 <colspec colwidth="6*" align="right"/>
39849 <tbody>
39850 <row>
39851 <entry><option>mailbox_filecount</option></entry>
39852 <entry>Use: <emphasis>appendfile</emphasis></entry>
39853 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
39854 <entry>Default: <emphasis>unset</emphasis></entry>
39855 </row>
39856 </tbody>
39857 </tgroup>
39858 </informaltable>
39859 <para>
39860 <indexterm role="concept">
39861 <primary>mailbox</primary>
39862 <secondary>specifying size of</secondary>
39863 </indexterm>
39864 <indexterm role="concept">
39865 <primary>size</primary>
39866 <secondary>of mailbox</secondary>
39867 </indexterm>
39868 If this option is set, it is expanded, and the result is taken as the current
39869 number of files in the mailbox. It must be a decimal number, optionally
39870 followed by K or M. This provides a way of obtaining this information from an
39871 external source that maintains the data.
39872 </para>
39873 <para>
39874 <indexterm role="option">
39875 <primary><option>mailbox_size</option></primary>
39876 </indexterm>
39877 </para>
39878 <informaltable frame="all">
39879 <tgroup cols="4" colsep="0" rowsep="0">
39880 <colspec colwidth="8*" align="left"/>
39881 <colspec colwidth="6*" align="center"/>
39882 <colspec colwidth="6*" align="center"/>
39883 <colspec colwidth="6*" align="right"/>
39884 <tbody>
39885 <row>
39886 <entry><option>mailbox_size</option></entry>
39887 <entry>Use: <emphasis>appendfile</emphasis></entry>
39888 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
39889 <entry>Default: <emphasis>unset</emphasis></entry>
39890 </row>
39891 </tbody>
39892 </tgroup>
39893 </informaltable>
39894 <para>
39895 <indexterm role="concept">
39896 <primary>mailbox</primary>
39897 <secondary>specifying size of</secondary>
39898 </indexterm>
39899 <indexterm role="concept">
39900 <primary>size</primary>
39901 <secondary>of mailbox</secondary>
39902 </indexterm>
39903 If this option is set, it is expanded, and the result is taken as the current
39904 size the mailbox. It must be a decimal number, optionally followed by K or M.
39905 This provides a way of obtaining this information from an external source that
39906 maintains the data. This is likely to be helpful for maildir deliveries where
39907 it is computationally expensive to compute the size of a mailbox.
39908 </para>
39909 <para>
39910 <indexterm role="option">
39911 <primary><option>maildir_format</option></primary>
39912 </indexterm>
39913 </para>
39914 <informaltable frame="all">
39915 <tgroup cols="4" colsep="0" rowsep="0">
39916 <colspec colwidth="8*" align="left"/>
39917 <colspec colwidth="6*" align="center"/>
39918 <colspec colwidth="6*" align="center"/>
39919 <colspec colwidth="6*" align="right"/>
39920 <tbody>
39921 <row>
39922 <entry><option>maildir_format</option></entry>
39923 <entry>Use: <emphasis>appendfile</emphasis></entry>
39924 <entry>Type: <emphasis>boolean</emphasis></entry>
39925 <entry>Default: <emphasis>false</emphasis></entry>
39926 </row>
39927 </tbody>
39928 </tgroup>
39929 </informaltable>
39930 <para>
39931 <indexterm role="concept">
39932 <primary>maildir format</primary>
39933 <secondary>specifying</secondary>
39934 </indexterm>
39935 If this option is set with the <option>directory</option> option, the delivery is into a new
39936 file, in the <quote>maildir</quote> format that is used by other mail software. When the
39937 transport is activated directly from a <command>redirect</command> router (for example, the
39938 <command>address_file</command> transport in the default configuration), setting
39939 <option>maildir_format</option> causes the path received from the router to be treated as a
39940 directory, whether or not it ends with <literal>/</literal>. This option is available only if
39941 SUPPORT_MAILDIR is present in <filename>Local/Makefile</filename>. See section
39942 <xref linkend="SECTmaildirdelivery"/> below for further details.
39943 </para>
39944 <para>
39945 <indexterm role="option">
39946 <primary><option>maildir_quota_directory_regex</option></primary>
39947 </indexterm>
39948 </para>
39949 <informaltable frame="all">
39950 <tgroup cols="4" colsep="0" rowsep="0">
39951 <colspec colwidth="8*" align="left"/>
39952 <colspec colwidth="6*" align="center"/>
39953 <colspec colwidth="6*" align="center"/>
39954 <colspec colwidth="6*" align="right"/>
39955 <tbody>
39956 <row>
39957 <entry><option>maildir_quota_directory_regex</option></entry>
39958 <entry>Use: <emphasis>appendfile</emphasis></entry>
39959 <entry>Type: <emphasis>string</emphasis></entry>
39960 <entry>Default: <emphasis>See below</emphasis></entry>
39961 </row>
39962 </tbody>
39963 </tgroup>
39964 </informaltable>
39965 <para>
39966 <indexterm role="concept">
39967 <primary>maildir format</primary>
39968 <secondary>quota; directories included in</secondary>
39969 </indexterm>
39970 <indexterm role="concept">
39971 <primary>quota</primary>
39972 <secondary>maildir; directories included in</secondary>
39973 </indexterm>
39974 This option is relevant only when <option>maildir_use_size_file</option> is set. It defines
39975 a regular expression for specifying directories, relative to the quota
39976 directory (see <option>quota_directory</option>), that should be included in the quota
39977 calculation. The default value is:
39978 </para>
39979 <literallayout class="monospaced">
39980 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
39981 </literallayout>
39982 <para>
39983 This includes the <filename>cur</filename> and <filename>new</filename> directories, and any maildir++ folders
39984 (directories whose names begin with a dot). If you want to exclude the
39985 <filename>Trash</filename>
39986 folder from the count (as some sites do), you need to change this setting to
39987 </para>
39988 <literallayout class="monospaced">
39989 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
39990 </literallayout>
39991 <para>
39992 This uses a negative lookahead in the regular expression to exclude the
39993 directory whose name is <filename>.Trash</filename>. When a directory is excluded from quota
39994 calculations, quota processing is bypassed for any messages that are delivered
39995 directly into that directory.
39996 </para>
39997 <para>
39998 <indexterm role="option">
39999 <primary><option>maildir_retries</option></primary>
40000 </indexterm>
40001 </para>
40002 <informaltable frame="all">
40003 <tgroup cols="4" colsep="0" rowsep="0">
40004 <colspec colwidth="8*" align="left"/>
40005 <colspec colwidth="6*" align="center"/>
40006 <colspec colwidth="6*" align="center"/>
40007 <colspec colwidth="6*" align="right"/>
40008 <tbody>
40009 <row>
40010 <entry><option>maildir_retries</option></entry>
40011 <entry>Use: <emphasis>appendfile</emphasis></entry>
40012 <entry>Type: <emphasis>integer</emphasis></entry>
40013 <entry>Default: <emphasis>10</emphasis></entry>
40014 </row>
40015 </tbody>
40016 </tgroup>
40017 </informaltable>
40018 <para>
40019 This option specifies the number of times to retry when writing a file in
40020 <quote>maildir</quote> format. See section <xref linkend="SECTmaildirdelivery"/> below.
40021 </para>
40022 <para>
40023 <indexterm role="option">
40024 <primary><option>maildir_tag</option></primary>
40025 </indexterm>
40026 </para>
40027 <informaltable frame="all">
40028 <tgroup cols="4" colsep="0" rowsep="0">
40029 <colspec colwidth="8*" align="left"/>
40030 <colspec colwidth="6*" align="center"/>
40031 <colspec colwidth="6*" align="center"/>
40032 <colspec colwidth="6*" align="right"/>
40033 <tbody>
40034 <row>
40035 <entry><option>maildir_tag</option></entry>
40036 <entry>Use: <emphasis>appendfile</emphasis></entry>
40037 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
40038 <entry>Default: <emphasis>unset</emphasis></entry>
40039 </row>
40040 </tbody>
40041 </tgroup>
40042 </informaltable>
40043 <para>
40044 This option applies only to deliveries in maildir format, and is described in
40045 section <xref linkend="SECTmaildirdelivery"/> below.
40046 </para>
40047 <para>
40048 <indexterm role="option">
40049 <primary><option>maildir_use_size_file</option></primary>
40050 </indexterm>
40051 </para>
40052 <informaltable frame="all">
40053 <tgroup cols="4" colsep="0" rowsep="0">
40054 <colspec colwidth="8*" align="left"/>
40055 <colspec colwidth="6*" align="center"/>
40056 <colspec colwidth="6*" align="center"/>
40057 <colspec colwidth="6*" align="right"/>
40058 <tbody>
40059 <row>
40060 <entry><option>maildir_use_size_file</option></entry>
40061 <entry>Use: <emphasis>appendfile</emphasis>&dagger;<emphasis></emphasis></entry>
40062 <entry>Type: <emphasis>boolean</emphasis></entry>
40063 <entry>Default: <emphasis>false</emphasis></entry>
40064 </row>
40065 </tbody>
40066 </tgroup>
40067 </informaltable>
40068 <para>
40069 <indexterm role="concept">
40070 <primary>maildir format</primary>
40071 <secondary><filename>maildirsize</filename> file</secondary>
40072 </indexterm>
40073 The result of string expansion for this option must be a valid boolean value.
40074 If it is true, it enables support for <filename>maildirsize</filename> files. Exim
40075 creates a <filename>maildirsize</filename> file in a maildir if one does not exist, taking the
40076 quota from the <option>quota</option> option of the transport. If <option>quota</option> is unset, the
40077 value is zero. See <option>maildir_quota_directory_regex</option> above and section
40078 <xref linkend="SECTmaildirdelivery"/> below for further details.
40079 </para>
40080 <para>
40081 <indexterm role="option">
40082 <primary><option>maildirfolder_create_regex</option></primary>
40083 </indexterm>
40084 </para>
40085 <informaltable frame="all">
40086 <tgroup cols="4" colsep="0" rowsep="0">
40087 <colspec colwidth="8*" align="left"/>
40088 <colspec colwidth="6*" align="center"/>
40089 <colspec colwidth="6*" align="center"/>
40090 <colspec colwidth="6*" align="right"/>
40091 <tbody>
40092 <row>
40093 <entry><option>maildirfolder_create_regex</option></entry>
40094 <entry>Use: <emphasis>appendfile</emphasis></entry>
40095 <entry>Type: <emphasis>string</emphasis></entry>
40096 <entry>Default: <emphasis>unset</emphasis></entry>
40097 </row>
40098 </tbody>
40099 </tgroup>
40100 </informaltable>
40101 <para>
40102 <indexterm role="concept">
40103 <primary>maildir format</primary>
40104 <secondary><filename>maildirfolder</filename> file</secondary>
40105 </indexterm>
40106 <indexterm role="concept">
40107 <primary><filename>maildirfolder</filename>, creating</primary>
40108 </indexterm>
40109 The value of this option is a regular expression. If it is unset, it has no
40110 effect. Otherwise, before a maildir delivery takes place, the pattern is
40111 matched against the name of the maildir directory, that is, the directory
40112 containing the <filename>new</filename> and <filename>tmp</filename> subdirectories that will be used for the
40113 delivery. If there is a match, Exim checks for the existence of a file called
40114 <filename>maildirfolder</filename> in the directory, and creates it if it does not exist.
40115 See section <xref linkend="SECTmaildirdelivery"/> for more details.
40116 </para>
40117 <para>
40118 <indexterm role="option">
40119 <primary><option>mailstore_format</option></primary>
40120 </indexterm>
40121 </para>
40122 <informaltable frame="all">
40123 <tgroup cols="4" colsep="0" rowsep="0">
40124 <colspec colwidth="8*" align="left"/>
40125 <colspec colwidth="6*" align="center"/>
40126 <colspec colwidth="6*" align="center"/>
40127 <colspec colwidth="6*" align="right"/>
40128 <tbody>
40129 <row>
40130 <entry><option>mailstore_format</option></entry>
40131 <entry>Use: <emphasis>appendfile</emphasis></entry>
40132 <entry>Type: <emphasis>boolean</emphasis></entry>
40133 <entry>Default: <emphasis>false</emphasis></entry>
40134 </row>
40135 </tbody>
40136 </tgroup>
40137 </informaltable>
40138 <para>
40139 <indexterm role="concept">
40140 <primary>mailstore format</primary>
40141 <secondary>specifying</secondary>
40142 </indexterm>
40143 If this option is set with the <option>directory</option> option, the delivery is into two
40144 new files in  <quote>mailstore</quote> format. The option is available only if
40145 SUPPORT_MAILSTORE is present in <filename>Local/Makefile</filename>. See section <xref linkend="SECTopdir"/>
40146 below for further details.
40147 </para>
40148 <para>
40149 <indexterm role="option">
40150 <primary><option>mailstore_prefix</option></primary>
40151 </indexterm>
40152 </para>
40153 <informaltable frame="all">
40154 <tgroup cols="4" colsep="0" rowsep="0">
40155 <colspec colwidth="8*" align="left"/>
40156 <colspec colwidth="6*" align="center"/>
40157 <colspec colwidth="6*" align="center"/>
40158 <colspec colwidth="6*" align="right"/>
40159 <tbody>
40160 <row>
40161 <entry><option>mailstore_prefix</option></entry>
40162 <entry>Use: <emphasis>appendfile</emphasis></entry>
40163 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
40164 <entry>Default: <emphasis>unset</emphasis></entry>
40165 </row>
40166 </tbody>
40167 </tgroup>
40168 </informaltable>
40169 <para>
40170 This option applies only to deliveries in mailstore format, and is described in
40171 section <xref linkend="SECTopdir"/> below.
40172 </para>
40173 <para>
40174 <indexterm role="option">
40175 <primary><option>mailstore_suffix</option></primary>
40176 </indexterm>
40177 </para>
40178 <informaltable frame="all">
40179 <tgroup cols="4" colsep="0" rowsep="0">
40180 <colspec colwidth="8*" align="left"/>
40181 <colspec colwidth="6*" align="center"/>
40182 <colspec colwidth="6*" align="center"/>
40183 <colspec colwidth="6*" align="right"/>
40184 <tbody>
40185 <row>
40186 <entry><option>mailstore_suffix</option></entry>
40187 <entry>Use: <emphasis>appendfile</emphasis></entry>
40188 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
40189 <entry>Default: <emphasis>unset</emphasis></entry>
40190 </row>
40191 </tbody>
40192 </tgroup>
40193 </informaltable>
40194 <para>
40195 This option applies only to deliveries in mailstore format, and is described in
40196 section <xref linkend="SECTopdir"/> below.
40197 </para>
40198 <para>
40199 <indexterm role="option">
40200 <primary><option>mbx_format</option></primary>
40201 </indexterm>
40202 </para>
40203 <informaltable frame="all">
40204 <tgroup cols="4" colsep="0" rowsep="0">
40205 <colspec colwidth="8*" align="left"/>
40206 <colspec colwidth="6*" align="center"/>
40207 <colspec colwidth="6*" align="center"/>
40208 <colspec colwidth="6*" align="right"/>
40209 <tbody>
40210 <row>
40211 <entry><option>mbx_format</option></entry>
40212 <entry>Use: <emphasis>appendfile</emphasis></entry>
40213 <entry>Type: <emphasis>boolean</emphasis></entry>
40214 <entry>Default: <emphasis>false</emphasis></entry>
40215 </row>
40216 </tbody>
40217 </tgroup>
40218 </informaltable>
40219 <para>
40220 <indexterm role="concept">
40221 <primary>locking files</primary>
40222 </indexterm>
40223 <indexterm role="concept">
40224 <primary>file</primary>
40225 <secondary>locking</secondary>
40226 </indexterm>
40227 <indexterm role="concept">
40228 <primary>file</primary>
40229 <secondary>MBX format</secondary>
40230 </indexterm>
40231 <indexterm role="concept">
40232 <primary>MBX format, specifying</primary>
40233 </indexterm>
40234 This option is available only if Exim has been compiled with SUPPORT_MBX
40235 set in <filename>Local/Makefile</filename>. If <option>mbx_format</option> is set with the <option>file</option> option,
40236 the message is appended to the mailbox file in MBX format instead of
40237 traditional Unix format. This format is supported by Pine4 and its associated
40238 IMAP and POP daemons, by means of the <emphasis>c-client</emphasis> library that they all use.
40239 </para>
40240 <para>
40241 <emphasis role="bold">Note</emphasis>: The <option>message_prefix</option> and <option>message_suffix</option> options are not
40242 automatically changed by the use of <option>mbx_format</option>. They should normally be set
40243 empty when using MBX format, so this option almost always appears in this
40244 combination:
40245 </para>
40246 <literallayout class="monospaced">
40247 mbx_format = true
40248 message_prefix =
40249 message_suffix =
40250 </literallayout>
40251 <para>
40252 If none of the locking options are mentioned in the configuration,
40253 <option>use_mbx_lock</option> is assumed and the other locking options default to false. It
40254 is possible to specify the other kinds of locking with <option>mbx_format</option>, but
40255 <option>use_fcntl_lock</option> and <option>use_mbx_lock</option> are mutually exclusive. MBX locking
40256 interworks with <emphasis>c-client</emphasis>, providing for shared access to the mailbox. It
40257 should not be used if any program that does not use this form of locking is
40258 going to access the mailbox, nor should it be used if the mailbox file is NFS
40259 mounted, because it works only when the mailbox is accessed from a single host.
40260 </para>
40261 <para>
40262 If you set <option>use_fcntl_lock</option> with an MBX-format mailbox, you cannot use
40263 the standard version of <emphasis>c-client</emphasis>, because as long as it has a mailbox open
40264 (this means for the whole of a Pine or IMAP session), Exim will not be able to
40265 append messages to it.
40266 </para>
40267 <para>
40268 <indexterm role="option">
40269 <primary><option>message_prefix</option></primary>
40270 </indexterm>
40271 </para>
40272 <informaltable frame="all">
40273 <tgroup cols="4" colsep="0" rowsep="0">
40274 <colspec colwidth="8*" align="left"/>
40275 <colspec colwidth="6*" align="center"/>
40276 <colspec colwidth="6*" align="center"/>
40277 <colspec colwidth="6*" align="right"/>
40278 <tbody>
40279 <row>
40280 <entry><option>message_prefix</option></entry>
40281 <entry>Use: <emphasis>appendfile</emphasis></entry>
40282 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
40283 <entry>Default: <emphasis>see below</emphasis></entry>
40284 </row>
40285 </tbody>
40286 </tgroup>
40287 </informaltable>
40288 <para>
40289 <indexterm role="concept">
40290 <primary><quote>From</quote> line</primary>
40291 </indexterm>
40292 The string specified here is expanded and output at the start of every message.
40293 The default is unset unless <option>file</option> is specified and <option>use_bsmtp</option> is not set,
40294 in which case it is:
40295 </para>
40296 <literallayout class="monospaced">
40297 message_prefix = "From ${if def:return_path{$return_path}\
40298   {MAILER-DAEMON}} $tod_bsdinbox\n"
40299 </literallayout>
40300 <para>
40301 <emphasis role="bold">Note:</emphasis> If you set <option>use_crlf</option> true, you must change any occurrences of
40302 <literal>\n</literal> to <literal>\r\n</literal> in <option>message_prefix</option>.
40303 </para>
40304 <para>
40305 <indexterm role="option">
40306 <primary><option>message_suffix</option></primary>
40307 </indexterm>
40308 </para>
40309 <informaltable frame="all">
40310 <tgroup cols="4" colsep="0" rowsep="0">
40311 <colspec colwidth="8*" align="left"/>
40312 <colspec colwidth="6*" align="center"/>
40313 <colspec colwidth="6*" align="center"/>
40314 <colspec colwidth="6*" align="right"/>
40315 <tbody>
40316 <row>
40317 <entry><option>message_suffix</option></entry>
40318 <entry>Use: <emphasis>appendfile</emphasis></entry>
40319 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
40320 <entry>Default: <emphasis>see below</emphasis></entry>
40321 </row>
40322 </tbody>
40323 </tgroup>
40324 </informaltable>
40325 <para>
40326 The string specified here is expanded and output at the end of every message.
40327 The default is unset unless <option>file</option> is specified and <option>use_bsmtp</option> is not set,
40328 in which case it is a single newline character. The suffix can be suppressed by
40329 setting
40330 </para>
40331 <literallayout class="monospaced">
40332 message_suffix =
40333 </literallayout>
40334 <para>
40335 <emphasis role="bold">Note:</emphasis> If you set <option>use_crlf</option> true, you must change any occurrences of
40336 <literal>\n</literal> to <literal>\r\n</literal> in <option>message_suffix</option>.
40337 </para>
40338 <para>
40339 <indexterm role="option">
40340 <primary><option>mode</option></primary>
40341 </indexterm>
40342 </para>
40343 <informaltable frame="all">
40344 <tgroup cols="4" colsep="0" rowsep="0">
40345 <colspec colwidth="8*" align="left"/>
40346 <colspec colwidth="6*" align="center"/>
40347 <colspec colwidth="6*" align="center"/>
40348 <colspec colwidth="6*" align="right"/>
40349 <tbody>
40350 <row>
40351 <entry><option>mode</option></entry>
40352 <entry>Use: <emphasis>appendfile</emphasis></entry>
40353 <entry>Type: <emphasis>octal integer</emphasis></entry>
40354 <entry>Default: <emphasis>0600</emphasis></entry>
40355 </row>
40356 </tbody>
40357 </tgroup>
40358 </informaltable>
40359 <para>
40360 If the output file is created, it is given this mode. If it already exists and
40361 has wider permissions, they are reduced to this mode. If it has narrower
40362 permissions, an error occurs unless <option>mode_fail_narrower</option> is false. However,
40363 if the delivery is the result of a <option>save</option> command in a filter file specifying
40364 a particular mode, the mode of the output file is always forced to take that
40365 value, and this option is ignored.
40366 </para>
40367 <para>
40368 <indexterm role="option">
40369 <primary><option>mode_fail_narrower</option></primary>
40370 </indexterm>
40371 </para>
40372 <informaltable frame="all">
40373 <tgroup cols="4" colsep="0" rowsep="0">
40374 <colspec colwidth="8*" align="left"/>
40375 <colspec colwidth="6*" align="center"/>
40376 <colspec colwidth="6*" align="center"/>
40377 <colspec colwidth="6*" align="right"/>
40378 <tbody>
40379 <row>
40380 <entry><option>mode_fail_narrower</option></entry>
40381 <entry>Use: <emphasis>appendfile</emphasis></entry>
40382 <entry>Type: <emphasis>boolean</emphasis></entry>
40383 <entry>Default: <emphasis>true</emphasis></entry>
40384 </row>
40385 </tbody>
40386 </tgroup>
40387 </informaltable>
40388 <para>
40389 This option applies in the case when an existing mailbox file has a narrower
40390 mode than that specified by the <option>mode</option> option. If <option>mode_fail_narrower</option> is
40391 true, the delivery is deferred (<quote>mailbox has the wrong mode</quote>); otherwise Exim
40392 continues with the delivery attempt, using the existing mode of the file.
40393 </para>
40394 <para>
40395 <indexterm role="option">
40396 <primary><option>notify_comsat</option></primary>
40397 </indexterm>
40398 </para>
40399 <informaltable frame="all">
40400 <tgroup cols="4" colsep="0" rowsep="0">
40401 <colspec colwidth="8*" align="left"/>
40402 <colspec colwidth="6*" align="center"/>
40403 <colspec colwidth="6*" align="center"/>
40404 <colspec colwidth="6*" align="right"/>
40405 <tbody>
40406 <row>
40407 <entry><option>notify_comsat</option></entry>
40408 <entry>Use: <emphasis>appendfile</emphasis></entry>
40409 <entry>Type: <emphasis>boolean</emphasis></entry>
40410 <entry>Default: <emphasis>false</emphasis></entry>
40411 </row>
40412 </tbody>
40413 </tgroup>
40414 </informaltable>
40415 <para>
40416 If this option is true, the <emphasis>comsat</emphasis> daemon is notified after every
40417 successful delivery to a user mailbox. This is the daemon that notifies logged
40418 on users about incoming mail.
40419 </para>
40420 <para>
40421 <indexterm role="option">
40422 <primary><option>quota</option></primary>
40423 </indexterm>
40424 </para>
40425 <informaltable frame="all">
40426 <tgroup cols="4" colsep="0" rowsep="0">
40427 <colspec colwidth="8*" align="left"/>
40428 <colspec colwidth="6*" align="center"/>
40429 <colspec colwidth="6*" align="center"/>
40430 <colspec colwidth="6*" align="right"/>
40431 <tbody>
40432 <row>
40433 <entry><option>quota</option></entry>
40434 <entry>Use: <emphasis>appendfile</emphasis></entry>
40435 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
40436 <entry>Default: <emphasis>unset</emphasis></entry>
40437 </row>
40438 </tbody>
40439 </tgroup>
40440 </informaltable>
40441 <para>
40442 <indexterm role="concept">
40443 <primary>quota</primary>
40444 <secondary>imposed by Exim</secondary>
40445 </indexterm>
40446 This option imposes a limit on the size of the file to which Exim is appending,
40447 or to the total space used in the directory tree when the <option>directory</option> option
40448 is set. In the latter case, computation of the space used is expensive, because
40449 all the files in the directory (and any sub-directories) have to be
40450 individually inspected and their sizes summed. (See <option>quota_size_regex</option> and
40451 <option>maildir_use_size_file</option> for ways to avoid this in environments where users
40452 have no shell access to their mailboxes).
40453 </para>
40454 <para>
40455 As there is no interlock against two simultaneous deliveries into a
40456 multi-file mailbox, it is possible for the quota to be overrun in this case.
40457 For single-file mailboxes, of course, an interlock is a necessity.
40458 </para>
40459 <para>
40460 A file&#x2019;s size is taken as its <emphasis>used</emphasis> value. Because of blocking effects, this
40461 may be a lot less than the actual amount of disk space allocated to the file.
40462 If the sizes of a number of files are being added up, the rounding effect can
40463 become quite noticeable, especially on systems that have large block sizes.
40464 Nevertheless, it seems best to stick to the <emphasis>used</emphasis> figure, because this is
40465 the obvious value which users understand most easily.
40466 </para>
40467 <para>
40468 The value of the option is expanded, and must then be a numerical value
40469 (decimal point allowed), optionally followed by one of the letters K, M, or G,
40470 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
40471 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
40472 be handled.
40473 </para>
40474 <para>
40475 <emphasis role="bold">Note</emphasis>: A value of zero is interpreted as <quote>no quota</quote>.
40476 </para>
40477 <para>
40478 The expansion happens while Exim is running as root, before it changes uid for
40479 the delivery. This means that files that are inaccessible to the end user can
40480 be used to hold quota values that are looked up in the expansion. When delivery
40481 fails because this quota is exceeded, the handling of the error is as for
40482 system quota failures.
40483 </para>
40484 <para>
40485 By default, Exim&#x2019;s quota checking mimics system quotas, and restricts the
40486 mailbox to the specified maximum size, though the value is not accurate to the
40487 last byte, owing to separator lines and additional headers that may get added
40488 during message delivery. When a mailbox is nearly full, large messages may get
40489 refused even though small ones are accepted, because the size of the current
40490 message is added to the quota when the check is made. This behaviour can be
40491 changed by setting <option>quota_is_inclusive</option> false. When this is done, the check
40492 for exceeding the quota does not include the current message. Thus, deliveries
40493 continue until the quota has been exceeded; thereafter, no further messages are
40494 delivered. See also <option>quota_warn_threshold</option>.
40495 </para>
40496 <para>
40497 <indexterm role="option">
40498 <primary><option>quota_directory</option></primary>
40499 </indexterm>
40500 </para>
40501 <informaltable frame="all">
40502 <tgroup cols="4" colsep="0" rowsep="0">
40503 <colspec colwidth="8*" align="left"/>
40504 <colspec colwidth="6*" align="center"/>
40505 <colspec colwidth="6*" align="center"/>
40506 <colspec colwidth="6*" align="right"/>
40507 <tbody>
40508 <row>
40509 <entry><option>quota_directory</option></entry>
40510 <entry>Use: <emphasis>appendfile</emphasis></entry>
40511 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
40512 <entry>Default: <emphasis>unset</emphasis></entry>
40513 </row>
40514 </tbody>
40515 </tgroup>
40516 </informaltable>
40517 <para>
40518 This option defines the directory to check for quota purposes when delivering
40519 into individual files. The default is the delivery directory, or, if a file
40520 called <filename>maildirfolder</filename> exists in a maildir directory, the parent of the
40521 delivery directory.
40522 </para>
40523 <para>
40524 <indexterm role="option">
40525 <primary><option>quota_filecount</option></primary>
40526 </indexterm>
40527 </para>
40528 <informaltable frame="all">
40529 <tgroup cols="4" colsep="0" rowsep="0">
40530 <colspec colwidth="8*" align="left"/>
40531 <colspec colwidth="6*" align="center"/>
40532 <colspec colwidth="6*" align="center"/>
40533 <colspec colwidth="6*" align="right"/>
40534 <tbody>
40535 <row>
40536 <entry><option>quota_filecount</option></entry>
40537 <entry>Use: <emphasis>appendfile</emphasis></entry>
40538 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
40539 <entry>Default: <emphasis>0</emphasis></entry>
40540 </row>
40541 </tbody>
40542 </tgroup>
40543 </informaltable>
40544 <para>
40545 This option applies when the <option>directory</option> option is set. It limits the total
40546 number of files in the directory (compare the inode limit in system quotas). It
40547 can only be used if <option>quota</option> is also set. The value is expanded; an expansion
40548 failure causes delivery to be deferred. A value of zero is interpreted as
40549 <quote>no quota</quote>.
40550 </para>
40551 <para>
40552 <indexterm role="option">
40553 <primary><option>quota_is_inclusive</option></primary>
40554 </indexterm>
40555 </para>
40556 <informaltable frame="all">
40557 <tgroup cols="4" colsep="0" rowsep="0">
40558 <colspec colwidth="8*" align="left"/>
40559 <colspec colwidth="6*" align="center"/>
40560 <colspec colwidth="6*" align="center"/>
40561 <colspec colwidth="6*" align="right"/>
40562 <tbody>
40563 <row>
40564 <entry><option>quota_is_inclusive</option></entry>
40565 <entry>Use: <emphasis>appendfile</emphasis></entry>
40566 <entry>Type: <emphasis>boolean</emphasis></entry>
40567 <entry>Default: <emphasis>true</emphasis></entry>
40568 </row>
40569 </tbody>
40570 </tgroup>
40571 </informaltable>
40572 <para>
40573 See <option>quota</option> above.
40574 </para>
40575 <para>
40576 <indexterm role="option">
40577 <primary><option>quota_size_regex</option></primary>
40578 </indexterm>
40579 </para>
40580 <informaltable frame="all">
40581 <tgroup cols="4" colsep="0" rowsep="0">
40582 <colspec colwidth="8*" align="left"/>
40583 <colspec colwidth="6*" align="center"/>
40584 <colspec colwidth="6*" align="center"/>
40585 <colspec colwidth="6*" align="right"/>
40586 <tbody>
40587 <row>
40588 <entry><option>quota_size_regex</option></entry>
40589 <entry>Use: <emphasis>appendfile</emphasis></entry>
40590 <entry>Type: <emphasis>string</emphasis></entry>
40591 <entry>Default: <emphasis>unset</emphasis></entry>
40592 </row>
40593 </tbody>
40594 </tgroup>
40595 </informaltable>
40596 <para>
40597 This option applies when one of the delivery modes that writes a separate file
40598 for each message is being used. When Exim wants to find the size of one of
40599 these files in order to test the quota, it first checks <option>quota_size_regex</option>.
40600 If this is set to a regular expression that matches the file name, and it
40601 captures one string, that string is interpreted as a representation of the
40602 file&#x2019;s size. The value of <option>quota_size_regex</option> is not expanded.
40603 </para>
40604 <para>
40605 This feature is useful only when users have no shell access to their mailboxes
40606 &ndash; otherwise they could defeat the quota simply by renaming the files. This
40607 facility can be used with maildir deliveries, by setting <option>maildir_tag</option> to add
40608 the file length to the file name. For example:
40609 </para>
40610 <literallayout class="monospaced">
40611 maildir_tag = ,S=$message_size
40612 quota_size_regex = ,S=(\d+)
40613 </literallayout>
40614 <para>
40615 An alternative to <varname>$message_size</varname> is <varname>$message_linecount</varname>, which contains the
40616 number of lines in the message.
40617 </para>
40618 <para>
40619 The regular expression should not assume that the length is at the end of the
40620 file name (even though <option>maildir_tag</option> puts it there) because maildir MUAs
40621 sometimes add other information onto the ends of message file names.
40622 </para>
40623 <para>
40624 Section <xref linkend="SECID136"/> contains further information.
40625 </para>
40626 <para>
40627 <indexterm role="option">
40628 <primary><option>quota_warn_message</option></primary>
40629 </indexterm>
40630 </para>
40631 <informaltable frame="all">
40632 <tgroup cols="4" colsep="0" rowsep="0">
40633 <colspec colwidth="8*" align="left"/>
40634 <colspec colwidth="6*" align="center"/>
40635 <colspec colwidth="6*" align="center"/>
40636 <colspec colwidth="6*" align="right"/>
40637 <tbody>
40638 <row>
40639 <entry><option>quota_warn_message</option></entry>
40640 <entry>Use: <emphasis>appendfile</emphasis></entry>
40641 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
40642 <entry>Default: <emphasis>see below</emphasis></entry>
40643 </row>
40644 </tbody>
40645 </tgroup>
40646 </informaltable>
40647 <para>
40648 See below for the use of this option. If it is not set when
40649 <option>quota_warn_threshold</option> is set, it defaults to
40650 </para>
40651 <literallayout class="monospaced">
40652 quota_warn_message = "\
40653   To: $local_part@$domain\n\
40654   Subject: Your mailbox\n\n\
40655   This message is automatically created \
40656   by mail delivery software.\n\n\
40657   The size of your mailbox has exceeded \
40658   a warning threshold that is\n\
40659   set by the system administrator.\n"
40660 </literallayout>
40661 <para>
40662 <indexterm role="option">
40663 <primary><option>quota_warn_threshold</option></primary>
40664 </indexterm>
40665 </para>
40666 <informaltable frame="all">
40667 <tgroup cols="4" colsep="0" rowsep="0">
40668 <colspec colwidth="8*" align="left"/>
40669 <colspec colwidth="6*" align="center"/>
40670 <colspec colwidth="6*" align="center"/>
40671 <colspec colwidth="6*" align="right"/>
40672 <tbody>
40673 <row>
40674 <entry><option>quota_warn_threshold</option></entry>
40675 <entry>Use: <emphasis>appendfile</emphasis></entry>
40676 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
40677 <entry>Default: <emphasis>0</emphasis></entry>
40678 </row>
40679 </tbody>
40680 </tgroup>
40681 </informaltable>
40682 <para>
40683 <indexterm role="concept">
40684 <primary>quota</primary>
40685 <secondary>warning threshold</secondary>
40686 </indexterm>
40687 <indexterm role="concept">
40688 <primary>mailbox</primary>
40689 <secondary>size warning</secondary>
40690 </indexterm>
40691 <indexterm role="concept">
40692 <primary>size</primary>
40693 <secondary>of mailbox</secondary>
40694 </indexterm>
40695 This option is expanded in the same way as <option>quota</option> (see above). If the
40696 resulting value is greater than zero, and delivery of the message causes the
40697 size of the file or total space in the directory tree to cross the given
40698 threshold, a warning message is sent. If <option>quota</option> is also set, the threshold
40699 may be specified as a percentage of it by following the value with a percent
40700 sign. For example:
40701 </para>
40702 <literallayout class="monospaced">
40703 quota = 10M
40704 quota_warn_threshold = 75%
40705 </literallayout>
40706 <para>
40707 If <option>quota</option> is not set, a setting of <option>quota_warn_threshold</option> that ends with a
40708 percent sign is ignored.
40709 </para>
40710 <para>
40711 The warning message itself is specified by the <option>quota_warn_message</option> option,
40712 and it must start with a <emphasis>To:</emphasis> header line containing the recipient(s) of the
40713 warning message. These do not necessarily have to include the recipient(s) of
40714 the original message. A <emphasis>Subject:</emphasis> line should also normally be supplied. You
40715 can include any other header lines that you want. If you do not include a
40716 <emphasis>From:</emphasis> line, the default is:
40717 </para>
40718 <literallayout class="monospaced">
40719 From: Mail Delivery System &lt;mailer-daemon@$qualify_domain_sender&gt;
40720 </literallayout>
40721 <para>
40722 <indexterm role="option">
40723 <primary><option>errors_reply_to</option></primary>
40724 </indexterm>
40725 If you supply a <emphasis>Reply-To:</emphasis> line, it overrides the global <option>errors_reply_to</option>
40726 option.
40727 </para>
40728 <para>
40729 The <option>quota</option> option does not have to be set in order to use this option; they
40730 are independent of one another except when the threshold is specified as a
40731 percentage.
40732 </para>
40733 <para>
40734 <indexterm role="option">
40735 <primary><option>use_bsmtp</option></primary>
40736 </indexterm>
40737 </para>
40738 <informaltable frame="all">
40739 <tgroup cols="4" colsep="0" rowsep="0">
40740 <colspec colwidth="8*" align="left"/>
40741 <colspec colwidth="6*" align="center"/>
40742 <colspec colwidth="6*" align="center"/>
40743 <colspec colwidth="6*" align="right"/>
40744 <tbody>
40745 <row>
40746 <entry><option>use_bsmtp</option></entry>
40747 <entry>Use: <emphasis>appendfile</emphasis></entry>
40748 <entry>Type: <emphasis>boolean</emphasis></entry>
40749 <entry>Default: <emphasis>false</emphasis></entry>
40750 </row>
40751 </tbody>
40752 </tgroup>
40753 </informaltable>
40754 <para>
40755 <indexterm role="concept">
40756 <primary>envelope sender</primary>
40757 </indexterm>
40758 If this option is set true, <command>appendfile</command> writes messages in <quote>batch SMTP</quote>
40759 format, with the envelope sender and recipient(s) included as SMTP commands. If
40760 you want to include a leading HELO command with such messages, you can do
40761 so by setting the <option>message_prefix</option> option. See section <xref linkend="SECTbatchSMTP"/>
40762 for details of batch SMTP.
40763 </para>
40764 <para>
40765 <indexterm role="option">
40766 <primary><option>use_crlf</option></primary>
40767 </indexterm>
40768 </para>
40769 <informaltable frame="all">
40770 <tgroup cols="4" colsep="0" rowsep="0">
40771 <colspec colwidth="8*" align="left"/>
40772 <colspec colwidth="6*" align="center"/>
40773 <colspec colwidth="6*" align="center"/>
40774 <colspec colwidth="6*" align="right"/>
40775 <tbody>
40776 <row>
40777 <entry><option>use_crlf</option></entry>
40778 <entry>Use: <emphasis>appendfile</emphasis></entry>
40779 <entry>Type: <emphasis>boolean</emphasis></entry>
40780 <entry>Default: <emphasis>false</emphasis></entry>
40781 </row>
40782 </tbody>
40783 </tgroup>
40784 </informaltable>
40785 <para>
40786 <indexterm role="concept">
40787 <primary>carriage return</primary>
40788 </indexterm>
40789 <indexterm role="concept">
40790 <primary>linefeed</primary>
40791 </indexterm>
40792 This option causes lines to be terminated with the two-character CRLF sequence
40793 (carriage return, linefeed) instead of just a linefeed character. In the case
40794 of batched SMTP, the byte sequence written to the file is then an exact image
40795 of what would be sent down a real SMTP connection.
40796 </para>
40797 <para>
40798 <emphasis role="bold">Note:</emphasis> The contents of the <option>message_prefix</option> and <option>message_suffix</option> options
40799 (which are used to supply the traditional <quote>From&nbsp;</quote> and blank line separators
40800 in Berkeley-style mailboxes) are written verbatim, so must contain their own
40801 carriage return characters if these are needed. In cases where these options
40802 have non-empty defaults, the values end with a single linefeed, so they must be
40803 changed to end with <literal>\r\n</literal> if <option>use_crlf</option> is set.
40804 </para>
40805 <para>
40806 <indexterm role="option">
40807 <primary><option>use_fcntl_lock</option></primary>
40808 </indexterm>
40809 </para>
40810 <informaltable frame="all">
40811 <tgroup cols="4" colsep="0" rowsep="0">
40812 <colspec colwidth="8*" align="left"/>
40813 <colspec colwidth="6*" align="center"/>
40814 <colspec colwidth="6*" align="center"/>
40815 <colspec colwidth="6*" align="right"/>
40816 <tbody>
40817 <row>
40818 <entry><option>use_fcntl_lock</option></entry>
40819 <entry>Use: <emphasis>appendfile</emphasis></entry>
40820 <entry>Type: <emphasis>boolean</emphasis></entry>
40821 <entry>Default: <emphasis>see below</emphasis></entry>
40822 </row>
40823 </tbody>
40824 </tgroup>
40825 </informaltable>
40826 <para>
40827 This option controls the use of the <function>fcntl()</function> function to lock a file for
40828 exclusive use when a message is being appended. It is set by default unless
40829 <option>use_flock_lock</option> is set. Otherwise, it should be turned off only if you know
40830 that all your MUAs use lock file locking. When both <option>use_fcntl_lock</option> and
40831 <option>use_flock_lock</option> are unset, <option>use_lockfile</option> must be set.
40832 </para>
40833 <para>
40834 <indexterm role="option">
40835 <primary><option>use_flock_lock</option></primary>
40836 </indexterm>
40837 </para>
40838 <informaltable frame="all">
40839 <tgroup cols="4" colsep="0" rowsep="0">
40840 <colspec colwidth="8*" align="left"/>
40841 <colspec colwidth="6*" align="center"/>
40842 <colspec colwidth="6*" align="center"/>
40843 <colspec colwidth="6*" align="right"/>
40844 <tbody>
40845 <row>
40846 <entry><option>use_flock_lock</option></entry>
40847 <entry>Use: <emphasis>appendfile</emphasis></entry>
40848 <entry>Type: <emphasis>boolean</emphasis></entry>
40849 <entry>Default: <emphasis>false</emphasis></entry>
40850 </row>
40851 </tbody>
40852 </tgroup>
40853 </informaltable>
40854 <para>
40855 This option is provided to support the use of <function>flock()</function> for file locking, for
40856 the few situations where it is needed. Most modern operating systems support
40857 <function>fcntl()</function> and <function>lockf()</function> locking, and these two functions interwork with
40858 each other. Exim uses <function>fcntl()</function> locking by default.
40859 </para>
40860 <para>
40861 This option is required only if you are using an operating system where
40862 <function>flock()</function> is used by programs that access mailboxes (typically MUAs), and
40863 where <function>flock()</function> does not correctly interwork with <function>fcntl()</function>. You can use
40864 both <function>fcntl()</function> and <function>flock()</function> locking simultaneously if you want.
40865 </para>
40866 <para>
40867 <indexterm role="concept">
40868 <primary>Solaris</primary>
40869 <secondary><function>flock()</function> support</secondary>
40870 </indexterm>
40871 Not all operating systems provide <function>flock()</function>. Some versions of Solaris do not
40872 have it (and some, I think, provide a not quite right version built on top of
40873 <function>lockf()</function>). If the OS does not have <function>flock()</function>, Exim will be built without
40874 the ability to use it, and any attempt to do so will cause a configuration
40875 error.
40876 </para>
40877 <para>
40878 <emphasis role="bold">Warning</emphasis>: <function>flock()</function> locks do not work on NFS files (unless <function>flock()</function>
40879 is just being mapped onto <function>fcntl()</function> by the OS).
40880 </para>
40881 <para>
40882 <indexterm role="option">
40883 <primary><option>use_lockfile</option></primary>
40884 </indexterm>
40885 </para>
40886 <informaltable frame="all">
40887 <tgroup cols="4" colsep="0" rowsep="0">
40888 <colspec colwidth="8*" align="left"/>
40889 <colspec colwidth="6*" align="center"/>
40890 <colspec colwidth="6*" align="center"/>
40891 <colspec colwidth="6*" align="right"/>
40892 <tbody>
40893 <row>
40894 <entry><option>use_lockfile</option></entry>
40895 <entry>Use: <emphasis>appendfile</emphasis></entry>
40896 <entry>Type: <emphasis>boolean</emphasis></entry>
40897 <entry>Default: <emphasis>see below</emphasis></entry>
40898 </row>
40899 </tbody>
40900 </tgroup>
40901 </informaltable>
40902 <para>
40903 If this option is turned off, Exim does not attempt to create a lock file when
40904 appending to a mailbox file. In this situation, the only locking is by
40905 <function>fcntl()</function>. You should only turn <option>use_lockfile</option> off if you are absolutely
40906 sure that every MUA that is ever going to look at your users&#x2019; mailboxes uses
40907 <function>fcntl()</function> rather than a lock file, and even then only when you are not
40908 delivering over NFS from more than one host.
40909 </para>
40910 <para>
40911 <indexterm role="concept">
40912 <primary>NFS</primary>
40913 <secondary>lock file</secondary>
40914 </indexterm>
40915 In order to append to an NFS file safely from more than one host, it is
40916 necessary to take out a lock <emphasis>before</emphasis> opening the file, and the lock file
40917 achieves this. Otherwise, even with <function>fcntl()</function> locking, there is a risk of
40918 file corruption.
40919 </para>
40920 <para>
40921 The <option>use_lockfile</option> option is set by default unless <option>use_mbx_lock</option> is set.
40922 It is not possible to turn both <option>use_lockfile</option> and <option>use_fcntl_lock</option> off,
40923 except when <option>mbx_format</option> is set.
40924 </para>
40925 <para>
40926 <indexterm role="option">
40927 <primary><option>use_mbx_lock</option></primary>
40928 </indexterm>
40929 </para>
40930 <informaltable frame="all">
40931 <tgroup cols="4" colsep="0" rowsep="0">
40932 <colspec colwidth="8*" align="left"/>
40933 <colspec colwidth="6*" align="center"/>
40934 <colspec colwidth="6*" align="center"/>
40935 <colspec colwidth="6*" align="right"/>
40936 <tbody>
40937 <row>
40938 <entry><option>use_mbx_lock</option></entry>
40939 <entry>Use: <emphasis>appendfile</emphasis></entry>
40940 <entry>Type: <emphasis>boolean</emphasis></entry>
40941 <entry>Default: <emphasis>see below</emphasis></entry>
40942 </row>
40943 </tbody>
40944 </tgroup>
40945 </informaltable>
40946 <para>
40947 This option is available only if Exim has been compiled with SUPPORT_MBX
40948 set in <filename>Local/Makefile</filename>. Setting the option specifies that special MBX
40949 locking rules be used. It is set by default if <option>mbx_format</option> is set and none
40950 of the locking options are mentioned in the configuration. The locking rules
40951 are the same as are used by the <emphasis>c-client</emphasis> library that underlies Pine and
40952 the IMAP4 and POP daemons that come with it (see the discussion below). The
40953 rules allow for shared access to the mailbox. However, this kind of locking
40954 does not work when the mailbox is NFS mounted.
40955 </para>
40956 <para>
40957 You can set <option>use_mbx_lock</option> with either (or both) of <option>use_fcntl_lock</option> and
40958 <option>use_flock_lock</option> to control what kind of locking is used in implementing the
40959 MBX locking rules. The default is to use <function>fcntl()</function> if <option>use_mbx_lock</option> is set
40960 without <option>use_fcntl_lock</option> or <option>use_flock_lock</option>.
40961 </para>
40962 </section>
40963 <section id="SECTopappend">
40964 <title>Operational details for appending</title>
40965 <para>
40966 <indexterm role="concept">
40967 <primary>appending to a file</primary>
40968 </indexterm>
40969 <indexterm role="concept">
40970 <primary>file</primary>
40971 <secondary>appending</secondary>
40972 </indexterm>
40973 Before appending to a file, the following preparations are made:
40974 </para>
40975 <itemizedlist>
40976 <listitem>
40977 <para>
40978 If the name of the file is <filename>/dev/null</filename>, no action is taken, and a success
40979 return is given.
40980 </para>
40981 </listitem>
40982 <listitem>
40983 <para>
40984 <indexterm role="concept">
40985 <primary>directory creation</primary>
40986 </indexterm>
40987 If any directories on the file&#x2019;s path are missing, Exim creates them if the
40988 <option>create_directory</option> option is set. A created directory&#x2019;s mode is given by the
40989 <option>directory_mode</option> option.
40990 </para>
40991 </listitem>
40992 <listitem>
40993 <para>
40994 If <option>file_format</option> is set, the format of an existing file is checked. If this
40995 indicates that a different transport should be used, control is passed to that
40996 transport.
40997 </para>
40998 </listitem>
40999 <listitem>
41000 <para>
41001 <indexterm role="concept">
41002 <primary>file</primary>
41003 <secondary>locking</secondary>
41004 </indexterm>
41005 <indexterm role="concept">
41006 <primary>locking files</primary>
41007 </indexterm>
41008 <indexterm role="concept">
41009 <primary>NFS</primary>
41010 <secondary>lock file</secondary>
41011 </indexterm>
41012 If <option>use_lockfile</option> is set, a lock file is built in a way that will work
41013 reliably over NFS, as follows:
41014 </para>
41015 <orderedlist numeration="arabic">
41016 <listitem>
41017 <para>
41018 Create a <quote>hitching post</quote> file whose name is that of the lock file with the
41019 current time, primary host name, and process id added, by opening for writing
41020 as a new file. If this fails with an access error, delivery is deferred.
41021 </para>
41022 </listitem>
41023 <listitem>
41024 <para>
41025 Close the hitching post file, and hard link it to the lock file name.
41026 </para>
41027 </listitem>
41028 <listitem>
41029 <para>
41030 If the call to <function>link()</function> succeeds, creation of the lock file has succeeded.
41031 Unlink the hitching post name.
41032 </para>
41033 </listitem>
41034 <listitem>
41035 <para>
41036 Otherwise, use <function>stat()</function> to get information about the hitching post file, and
41037 then unlink hitching post name. If the number of links is exactly two, creation
41038 of the lock file succeeded but something (for example, an NFS server crash and
41039 restart) caused this fact not to be communicated to the <function>link()</function> call.
41040 </para>
41041 </listitem>
41042 <listitem>
41043 <para>
41044 If creation of the lock file failed, wait for <option>lock_interval</option> and try again,
41045 up to <option>lock_retries</option> times. However, since any program that writes to a
41046 mailbox should complete its task very quickly, it is reasonable to time out old
41047 lock files that are normally the result of user agent and system crashes. If an
41048 existing lock file is older than <option>lockfile_timeout</option> Exim attempts to unlink
41049 it before trying again.
41050 </para>
41051 </listitem>
41052 </orderedlist>
41053 </listitem>
41054 <listitem>
41055 <para>
41056 A call is made to <function>lstat()</function> to discover whether the main file exists, and if
41057 so, what its characteristics are. If <function>lstat()</function> fails for any reason other
41058 than non-existence, delivery is deferred.
41059 </para>
41060 </listitem>
41061 <listitem>
41062 <para>
41063 <indexterm role="concept">
41064 <primary>symbolic link</primary>
41065 <secondary>to mailbox</secondary>
41066 </indexterm>
41067 <indexterm role="concept">
41068 <primary>mailbox</primary>
41069 <secondary>symbolic link</secondary>
41070 </indexterm>
41071 If the file does exist and is a symbolic link, delivery is deferred, unless the
41072 <option>allow_symlink</option> option is set, in which case the ownership of the link is
41073 checked, and then <function>stat()</function> is called to find out about the real file, which
41074 is then subjected to the checks below. The check on the top-level link
41075 ownership prevents one user creating a link for another&#x2019;s mailbox in a sticky
41076 directory, though allowing symbolic links in this case is definitely not a good
41077 idea. If there is a chain of symbolic links, the intermediate ones are not
41078 checked.
41079 </para>
41080 </listitem>
41081 <listitem>
41082 <para>
41083 If the file already exists but is not a regular file, or if the file&#x2019;s owner
41084 and group (if the group is being checked &ndash; see <option>check_group</option> above) are
41085 different from the user and group under which the delivery is running,
41086 delivery is deferred.
41087 </para>
41088 </listitem>
41089 <listitem>
41090 <para>
41091 If the file&#x2019;s permissions are more generous than specified, they are reduced.
41092 If they are insufficient, delivery is deferred, unless <option>mode_fail_narrower</option>
41093 is set false, in which case the delivery is tried using the existing
41094 permissions.
41095 </para>
41096 </listitem>
41097 <listitem>
41098 <para>
41099 The file&#x2019;s inode number is saved, and the file is then opened for appending.
41100 If this fails because the file has vanished, <command>appendfile</command> behaves as if it
41101 hadn&#x2019;t existed (see below). For any other failures, delivery is deferred.
41102 </para>
41103 </listitem>
41104 <listitem>
41105 <para>
41106 If the file is opened successfully, check that the inode number hasn&#x2019;t
41107 changed, that it is still a regular file, and that the owner and permissions
41108 have not changed. If anything is wrong, defer delivery and freeze the message.
41109 </para>
41110 </listitem>
41111 <listitem>
41112 <para>
41113 If the file did not exist originally, defer delivery if the <option>file_must_exist</option>
41114 option is set. Otherwise, check that the file is being created in a permitted
41115 directory if the <option>create_file</option> option is set (deferring on failure), and then
41116 open for writing as a new file, with the O_EXCL and O_CREAT options,
41117 except when dealing with a symbolic link (the <option>allow_symlink</option> option must be
41118 set). In this case, which can happen if the link points to a non-existent file,
41119 the file is opened for writing using O_CREAT but not O_EXCL, because
41120 that prevents link following.
41121 </para>
41122 </listitem>
41123 <listitem>
41124 <para>
41125 <indexterm role="concept">
41126 <primary>loop</primary>
41127 <secondary>while file testing</secondary>
41128 </indexterm>
41129 If opening fails because the file exists, obey the tests given above for
41130 existing files. However, to avoid looping in a situation where the file is
41131 being continuously created and destroyed, the exists/not-exists loop is broken
41132 after 10 repetitions, and the message is then frozen.
41133 </para>
41134 </listitem>
41135 <listitem>
41136 <para>
41137 If opening fails with any other error, defer delivery.
41138 </para>
41139 </listitem>
41140 <listitem>
41141 <para>
41142 <indexterm role="concept">
41143 <primary>file</primary>
41144 <secondary>locking</secondary>
41145 </indexterm>
41146 <indexterm role="concept">
41147 <primary>locking files</primary>
41148 </indexterm>
41149 Once the file is open, unless both <option>use_fcntl_lock</option> and <option>use_flock_lock</option>
41150 are false, it is locked using <function>fcntl()</function> or <function>flock()</function> or both. If
41151 <option>use_mbx_lock</option> is false, an exclusive lock is requested in each case.
41152 However, if <option>use_mbx_lock</option> is true, Exim takes out a shared lock on the open
41153 file, and an exclusive lock on the file whose name is
41154 </para>
41155 <literallayout class="monospaced">
41156 /tmp/.&lt;device-number&gt;.&lt;inode-number&gt;
41157 </literallayout>
41158 <para>
41159 using the device and inode numbers of the open mailbox file, in accordance with
41160 the MBX locking rules. This file is created with a mode that is specified by
41161 the <option>lockfile_mode</option> option.
41162 </para>
41163 <para>
41164 If Exim fails to lock the file, there are two possible courses of action,
41165 depending on the value of the locking timeout. This is obtained from
41166 <option>lock_fcntl_timeout</option> or <option>lock_flock_timeout</option>, as appropriate.
41167 </para>
41168 <para>
41169 If the timeout value is zero, the file is closed, Exim waits for
41170 <option>lock_interval</option>, and then goes back and re-opens the file as above and tries
41171 to lock it again. This happens up to <option>lock_retries</option> times, after which the
41172 delivery is deferred.
41173 </para>
41174 <para>
41175 If the timeout has a value greater than zero, blocking calls to <function>fcntl()</function> or
41176 <function>flock()</function> are used (with the given timeout), so there has already been some
41177 waiting involved by the time locking fails. Nevertheless, Exim does not give up
41178 immediately. It retries up to
41179 </para>
41180 <literallayout class="monospaced">
41181 (lock_retries * lock_interval) / &lt;timeout&gt;
41182 </literallayout>
41183 <para>
41184 times (rounded up).
41185 </para>
41186 </listitem>
41187 </itemizedlist>
41188 <para>
41189 At the end of delivery, Exim closes the file (which releases the <function>fcntl()</function>
41190 and/or <function>flock()</function> locks) and then deletes the lock file if one was created.
41191 </para>
41192 </section>
41193 <section id="SECTopdir">
41194 <title>Operational details for delivery to a new file</title>
41195 <para>
41196 <indexterm role="concept">
41197 <primary>delivery</primary>
41198 <secondary>to single file</secondary>
41199 </indexterm>
41200 <indexterm role="concept">
41201 <primary><quote>From</quote> line</primary>
41202 </indexterm>
41203 When the <option>directory</option> option is set instead of <option>file</option>, each message is
41204 delivered into a newly-created file or set of files. When <command>appendfile</command> is
41205 activated directly from a <command>redirect</command> router, neither <option>file</option> nor
41206 <option>directory</option> is normally set, because the path for delivery is supplied by the
41207 router. (See for example, the <command>address_file</command> transport in the default
41208 configuration.) In this case, delivery is to a new file if either the path name
41209 ends in <literal>/</literal>, or the <option>maildir_format</option> or <option>mailstore_format</option> option is set.
41210 </para>
41211 <para>
41212 No locking is required while writing the message to a new file, so the various
41213 locking options of the transport are ignored. The <quote>From</quote> line that by default
41214 separates messages in a single file is not normally needed, nor is the escaping
41215 of message lines that start with <quote>From</quote>, and there is no need to ensure a
41216 newline at the end of each message. Consequently, the default values for
41217 <option>check_string</option>, <option>message_prefix</option>, and <option>message_suffix</option> are all unset when
41218 any of <option>directory</option>, <option>maildir_format</option>, or <option>mailstore_format</option> is set.
41219 </para>
41220 <para>
41221 If Exim is required to check a <option>quota</option> setting, it adds up the sizes of all
41222 the files in the delivery directory by default. However, you can specify a
41223 different directory by setting <option>quota_directory</option>. Also, for maildir
41224 deliveries (see below) the <filename>maildirfolder</filename> convention is honoured.
41225 </para>
41226 <para>
41227 <indexterm role="concept">
41228 <primary>maildir format</primary>
41229 </indexterm>
41230 <indexterm role="concept">
41231 <primary>mailstore format</primary>
41232 </indexterm>
41233 There are three different ways in which delivery to individual files can be
41234 done, controlled by the settings of the <option>maildir_format</option> and
41235 <option>mailstore_format</option> options. Note that code to support maildir or mailstore
41236 formats is not included in the binary unless SUPPORT_MAILDIR or
41237 SUPPORT_MAILSTORE, respectively, is set in <filename>Local/Makefile</filename>.
41238 </para>
41239 <para>
41240 <indexterm role="concept">
41241 <primary>directory creation</primary>
41242 </indexterm>
41243 In all three cases an attempt is made to create the directory and any necessary
41244 sub-directories if they do not exist, provided that the <option>create_directory</option>
41245 option is set (the default). The location of a created directory can be
41246 constrained by setting <option>create_file</option>. A created directory&#x2019;s mode is given by
41247 the <option>directory_mode</option> option. If creation fails, or if the
41248 <option>create_directory</option> option is not set when creation is required, delivery is
41249 deferred.
41250 </para>
41251 </section>
41252 <section id="SECTmaildirdelivery">
41253 <title>Maildir delivery</title>
41254 <para>
41255 <indexterm role="concept">
41256 <primary>maildir format</primary>
41257 <secondary>description of</secondary>
41258 </indexterm>
41259 If the <option>maildir_format</option> option is true, Exim delivers each message by writing
41260 it to a file whose name is <filename>tmp/&lt;stime&gt;.H&lt;mtime&gt;P&lt;pid&gt;.&lt;host&gt;</filename> in the
41261 directory that is defined by the <option>directory</option> option (the <quote>delivery
41262 directory</quote>). If the delivery is successful, the file is renamed into the
41263 <filename>new</filename> subdirectory.
41264 </para>
41265 <para>
41266 In the file name, &lt;<emphasis>stime</emphasis>&gt; is the current time of day in seconds, and
41267 &lt;<emphasis>mtime</emphasis>&gt; is the microsecond fraction of the time. After a maildir delivery,
41268 Exim checks that the time-of-day clock has moved on by at least one microsecond
41269 before terminating the delivery process. This guarantees uniqueness for the
41270 file name. However, as a precaution, Exim calls <function>stat()</function> for the file before
41271 opening it. If any response other than ENOENT (does not exist) is given,
41272 Exim waits 2 seconds and tries again, up to <option>maildir_retries</option> times.
41273 </para>
41274 <para>
41275 Before Exim carries out a maildir delivery, it ensures that subdirectories
41276 called <filename>new</filename>, <filename>cur</filename>, and <filename>tmp</filename> exist in the delivery directory. If they
41277 do not exist, Exim tries to create them and any superior directories in their
41278 path, subject to the <option>create_directory</option> and <option>create_file</option> options. If the
41279 <option>maildirfolder_create_regex</option> option is set, and the regular expression it
41280 contains matches the delivery directory, Exim also ensures that a file called
41281 <filename>maildirfolder</filename> exists in the delivery directory. If a missing directory or
41282 <filename>maildirfolder</filename> file cannot be created, delivery is deferred.
41283 </para>
41284 <para>
41285 These features make it possible to use Exim to create all the necessary files
41286 and directories in a maildir mailbox, including subdirectories for maildir++
41287 folders. Consider this example:
41288 </para>
41289 <literallayout class="monospaced">
41290 maildir_format = true
41291 directory = /var/mail/$local_part\
41292            ${if eq{$local_part_suffix}{}{}\
41293            {/.${substr_1:$local_part_suffix}}}
41294 maildirfolder_create_regex = /\.[^/]+$
41295 </literallayout>
41296 <para>
41297 If <varname>$local_part_suffix</varname> is empty (there was no suffix for the local part),
41298 delivery is into a toplevel maildir with a name like <filename>/var/mail/pimbo</filename> (for
41299 the user called <emphasis>pimbo</emphasis>). The pattern in <option>maildirfolder_create_regex</option> does
41300 not match this name, so Exim will not look for or create the file
41301 <filename>/var/mail/pimbo/maildirfolder</filename>, though it will create
41302 <filename>/var/mail/pimbo/{cur,new,tmp}</filename> if necessary.
41303 </para>
41304 <para>
41305 However, if <varname>$local_part_suffix</varname> contains <literal>-eximusers</literal> (for example),
41306 delivery is into the maildir++ folder <filename>/var/mail/pimbo/.eximusers</filename>, which
41307 does match <option>maildirfolder_create_regex</option>. In this case, Exim will create
41308 <filename>/var/mail/pimbo/.eximusers/maildirfolder</filename> as well as the three maildir
41309 directories <filename>/var/mail/pimbo/.eximusers/{cur,new,tmp}</filename>.
41310 </para>
41311 <para>
41312 <emphasis role="bold">Warning:</emphasis> Take care when setting <option>maildirfolder_create_regex</option> that it does
41313 not inadvertently match the toplevel maildir directory, because a
41314 <filename>maildirfolder</filename> file at top level would completely break quota calculations.
41315 </para>
41316 <para>
41317 <indexterm role="concept">
41318 <primary>quota</primary>
41319 <secondary>in maildir delivery</secondary>
41320 </indexterm>
41321 <indexterm role="concept">
41322 <primary>maildir++</primary>
41323 </indexterm>
41324 If Exim is required to check a <option>quota</option> setting before a maildir delivery, and
41325 <option>quota_directory</option> is not set, it looks for a file called <filename>maildirfolder</filename> in
41326 the maildir directory (alongside <filename>new</filename>, <filename>cur</filename>, <filename>tmp</filename>). If this exists,
41327 Exim assumes the directory is a maildir++ folder directory, which is one level
41328 down from the user&#x2019;s top level mailbox directory. This causes it to start at
41329 the parent directory instead of the current directory when calculating the
41330 amount of space used.
41331 </para>
41332 <para>
41333 One problem with delivering into a multi-file mailbox is that it is
41334 computationally expensive to compute the size of the mailbox for quota
41335 checking. Various approaches have been taken to reduce the amount of work
41336 needed. The next two sections describe two of them. A third alternative is to
41337 use some external process for maintaining the size data, and use the expansion
41338 of the <option>mailbox_size</option> option as a way of importing it into Exim.
41339 </para>
41340 </section>
41341 <section id="SECID135">
41342 <title>Using tags to record message sizes</title>
41343 <para>
41344 If <option>maildir_tag</option> is set, the string is expanded for each delivery.
41345 When the maildir file is renamed into the <filename>new</filename> sub-directory, the
41346 tag is added to its name. However, if adding the tag takes the length of the
41347 name to the point where the test <function>stat()</function> call fails with ENAMETOOLONG,
41348 the tag is dropped and the maildir file is created with no tag.
41349 </para>
41350 <para>
41351 <indexterm role="variable">
41352 <primary><varname>$message_size</varname></primary>
41353 </indexterm>
41354 Tags can be used to encode the size of files in their names; see
41355 <option>quota_size_regex</option> above for an example. The expansion of <option>maildir_tag</option>
41356 happens after the message has been written. The value of the <varname>$message_size</varname>
41357 variable is set to the number of bytes actually written. If the expansion is
41358 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
41359 be deferred. The expanded tag may contain any printing characters except <quote>/</quote>.
41360 Non-printing characters in the string are ignored; if the resulting string is
41361 empty, it is ignored. If it starts with an alphanumeric character, a leading
41362 colon is inserted; this default has not proven to be the path that popular
41363 maildir implementations have chosen (but changing it in Exim would break
41364 backwards compatibility).
41365 </para>
41366 <para>
41367 For one common implementation, you might set:
41368 </para>
41369 <literallayout class="monospaced">
41370 maildir_tag = ,S=${message_size}
41371 </literallayout>
41372 <para>
41373 but you should check the documentation of the other software to be sure.
41374 </para>
41375 <para>
41376 It is advisable to also set <option>quota_size_regex</option> when setting <option>maildir_tag</option>
41377 as this allows Exim to extract the size from your tag, instead of having to
41378 <function>stat()</function> each message file.
41379 </para>
41380 </section>
41381 <section id="SECID136">
41382 <title>Using a maildirsize file</title>
41383 <para>
41384 <indexterm role="concept">
41385 <primary>quota</primary>
41386 <secondary>in maildir delivery</secondary>
41387 </indexterm>
41388 <indexterm role="concept">
41389 <primary>maildir format</primary>
41390 <secondary><filename>maildirsize</filename> file</secondary>
41391 </indexterm>
41392 If <option>maildir_use_size_file</option> is true, Exim implements the maildir++ rules for
41393 storing quota and message size information in a file called <filename>maildirsize</filename>
41394 within the toplevel maildir directory. If this file does not exist, Exim
41395 creates it, setting the quota from the <option>quota</option> option of the transport. If
41396 the maildir directory itself does not exist, it is created before any attempt
41397 to write a <filename>maildirsize</filename> file.
41398 </para>
41399 <para>
41400 The <filename>maildirsize</filename> file is used to hold information about the sizes of
41401 messages in the maildir, thus speeding up quota calculations. The quota value
41402 in the file is just a cache; if the quota is changed in the transport, the new
41403 value overrides the cached value when the next message is delivered. The cache
41404 is maintained for the benefit of other programs that access the maildir and
41405 need to know the quota.
41406 </para>
41407 <para>
41408 If the <option>quota</option> option in the transport is unset or zero, the <filename>maildirsize</filename>
41409 file is maintained (with a zero quota setting), but no quota is imposed.
41410 </para>
41411 <para>
41412 A regular expression is available for controlling which directories in the
41413 maildir participate in quota calculations when a <filename>maildirsizefile</filename> is in use.
41414 See the description of the <option>maildir_quota_directory_regex</option> option above for
41415 details.
41416 </para>
41417 </section>
41418 <section id="SECID137">
41419 <title>Mailstore delivery</title>
41420 <para>
41421 <indexterm role="concept">
41422 <primary>mailstore format</primary>
41423 <secondary>description of</secondary>
41424 </indexterm>
41425 If the <option>mailstore_format</option> option is true, each message is written as two
41426 files in the given directory. A unique base name is constructed from the
41427 message id and the current delivery process, and the files that are written use
41428 this base name plus the suffixes <filename>.env</filename> and <filename>.msg</filename>. The <filename>.env</filename> file
41429 contains the message&#x2019;s envelope, and the <filename>.msg</filename> file contains the message
41430 itself. The base name is placed in the variable <varname>$mailstore_basename</varname>.
41431 </para>
41432 <para>
41433 During delivery, the envelope is first written to a file with the suffix
41434 <filename>.tmp</filename>. The <filename>.msg</filename> file is then written, and when it is complete, the
41435 <filename>.tmp</filename> file is renamed as the <filename>.env</filename> file. Programs that access messages in
41436 mailstore format should wait for the presence of both a <filename>.msg</filename> and a <filename>.env</filename>
41437 file before accessing either of them. An alternative approach is to wait for
41438 the absence of a <filename>.tmp</filename> file.
41439 </para>
41440 <para>
41441 The envelope file starts with any text defined by the <option>mailstore_prefix</option>
41442 option, expanded and terminated by a newline if there isn&#x2019;t one. Then follows
41443 the sender address on one line, then all the recipient addresses, one per line.
41444 There can be more than one recipient only if the <option>batch_max</option> option is set
41445 greater than one. Finally, <option>mailstore_suffix</option> is expanded and the result
41446 appended to the file, followed by a newline if it does not end with one.
41447 </para>
41448 <para>
41449 If expansion of <option>mailstore_prefix</option> or <option>mailstore_suffix</option> ends with a forced
41450 failure, it is ignored. Other expansion errors are treated as serious
41451 configuration errors, and delivery is deferred. The variable
41452 <varname>$mailstore_basename</varname> is available for use during these expansions.
41453 </para>
41454 </section>
41455 <section id="SECID138">
41456 <title>Non-special new file delivery</title>
41457 <para>
41458 If neither <option>maildir_format</option> nor <option>mailstore_format</option> is set, a single new
41459 file is created directly in the named directory. For example, when delivering
41460 messages into files in batched SMTP format for later delivery to some host (see
41461 section <xref linkend="SECTbatchSMTP"/>), a setting such as
41462 </para>
41463 <literallayout class="monospaced">
41464 directory = /var/bsmtp/$host
41465 </literallayout>
41466 <para>
41467 might be used. A message is written to a file with a temporary name, which is
41468 then renamed when the delivery is complete. The final name is obtained by
41469 expanding the contents of the <option>directory_file</option> option.
41470 <indexterm role="concept" startref="IIDapptra1" class="endofrange"/>
41471 <indexterm role="concept" startref="IIDapptra2" class="endofrange"/>
41472 </para>
41473 </section>
41474 </chapter>
41475
41476 <chapter id="CHID8">
41477 <title>The autoreply transport</title>
41478 <para>
41479 <indexterm role="concept" id="IIDauttra1" class="startofrange">
41480 <primary>transports</primary>
41481 <secondary><command>autoreply</command></secondary>
41482 </indexterm>
41483 <indexterm role="concept" id="IIDauttra2" class="startofrange">
41484 <primary><command>autoreply</command> transport</primary>
41485 </indexterm>
41486 The <command>autoreply</command> transport is not a true transport in that it does not cause
41487 the message to be transmitted. Instead, it generates a new mail message as an
41488 automatic reply to the incoming message. <emphasis>References:</emphasis> and
41489 <emphasis>Auto-Submitted:</emphasis> header lines are included. These are constructed according
41490 to the rules in RFCs 2822 and 3834, respectively.
41491 </para>
41492 <para>
41493 If the router that passes the message to this transport does not have the
41494 <option>unseen</option> option set, the original message (for the current recipient) is not
41495 delivered anywhere. However, when the <option>unseen</option> option is set on the router
41496 that passes the message to this transport, routing of the address continues, so
41497 another router can set up a normal message delivery.
41498 </para>
41499 <para>
41500 The <command>autoreply</command> transport is usually run as the result of mail filtering, a
41501 <quote>vacation</quote> message being the standard example. However, it can also be run
41502 directly from a router like any other transport. To reduce the possibility of
41503 message cascades, messages created by the <command>autoreply</command> transport always have
41504 empty envelope sender addresses, like bounce messages.
41505 </para>
41506 <para>
41507 The parameters of the message to be sent can be specified in the configuration
41508 by options described below. However, these are used only when the address
41509 passed to the transport does not contain its own reply information. When the
41510 transport is run as a consequence of a
41511 <option>mail</option>
41512 or <option>vacation</option> command in a filter file, the parameters of the message are
41513 supplied by the filter, and passed with the address. The transport&#x2019;s options
41514 that define the message are then ignored (so they are not usually set in this
41515 case). The message is specified entirely by the filter or by the transport; it
41516 is never built from a mixture of options. However, the <option>file_optional</option>,
41517 <option>mode</option>, and <option>return_message</option> options apply in all cases.
41518 </para>
41519 <para>
41520 <command>Autoreply</command> is implemented as a local transport. When used as a result of a
41521 command in a user&#x2019;s filter file, <command>autoreply</command> normally runs under the uid and
41522 gid of the user, and with appropriate current and home directories (see chapter
41523 <xref linkend="CHAPenvironment"/>).
41524 </para>
41525 <para>
41526 There is a subtle difference between routing a message to a <command>pipe</command> transport
41527 that generates some text to be returned to the sender, and routing it to an
41528 <command>autoreply</command> transport. This difference is noticeable only if more than one
41529 address from the same message is so handled. In the case of a pipe, the
41530 separate outputs from the different addresses are gathered up and returned to
41531 the sender in a single message, whereas if <command>autoreply</command> is used, a separate
41532 message is generated for each address that is passed to it.
41533 </para>
41534 <para>
41535 Non-printing characters are not permitted in the header lines generated for the
41536 message that <command>autoreply</command> creates, with the exception of newlines that are
41537 immediately followed by white space. If any non-printing characters are found,
41538 the transport defers.
41539 Whether characters with the top bit set count as printing characters or not is
41540 controlled by the <option>print_topbitchars</option> global option.
41541 </para>
41542 <para>
41543 If any of the generic options for manipulating headers (for example,
41544 <option>headers_add</option>) are set on an <command>autoreply</command> transport, they apply to the copy
41545 of the original message that is included in the generated message when
41546 <option>return_message</option> is set. They do not apply to the generated message itself.
41547 </para>
41548 <para>
41549 <indexterm role="variable">
41550 <primary><varname>$sender_address</varname></primary>
41551 </indexterm>
41552 If the <command>autoreply</command> transport receives return code 2 from Exim when it submits
41553 the message, indicating that there were no recipients, it does not treat this
41554 as an error. This means that autoreplies sent to <varname>$sender_address</varname> when this
41555 is empty (because the incoming message is a bounce message) do not cause
41556 problems. They are just discarded.
41557 </para>
41558 <section id="SECID139">
41559 <title>Private options for autoreply</title>
41560 <para>
41561 <indexterm role="concept">
41562 <primary>options</primary>
41563 <secondary><command>autoreply</command> transport</secondary>
41564 </indexterm>
41565 </para>
41566 <para>
41567 <indexterm role="option">
41568 <primary><option>bcc</option></primary>
41569 </indexterm>
41570 </para>
41571 <informaltable frame="all">
41572 <tgroup cols="4" colsep="0" rowsep="0">
41573 <colspec colwidth="8*" align="left"/>
41574 <colspec colwidth="6*" align="center"/>
41575 <colspec colwidth="6*" align="center"/>
41576 <colspec colwidth="6*" align="right"/>
41577 <tbody>
41578 <row>
41579 <entry><option>bcc</option></entry>
41580 <entry>Use: <emphasis>autoreply</emphasis></entry>
41581 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
41582 <entry>Default: <emphasis>unset</emphasis></entry>
41583 </row>
41584 </tbody>
41585 </tgroup>
41586 </informaltable>
41587 <para>
41588 This specifies the addresses that are to receive <quote>blind carbon copies</quote> of the
41589 message when the message is specified by the transport.
41590 </para>
41591 <para>
41592 <indexterm role="option">
41593 <primary><option>cc</option></primary>
41594 </indexterm>
41595 </para>
41596 <informaltable frame="all">
41597 <tgroup cols="4" colsep="0" rowsep="0">
41598 <colspec colwidth="8*" align="left"/>
41599 <colspec colwidth="6*" align="center"/>
41600 <colspec colwidth="6*" align="center"/>
41601 <colspec colwidth="6*" align="right"/>
41602 <tbody>
41603 <row>
41604 <entry><option>cc</option></entry>
41605 <entry>Use: <emphasis>autoreply</emphasis></entry>
41606 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
41607 <entry>Default: <emphasis>unset</emphasis></entry>
41608 </row>
41609 </tbody>
41610 </tgroup>
41611 </informaltable>
41612 <para>
41613 This specifies recipients of the message and the contents of the <emphasis>Cc:</emphasis> header
41614 when the message is specified by the transport.
41615 </para>
41616 <para>
41617 <indexterm role="option">
41618 <primary><option>file</option></primary>
41619 </indexterm>
41620 </para>
41621 <informaltable frame="all">
41622 <tgroup cols="4" colsep="0" rowsep="0">
41623 <colspec colwidth="8*" align="left"/>
41624 <colspec colwidth="6*" align="center"/>
41625 <colspec colwidth="6*" align="center"/>
41626 <colspec colwidth="6*" align="right"/>
41627 <tbody>
41628 <row>
41629 <entry><option>file</option></entry>
41630 <entry>Use: <emphasis>autoreply</emphasis></entry>
41631 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
41632 <entry>Default: <emphasis>unset</emphasis></entry>
41633 </row>
41634 </tbody>
41635 </tgroup>
41636 </informaltable>
41637 <para>
41638 The contents of the file are sent as the body of the message when the message
41639 is specified by the transport. If both <option>file</option> and <option>text</option> are set, the text
41640 string comes first.
41641 </para>
41642 <para>
41643 <indexterm role="option">
41644 <primary><option>file_expand</option></primary>
41645 </indexterm>
41646 </para>
41647 <informaltable frame="all">
41648 <tgroup cols="4" colsep="0" rowsep="0">
41649 <colspec colwidth="8*" align="left"/>
41650 <colspec colwidth="6*" align="center"/>
41651 <colspec colwidth="6*" align="center"/>
41652 <colspec colwidth="6*" align="right"/>
41653 <tbody>
41654 <row>
41655 <entry><option>file_expand</option></entry>
41656 <entry>Use: <emphasis>autoreply</emphasis></entry>
41657 <entry>Type: <emphasis>boolean</emphasis></entry>
41658 <entry>Default: <emphasis>false</emphasis></entry>
41659 </row>
41660 </tbody>
41661 </tgroup>
41662 </informaltable>
41663 <para>
41664 If this is set, the contents of the file named by the <option>file</option> option are
41665 subjected to string expansion as they are added to the message.
41666 </para>
41667 <para>
41668 <indexterm role="option">
41669 <primary><option>file_optional</option></primary>
41670 </indexterm>
41671 </para>
41672 <informaltable frame="all">
41673 <tgroup cols="4" colsep="0" rowsep="0">
41674 <colspec colwidth="8*" align="left"/>
41675 <colspec colwidth="6*" align="center"/>
41676 <colspec colwidth="6*" align="center"/>
41677 <colspec colwidth="6*" align="right"/>
41678 <tbody>
41679 <row>
41680 <entry><option>file_optional</option></entry>
41681 <entry>Use: <emphasis>autoreply</emphasis></entry>
41682 <entry>Type: <emphasis>boolean</emphasis></entry>
41683 <entry>Default: <emphasis>false</emphasis></entry>
41684 </row>
41685 </tbody>
41686 </tgroup>
41687 </informaltable>
41688 <para>
41689 If this option is true, no error is generated if the file named by the <option>file</option>
41690 option or passed with the address does not exist or cannot be read.
41691 </para>
41692 <para>
41693 <indexterm role="option">
41694 <primary><option>from</option></primary>
41695 </indexterm>
41696 </para>
41697 <informaltable frame="all">
41698 <tgroup cols="4" colsep="0" rowsep="0">
41699 <colspec colwidth="8*" align="left"/>
41700 <colspec colwidth="6*" align="center"/>
41701 <colspec colwidth="6*" align="center"/>
41702 <colspec colwidth="6*" align="right"/>
41703 <tbody>
41704 <row>
41705 <entry><option>from</option></entry>
41706 <entry>Use: <emphasis>autoreply</emphasis></entry>
41707 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
41708 <entry>Default: <emphasis>unset</emphasis></entry>
41709 </row>
41710 </tbody>
41711 </tgroup>
41712 </informaltable>
41713 <para>
41714 This specifies the contents of the <emphasis>From:</emphasis> header when the message is
41715 specified by the transport.
41716 </para>
41717 <para>
41718 <indexterm role="option">
41719 <primary><option>headers</option></primary>
41720 </indexterm>
41721 </para>
41722 <informaltable frame="all">
41723 <tgroup cols="4" colsep="0" rowsep="0">
41724 <colspec colwidth="8*" align="left"/>
41725 <colspec colwidth="6*" align="center"/>
41726 <colspec colwidth="6*" align="center"/>
41727 <colspec colwidth="6*" align="right"/>
41728 <tbody>
41729 <row>
41730 <entry><option>headers</option></entry>
41731 <entry>Use: <emphasis>autoreply</emphasis></entry>
41732 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
41733 <entry>Default: <emphasis>unset</emphasis></entry>
41734 </row>
41735 </tbody>
41736 </tgroup>
41737 </informaltable>
41738 <para>
41739 This specifies additional RFC 2822 headers that are to be added to the message
41740 when the message is specified by the transport. Several can be given by using
41741 <quote>\n</quote> to separate them. There is no check on the format.
41742 </para>
41743 <para>
41744 <indexterm role="option">
41745 <primary><option>log</option></primary>
41746 </indexterm>
41747 </para>
41748 <informaltable frame="all">
41749 <tgroup cols="4" colsep="0" rowsep="0">
41750 <colspec colwidth="8*" align="left"/>
41751 <colspec colwidth="6*" align="center"/>
41752 <colspec colwidth="6*" align="center"/>
41753 <colspec colwidth="6*" align="right"/>
41754 <tbody>
41755 <row>
41756 <entry><option>log</option></entry>
41757 <entry>Use: <emphasis>autoreply</emphasis></entry>
41758 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
41759 <entry>Default: <emphasis>unset</emphasis></entry>
41760 </row>
41761 </tbody>
41762 </tgroup>
41763 </informaltable>
41764 <para>
41765 This option names a file in which a record of every message sent is logged when
41766 the message is specified by the transport.
41767 </para>
41768 <para>
41769 <indexterm role="option">
41770 <primary><option>mode</option></primary>
41771 </indexterm>
41772 </para>
41773 <informaltable frame="all">
41774 <tgroup cols="4" colsep="0" rowsep="0">
41775 <colspec colwidth="8*" align="left"/>
41776 <colspec colwidth="6*" align="center"/>
41777 <colspec colwidth="6*" align="center"/>
41778 <colspec colwidth="6*" align="right"/>
41779 <tbody>
41780 <row>
41781 <entry><option>mode</option></entry>
41782 <entry>Use: <emphasis>autoreply</emphasis></entry>
41783 <entry>Type: <emphasis>octal integer</emphasis></entry>
41784 <entry>Default: <emphasis>0600</emphasis></entry>
41785 </row>
41786 </tbody>
41787 </tgroup>
41788 </informaltable>
41789 <para>
41790 If either the log file or the <quote>once</quote> file has to be created, this mode is
41791 used.
41792 </para>
41793 <para>
41794 <indexterm role="option">
41795 <primary><option>never_mail</option></primary>
41796 </indexterm>
41797 </para>
41798 <informaltable frame="all">
41799 <tgroup cols="4" colsep="0" rowsep="0">
41800 <colspec colwidth="8*" align="left"/>
41801 <colspec colwidth="6*" align="center"/>
41802 <colspec colwidth="6*" align="center"/>
41803 <colspec colwidth="6*" align="right"/>
41804 <tbody>
41805 <row>
41806 <entry><option>never_mail</option></entry>
41807 <entry>Use: <emphasis>autoreply</emphasis></entry>
41808 <entry>Type: <emphasis>address list</emphasis>&dagger;<emphasis></emphasis></entry>
41809 <entry>Default: <emphasis>unset</emphasis></entry>
41810 </row>
41811 </tbody>
41812 </tgroup>
41813 </informaltable>
41814 <para>
41815 If any run of the transport creates a message with a recipient that matches any
41816 item in the list, that recipient is quietly discarded. If all recipients are
41817 discarded, no message is created. This applies both when the recipients are
41818 generated by a filter and when they are specified in the transport.
41819 </para>
41820 <para>
41821 <indexterm role="option">
41822 <primary><option>once</option></primary>
41823 </indexterm>
41824 </para>
41825 <informaltable frame="all">
41826 <tgroup cols="4" colsep="0" rowsep="0">
41827 <colspec colwidth="8*" align="left"/>
41828 <colspec colwidth="6*" align="center"/>
41829 <colspec colwidth="6*" align="center"/>
41830 <colspec colwidth="6*" align="right"/>
41831 <tbody>
41832 <row>
41833 <entry><option>once</option></entry>
41834 <entry>Use: <emphasis>autoreply</emphasis></entry>
41835 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
41836 <entry>Default: <emphasis>unset</emphasis></entry>
41837 </row>
41838 </tbody>
41839 </tgroup>
41840 </informaltable>
41841 <para>
41842 This option names a file or DBM database in which a record of each <emphasis>To:</emphasis>
41843 recipient is kept when the message is specified by the transport. <emphasis role="bold">Note</emphasis>:
41844 This does not apply to <emphasis>Cc:</emphasis> or <emphasis>Bcc:</emphasis> recipients.
41845 </para>
41846 <para>
41847 If <option>once</option> is unset, or is set to an empty string, the message is always sent.
41848 By default, if <option>once</option> is set to a non-empty file name, the message
41849 is not sent if a potential recipient is already listed in the database.
41850 However, if the <option>once_repeat</option> option specifies a time greater than zero, the
41851 message is sent if that much time has elapsed since a message was last sent to
41852 this recipient. A setting of zero time for <option>once_repeat</option> (the default)
41853 prevents a message from being sent a second time &ndash; in this case, zero means
41854 infinity.
41855 </para>
41856 <para>
41857 If <option>once_file_size</option> is zero, a DBM database is used to remember recipients,
41858 and it is allowed to grow as large as necessary. If <option>once_file_size</option> is set
41859 greater than zero, it changes the way Exim implements the <option>once</option> option.
41860 Instead of using a DBM file to record every recipient it sends to, it uses a
41861 regular file, whose size will never get larger than the given value.
41862 </para>
41863 <para>
41864 In the file, Exim keeps a linear list of recipient addresses and the times at
41865 which they were sent messages. If the file is full when a new address needs to
41866 be added, the oldest address is dropped. If <option>once_repeat</option> is not set, this
41867 means that a given recipient may receive multiple messages, but at
41868 unpredictable intervals that depend on the rate of turnover of addresses in the
41869 file. If <option>once_repeat</option> is set, it specifies a maximum time between repeats.
41870 </para>
41871 <para>
41872 <indexterm role="option">
41873 <primary><option>once_file_size</option></primary>
41874 </indexterm>
41875 </para>
41876 <informaltable frame="all">
41877 <tgroup cols="4" colsep="0" rowsep="0">
41878 <colspec colwidth="8*" align="left"/>
41879 <colspec colwidth="6*" align="center"/>
41880 <colspec colwidth="6*" align="center"/>
41881 <colspec colwidth="6*" align="right"/>
41882 <tbody>
41883 <row>
41884 <entry><option>once_file_size</option></entry>
41885 <entry>Use: <emphasis>autoreply</emphasis></entry>
41886 <entry>Type: <emphasis>integer</emphasis></entry>
41887 <entry>Default: <emphasis>0</emphasis></entry>
41888 </row>
41889 </tbody>
41890 </tgroup>
41891 </informaltable>
41892 <para>
41893 See <option>once</option> above.
41894 </para>
41895 <para>
41896 <indexterm role="option">
41897 <primary><option>once_repeat</option></primary>
41898 </indexterm>
41899 </para>
41900 <informaltable frame="all">
41901 <tgroup cols="4" colsep="0" rowsep="0">
41902 <colspec colwidth="8*" align="left"/>
41903 <colspec colwidth="6*" align="center"/>
41904 <colspec colwidth="6*" align="center"/>
41905 <colspec colwidth="6*" align="right"/>
41906 <tbody>
41907 <row>
41908 <entry><option>once_repeat</option></entry>
41909 <entry>Use: <emphasis>autoreply</emphasis></entry>
41910 <entry>Type: <emphasis>time</emphasis>&dagger;<emphasis></emphasis></entry>
41911 <entry>Default: <emphasis>0s</emphasis></entry>
41912 </row>
41913 </tbody>
41914 </tgroup>
41915 </informaltable>
41916 <para>
41917 See <option>once</option> above.
41918 After expansion, the value of this option must be a valid time value.
41919 </para>
41920 <para>
41921 <indexterm role="option">
41922 <primary><option>reply_to</option></primary>
41923 </indexterm>
41924 </para>
41925 <informaltable frame="all">
41926 <tgroup cols="4" colsep="0" rowsep="0">
41927 <colspec colwidth="8*" align="left"/>
41928 <colspec colwidth="6*" align="center"/>
41929 <colspec colwidth="6*" align="center"/>
41930 <colspec colwidth="6*" align="right"/>
41931 <tbody>
41932 <row>
41933 <entry><option>reply_to</option></entry>
41934 <entry>Use: <emphasis>autoreply</emphasis></entry>
41935 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
41936 <entry>Default: <emphasis>unset</emphasis></entry>
41937 </row>
41938 </tbody>
41939 </tgroup>
41940 </informaltable>
41941 <para>
41942 This specifies the contents of the <emphasis>Reply-To:</emphasis> header when the message is
41943 specified by the transport.
41944 </para>
41945 <para>
41946 <indexterm role="option">
41947 <primary><option>return_message</option></primary>
41948 </indexterm>
41949 </para>
41950 <informaltable frame="all">
41951 <tgroup cols="4" colsep="0" rowsep="0">
41952 <colspec colwidth="8*" align="left"/>
41953 <colspec colwidth="6*" align="center"/>
41954 <colspec colwidth="6*" align="center"/>
41955 <colspec colwidth="6*" align="right"/>
41956 <tbody>
41957 <row>
41958 <entry><option>return_message</option></entry>
41959 <entry>Use: <emphasis>autoreply</emphasis></entry>
41960 <entry>Type: <emphasis>boolean</emphasis></entry>
41961 <entry>Default: <emphasis>false</emphasis></entry>
41962 </row>
41963 </tbody>
41964 </tgroup>
41965 </informaltable>
41966 <para>
41967 If this is set, a copy of the original message is returned with the new
41968 message, subject to the maximum size set in the <option>return_size_limit</option> global
41969 configuration option.
41970 </para>
41971 <para>
41972 <indexterm role="option">
41973 <primary><option>subject</option></primary>
41974 </indexterm>
41975 </para>
41976 <informaltable frame="all">
41977 <tgroup cols="4" colsep="0" rowsep="0">
41978 <colspec colwidth="8*" align="left"/>
41979 <colspec colwidth="6*" align="center"/>
41980 <colspec colwidth="6*" align="center"/>
41981 <colspec colwidth="6*" align="right"/>
41982 <tbody>
41983 <row>
41984 <entry><option>subject</option></entry>
41985 <entry>Use: <emphasis>autoreply</emphasis></entry>
41986 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
41987 <entry>Default: <emphasis>unset</emphasis></entry>
41988 </row>
41989 </tbody>
41990 </tgroup>
41991 </informaltable>
41992 <para>
41993 This specifies the contents of the <emphasis>Subject:</emphasis> header when the message is
41994 specified by the transport. It is tempting to quote the original subject in
41995 automatic responses. For example:
41996 </para>
41997 <literallayout class="monospaced">
41998 subject = Re: $h_subject:
41999 </literallayout>
42000 <para>
42001 There is a danger in doing this, however. It may allow a third party to
42002 subscribe your users to an opt-in mailing list, provided that the list accepts
42003 bounce messages as subscription confirmations. Well-managed lists require a
42004 non-bounce message to confirm a subscription, so the danger is relatively
42005 small.
42006 </para>
42007 <para>
42008 <indexterm role="option">
42009 <primary><option>text</option></primary>
42010 </indexterm>
42011 </para>
42012 <informaltable frame="all">
42013 <tgroup cols="4" colsep="0" rowsep="0">
42014 <colspec colwidth="8*" align="left"/>
42015 <colspec colwidth="6*" align="center"/>
42016 <colspec colwidth="6*" align="center"/>
42017 <colspec colwidth="6*" align="right"/>
42018 <tbody>
42019 <row>
42020 <entry><option>text</option></entry>
42021 <entry>Use: <emphasis>autoreply</emphasis></entry>
42022 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
42023 <entry>Default: <emphasis>unset</emphasis></entry>
42024 </row>
42025 </tbody>
42026 </tgroup>
42027 </informaltable>
42028 <para>
42029 This specifies a single string to be used as the body of the message when the
42030 message is specified by the transport. If both <option>text</option> and <option>file</option> are set,
42031 the text comes first.
42032 </para>
42033 <para>
42034 <indexterm role="option">
42035 <primary><option>to</option></primary>
42036 </indexterm>
42037 </para>
42038 <informaltable frame="all">
42039 <tgroup cols="4" colsep="0" rowsep="0">
42040 <colspec colwidth="8*" align="left"/>
42041 <colspec colwidth="6*" align="center"/>
42042 <colspec colwidth="6*" align="center"/>
42043 <colspec colwidth="6*" align="right"/>
42044 <tbody>
42045 <row>
42046 <entry><option>to</option></entry>
42047 <entry>Use: <emphasis>autoreply</emphasis></entry>
42048 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
42049 <entry>Default: <emphasis>unset</emphasis></entry>
42050 </row>
42051 </tbody>
42052 </tgroup>
42053 </informaltable>
42054 <para>
42055 This specifies recipients of the message and the contents of the <emphasis>To:</emphasis> header
42056 when the message is specified by the transport.
42057 <indexterm role="concept" startref="IIDauttra1" class="endofrange"/>
42058 <indexterm role="concept" startref="IIDauttra2" class="endofrange"/>
42059 </para>
42060 </section>
42061 </chapter>
42062
42063 <chapter id="CHAPLMTP">
42064 <title>The lmtp transport</title>
42065 <para>
42066 <indexterm role="concept">
42067 <primary>transports</primary>
42068 <secondary><command>lmtp</command></secondary>
42069 </indexterm>
42070 <indexterm role="concept">
42071 <primary><command>lmtp</command> transport</primary>
42072 </indexterm>
42073 <indexterm role="concept">
42074 <primary>LMTP</primary>
42075 <secondary>over a pipe</secondary>
42076 </indexterm>
42077 <indexterm role="concept">
42078 <primary>LMTP</primary>
42079 <secondary>over a socket</secondary>
42080 </indexterm>
42081 The <command>lmtp</command> transport runs the LMTP protocol (RFC 2033) over a pipe to a
42082 specified command
42083 or by interacting with a Unix domain socket.
42084 This transport is something of a cross between the <command>pipe</command> and <command>smtp</command>
42085 transports. Exim also has support for using LMTP over TCP/IP; this is
42086 implemented as an option for the <command>smtp</command> transport. Because LMTP is expected
42087 to be of minority interest, the default build-time configure in <filename>src/EDITME</filename>
42088 has it commented out. You need to ensure that
42089 </para>
42090 <literallayout class="monospaced">
42091 TRANSPORT_LMTP=yes
42092 </literallayout>
42093 <para>
42094 <indexterm role="concept">
42095 <primary>options</primary>
42096 <secondary><command>lmtp</command> transport</secondary>
42097 </indexterm>
42098 is present in your <filename>Local/Makefile</filename> in order to have the <command>lmtp</command> transport
42099 included in the Exim binary. The private options of the <command>lmtp</command> transport are
42100 as follows:
42101 </para>
42102 <para>
42103 <indexterm role="option">
42104 <primary><option>batch_id</option></primary>
42105 </indexterm>
42106 </para>
42107 <informaltable frame="all">
42108 <tgroup cols="4" colsep="0" rowsep="0">
42109 <colspec colwidth="8*" align="left"/>
42110 <colspec colwidth="6*" align="center"/>
42111 <colspec colwidth="6*" align="center"/>
42112 <colspec colwidth="6*" align="right"/>
42113 <tbody>
42114 <row>
42115 <entry><option>batch_id</option></entry>
42116 <entry>Use: <emphasis>lmtp</emphasis></entry>
42117 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
42118 <entry>Default: <emphasis>unset</emphasis></entry>
42119 </row>
42120 </tbody>
42121 </tgroup>
42122 </informaltable>
42123 <para>
42124 See the description of local delivery batching in chapter <xref linkend="CHAPbatching"/>.
42125 </para>
42126 <para>
42127 <indexterm role="option">
42128 <primary><option>batch_max</option></primary>
42129 </indexterm>
42130 </para>
42131 <informaltable frame="all">
42132 <tgroup cols="4" colsep="0" rowsep="0">
42133 <colspec colwidth="8*" align="left"/>
42134 <colspec colwidth="6*" align="center"/>
42135 <colspec colwidth="6*" align="center"/>
42136 <colspec colwidth="6*" align="right"/>
42137 <tbody>
42138 <row>
42139 <entry><option>batch_max</option></entry>
42140 <entry>Use: <emphasis>lmtp</emphasis></entry>
42141 <entry>Type: <emphasis>integer</emphasis></entry>
42142 <entry>Default: <emphasis>1</emphasis></entry>
42143 </row>
42144 </tbody>
42145 </tgroup>
42146 </informaltable>
42147 <para>
42148 This limits the number of addresses that can be handled in a single delivery.
42149 Most LMTP servers can handle several addresses at once, so it is normally a
42150 good idea to increase this value. See the description of local delivery
42151 batching in chapter <xref linkend="CHAPbatching"/>.
42152 </para>
42153 <para>
42154 <indexterm role="option">
42155 <primary><option>command</option></primary>
42156 </indexterm>
42157 </para>
42158 <informaltable frame="all">
42159 <tgroup cols="4" colsep="0" rowsep="0">
42160 <colspec colwidth="8*" align="left"/>
42161 <colspec colwidth="6*" align="center"/>
42162 <colspec colwidth="6*" align="center"/>
42163 <colspec colwidth="6*" align="right"/>
42164 <tbody>
42165 <row>
42166 <entry><option>command</option></entry>
42167 <entry>Use: <emphasis>lmtp</emphasis></entry>
42168 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
42169 <entry>Default: <emphasis>unset</emphasis></entry>
42170 </row>
42171 </tbody>
42172 </tgroup>
42173 </informaltable>
42174 <para>
42175 This option must be set if <option>socket</option> is not set. The string is a command which
42176 is run in a separate process. It is split up into a command name and list of
42177 arguments, each of which is separately expanded (so expansion cannot change the
42178 number of arguments). The command is run directly, not via a shell. The message
42179 is passed to the new process using the standard input and output to operate the
42180 LMTP protocol.
42181 </para>
42182 <para>
42183 <indexterm role="option">
42184 <primary><option>ignore_quota</option></primary>
42185 </indexterm>
42186 </para>
42187 <informaltable frame="all">
42188 <tgroup cols="4" colsep="0" rowsep="0">
42189 <colspec colwidth="8*" align="left"/>
42190 <colspec colwidth="6*" align="center"/>
42191 <colspec colwidth="6*" align="center"/>
42192 <colspec colwidth="6*" align="right"/>
42193 <tbody>
42194 <row>
42195 <entry><option>ignore_quota</option></entry>
42196 <entry>Use: <emphasis>lmtp</emphasis></entry>
42197 <entry>Type: <emphasis>boolean</emphasis></entry>
42198 <entry>Default: <emphasis>false</emphasis></entry>
42199 </row>
42200 </tbody>
42201 </tgroup>
42202 </informaltable>
42203 <para>
42204 <indexterm role="concept">
42205 <primary>LMTP</primary>
42206 <secondary>ignoring quota errors</secondary>
42207 </indexterm>
42208 If this option is set true, the string <literal>IGNOREQUOTA</literal> is added to RCPT
42209 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
42210 in its response to the LHLO command.
42211 </para>
42212 <para>
42213 <indexterm role="option">
42214 <primary><option>socket</option></primary>
42215 </indexterm>
42216 </para>
42217 <informaltable frame="all">
42218 <tgroup cols="4" colsep="0" rowsep="0">
42219 <colspec colwidth="8*" align="left"/>
42220 <colspec colwidth="6*" align="center"/>
42221 <colspec colwidth="6*" align="center"/>
42222 <colspec colwidth="6*" align="right"/>
42223 <tbody>
42224 <row>
42225 <entry><option>socket</option></entry>
42226 <entry>Use: <emphasis>lmtp</emphasis></entry>
42227 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
42228 <entry>Default: <emphasis>unset</emphasis></entry>
42229 </row>
42230 </tbody>
42231 </tgroup>
42232 </informaltable>
42233 <para>
42234 This option must be set if <option>command</option> is not set. The result of expansion must
42235 be the name of a Unix domain socket. The transport connects to the socket and
42236 delivers the message to it using the LMTP protocol.
42237 </para>
42238 <para>
42239 <indexterm role="option">
42240 <primary><option>timeout</option></primary>
42241 </indexterm>
42242 </para>
42243 <informaltable frame="all">
42244 <tgroup cols="4" colsep="0" rowsep="0">
42245 <colspec colwidth="8*" align="left"/>
42246 <colspec colwidth="6*" align="center"/>
42247 <colspec colwidth="6*" align="center"/>
42248 <colspec colwidth="6*" align="right"/>
42249 <tbody>
42250 <row>
42251 <entry><option>timeout</option></entry>
42252 <entry>Use: <emphasis>lmtp</emphasis></entry>
42253 <entry>Type: <emphasis>time</emphasis></entry>
42254 <entry>Default: <emphasis>5m</emphasis></entry>
42255 </row>
42256 </tbody>
42257 </tgroup>
42258 </informaltable>
42259 <para>
42260 The transport is aborted if the created process or Unix domain socket does not
42261 respond to LMTP commands or message input within this timeout. Delivery
42262 is deferred, and will be tried again later. Here is an example of a typical
42263 LMTP transport:
42264 </para>
42265 <literallayout class="monospaced">
42266 lmtp:
42267   driver = lmtp
42268   command = /some/local/lmtp/delivery/program
42269   batch_max = 20
42270   user = exim
42271 </literallayout>
42272 <para>
42273 This delivers up to 20 addresses at a time, in a mixture of domains if
42274 necessary, running as the user <emphasis>exim</emphasis>.
42275 </para>
42276 </chapter>
42277
42278 <chapter id="CHAPpipetransport">
42279 <title>The pipe transport</title>
42280 <para>
42281 <indexterm role="concept" id="IIDpiptra1" class="startofrange">
42282 <primary>transports</primary>
42283 <secondary><command>pipe</command></secondary>
42284 </indexterm>
42285 <indexterm role="concept" id="IIDpiptra2" class="startofrange">
42286 <primary><command>pipe</command> transport</primary>
42287 </indexterm>
42288 The <command>pipe</command> transport is used to deliver messages via a pipe to a command
42289 running in another process. One example is the use of <command>pipe</command> as a
42290 pseudo-remote transport for passing messages to some other delivery mechanism
42291 (such as UUCP). Another is the use by individual users to automatically process
42292 their incoming messages. The <command>pipe</command> transport can be used in one of the
42293 following ways:
42294 </para>
42295 <itemizedlist>
42296 <listitem>
42297 <para>
42298 <indexterm role="variable">
42299 <primary><varname>$local_part</varname></primary>
42300 </indexterm>
42301 A router routes one address to a transport in the normal way, and the
42302 transport is configured as a <command>pipe</command> transport. In this case, <varname>$local_part</varname>
42303 contains the local part of the address (as usual), and the command that is run
42304 is specified by the <option>command</option> option on the transport.
42305 </para>
42306 </listitem>
42307 <listitem>
42308 <para>
42309 <indexterm role="variable">
42310 <primary><varname>$pipe_addresses</varname></primary>
42311 </indexterm>
42312 If the <option>batch_max</option> option is set greater than 1 (the default is 1), the
42313 transport can handle more than one address in a single run. In this case, when
42314 more than one address is routed to the transport, <varname>$local_part</varname> is not set
42315 (because it is not unique). However, the pseudo-variable <varname>$pipe_addresses</varname>
42316 (described in section <xref linkend="SECThowcommandrun"/> below) contains all the addresses
42317 that are routed to the transport.
42318 </para>
42319 </listitem>
42320 <listitem>
42321 <para>
42322 <indexterm role="variable">
42323 <primary><varname>$address_pipe</varname></primary>
42324 </indexterm>
42325 A router redirects an address directly to a pipe command (for example, from an
42326 alias or forward file). In this case, <varname>$address_pipe</varname> contains the text of the
42327 pipe command, and the <option>command</option> option on the transport is ignored unless
42328 <option>force_command</option> is set. If only one address is being transported
42329 (<option>batch_max</option> is not greater than one, or only one address was redirected to
42330 this pipe command), <varname>$local_part</varname> contains the local part that was redirected.
42331 </para>
42332 </listitem>
42333 </itemizedlist>
42334 <para>
42335 The <command>pipe</command> transport is a non-interactive delivery method. Exim can also
42336 deliver messages over pipes using the LMTP interactive protocol. This is
42337 implemented by the <command>lmtp</command> transport.
42338 </para>
42339 <para>
42340 In the case when <command>pipe</command> is run as a consequence of an entry in a local user&#x2019;s
42341 <filename>.forward</filename> file, the command runs under the uid and gid of that user. In
42342 other cases, the uid and gid have to be specified explicitly, either on the
42343 transport or on the router that handles the address. Current and <quote>home</quote>
42344 directories are also controllable. See chapter <xref linkend="CHAPenvironment"/> for
42345 details of the local delivery environment and chapter <xref linkend="CHAPbatching"/>
42346 for a discussion of local delivery batching.
42347 </para>
42348 <section id="SECID140">
42349 <title>Concurrent delivery</title>
42350 <para>
42351 If two messages arrive at almost the same time, and both are routed to a pipe
42352 delivery, the two pipe transports may be run concurrently. You must ensure that
42353 any pipe commands you set up are robust against this happening. If the commands
42354 write to a file, the <option>exim_lock</option> utility might be of use.
42355 </para>
42356 </section>
42357 <section id="SECID141">
42358 <title>Returned status and data</title>
42359 <para>
42360 <indexterm role="concept">
42361 <primary><command>pipe</command> transport</primary>
42362 <secondary>returned data</secondary>
42363 </indexterm>
42364 If the command exits with a non-zero return code, the delivery is deemed to
42365 have failed, unless either the <option>ignore_status</option> option is set (in which case
42366 the return code is treated as zero), or the return code is one of those listed
42367 in the <option>temp_errors</option> option, which are interpreted as meaning <quote>try again
42368 later</quote>. In this case, delivery is deferred. Details of a permanent failure are
42369 logged, but are not included in the bounce message, which merely contains
42370 <quote>local delivery failed</quote>.
42371 </para>
42372 <para>
42373 If the command exits on a signal and the <option>freeze_signal</option> option is set then
42374 the message will be frozen in the queue. If that option is not set, a bounce
42375 will be sent as normal.
42376 </para>
42377 <para>
42378 If the return code is greater than 128 and the command being run is a shell
42379 script, it normally means that the script was terminated by a signal whose
42380 value is the return code minus 128. The <option>freeze_signal</option> option does not
42381 apply in this case.
42382 </para>
42383 <para>
42384 If Exim is unable to run the command (that is, if <function>execve()</function> fails), the
42385 return code is set to 127. This is the value that a shell returns if it is
42386 asked to run a non-existent command. The wording for the log line suggests that
42387 a non-existent command may be the problem.
42388 </para>
42389 <para>
42390 The <option>return_output</option> option can affect the result of a pipe delivery. If it is
42391 set and the command produces any output on its standard output or standard
42392 error streams, the command is considered to have failed, even if it gave a zero
42393 return code or if <option>ignore_status</option> is set. The output from the command is
42394 included as part of the bounce message. The <option>return_fail_output</option> option is
42395 similar, except that output is returned only when the command exits with a
42396 failure return code, that is, a value other than zero or a code that matches
42397 <option>temp_errors</option>.
42398 </para>
42399 </section>
42400 <section id="SECThowcommandrun">
42401 <title>How the command is run</title>
42402 <para>
42403 <indexterm role="concept">
42404 <primary><command>pipe</command> transport</primary>
42405 <secondary>path for command</secondary>
42406 </indexterm>
42407 The command line is (by default) broken down into a command name and arguments
42408 by the <command>pipe</command> transport itself. The <option>allow_commands</option> and
42409 <option>restrict_to_path</option> options can be used to restrict the commands that may be
42410 run.
42411 </para>
42412 <para>
42413 <indexterm role="concept">
42414 <primary>quoting</primary>
42415 <secondary>in pipe command</secondary>
42416 </indexterm>
42417 Unquoted arguments are delimited by white space. If an argument appears in
42418 double quotes, backslash is interpreted as an escape character in the usual
42419 way. If an argument appears in single quotes, no escaping is done.
42420 </para>
42421 <para>
42422 String expansion is applied to the command line except when it comes from a
42423 traditional <filename>.forward</filename> file (commands from a filter file are expanded). The
42424 expansion is applied to each argument in turn rather than to the whole line.
42425 For this reason, any string expansion item that contains white space must be
42426 quoted so as to be contained within a single argument. A setting such as
42427 </para>
42428 <literallayout class="monospaced">
42429 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
42430 </literallayout>
42431 <para>
42432 will not work, because the expansion item gets split between several
42433 arguments. You have to write
42434 </para>
42435 <literallayout class="monospaced">
42436 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
42437 </literallayout>
42438 <para>
42439 to ensure that it is all in one argument. The expansion is done in this way,
42440 argument by argument, so that the number of arguments cannot be changed as a
42441 result of expansion, and quotes or backslashes in inserted variables do not
42442 interact with external quoting. However, this leads to problems if you want to
42443 generate multiple arguments (or the command name plus arguments) from a single
42444 expansion. In this situation, the simplest solution is to use a shell. For
42445 example:
42446 </para>
42447 <literallayout class="monospaced">
42448 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
42449 </literallayout>
42450 <para>
42451 <indexterm role="concept">
42452 <primary>transport</primary>
42453 <secondary>filter</secondary>
42454 </indexterm>
42455 <indexterm role="concept">
42456 <primary>filter</primary>
42457 <secondary>transport filter</secondary>
42458 </indexterm>
42459 <indexterm role="variable">
42460 <primary><varname>$pipe_addresses</varname></primary>
42461 </indexterm>
42462 Special handling takes place when an argument consists of precisely the text
42463 <literal>$pipe_addresses</literal>. This is not a general expansion variable; the only
42464 place this string is recognized is when it appears as an argument for a pipe or
42465 transport filter command. It causes each address that is being handled to be
42466 inserted in the argument list at that point <emphasis>as a separate argument</emphasis>. This
42467 avoids any problems with spaces or shell metacharacters, and is of use when a
42468 <command>pipe</command> transport is handling groups of addresses in a batch.
42469 </para>
42470 <para>
42471 If <option>force_command</option> is enabled on the transport, Special handling takes place
42472 for an argument that consists of precisely the text <literal>$address_pipe</literal>.  It
42473 is handled similarly to <varname>$pipe_addresses</varname> above.  It is expanded and each
42474 argument is inserted in the argument list at that point
42475 <emphasis>as a separate argument</emphasis>.  The <literal>$address_pipe</literal> item does not need to be
42476 the only item in the argument; in fact, if it were then <option>force_command</option>
42477 should behave as a no-op.  Rather, it should be used to adjust the command
42478 run while preserving the argument vector separation.
42479 </para>
42480 <para>
42481 After splitting up into arguments and expansion, the resulting command is run
42482 in a subprocess directly from the transport, <emphasis>not</emphasis> under a shell. The
42483 message that is being delivered is supplied on the standard input, and the
42484 standard output and standard error are both connected to a single pipe that is
42485 read by Exim. The <option>max_output</option> option controls how much output the command
42486 may produce, and the <option>return_output</option> and <option>return_fail_output</option> options
42487 control what is done with it.
42488 </para>
42489 <para>
42490 Not running the command under a shell (by default) lessens the security risks
42491 in cases when a command from a user&#x2019;s filter file is built out of data that was
42492 taken from an incoming message. If a shell is required, it can of course be
42493 explicitly specified as the command to be run. However, there are circumstances
42494 where existing commands (for example, in <filename>.forward</filename> files) expect to be run
42495 under a shell and cannot easily be modified. To allow for these cases, there is
42496 an option called <option>use_shell</option>, which changes the way the <command>pipe</command> transport
42497 works. Instead of breaking up the command line as just described, it expands it
42498 as a single string and passes the result to <filename>/bin/sh</filename>. The
42499 <option>restrict_to_path</option> option and the <varname>$pipe_addresses</varname> facility cannot be used
42500 with <option>use_shell</option>, and the whole mechanism is inherently less secure.
42501 </para>
42502 </section>
42503 <section id="SECTpipeenv">
42504 <title>Environment variables</title>
42505 <para>
42506 <indexterm role="concept">
42507 <primary><command>pipe</command> transport</primary>
42508 <secondary>environment for command</secondary>
42509 </indexterm>
42510 <indexterm role="concept">
42511 <primary>environment for pipe transport</primary>
42512 </indexterm>
42513 The environment variables listed below are set up when the command is invoked.
42514 This list is a compromise for maximum compatibility with other MTAs. Note that
42515 the <option>environment</option> option can be used to add additional variables to this
42516 environment.
42517 </para>
42518 <literallayout>
42519 <literal>DOMAIN            </literal>   the domain of the address
42520 <literal>HOME              </literal>   the home directory, if set
42521 <literal>HOST              </literal>   the host name when called from a router (see below)
42522 <literal>LOCAL_PART        </literal>   see below
42523 <literal>LOCAL_PART_PREFIX </literal>   see below
42524 <literal>LOCAL_PART_SUFFIX </literal>   see below
42525 <literal>LOGNAME           </literal>   see below
42526 <literal>MESSAGE_ID        </literal>   Exim&#x2019;s local ID for the message
42527 <literal>PATH              </literal>   as specified by the <option>path</option> option below
42528 <literal>QUALIFY_DOMAIN    </literal>   the sender qualification domain
42529 <literal>RECIPIENT         </literal>   the complete recipient address
42530 <literal>SENDER            </literal>   the sender of the message (empty if a bounce)
42531 <literal>SHELL             </literal>   <literal>/bin/sh</literal>
42532 <literal>TZ                </literal>   the value of the <option>timezone</option> option, if set
42533 <literal>USER              </literal>   see below
42534 </literallayout>
42535 <para>
42536 When a <command>pipe</command> transport is called directly from (for example) an <command>accept</command>
42537 router, LOCAL_PART is set to the local part of the address. When it is
42538 called as a result of a forward or alias expansion, LOCAL_PART is set to
42539 the local part of the address that was expanded. In both cases, any affixes are
42540 removed from the local part, and made available in LOCAL_PART_PREFIX and
42541 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
42542 same value as LOCAL_PART for compatibility with other MTAs.
42543 </para>
42544 <para>
42545 <indexterm role="concept">
42546 <primary>HOST</primary>
42547 </indexterm>
42548 HOST is set only when a <command>pipe</command> transport is called from a router that
42549 associates hosts with an address, typically when using <command>pipe</command> as a
42550 pseudo-remote transport. HOST is set to the first host name specified by
42551 the router.
42552 </para>
42553 <para>
42554 <indexterm role="concept">
42555 <primary>HOME</primary>
42556 </indexterm>
42557 If the transport&#x2019;s generic <option>home_directory</option> option is set, its value is used
42558 for the HOME environment variable. Otherwise, a home directory may be set
42559 by the router&#x2019;s <option>transport_home_directory</option> option, which defaults to the
42560 user&#x2019;s home directory if <option>check_local_user</option> is set.
42561 </para>
42562 </section>
42563 <section id="SECID142">
42564 <title>Private options for pipe</title>
42565 <para>
42566 <indexterm role="concept">
42567 <primary>options</primary>
42568 <secondary><command>pipe</command> transport</secondary>
42569 </indexterm>
42570 </para>
42571 <para>
42572 <indexterm role="option">
42573 <primary><option>allow_commands</option></primary>
42574 </indexterm>
42575 </para>
42576 <informaltable frame="all">
42577 <tgroup cols="4" colsep="0" rowsep="0">
42578 <colspec colwidth="8*" align="left"/>
42579 <colspec colwidth="6*" align="center"/>
42580 <colspec colwidth="6*" align="center"/>
42581 <colspec colwidth="6*" align="right"/>
42582 <tbody>
42583 <row>
42584 <entry><option>allow_commands</option></entry>
42585 <entry>Use: <emphasis>pipe</emphasis></entry>
42586 <entry>Type: <emphasis>string list</emphasis>&dagger;<emphasis></emphasis></entry>
42587 <entry>Default: <emphasis>unset</emphasis></entry>
42588 </row>
42589 </tbody>
42590 </tgroup>
42591 </informaltable>
42592 <para>
42593 <indexterm role="concept">
42594 <primary><command>pipe</command> transport</primary>
42595 <secondary>permitted commands</secondary>
42596 </indexterm>
42597 The string is expanded, and is then interpreted as a colon-separated list of
42598 permitted commands. If <option>restrict_to_path</option> is not set, the only commands
42599 permitted are those in the <option>allow_commands</option> list. They need not be absolute
42600 paths; the <option>path</option> option is still used for relative paths. If
42601 <option>restrict_to_path</option> is set with <option>allow_commands</option>, the command must either be
42602 in the <option>allow_commands</option> list, or a name without any slashes that is found on
42603 the path. In other words, if neither <option>allow_commands</option> nor
42604 <option>restrict_to_path</option> is set, there is no restriction on the command, but
42605 otherwise only commands that are permitted by one or the other are allowed. For
42606 example, if
42607 </para>
42608 <literallayout class="monospaced">
42609 allow_commands = /usr/bin/vacation
42610 </literallayout>
42611 <para>
42612 and <option>restrict_to_path</option> is not set, the only permitted command is
42613 <filename>/usr/bin/vacation</filename>. The <option>allow_commands</option> option may not be set if
42614 <option>use_shell</option> is set.
42615 </para>
42616 <para>
42617 <indexterm role="option">
42618 <primary><option>batch_id</option></primary>
42619 </indexterm>
42620 </para>
42621 <informaltable frame="all">
42622 <tgroup cols="4" colsep="0" rowsep="0">
42623 <colspec colwidth="8*" align="left"/>
42624 <colspec colwidth="6*" align="center"/>
42625 <colspec colwidth="6*" align="center"/>
42626 <colspec colwidth="6*" align="right"/>
42627 <tbody>
42628 <row>
42629 <entry><option>batch_id</option></entry>
42630 <entry>Use: <emphasis>pipe</emphasis></entry>
42631 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
42632 <entry>Default: <emphasis>unset</emphasis></entry>
42633 </row>
42634 </tbody>
42635 </tgroup>
42636 </informaltable>
42637 <para>
42638 See the description of local delivery batching in chapter <xref linkend="CHAPbatching"/>.
42639 </para>
42640 <para>
42641 <indexterm role="option">
42642 <primary><option>batch_max</option></primary>
42643 </indexterm>
42644 </para>
42645 <informaltable frame="all">
42646 <tgroup cols="4" colsep="0" rowsep="0">
42647 <colspec colwidth="8*" align="left"/>
42648 <colspec colwidth="6*" align="center"/>
42649 <colspec colwidth="6*" align="center"/>
42650 <colspec colwidth="6*" align="right"/>
42651 <tbody>
42652 <row>
42653 <entry><option>batch_max</option></entry>
42654 <entry>Use: <emphasis>pipe</emphasis></entry>
42655 <entry>Type: <emphasis>integer</emphasis></entry>
42656 <entry>Default: <emphasis>1</emphasis></entry>
42657 </row>
42658 </tbody>
42659 </tgroup>
42660 </informaltable>
42661 <para>
42662 This limits the number of addresses that can be handled in a single delivery.
42663 See the description of local delivery batching in chapter <xref linkend="CHAPbatching"/>.
42664 </para>
42665 <para>
42666 <indexterm role="option">
42667 <primary><option>check_string</option></primary>
42668 </indexterm>
42669 </para>
42670 <informaltable frame="all">
42671 <tgroup cols="4" colsep="0" rowsep="0">
42672 <colspec colwidth="8*" align="left"/>
42673 <colspec colwidth="6*" align="center"/>
42674 <colspec colwidth="6*" align="center"/>
42675 <colspec colwidth="6*" align="right"/>
42676 <tbody>
42677 <row>
42678 <entry><option>check_string</option></entry>
42679 <entry>Use: <emphasis>pipe</emphasis></entry>
42680 <entry>Type: <emphasis>string</emphasis></entry>
42681 <entry>Default: <emphasis>unset</emphasis></entry>
42682 </row>
42683 </tbody>
42684 </tgroup>
42685 </informaltable>
42686 <para>
42687 As <command>pipe</command> writes the message, the start of each line is tested for matching
42688 <option>check_string</option>, and if it does, the initial matching characters are replaced
42689 by the contents of <option>escape_string</option>, provided both are set. The value of
42690 <option>check_string</option> is a literal string, not a regular expression, and the case of
42691 any letters it contains is significant. When <option>use_bsmtp</option> is set, the contents
42692 of <option>check_string</option> and <option>escape_string</option> are forced to values that implement
42693 the SMTP escaping protocol. Any settings made in the configuration file are
42694 ignored.
42695 </para>
42696 <para>
42697 <indexterm role="option">
42698 <primary><option>command</option></primary>
42699 </indexterm>
42700 </para>
42701 <informaltable frame="all">
42702 <tgroup cols="4" colsep="0" rowsep="0">
42703 <colspec colwidth="8*" align="left"/>
42704 <colspec colwidth="6*" align="center"/>
42705 <colspec colwidth="6*" align="center"/>
42706 <colspec colwidth="6*" align="right"/>
42707 <tbody>
42708 <row>
42709 <entry><option>command</option></entry>
42710 <entry>Use: <emphasis>pipe</emphasis></entry>
42711 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
42712 <entry>Default: <emphasis>unset</emphasis></entry>
42713 </row>
42714 </tbody>
42715 </tgroup>
42716 </informaltable>
42717 <para>
42718 This option need not be set when <command>pipe</command> is being used to deliver to pipes
42719 obtained directly from address redirections. In other cases, the option must be
42720 set, to provide a command to be run. It need not yield an absolute path (see
42721 the <option>path</option> option below). The command is split up into separate arguments by
42722 Exim, and each argument is separately expanded, as described in section
42723 <xref linkend="SECThowcommandrun"/> above.
42724 </para>
42725 <para>
42726 <indexterm role="option">
42727 <primary><option>environment</option></primary>
42728 </indexterm>
42729 </para>
42730 <informaltable frame="all">
42731 <tgroup cols="4" colsep="0" rowsep="0">
42732 <colspec colwidth="8*" align="left"/>
42733 <colspec colwidth="6*" align="center"/>
42734 <colspec colwidth="6*" align="center"/>
42735 <colspec colwidth="6*" align="right"/>
42736 <tbody>
42737 <row>
42738 <entry><option>environment</option></entry>
42739 <entry>Use: <emphasis>pipe</emphasis></entry>
42740 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
42741 <entry>Default: <emphasis>unset</emphasis></entry>
42742 </row>
42743 </tbody>
42744 </tgroup>
42745 </informaltable>
42746 <para>
42747 <indexterm role="concept">
42748 <primary><command>pipe</command> transport</primary>
42749 <secondary>environment for command</secondary>
42750 </indexterm>
42751 <indexterm role="concept">
42752 <primary>environment for <command>pipe</command> transport</primary>
42753 </indexterm>
42754 This option is used to add additional variables to the environment in which the
42755 command runs (see section <xref linkend="SECTpipeenv"/> for the default list). Its value is
42756 a string which is expanded, and then interpreted as a colon-separated list of
42757 environment settings of the form &lt;<emphasis>name</emphasis>&gt;=&lt;<emphasis>value</emphasis>&gt;.
42758 </para>
42759 <para>
42760 <indexterm role="option">
42761 <primary><option>escape_string</option></primary>
42762 </indexterm>
42763 </para>
42764 <informaltable frame="all">
42765 <tgroup cols="4" colsep="0" rowsep="0">
42766 <colspec colwidth="8*" align="left"/>
42767 <colspec colwidth="6*" align="center"/>
42768 <colspec colwidth="6*" align="center"/>
42769 <colspec colwidth="6*" align="right"/>
42770 <tbody>
42771 <row>
42772 <entry><option>escape_string</option></entry>
42773 <entry>Use: <emphasis>pipe</emphasis></entry>
42774 <entry>Type: <emphasis>string</emphasis></entry>
42775 <entry>Default: <emphasis>unset</emphasis></entry>
42776 </row>
42777 </tbody>
42778 </tgroup>
42779 </informaltable>
42780 <para>
42781 See <option>check_string</option> above.
42782 </para>
42783 <para>
42784 <indexterm role="option">
42785 <primary><option>freeze_exec_fail</option></primary>
42786 </indexterm>
42787 </para>
42788 <informaltable frame="all">
42789 <tgroup cols="4" colsep="0" rowsep="0">
42790 <colspec colwidth="8*" align="left"/>
42791 <colspec colwidth="6*" align="center"/>
42792 <colspec colwidth="6*" align="center"/>
42793 <colspec colwidth="6*" align="right"/>
42794 <tbody>
42795 <row>
42796 <entry><option>freeze_exec_fail</option></entry>
42797 <entry>Use: <emphasis>pipe</emphasis></entry>
42798 <entry>Type: <emphasis>boolean</emphasis></entry>
42799 <entry>Default: <emphasis>false</emphasis></entry>
42800 </row>
42801 </tbody>
42802 </tgroup>
42803 </informaltable>
42804 <para>
42805 <indexterm role="concept">
42806 <primary>exec failure</primary>
42807 </indexterm>
42808 <indexterm role="concept">
42809 <primary>failure of exec</primary>
42810 </indexterm>
42811 <indexterm role="concept">
42812 <primary><command>pipe</command> transport</primary>
42813 <secondary>failure of exec</secondary>
42814 </indexterm>
42815 Failure to exec the command in a pipe transport is by default treated like
42816 any other failure while running the command. However, if <option>freeze_exec_fail</option>
42817 is set, failure to exec is treated specially, and causes the message to be
42818 frozen, whatever the setting of <option>ignore_status</option>.
42819 </para>
42820 <para>
42821 <indexterm role="option">
42822 <primary><option>freeze_signal</option></primary>
42823 </indexterm>
42824 </para>
42825 <informaltable frame="all">
42826 <tgroup cols="4" colsep="0" rowsep="0">
42827 <colspec colwidth="8*" align="left"/>
42828 <colspec colwidth="6*" align="center"/>
42829 <colspec colwidth="6*" align="center"/>
42830 <colspec colwidth="6*" align="right"/>
42831 <tbody>
42832 <row>
42833 <entry><option>freeze_signal</option></entry>
42834 <entry>Use: <emphasis>pipe</emphasis></entry>
42835 <entry>Type: <emphasis>boolean</emphasis></entry>
42836 <entry>Default: <emphasis>false</emphasis></entry>
42837 </row>
42838 </tbody>
42839 </tgroup>
42840 </informaltable>
42841 <para>
42842 <indexterm role="concept">
42843 <primary>signal exit</primary>
42844 </indexterm>
42845 <indexterm role="concept">
42846 <primary><command>pipe</command> transport</primary>
42847 <secondary>,</secondary>
42848 </indexterm>
42849 Normally if the process run by a command in a pipe transport exits on a signal,
42850 a bounce message is sent. If <option>freeze_signal</option> is set, the message will be
42851 frozen in Exim&#x2019;s queue instead.
42852 </para>
42853 <para>
42854 <indexterm role="option">
42855 <primary><option>force_command</option></primary>
42856 </indexterm>
42857 </para>
42858 <informaltable frame="all">
42859 <tgroup cols="4" colsep="0" rowsep="0">
42860 <colspec colwidth="8*" align="left"/>
42861 <colspec colwidth="6*" align="center"/>
42862 <colspec colwidth="6*" align="center"/>
42863 <colspec colwidth="6*" align="right"/>
42864 <tbody>
42865 <row>
42866 <entry><option>force_command</option></entry>
42867 <entry>Use: <emphasis>pipe</emphasis></entry>
42868 <entry>Type: <emphasis>boolean</emphasis></entry>
42869 <entry>Default: <emphasis>false</emphasis></entry>
42870 </row>
42871 </tbody>
42872 </tgroup>
42873 </informaltable>
42874 <para>
42875 <indexterm role="concept">
42876 <primary>force command</primary>
42877 </indexterm>
42878 <indexterm role="concept">
42879 <primary><command>pipe</command> transport</primary>
42880 <secondary>,</secondary>
42881 </indexterm>
42882 Normally when a router redirects an address directly to a pipe command
42883 the <option>command</option> option on the transport is ignored.  If <option>force_command</option>
42884 is set, the <option>command</option> option will used. This is especially
42885 useful for forcing a wrapper or additional argument to be added to the
42886 command. For example:
42887 </para>
42888 <literallayout class="monospaced">
42889 command = /usr/bin/remote_exec myhost -- $address_pipe
42890 force_command
42891 </literallayout>
42892 <para>
42893 Note that <varname>$address_pipe</varname> is handled specially in <option>command</option> when
42894 <option>force_command</option> is set, expanding out to the original argument vector as
42895 separate items, similarly to a Unix shell <literal>"$@"</literal> construct.
42896 </para>
42897 <para>
42898 <indexterm role="option">
42899 <primary><option>ignore_status</option></primary>
42900 </indexterm>
42901 </para>
42902 <informaltable frame="all">
42903 <tgroup cols="4" colsep="0" rowsep="0">
42904 <colspec colwidth="8*" align="left"/>
42905 <colspec colwidth="6*" align="center"/>
42906 <colspec colwidth="6*" align="center"/>
42907 <colspec colwidth="6*" align="right"/>
42908 <tbody>
42909 <row>
42910 <entry><option>ignore_status</option></entry>
42911 <entry>Use: <emphasis>pipe</emphasis></entry>
42912 <entry>Type: <emphasis>boolean</emphasis></entry>
42913 <entry>Default: <emphasis>false</emphasis></entry>
42914 </row>
42915 </tbody>
42916 </tgroup>
42917 </informaltable>
42918 <para>
42919 If this option is true, the status returned by the subprocess that is set up to
42920 run the command is ignored, and Exim behaves as if zero had been returned.
42921 Otherwise, a non-zero status or termination by signal causes an error return
42922 from the transport unless the status value is one of those listed in
42923 <option>temp_errors</option>; these cause the delivery to be deferred and tried again later.
42924 </para>
42925 <para>
42926 <emphasis role="bold">Note</emphasis>: This option does not apply to timeouts, which do not return a status.
42927 See the <option>timeout_defer</option> option for how timeouts are handled.
42928 </para>
42929 <para>
42930 <indexterm role="option">
42931 <primary><option>log_defer_output</option></primary>
42932 </indexterm>
42933 </para>
42934 <informaltable frame="all">
42935 <tgroup cols="4" colsep="0" rowsep="0">
42936 <colspec colwidth="8*" align="left"/>
42937 <colspec colwidth="6*" align="center"/>
42938 <colspec colwidth="6*" align="center"/>
42939 <colspec colwidth="6*" align="right"/>
42940 <tbody>
42941 <row>
42942 <entry><option>log_defer_output</option></entry>
42943 <entry>Use: <emphasis>pipe</emphasis></entry>
42944 <entry>Type: <emphasis>boolean</emphasis></entry>
42945 <entry>Default: <emphasis>false</emphasis></entry>
42946 </row>
42947 </tbody>
42948 </tgroup>
42949 </informaltable>
42950 <para>
42951 <indexterm role="concept">
42952 <primary><command>pipe</command> transport</primary>
42953 <secondary>logging output</secondary>
42954 </indexterm>
42955 If this option is set, and the status returned by the command is
42956 one of the codes listed in <option>temp_errors</option> (that is, delivery was deferred),
42957 and any output was produced, the first line of it is written to the main log.
42958 </para>
42959 <para>
42960 <indexterm role="option">
42961 <primary><option>log_fail_output</option></primary>
42962 </indexterm>
42963 </para>
42964 <informaltable frame="all">
42965 <tgroup cols="4" colsep="0" rowsep="0">
42966 <colspec colwidth="8*" align="left"/>
42967 <colspec colwidth="6*" align="center"/>
42968 <colspec colwidth="6*" align="center"/>
42969 <colspec colwidth="6*" align="right"/>
42970 <tbody>
42971 <row>
42972 <entry><option>log_fail_output</option></entry>
42973 <entry>Use: <emphasis>pipe</emphasis></entry>
42974 <entry>Type: <emphasis>boolean</emphasis></entry>
42975 <entry>Default: <emphasis>false</emphasis></entry>
42976 </row>
42977 </tbody>
42978 </tgroup>
42979 </informaltable>
42980 <para>
42981 If this option is set, and the command returns any output, and also ends with a
42982 return code that is neither zero nor one of the return codes listed in
42983 <option>temp_errors</option> (that is, the delivery failed), the first line of output is
42984 written to the main log. This option and <option>log_output</option> are mutually exclusive.
42985 Only one of them may be set.
42986 </para>
42987 <para>
42988 <indexterm role="option">
42989 <primary><option>log_output</option></primary>
42990 </indexterm>
42991 </para>
42992 <informaltable frame="all">
42993 <tgroup cols="4" colsep="0" rowsep="0">
42994 <colspec colwidth="8*" align="left"/>
42995 <colspec colwidth="6*" align="center"/>
42996 <colspec colwidth="6*" align="center"/>
42997 <colspec colwidth="6*" align="right"/>
42998 <tbody>
42999 <row>
43000 <entry><option>log_output</option></entry>
43001 <entry>Use: <emphasis>pipe</emphasis></entry>
43002 <entry>Type: <emphasis>boolean</emphasis></entry>
43003 <entry>Default: <emphasis>false</emphasis></entry>
43004 </row>
43005 </tbody>
43006 </tgroup>
43007 </informaltable>
43008 <para>
43009 If this option is set and the command returns any output, the first line of
43010 output is written to the main log, whatever the return code. This option and
43011 <option>log_fail_output</option> are mutually exclusive. Only one of them may be set.
43012 </para>
43013 <para>
43014 <indexterm role="option">
43015 <primary><option>max_output</option></primary>
43016 </indexterm>
43017 </para>
43018 <informaltable frame="all">
43019 <tgroup cols="4" colsep="0" rowsep="0">
43020 <colspec colwidth="8*" align="left"/>
43021 <colspec colwidth="6*" align="center"/>
43022 <colspec colwidth="6*" align="center"/>
43023 <colspec colwidth="6*" align="right"/>
43024 <tbody>
43025 <row>
43026 <entry><option>max_output</option></entry>
43027 <entry>Use: <emphasis>pipe</emphasis></entry>
43028 <entry>Type: <emphasis>integer</emphasis></entry>
43029 <entry>Default: <emphasis>20K</emphasis></entry>
43030 </row>
43031 </tbody>
43032 </tgroup>
43033 </informaltable>
43034 <para>
43035 This specifies the maximum amount of output that the command may produce on its
43036 standard output and standard error file combined. If the limit is exceeded, the
43037 process running the command is killed. This is intended as a safety measure to
43038 catch runaway processes. The limit is applied independently of the settings of
43039 the options that control what is done with such output (for example,
43040 <option>return_output</option>). Because of buffering effects, the amount of output may
43041 exceed the limit by a small amount before Exim notices.
43042 </para>
43043 <para>
43044 <indexterm role="option">
43045 <primary><option>message_prefix</option></primary>
43046 </indexterm>
43047 </para>
43048 <informaltable frame="all">
43049 <tgroup cols="4" colsep="0" rowsep="0">
43050 <colspec colwidth="8*" align="left"/>
43051 <colspec colwidth="6*" align="center"/>
43052 <colspec colwidth="6*" align="center"/>
43053 <colspec colwidth="6*" align="right"/>
43054 <tbody>
43055 <row>
43056 <entry><option>message_prefix</option></entry>
43057 <entry>Use: <emphasis>pipe</emphasis></entry>
43058 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
43059 <entry>Default: <emphasis>see below</emphasis></entry>
43060 </row>
43061 </tbody>
43062 </tgroup>
43063 </informaltable>
43064 <para>
43065 The string specified here is expanded and output at the start of every message.
43066 The default is unset if <option>use_bsmtp</option> is set. Otherwise it is
43067 </para>
43068 <literallayout class="monospaced">
43069 message_prefix = \
43070   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
43071   ${tod_bsdinbox}\n
43072 </literallayout>
43073 <para>
43074 <indexterm role="concept">
43075 <primary>Cyrus</primary>
43076 </indexterm>
43077 <indexterm role="concept">
43078 <primary><option>tmail</option></primary>
43079 </indexterm>
43080 <indexterm role="concept">
43081 <primary><quote>From</quote> line</primary>
43082 </indexterm>
43083 This is required by the commonly used <filename>/usr/bin/vacation</filename> program.
43084 However, it must <emphasis>not</emphasis> be present if delivery is to the Cyrus IMAP server,
43085 or to the <option>tmail</option> local delivery agent. The prefix can be suppressed by
43086 setting
43087 </para>
43088 <literallayout class="monospaced">
43089 message_prefix =
43090 </literallayout>
43091 <para>
43092 <emphasis role="bold">Note:</emphasis> If you set <option>use_crlf</option> true, you must change any occurrences of
43093 <literal>\n</literal> to <literal>\r\n</literal> in <option>message_prefix</option>.
43094 </para>
43095 <para>
43096 <indexterm role="option">
43097 <primary><option>message_suffix</option></primary>
43098 </indexterm>
43099 </para>
43100 <informaltable frame="all">
43101 <tgroup cols="4" colsep="0" rowsep="0">
43102 <colspec colwidth="8*" align="left"/>
43103 <colspec colwidth="6*" align="center"/>
43104 <colspec colwidth="6*" align="center"/>
43105 <colspec colwidth="6*" align="right"/>
43106 <tbody>
43107 <row>
43108 <entry><option>message_suffix</option></entry>
43109 <entry>Use: <emphasis>pipe</emphasis></entry>
43110 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
43111 <entry>Default: <emphasis>see below</emphasis></entry>
43112 </row>
43113 </tbody>
43114 </tgroup>
43115 </informaltable>
43116 <para>
43117 The string specified here is expanded and output at the end of every message.
43118 The default is unset if <option>use_bsmtp</option> is set. Otherwise it is a single newline.
43119 The suffix can be suppressed by setting
43120 </para>
43121 <literallayout class="monospaced">
43122 message_suffix =
43123 </literallayout>
43124 <para>
43125 <emphasis role="bold">Note:</emphasis> If you set <option>use_crlf</option> true, you must change any occurrences of
43126 <literal>\n</literal> to <literal>\r\n</literal> in <option>message_suffix</option>.
43127 </para>
43128 <para>
43129 <indexterm role="option">
43130 <primary><option>path</option></primary>
43131 </indexterm>
43132 </para>
43133 <informaltable frame="all">
43134 <tgroup cols="4" colsep="0" rowsep="0">
43135 <colspec colwidth="8*" align="left"/>
43136 <colspec colwidth="6*" align="center"/>
43137 <colspec colwidth="6*" align="center"/>
43138 <colspec colwidth="6*" align="right"/>
43139 <tbody>
43140 <row>
43141 <entry><option>path</option></entry>
43142 <entry>Use: <emphasis>pipe</emphasis></entry>
43143 <entry>Type: <emphasis>string</emphasis></entry>
43144 <entry>Default: <emphasis>see below</emphasis></entry>
43145 </row>
43146 </tbody>
43147 </tgroup>
43148 </informaltable>
43149 <para>
43150 This option specifies the string that is set up in the PATH environment
43151 variable of the subprocess. The default is:
43152 </para>
43153 <literallayout class="monospaced">
43154 /bin:/usr/bin
43155 </literallayout>
43156 <para>
43157 If the <option>command</option> option does not yield an absolute path name, the command is
43158 sought in the PATH directories, in the usual way. <emphasis role="bold">Warning</emphasis>: This does not
43159 apply to a command specified as a transport filter.
43160 </para>
43161 <para>
43162 <indexterm role="option">
43163 <primary><option>permit_coredump</option></primary>
43164 </indexterm>
43165 </para>
43166 <informaltable frame="all">
43167 <tgroup cols="4" colsep="0" rowsep="0">
43168 <colspec colwidth="8*" align="left"/>
43169 <colspec colwidth="6*" align="center"/>
43170 <colspec colwidth="6*" align="center"/>
43171 <colspec colwidth="6*" align="right"/>
43172 <tbody>
43173 <row>
43174 <entry><option>permit_coredump</option></entry>
43175 <entry>Use: <emphasis>pipe</emphasis></entry>
43176 <entry>Type: <emphasis>boolean</emphasis></entry>
43177 <entry>Default: <emphasis>false</emphasis></entry>
43178 </row>
43179 </tbody>
43180 </tgroup>
43181 </informaltable>
43182 <para>
43183 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
43184 a core-dump of a pipe command, enable this command.  This enables core-dumps
43185 during delivery and affects both the Exim binary and the pipe command run.
43186 It is recommended that this option remain off unless and until you have a need
43187 for it and that this only be enabled when needed, as the risk of excessive
43188 resource consumption can be quite high.  Note also that Exim is typically
43189 installed as a setuid binary and most operating systems will inhibit coredumps
43190 of these by default, so further OS-specific action may be required.
43191 </para>
43192 <para>
43193 <indexterm role="option">
43194 <primary><option>pipe_as_creator</option></primary>
43195 </indexterm>
43196 </para>
43197 <informaltable frame="all">
43198 <tgroup cols="4" colsep="0" rowsep="0">
43199 <colspec colwidth="8*" align="left"/>
43200 <colspec colwidth="6*" align="center"/>
43201 <colspec colwidth="6*" align="center"/>
43202 <colspec colwidth="6*" align="right"/>
43203 <tbody>
43204 <row>
43205 <entry><option>pipe_as_creator</option></entry>
43206 <entry>Use: <emphasis>pipe</emphasis></entry>
43207 <entry>Type: <emphasis>boolean</emphasis></entry>
43208 <entry>Default: <emphasis>false</emphasis></entry>
43209 </row>
43210 </tbody>
43211 </tgroup>
43212 </informaltable>
43213 <para>
43214 <indexterm role="concept">
43215 <primary>uid (user id)</primary>
43216 <secondary>local delivery</secondary>
43217 </indexterm>
43218 If the generic <option>user</option> option is not set and this option is true, the delivery
43219 process is run under the uid that was in force when Exim was originally called
43220 to accept the message. If the group id is not otherwise set (via the generic
43221 <option>group</option> option), the gid that was in force when Exim was originally called to
43222 accept the message is used.
43223 </para>
43224 <para>
43225 <indexterm role="option">
43226 <primary><option>restrict_to_path</option></primary>
43227 </indexterm>
43228 </para>
43229 <informaltable frame="all">
43230 <tgroup cols="4" colsep="0" rowsep="0">
43231 <colspec colwidth="8*" align="left"/>
43232 <colspec colwidth="6*" align="center"/>
43233 <colspec colwidth="6*" align="center"/>
43234 <colspec colwidth="6*" align="right"/>
43235 <tbody>
43236 <row>
43237 <entry><option>restrict_to_path</option></entry>
43238 <entry>Use: <emphasis>pipe</emphasis></entry>
43239 <entry>Type: <emphasis>boolean</emphasis></entry>
43240 <entry>Default: <emphasis>false</emphasis></entry>
43241 </row>
43242 </tbody>
43243 </tgroup>
43244 </informaltable>
43245 <para>
43246 When this option is set, any command name not listed in <option>allow_commands</option> must
43247 contain no slashes. The command is searched for only in the directories listed
43248 in the <option>path</option> option. This option is intended for use in the case when a pipe
43249 command has been generated from a user&#x2019;s <filename>.forward</filename> file. This is usually
43250 handled by a <command>pipe</command> transport called <option>address_pipe</option>.
43251 </para>
43252 <para>
43253 <indexterm role="option">
43254 <primary><option>return_fail_output</option></primary>
43255 </indexterm>
43256 </para>
43257 <informaltable frame="all">
43258 <tgroup cols="4" colsep="0" rowsep="0">
43259 <colspec colwidth="8*" align="left"/>
43260 <colspec colwidth="6*" align="center"/>
43261 <colspec colwidth="6*" align="center"/>
43262 <colspec colwidth="6*" align="right"/>
43263 <tbody>
43264 <row>
43265 <entry><option>return_fail_output</option></entry>
43266 <entry>Use: <emphasis>pipe</emphasis></entry>
43267 <entry>Type: <emphasis>boolean</emphasis></entry>
43268 <entry>Default: <emphasis>false</emphasis></entry>
43269 </row>
43270 </tbody>
43271 </tgroup>
43272 </informaltable>
43273 <para>
43274 If this option is true, and the command produced any output and ended with a
43275 return code other than zero or one of the codes listed in <option>temp_errors</option> (that
43276 is, the delivery failed), the output is returned in the bounce message.
43277 However, if the message has a null sender (that is, it is itself a bounce
43278 message), output from the command is discarded. This option and
43279 <option>return_output</option> are mutually exclusive. Only one of them may be set.
43280 </para>
43281 <para>
43282 <indexterm role="option">
43283 <primary><option>return_output</option></primary>
43284 </indexterm>
43285 </para>
43286 <informaltable frame="all">
43287 <tgroup cols="4" colsep="0" rowsep="0">
43288 <colspec colwidth="8*" align="left"/>
43289 <colspec colwidth="6*" align="center"/>
43290 <colspec colwidth="6*" align="center"/>
43291 <colspec colwidth="6*" align="right"/>
43292 <tbody>
43293 <row>
43294 <entry><option>return_output</option></entry>
43295 <entry>Use: <emphasis>pipe</emphasis></entry>
43296 <entry>Type: <emphasis>boolean</emphasis></entry>
43297 <entry>Default: <emphasis>false</emphasis></entry>
43298 </row>
43299 </tbody>
43300 </tgroup>
43301 </informaltable>
43302 <para>
43303 If this option is true, and the command produced any output, the delivery is
43304 deemed to have failed whatever the return code from the command, and the output
43305 is returned in the bounce message. Otherwise, the output is just discarded.
43306 However, if the message has a null sender (that is, it is a bounce message),
43307 output from the command is always discarded, whatever the setting of this
43308 option. This option and <option>return_fail_output</option> are mutually exclusive. Only one
43309 of them may be set.
43310 </para>
43311 <para>
43312 <indexterm role="option">
43313 <primary><option>temp_errors</option></primary>
43314 </indexterm>
43315 </para>
43316 <informaltable frame="all">
43317 <tgroup cols="4" colsep="0" rowsep="0">
43318 <colspec colwidth="8*" align="left"/>
43319 <colspec colwidth="6*" align="center"/>
43320 <colspec colwidth="6*" align="center"/>
43321 <colspec colwidth="6*" align="right"/>
43322 <tbody>
43323 <row>
43324 <entry><option>temp_errors</option></entry>
43325 <entry>Use: <emphasis>pipe</emphasis></entry>
43326 <entry>Type: <emphasis>string list</emphasis></entry>
43327 <entry>Default: <emphasis>see below</emphasis></entry>
43328 </row>
43329 </tbody>
43330 </tgroup>
43331 </informaltable>
43332 <para>
43333 <indexterm role="concept">
43334 <primary><command>pipe</command> transport</primary>
43335 <secondary>temporary failure</secondary>
43336 </indexterm>
43337 This option contains either a colon-separated list of numbers, or a single
43338 asterisk. If <option>ignore_status</option> is false
43339 and <option>return_output</option> is not set,
43340 and the command exits with a non-zero return code, the failure is treated as
43341 temporary and the delivery is deferred if the return code matches one of the
43342 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
43343 codes are treated as permanent errors. The default setting contains the codes
43344 defined by EX_TEMPFAIL and EX_CANTCREAT in <filename>sysexits.h</filename>. If Exim is
43345 compiled on a system that does not define these macros, it assumes values of 75
43346 and 73, respectively.
43347 </para>
43348 <para>
43349 <indexterm role="option">
43350 <primary><option>timeout</option></primary>
43351 </indexterm>
43352 </para>
43353 <informaltable frame="all">
43354 <tgroup cols="4" colsep="0" rowsep="0">
43355 <colspec colwidth="8*" align="left"/>
43356 <colspec colwidth="6*" align="center"/>
43357 <colspec colwidth="6*" align="center"/>
43358 <colspec colwidth="6*" align="right"/>
43359 <tbody>
43360 <row>
43361 <entry><option>timeout</option></entry>
43362 <entry>Use: <emphasis>pipe</emphasis></entry>
43363 <entry>Type: <emphasis>time</emphasis></entry>
43364 <entry>Default: <emphasis>1h</emphasis></entry>
43365 </row>
43366 </tbody>
43367 </tgroup>
43368 </informaltable>
43369 <para>
43370 If the command fails to complete within this time, it is killed. This normally
43371 causes the delivery to fail (but see <option>timeout_defer</option>). A zero time interval
43372 specifies no timeout. In order to ensure that any subprocesses created by the
43373 command are also killed, Exim makes the initial process a process group leader,
43374 and kills the whole process group on a timeout. However, this can be defeated
43375 if one of the processes starts a new process group.
43376 </para>
43377 <para>
43378 <indexterm role="option">
43379 <primary><option>timeout_defer</option></primary>
43380 </indexterm>
43381 </para>
43382 <informaltable frame="all">
43383 <tgroup cols="4" colsep="0" rowsep="0">
43384 <colspec colwidth="8*" align="left"/>
43385 <colspec colwidth="6*" align="center"/>
43386 <colspec colwidth="6*" align="center"/>
43387 <colspec colwidth="6*" align="right"/>
43388 <tbody>
43389 <row>
43390 <entry><option>timeout_defer</option></entry>
43391 <entry>Use: <emphasis>pipe</emphasis></entry>
43392 <entry>Type: <emphasis>boolean</emphasis></entry>
43393 <entry>Default: <emphasis>false</emphasis></entry>
43394 </row>
43395 </tbody>
43396 </tgroup>
43397 </informaltable>
43398 <para>
43399 A timeout in a <command>pipe</command> transport, either in the command that the transport
43400 runs, or in a transport filter that is associated with it, is by default
43401 treated as a hard error, and the delivery fails. However, if <option>timeout_defer</option>
43402 is set true, both kinds of timeout become temporary errors, causing the
43403 delivery to be deferred.
43404 </para>
43405 <para>
43406 <indexterm role="option">
43407 <primary><option>umask</option></primary>
43408 </indexterm>
43409 </para>
43410 <informaltable frame="all">
43411 <tgroup cols="4" colsep="0" rowsep="0">
43412 <colspec colwidth="8*" align="left"/>
43413 <colspec colwidth="6*" align="center"/>
43414 <colspec colwidth="6*" align="center"/>
43415 <colspec colwidth="6*" align="right"/>
43416 <tbody>
43417 <row>
43418 <entry><option>umask</option></entry>
43419 <entry>Use: <emphasis>pipe</emphasis></entry>
43420 <entry>Type: <emphasis>octal integer</emphasis></entry>
43421 <entry>Default: <emphasis>022</emphasis></entry>
43422 </row>
43423 </tbody>
43424 </tgroup>
43425 </informaltable>
43426 <para>
43427 This specifies the umask setting for the subprocess that runs the command.
43428 </para>
43429 <para>
43430 <indexterm role="option">
43431 <primary><option>use_bsmtp</option></primary>
43432 </indexterm>
43433 </para>
43434 <informaltable frame="all">
43435 <tgroup cols="4" colsep="0" rowsep="0">
43436 <colspec colwidth="8*" align="left"/>
43437 <colspec colwidth="6*" align="center"/>
43438 <colspec colwidth="6*" align="center"/>
43439 <colspec colwidth="6*" align="right"/>
43440 <tbody>
43441 <row>
43442 <entry><option>use_bsmtp</option></entry>
43443 <entry>Use: <emphasis>pipe</emphasis></entry>
43444 <entry>Type: <emphasis>boolean</emphasis></entry>
43445 <entry>Default: <emphasis>false</emphasis></entry>
43446 </row>
43447 </tbody>
43448 </tgroup>
43449 </informaltable>
43450 <para>
43451 <indexterm role="concept">
43452 <primary>envelope sender</primary>
43453 </indexterm>
43454 If this option is set true, the <command>pipe</command> transport writes messages in <quote>batch
43455 SMTP</quote> format, with the envelope sender and recipient(s) included as SMTP
43456 commands. If you want to include a leading HELO command with such messages,
43457 you can do so by setting the <option>message_prefix</option> option. See section
43458 <xref linkend="SECTbatchSMTP"/> for details of batch SMTP.
43459 </para>
43460 <para>
43461 <indexterm role="option">
43462 <primary><option>use_classresources</option></primary>
43463 </indexterm>
43464 </para>
43465 <informaltable frame="all">
43466 <tgroup cols="4" colsep="0" rowsep="0">
43467 <colspec colwidth="8*" align="left"/>
43468 <colspec colwidth="6*" align="center"/>
43469 <colspec colwidth="6*" align="center"/>
43470 <colspec colwidth="6*" align="right"/>
43471 <tbody>
43472 <row>
43473 <entry><option>use_classresources</option></entry>
43474 <entry>Use: <emphasis>pipe</emphasis></entry>
43475 <entry>Type: <emphasis>boolean</emphasis></entry>
43476 <entry>Default: <emphasis>false</emphasis></entry>
43477 </row>
43478 </tbody>
43479 </tgroup>
43480 </informaltable>
43481 <para>
43482 <indexterm role="concept">
43483 <primary>class resources (BSD)</primary>
43484 </indexterm>
43485 This option is available only when Exim is running on FreeBSD, NetBSD, or
43486 BSD/OS. If it is set true, the <function>setclassresources()</function> function is used to set
43487 resource limits when a <command>pipe</command> transport is run to perform a delivery. The
43488 limits for the uid under which the pipe is to run are obtained from the login
43489 class database.
43490 </para>
43491 <para>
43492 <indexterm role="option">
43493 <primary><option>use_crlf</option></primary>
43494 </indexterm>
43495 </para>
43496 <informaltable frame="all">
43497 <tgroup cols="4" colsep="0" rowsep="0">
43498 <colspec colwidth="8*" align="left"/>
43499 <colspec colwidth="6*" align="center"/>
43500 <colspec colwidth="6*" align="center"/>
43501 <colspec colwidth="6*" align="right"/>
43502 <tbody>
43503 <row>
43504 <entry><option>use_crlf</option></entry>
43505 <entry>Use: <emphasis>pipe</emphasis></entry>
43506 <entry>Type: <emphasis>boolean</emphasis></entry>
43507 <entry>Default: <emphasis>false</emphasis></entry>
43508 </row>
43509 </tbody>
43510 </tgroup>
43511 </informaltable>
43512 <para>
43513 <indexterm role="concept">
43514 <primary>carriage return</primary>
43515 </indexterm>
43516 <indexterm role="concept">
43517 <primary>linefeed</primary>
43518 </indexterm>
43519 This option causes lines to be terminated with the two-character CRLF sequence
43520 (carriage return, linefeed) instead of just a linefeed character. In the case
43521 of batched SMTP, the byte sequence written to the pipe is then an exact image
43522 of what would be sent down a real SMTP connection.
43523 </para>
43524 <para>
43525 The contents of the <option>message_prefix</option> and <option>message_suffix</option> options are
43526 written verbatim, so must contain their own carriage return characters if these
43527 are needed. When <option>use_bsmtp</option> is not set, the default values for both
43528 <option>message_prefix</option> and <option>message_suffix</option> end with a single linefeed, so their
43529 values must be changed to end with <literal>\r\n</literal> if <option>use_crlf</option> is set.
43530 </para>
43531 <para>
43532 <indexterm role="option">
43533 <primary><option>use_shell</option></primary>
43534 </indexterm>
43535 </para>
43536 <informaltable frame="all">
43537 <tgroup cols="4" colsep="0" rowsep="0">
43538 <colspec colwidth="8*" align="left"/>
43539 <colspec colwidth="6*" align="center"/>
43540 <colspec colwidth="6*" align="center"/>
43541 <colspec colwidth="6*" align="right"/>
43542 <tbody>
43543 <row>
43544 <entry><option>use_shell</option></entry>
43545 <entry>Use: <emphasis>pipe</emphasis></entry>
43546 <entry>Type: <emphasis>boolean</emphasis></entry>
43547 <entry>Default: <emphasis>false</emphasis></entry>
43548 </row>
43549 </tbody>
43550 </tgroup>
43551 </informaltable>
43552 <para>
43553 <indexterm role="variable">
43554 <primary><varname>$pipe_addresses</varname></primary>
43555 </indexterm>
43556 If this option is set, it causes the command to be passed to <filename>/bin/sh</filename>
43557 instead of being run directly from the transport, as described in section
43558 <xref linkend="SECThowcommandrun"/>. This is less secure, but is needed in some situations
43559 where the command is expected to be run under a shell and cannot easily be
43560 modified. The <option>allow_commands</option> and <option>restrict_to_path</option> options, and the
43561 <literal>$pipe_addresses</literal> facility are incompatible with <option>use_shell</option>. The
43562 command is expanded as a single string, and handed to <filename>/bin/sh</filename> as data for
43563 its <option>-c</option> option.
43564 </para>
43565 </section>
43566 <section id="SECID143">
43567 <title>Using an external local delivery agent</title>
43568 <para>
43569 <indexterm role="concept">
43570 <primary>local delivery</primary>
43571 <secondary>using an external agent</secondary>
43572 </indexterm>
43573 <indexterm role="concept">
43574 <primary><emphasis>procmail</emphasis></primary>
43575 </indexterm>
43576 <indexterm role="concept">
43577 <primary>external local delivery</primary>
43578 </indexterm>
43579 <indexterm role="concept">
43580 <primary>delivery</primary>
43581 <secondary><emphasis>procmail</emphasis></secondary>
43582 </indexterm>
43583 <indexterm role="concept">
43584 <primary>delivery</primary>
43585 <secondary>by external agent</secondary>
43586 </indexterm>
43587 The <command>pipe</command> transport can be used to pass all messages that require local
43588 delivery to a separate local delivery agent such as <option>procmail</option>. When doing
43589 this, care must be taken to ensure that the pipe is run under an appropriate
43590 uid and gid. In some configurations one wants this to be a uid that is trusted
43591 by the delivery agent to supply the correct sender of the message. It may be
43592 necessary to recompile or reconfigure the delivery agent so that it trusts an
43593 appropriate user. The following is an example transport and router
43594 configuration for <option>procmail</option>:
43595 </para>
43596 <literallayout class="monospaced">
43597 # transport
43598 procmail_pipe:
43599   driver = pipe
43600   command = /usr/local/bin/procmail -d $local_part
43601   return_path_add
43602   delivery_date_add
43603   envelope_to_add
43604   check_string = "From "
43605   escape_string = "&gt;From "
43606   umask = 077
43607   user = $local_part
43608   group = mail
43609
43610 # router
43611 procmail:
43612   driver = accept
43613   check_local_user
43614   transport = procmail_pipe
43615 </literallayout>
43616 <para>
43617 In this example, the pipe is run as the local user, but with the group set to
43618 <emphasis>mail</emphasis>. An alternative is to run the pipe as a specific user such as <emphasis>mail</emphasis>
43619 or <emphasis>exim</emphasis>, but in this case you must arrange for <option>procmail</option> to trust that
43620 user to supply a correct sender address. If you do not specify either a
43621 <option>group</option> or a <option>user</option> option, the pipe command is run as the local user. The
43622 home directory is the user&#x2019;s home directory by default.
43623 </para>
43624 <para>
43625 <emphasis role="bold">Note</emphasis>: The command that the pipe transport runs does <emphasis>not</emphasis> begin with
43626 </para>
43627 <literallayout class="monospaced">
43628 IFS=" "
43629 </literallayout>
43630 <para>
43631 as shown in some <option>procmail</option> documentation, because Exim does not by default
43632 use a shell to run pipe commands.
43633 </para>
43634 <para>
43635 <indexterm role="concept">
43636 <primary>Cyrus</primary>
43637 </indexterm>
43638 The next example shows a transport and a router for a system where local
43639 deliveries are handled by the Cyrus IMAP server.
43640 </para>
43641 <literallayout class="monospaced">
43642 # transport
43643 local_delivery_cyrus:
43644   driver = pipe
43645   command = /usr/cyrus/bin/deliver \
43646             -m ${substr_1:$local_part_suffix} -- $local_part
43647   user = cyrus
43648   group = mail
43649   return_output
43650   log_output
43651   message_prefix =
43652   message_suffix =
43653
43654 # router
43655 local_user_cyrus:
43656   driver = accept
43657   check_local_user
43658   local_part_suffix = .*
43659   transport = local_delivery_cyrus
43660 </literallayout>
43661 <para>
43662 Note the unsetting of <option>message_prefix</option> and <option>message_suffix</option>, and the use of
43663 <option>return_output</option> to cause any text written by Cyrus to be returned to the
43664 sender.
43665 <indexterm role="concept" startref="IIDpiptra1" class="endofrange"/>
43666 <indexterm role="concept" startref="IIDpiptra2" class="endofrange"/>
43667 </para>
43668 </section>
43669 </chapter>
43670
43671 <chapter id="CHAPsmtptrans">
43672 <title>The smtp transport</title>
43673 <para>
43674 <indexterm role="concept" id="IIDsmttra1" class="startofrange">
43675 <primary>transports</primary>
43676 <secondary><command>smtp</command></secondary>
43677 </indexterm>
43678 <indexterm role="concept" id="IIDsmttra2" class="startofrange">
43679 <primary><command>smtp</command> transport</primary>
43680 </indexterm>
43681 The <command>smtp</command> transport delivers messages over TCP/IP connections using the SMTP
43682 or LMTP protocol. The list of hosts to try can either be taken from the address
43683 that is being processed (having been set up by the router), or specified
43684 explicitly for the transport. Timeout and retry processing (see chapter
43685 <xref linkend="CHAPretry"/>) is applied to each IP address independently.
43686 </para>
43687 <section id="SECID144">
43688 <title>Multiple messages on a single connection</title>
43689 <para>
43690 The sending of multiple messages over a single TCP/IP connection can arise in
43691 two ways:
43692 </para>
43693 <itemizedlist>
43694 <listitem>
43695 <para>
43696 If a message contains more than <option>max_rcpt</option> (see below) addresses that are
43697 routed to the same host, more than one copy of the message has to be sent to
43698 that host. In this situation, multiple copies may be sent in a single run of
43699 the <command>smtp</command> transport over a single TCP/IP connection. (What Exim actually
43700 does when it has too many addresses to send in one message also depends on the
43701 value of the global <option>remote_max_parallel</option> option. Details are given in
43702 section <xref linkend="SECToutSMTPTCP"/>.)
43703 </para>
43704 </listitem>
43705 <listitem>
43706 <para>
43707 <indexterm role="concept">
43708 <primary>hints database</primary>
43709 <secondary>remembering routing</secondary>
43710 </indexterm>
43711 When a message has been successfully delivered over a TCP/IP connection, Exim
43712 looks in its hints database to see if there are any other messages awaiting a
43713 connection to the same host. If there are, a new delivery process is started
43714 for one of them, and the current TCP/IP connection is passed on to it. The new
43715 process may in turn send multiple copies and possibly create yet another
43716 process.
43717 </para>
43718 </listitem>
43719 </itemizedlist>
43720 <para>
43721 For each copy sent over the same TCP/IP connection, a sequence counter is
43722 incremented, and if it ever gets to the value of <option>connection_max_messages</option>,
43723 no further messages are sent over that connection.
43724 </para>
43725 </section>
43726 <section id="SECID145">
43727 <title>Use of the $host and $host_address variables</title>
43728 <para>
43729 <indexterm role="variable">
43730 <primary><varname>$host</varname></primary>
43731 </indexterm>
43732 <indexterm role="variable">
43733 <primary><varname>$host_address</varname></primary>
43734 </indexterm>
43735 At the start of a run of the <command>smtp</command> transport, the values of <varname>$host</varname> and
43736 <varname>$host_address</varname> are the name and IP address of the first host on the host list
43737 passed by the router. However, when the transport is about to connect to a
43738 specific host, and while it is connected to that host, <varname>$host</varname> and
43739 <varname>$host_address</varname> are set to the values for that host. These are the values
43740 that are in force when the <option>helo_data</option>, <option>hosts_try_auth</option>, <option>interface</option>,
43741 <option>serialize_hosts</option>, and the various TLS options are expanded.
43742 </para>
43743 </section>
43744 <section id="usecippeer">
43745 <title>Use of $tls_cipher and $tls_peerdn</title>
43746 <para>
43747 <indexterm role="variable">
43748 <primary><varname>$tls_bits</varname></primary>
43749 </indexterm>
43750 <indexterm role="variable">
43751 <primary><varname>$tls_cipher</varname></primary>
43752 </indexterm>
43753 <indexterm role="variable">
43754 <primary><varname>$tls_peerdn</varname></primary>
43755 </indexterm>
43756 <indexterm role="variable">
43757 <primary><varname>$tls_sni</varname></primary>
43758 </indexterm>
43759 At the start of a run of the <command>smtp</command> transport, the values of <varname>$tls_bits</varname>,
43760 <varname>$tls_cipher</varname>, <varname>$tls_peerdn</varname> and <varname>$tls_sni</varname>
43761 are the values that were set when the message was received.
43762 These are the values that are used for options that are expanded before any
43763 SMTP connections are made. Just before each connection is made, these four
43764 variables are emptied. If TLS is subsequently started, they are set to the
43765 appropriate values for the outgoing connection, and these are the values that
43766 are in force when any authenticators are run and when the
43767 <option>authenticated_sender</option> option is expanded.
43768 </para>
43769 <para>
43770 These variables are deprecated in favour of <varname>$tls_in_cipher</varname> et. al.
43771 and will be removed in a future release.
43772 </para>
43773 </section>
43774 <section id="SECID146">
43775 <title>Private options for smtp</title>
43776 <para>
43777 <indexterm role="concept">
43778 <primary>options</primary>
43779 <secondary><command>smtp</command> transport</secondary>
43780 </indexterm>
43781 The private options of the <command>smtp</command> transport are as follows:
43782 </para>
43783 <para>
43784 <indexterm role="option">
43785 <primary><option>address_retry_include_sender</option></primary>
43786 </indexterm>
43787 </para>
43788 <informaltable frame="all">
43789 <tgroup cols="4" colsep="0" rowsep="0">
43790 <colspec colwidth="8*" align="left"/>
43791 <colspec colwidth="6*" align="center"/>
43792 <colspec colwidth="6*" align="center"/>
43793 <colspec colwidth="6*" align="right"/>
43794 <tbody>
43795 <row>
43796 <entry><option>address_retry_include_sender</option></entry>
43797 <entry>Use: <emphasis>smtp</emphasis></entry>
43798 <entry>Type: <emphasis>boolean</emphasis></entry>
43799 <entry>Default: <emphasis>true</emphasis></entry>
43800 </row>
43801 </tbody>
43802 </tgroup>
43803 </informaltable>
43804 <para>
43805 <indexterm role="concept">
43806 <primary>4<emphasis>xx</emphasis> responses</primary>
43807 <secondary>retrying after</secondary>
43808 </indexterm>
43809 When an address is delayed because of a 4<emphasis>xx</emphasis> response to a RCPT command, it
43810 is the combination of sender and recipient that is delayed in subsequent queue
43811 runs until the retry time is reached. You can delay the recipient without
43812 reference to the sender (which is what earlier versions of Exim did), by
43813 setting <option>address_retry_include_sender</option> false. However, this can lead to
43814 problems with servers that regularly issue 4<emphasis>xx</emphasis> responses to RCPT commands.
43815 </para>
43816 <para>
43817 <indexterm role="option">
43818 <primary><option>allow_localhost</option></primary>
43819 </indexterm>
43820 </para>
43821 <informaltable frame="all">
43822 <tgroup cols="4" colsep="0" rowsep="0">
43823 <colspec colwidth="8*" align="left"/>
43824 <colspec colwidth="6*" align="center"/>
43825 <colspec colwidth="6*" align="center"/>
43826 <colspec colwidth="6*" align="right"/>
43827 <tbody>
43828 <row>
43829 <entry><option>allow_localhost</option></entry>
43830 <entry>Use: <emphasis>smtp</emphasis></entry>
43831 <entry>Type: <emphasis>boolean</emphasis></entry>
43832 <entry>Default: <emphasis>false</emphasis></entry>
43833 </row>
43834 </tbody>
43835 </tgroup>
43836 </informaltable>
43837 <para>
43838 <indexterm role="concept">
43839 <primary>local host</primary>
43840 <secondary>sending to</secondary>
43841 </indexterm>
43842 <indexterm role="concept">
43843 <primary>fallback</primary>
43844 <secondary>hosts specified on transport</secondary>
43845 </indexterm>
43846 When a host specified in <option>hosts</option> or <option>fallback_hosts</option> (see below) turns out
43847 to be the local host, or is listed in <option>hosts_treat_as_local</option>, delivery is
43848 deferred by default. However, if <option>allow_localhost</option> is set, Exim goes on to do
43849 the delivery anyway. This should be used only in special cases when the
43850 configuration ensures that no looping will result (for example, a differently
43851 configured Exim is listening on the port to which the message is sent).
43852 </para>
43853 <para>
43854 <indexterm role="option">
43855 <primary><option>authenticated_sender</option></primary>
43856 </indexterm>
43857 </para>
43858 <informaltable frame="all">
43859 <tgroup cols="4" colsep="0" rowsep="0">
43860 <colspec colwidth="8*" align="left"/>
43861 <colspec colwidth="6*" align="center"/>
43862 <colspec colwidth="6*" align="center"/>
43863 <colspec colwidth="6*" align="right"/>
43864 <tbody>
43865 <row>
43866 <entry><option>authenticated_sender</option></entry>
43867 <entry>Use: <emphasis>smtp</emphasis></entry>
43868 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
43869 <entry>Default: <emphasis>unset</emphasis></entry>
43870 </row>
43871 </tbody>
43872 </tgroup>
43873 </informaltable>
43874 <para>
43875 <indexterm role="concept">
43876 <primary>Cyrus</primary>
43877 </indexterm>
43878 When Exim has authenticated as a client, or if <option>authenticated_sender_force</option>
43879 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
43880 overriding any existing authenticated sender value. If the string expansion is
43881 forced to fail, the option is ignored. Other expansion failures cause delivery
43882 to be deferred. If the result of expansion is an empty string, that is also
43883 ignored.
43884 </para>
43885 <para>
43886 The expansion happens after the outgoing connection has been made and TLS
43887 started, if required. This means that the <varname>$host</varname>, <varname>$host_address</varname>,
43888 <varname>$tls_out_cipher</varname>, and <varname>$tls_out_peerdn</varname> variables are set according to the
43889 particular connection.
43890 </para>
43891 <para>
43892 If the SMTP session is not authenticated, the expansion of
43893 <option>authenticated_sender</option> still happens (and can cause the delivery to be
43894 deferred if it fails), but no AUTH= item is added to MAIL commands
43895 unless <option>authenticated_sender_force</option> is true.
43896 </para>
43897 <para>
43898 This option allows you to use the <command>smtp</command> transport in LMTP mode to
43899 deliver mail to Cyrus IMAP and provide the proper local part as the
43900 <quote>authenticated sender</quote>, via a setting such as:
43901 </para>
43902 <literallayout class="monospaced">
43903 authenticated_sender = $local_part
43904 </literallayout>
43905 <para>
43906 This removes the need for IMAP subfolders to be assigned special ACLs to
43907 allow direct delivery to those subfolders.
43908 </para>
43909 <para>
43910 Because of expected uses such as that just described for Cyrus (when no
43911 domain is involved), there is no checking on the syntax of the provided
43912 value.
43913 </para>
43914 <para>
43915 <indexterm role="option">
43916 <primary><option>authenticated_sender_force</option></primary>
43917 </indexterm>
43918 </para>
43919 <informaltable frame="all">
43920 <tgroup cols="4" colsep="0" rowsep="0">
43921 <colspec colwidth="8*" align="left"/>
43922 <colspec colwidth="6*" align="center"/>
43923 <colspec colwidth="6*" align="center"/>
43924 <colspec colwidth="6*" align="right"/>
43925 <tbody>
43926 <row>
43927 <entry><option>authenticated_sender_force</option></entry>
43928 <entry>Use: <emphasis>smtp</emphasis></entry>
43929 <entry>Type: <emphasis>boolean</emphasis></entry>
43930 <entry>Default: <emphasis>false</emphasis></entry>
43931 </row>
43932 </tbody>
43933 </tgroup>
43934 </informaltable>
43935 <para>
43936 If this option is set true, the <option>authenticated_sender</option> option&#x2019;s value
43937 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
43938 authenticated as a client.
43939 </para>
43940 <para>
43941 <indexterm role="option">
43942 <primary><option>command_timeout</option></primary>
43943 </indexterm>
43944 </para>
43945 <informaltable frame="all">
43946 <tgroup cols="4" colsep="0" rowsep="0">
43947 <colspec colwidth="8*" align="left"/>
43948 <colspec colwidth="6*" align="center"/>
43949 <colspec colwidth="6*" align="center"/>
43950 <colspec colwidth="6*" align="right"/>
43951 <tbody>
43952 <row>
43953 <entry><option>command_timeout</option></entry>
43954 <entry>Use: <emphasis>smtp</emphasis></entry>
43955 <entry>Type: <emphasis>time</emphasis></entry>
43956 <entry>Default: <emphasis>5m</emphasis></entry>
43957 </row>
43958 </tbody>
43959 </tgroup>
43960 </informaltable>
43961 <para>
43962 This sets a timeout for receiving a response to an SMTP command that has been
43963 sent out. It is also used when waiting for the initial banner line from the
43964 remote host. Its value must not be zero.
43965 </para>
43966 <para>
43967 <indexterm role="option">
43968 <primary><option>connect_timeout</option></primary>
43969 </indexterm>
43970 </para>
43971 <informaltable frame="all">
43972 <tgroup cols="4" colsep="0" rowsep="0">
43973 <colspec colwidth="8*" align="left"/>
43974 <colspec colwidth="6*" align="center"/>
43975 <colspec colwidth="6*" align="center"/>
43976 <colspec colwidth="6*" align="right"/>
43977 <tbody>
43978 <row>
43979 <entry><option>connect_timeout</option></entry>
43980 <entry>Use: <emphasis>smtp</emphasis></entry>
43981 <entry>Type: <emphasis>time</emphasis></entry>
43982 <entry>Default: <emphasis>5m</emphasis></entry>
43983 </row>
43984 </tbody>
43985 </tgroup>
43986 </informaltable>
43987 <para>
43988 This sets a timeout for the <function>connect()</function> function, which sets up a TCP/IP call
43989 to a remote host. A setting of zero allows the system timeout (typically
43990 several minutes) to act. To have any effect, the value of this option must be
43991 less than the system timeout. However, it has been observed that on some
43992 systems there is no system timeout, which is why the default value for this
43993 option is 5 minutes, a value recommended by RFC 1123.
43994 </para>
43995 <para>
43996 <indexterm role="option">
43997 <primary><option>connection_max_messages</option></primary>
43998 </indexterm>
43999 </para>
44000 <informaltable frame="all">
44001 <tgroup cols="4" colsep="0" rowsep="0">
44002 <colspec colwidth="8*" align="left"/>
44003 <colspec colwidth="6*" align="center"/>
44004 <colspec colwidth="6*" align="center"/>
44005 <colspec colwidth="6*" align="right"/>
44006 <tbody>
44007 <row>
44008 <entry><option>connection_max_messages</option></entry>
44009 <entry>Use: <emphasis>smtp</emphasis></entry>
44010 <entry>Type: <emphasis>integer</emphasis></entry>
44011 <entry>Default: <emphasis>500</emphasis></entry>
44012 </row>
44013 </tbody>
44014 </tgroup>
44015 </informaltable>
44016 <para>
44017 <indexterm role="concept">
44018 <primary>SMTP</primary>
44019 <secondary>passed connection</secondary>
44020 </indexterm>
44021 <indexterm role="concept">
44022 <primary>SMTP</primary>
44023 <secondary>multiple deliveries</secondary>
44024 </indexterm>
44025 <indexterm role="concept">
44026 <primary>multiple SMTP deliveries</primary>
44027 </indexterm>
44028 This controls the maximum number of separate message deliveries that are sent
44029 over a single TCP/IP connection. If the value is zero, there is no limit.
44030 For testing purposes, this value can be overridden by the <option>-oB</option> command line
44031 option.
44032 </para>
44033 <para>
44034 <indexterm role="option">
44035 <primary><option>data_timeout</option></primary>
44036 </indexterm>
44037 </para>
44038 <informaltable frame="all">
44039 <tgroup cols="4" colsep="0" rowsep="0">
44040 <colspec colwidth="8*" align="left"/>
44041 <colspec colwidth="6*" align="center"/>
44042 <colspec colwidth="6*" align="center"/>
44043 <colspec colwidth="6*" align="right"/>
44044 <tbody>
44045 <row>
44046 <entry><option>data_timeout</option></entry>
44047 <entry>Use: <emphasis>smtp</emphasis></entry>
44048 <entry>Type: <emphasis>time</emphasis></entry>
44049 <entry>Default: <emphasis>5m</emphasis></entry>
44050 </row>
44051 </tbody>
44052 </tgroup>
44053 </informaltable>
44054 <para>
44055 This sets a timeout for the transmission of each block in the data portion of
44056 the message. As a result, the overall timeout for a message depends on the size
44057 of the message. Its value must not be zero. See also <option>final_timeout</option>.
44058 </para>
44059 <para>
44060 <indexterm role="option">
44061 <primary><option>delay_after_cutoff</option></primary>
44062 </indexterm>
44063 </para>
44064 <informaltable frame="all">
44065 <tgroup cols="4" colsep="0" rowsep="0">
44066 <colspec colwidth="8*" align="left"/>
44067 <colspec colwidth="6*" align="center"/>
44068 <colspec colwidth="6*" align="center"/>
44069 <colspec colwidth="6*" align="right"/>
44070 <tbody>
44071 <row>
44072 <entry><option>delay_after_cutoff</option></entry>
44073 <entry>Use: <emphasis>smtp</emphasis></entry>
44074 <entry>Type: <emphasis>boolean</emphasis></entry>
44075 <entry>Default: <emphasis>true</emphasis></entry>
44076 </row>
44077 </tbody>
44078 </tgroup>
44079 </informaltable>
44080 <para>
44081 This option controls what happens when all remote IP addresses for a given
44082 domain have been inaccessible for so long that they have passed their retry
44083 cutoff times.
44084 </para>
44085 <para>
44086 In the default state, if the next retry time has not been reached for any of
44087 them, the address is bounced without trying any deliveries. In other words,
44088 Exim delays retrying an IP address after the final cutoff time until a new
44089 retry time is reached, and can therefore bounce an address without ever trying
44090 a delivery, when machines have been down for a long time. Some people are
44091 unhappy at this prospect, so...
44092 </para>
44093 <para>
44094 If <option>delay_after_cutoff</option> is set false, Exim behaves differently. If all IP
44095 addresses are past their final cutoff time, Exim tries to deliver to those
44096 IP addresses that have not been tried since the message arrived. If there are
44097 none, of if they all fail, the address is bounced. In other words, it does not
44098 delay when a new message arrives, but immediately tries those expired IP
44099 addresses that haven&#x2019;t been tried since the message arrived. If there is a
44100 continuous stream of messages for the dead hosts, unsetting
44101 <option>delay_after_cutoff</option> means that there will be many more attempts to deliver
44102 to them.
44103 </para>
44104 <para>
44105 <indexterm role="option">
44106 <primary><option>dns_qualify_single</option></primary>
44107 </indexterm>
44108 </para>
44109 <informaltable frame="all">
44110 <tgroup cols="4" colsep="0" rowsep="0">
44111 <colspec colwidth="8*" align="left"/>
44112 <colspec colwidth="6*" align="center"/>
44113 <colspec colwidth="6*" align="center"/>
44114 <colspec colwidth="6*" align="right"/>
44115 <tbody>
44116 <row>
44117 <entry><option>dns_qualify_single</option></entry>
44118 <entry>Use: <emphasis>smtp</emphasis></entry>
44119 <entry>Type: <emphasis>boolean</emphasis></entry>
44120 <entry>Default: <emphasis>true</emphasis></entry>
44121 </row>
44122 </tbody>
44123 </tgroup>
44124 </informaltable>
44125 <para>
44126 If the <option>hosts</option> or <option>fallback_hosts</option> option is being used,
44127 and the <option>gethostbyname</option> option is false,
44128 the RES_DEFNAMES resolver option is set. See the <option>qualify_single</option> option
44129 in chapter <xref linkend="CHAPdnslookup"/> for more details.
44130 </para>
44131 <para>
44132 <indexterm role="option">
44133 <primary><option>dns_search_parents</option></primary>
44134 </indexterm>
44135 </para>
44136 <informaltable frame="all">
44137 <tgroup cols="4" colsep="0" rowsep="0">
44138 <colspec colwidth="8*" align="left"/>
44139 <colspec colwidth="6*" align="center"/>
44140 <colspec colwidth="6*" align="center"/>
44141 <colspec colwidth="6*" align="right"/>
44142 <tbody>
44143 <row>
44144 <entry><option>dns_search_parents</option></entry>
44145 <entry>Use: <emphasis>smtp</emphasis></entry>
44146 <entry>Type: <emphasis>boolean</emphasis></entry>
44147 <entry>Default: <emphasis>false</emphasis></entry>
44148 </row>
44149 </tbody>
44150 </tgroup>
44151 </informaltable>
44152 <para>
44153 If the <option>hosts</option> or <option>fallback_hosts</option> option is being used, and the
44154 <option>gethostbyname</option> option is false, the RES_DNSRCH resolver option is set.
44155 See the <option>search_parents</option> option in chapter <xref linkend="CHAPdnslookup"/> for more
44156 details.
44157 </para>
44158 <para revisionflag="changed">
44159 <indexterm role="option">
44160 <primary><option>dnssec_request_domains</option></primary>
44161 </indexterm>
44162 </para>
44163 <informaltable frame="all" revisionflag="changed">
44164 <tgroup cols="4" colsep="0" rowsep="0">
44165 <colspec colwidth="8*" align="left"/>
44166 <colspec colwidth="6*" align="center"/>
44167 <colspec colwidth="6*" align="center"/>
44168 <colspec colwidth="6*" align="right"/>
44169 <tbody>
44170 <row>
44171 <entry><option>dnssec_request_domains</option></entry>
44172 <entry>Use: <emphasis>smtp</emphasis></entry>
44173 <entry>Type: <emphasis>domain list</emphasis>&dagger;<emphasis></emphasis></entry>
44174 <entry>Default: <emphasis>unset</emphasis></entry>
44175 </row>
44176 </tbody>
44177 </tgroup>
44178 </informaltable>
44179 <para revisionflag="changed">
44180 <indexterm role="concept">
44181 <primary>MX record</primary>
44182 <secondary>security</secondary>
44183 </indexterm>
44184 <indexterm role="concept">
44185 <primary>DNSSEC</primary>
44186 <secondary>MX lookup</secondary>
44187 </indexterm>
44188 <indexterm role="concept">
44189 <primary>security</primary>
44190 <secondary>MX lookup</secondary>
44191 </indexterm>
44192 <indexterm role="concept">
44193 <primary>DNS</primary>
44194 <secondary>DNSSEC</secondary>
44195 </indexterm>
44196 DNS lookups for domains matching <option>dnssec_request_domains</option> will be done with
44197 the dnssec request bit set.
44198 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
44199 </para>
44200 <para revisionflag="changed">
44201 <indexterm role="option">
44202 <primary><option>dnssec_require_domains</option></primary>
44203 </indexterm>
44204 </para>
44205 <informaltable frame="all" revisionflag="changed">
44206 <tgroup cols="4" colsep="0" rowsep="0">
44207 <colspec colwidth="8*" align="left"/>
44208 <colspec colwidth="6*" align="center"/>
44209 <colspec colwidth="6*" align="center"/>
44210 <colspec colwidth="6*" align="right"/>
44211 <tbody>
44212 <row>
44213 <entry><option>dnssec_require_domains</option></entry>
44214 <entry>Use: <emphasis>smtp</emphasis></entry>
44215 <entry>Type: <emphasis>domain list</emphasis>&dagger;<emphasis></emphasis></entry>
44216 <entry>Default: <emphasis>unset</emphasis></entry>
44217 </row>
44218 </tbody>
44219 </tgroup>
44220 </informaltable>
44221 <para revisionflag="changed">
44222 <indexterm role="concept">
44223 <primary>MX record</primary>
44224 <secondary>security</secondary>
44225 </indexterm>
44226 <indexterm role="concept">
44227 <primary>DNSSEC</primary>
44228 <secondary>MX lookup</secondary>
44229 </indexterm>
44230 <indexterm role="concept">
44231 <primary>security</primary>
44232 <secondary>MX lookup</secondary>
44233 </indexterm>
44234 <indexterm role="concept">
44235 <primary>DNS</primary>
44236 <secondary>DNSSEC</secondary>
44237 </indexterm>
44238 DNS lookups for domains matching <option>dnssec_request_domains</option> will be done with
44239 the dnssec request bit set.  Any returns not having the Authenticated Data bit
44240 (AD bit) set wil be ignored and logged as a host-lookup failure.
44241 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
44242 </para>
44243 <para>
44244 <indexterm role="option">
44245 <primary><option>dscp</option></primary>
44246 </indexterm>
44247 </para>
44248 <informaltable frame="all">
44249 <tgroup cols="4" colsep="0" rowsep="0">
44250 <colspec colwidth="8*" align="left"/>
44251 <colspec colwidth="6*" align="center"/>
44252 <colspec colwidth="6*" align="center"/>
44253 <colspec colwidth="6*" align="right"/>
44254 <tbody>
44255 <row>
44256 <entry><option>dscp</option></entry>
44257 <entry>Use: <emphasis>smtp</emphasis></entry>
44258 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
44259 <entry>Default: <emphasis>unset</emphasis></entry>
44260 </row>
44261 </tbody>
44262 </tgroup>
44263 </informaltable>
44264 <para>
44265 <indexterm role="concept">
44266 <primary>DCSP</primary>
44267 <secondary>outbound</secondary>
44268 </indexterm>
44269 This option causes the DSCP value associated with a socket to be set to one
44270 of a number of fixed strings or to numeric value.
44271 The <option>-bI:dscp</option> option may be used to ask Exim which names it knows of.
44272 Common values include <literal>throughput</literal>, <literal>mincost</literal>, and on newer systems
44273 <literal>ef</literal>, <literal>af41</literal>, etc.  Numeric values may be in the range 0 to 0x3F.
44274 </para>
44275 <para>
44276 The outbound packets from Exim will be marked with this value in the header
44277 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
44278 that these values will have any effect, not be stripped by networking
44279 equipment, or do much of anything without cooperation with your Network
44280 Engineer and those of all network operators between the source and destination.
44281 </para>
44282 <para>
44283 <indexterm role="option">
44284 <primary><option>fallback_hosts</option></primary>
44285 </indexterm>
44286 </para>
44287 <informaltable frame="all">
44288 <tgroup cols="4" colsep="0" rowsep="0">
44289 <colspec colwidth="8*" align="left"/>
44290 <colspec colwidth="6*" align="center"/>
44291 <colspec colwidth="6*" align="center"/>
44292 <colspec colwidth="6*" align="right"/>
44293 <tbody>
44294 <row>
44295 <entry><option>fallback_hosts</option></entry>
44296 <entry>Use: <emphasis>smtp</emphasis></entry>
44297 <entry>Type: <emphasis>string list</emphasis></entry>
44298 <entry>Default: <emphasis>unset</emphasis></entry>
44299 </row>
44300 </tbody>
44301 </tgroup>
44302 </informaltable>
44303 <para>
44304 <indexterm role="concept">
44305 <primary>fallback</primary>
44306 <secondary>hosts specified on transport</secondary>
44307 </indexterm>
44308 String expansion is not applied to this option. The argument must be a
44309 colon-separated list of host names or IP addresses, optionally also including
44310 port numbers, though the separator can be changed, as described in section
44311 <xref linkend="SECTlistconstruct"/>. Each individual item in the list is the same as an
44312 item in a <option>route_list</option> setting for the <command>manualroute</command> router, as described
44313 in section <xref linkend="SECTformatonehostitem"/>.
44314 </para>
44315 <para>
44316 Fallback hosts can also be specified on routers, which associate them with the
44317 addresses they process. As for the <option>hosts</option> option without <option>hosts_override</option>,
44318 <option>fallback_hosts</option> specified on the transport is used only if the address does
44319 not have its own associated fallback host list. Unlike <option>hosts</option>, a setting of
44320 <option>fallback_hosts</option> on an address is not overridden by <option>hosts_override</option>.
44321 However, <option>hosts_randomize</option> does apply to fallback host lists.
44322 </para>
44323 <para>
44324 If Exim is unable to deliver to any of the hosts for a particular address, and
44325 the errors are not permanent rejections, the address is put on a separate
44326 transport queue with its host list replaced by the fallback hosts, unless the
44327 address was routed via MX records and the current host was in the original MX
44328 list. In that situation, the fallback host list is not used.
44329 </para>
44330 <para>
44331 Once normal deliveries are complete, the fallback queue is delivered by
44332 re-running the same transports with the new host lists. If several failing
44333 addresses have the same fallback hosts (and <option>max_rcpt</option> permits it), a single
44334 copy of the message is sent.
44335 </para>
44336 <para>
44337 The resolution of the host names on the fallback list is controlled by the
44338 <option>gethostbyname</option> option, as for the <option>hosts</option> option. Fallback hosts apply
44339 both to cases when the host list comes with the address and when it is taken
44340 from <option>hosts</option>. This option provides a <quote>use a smart host only if delivery
44341 fails</quote> facility.
44342 </para>
44343 <para>
44344 <indexterm role="option">
44345 <primary><option>final_timeout</option></primary>
44346 </indexterm>
44347 </para>
44348 <informaltable frame="all">
44349 <tgroup cols="4" colsep="0" rowsep="0">
44350 <colspec colwidth="8*" align="left"/>
44351 <colspec colwidth="6*" align="center"/>
44352 <colspec colwidth="6*" align="center"/>
44353 <colspec colwidth="6*" align="right"/>
44354 <tbody>
44355 <row>
44356 <entry><option>final_timeout</option></entry>
44357 <entry>Use: <emphasis>smtp</emphasis></entry>
44358 <entry>Type: <emphasis>time</emphasis></entry>
44359 <entry>Default: <emphasis>10m</emphasis></entry>
44360 </row>
44361 </tbody>
44362 </tgroup>
44363 </informaltable>
44364 <para>
44365 This is the timeout that applies while waiting for the response to the final
44366 line containing just <quote>.</quote> that terminates a message. Its value must not be
44367 zero.
44368 </para>
44369 <para>
44370 <indexterm role="option">
44371 <primary><option>gethostbyname</option></primary>
44372 </indexterm>
44373 </para>
44374 <informaltable frame="all">
44375 <tgroup cols="4" colsep="0" rowsep="0">
44376 <colspec colwidth="8*" align="left"/>
44377 <colspec colwidth="6*" align="center"/>
44378 <colspec colwidth="6*" align="center"/>
44379 <colspec colwidth="6*" align="right"/>
44380 <tbody>
44381 <row>
44382 <entry><option>gethostbyname</option></entry>
44383 <entry>Use: <emphasis>smtp</emphasis></entry>
44384 <entry>Type: <emphasis>boolean</emphasis></entry>
44385 <entry>Default: <emphasis>false</emphasis></entry>
44386 </row>
44387 </tbody>
44388 </tgroup>
44389 </informaltable>
44390 <para>
44391 If this option is true when the <option>hosts</option> and/or <option>fallback_hosts</option> options are
44392 being used, names are looked up using <function>gethostbyname()</function>
44393 (or <function>getipnodebyname()</function> when available)
44394 instead of using the DNS. Of course, that function may in fact use the DNS, but
44395 it may also consult other sources of information such as <filename>/etc/hosts</filename>.
44396 </para>
44397 <para>
44398 <indexterm role="option">
44399 <primary><option>gnutls_compat_mode</option></primary>
44400 </indexterm>
44401 </para>
44402 <informaltable frame="all">
44403 <tgroup cols="4" colsep="0" rowsep="0">
44404 <colspec colwidth="8*" align="left"/>
44405 <colspec colwidth="6*" align="center"/>
44406 <colspec colwidth="6*" align="center"/>
44407 <colspec colwidth="6*" align="right"/>
44408 <tbody>
44409 <row>
44410 <entry><option>gnutls_compat_mode</option></entry>
44411 <entry>Use: <emphasis>smtp</emphasis></entry>
44412 <entry>Type: <emphasis>boolean</emphasis></entry>
44413 <entry>Default: <emphasis>unset</emphasis></entry>
44414 </row>
44415 </tbody>
44416 </tgroup>
44417 </informaltable>
44418 <para>
44419 This option controls whether GnuTLS is used in compatibility mode in an Exim
44420 server. This reduces security slightly, but improves interworking with older
44421 implementations of TLS.
44422 </para>
44423 <para>
44424 <indexterm role="option">
44425 <primary><option>helo_data</option></primary>
44426 </indexterm>
44427 </para>
44428 <informaltable frame="all">
44429 <tgroup cols="4" colsep="0" rowsep="0">
44430 <colspec colwidth="8*" align="left"/>
44431 <colspec colwidth="6*" align="center"/>
44432 <colspec colwidth="6*" align="center"/>
44433 <colspec colwidth="6*" align="right"/>
44434 <tbody>
44435 <row>
44436 <entry><option>helo_data</option></entry>
44437 <entry>Use: <emphasis>smtp</emphasis></entry>
44438 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
44439 <entry>Default: <emphasis>see below</emphasis></entry>
44440 </row>
44441 </tbody>
44442 </tgroup>
44443 </informaltable>
44444 <para>
44445 <indexterm role="concept">
44446 <primary>HELO</primary>
44447 <secondary>argument, setting</secondary>
44448 </indexterm>
44449 <indexterm role="concept">
44450 <primary>EHLO</primary>
44451 <secondary>argument, setting</secondary>
44452 </indexterm>
44453 <indexterm role="concept">
44454 <primary>LHLO argument setting</primary>
44455 </indexterm>
44456 The value of this option is expanded after a connection to a another host has
44457 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
44458 command that starts the outgoing SMTP or LMTP session. The default value of the
44459 option is:
44460 </para>
44461 <literallayout class="monospaced">
44462 $primary_hostname
44463 </literallayout>
44464 <para>
44465 During the expansion, the variables <varname>$host</varname> and <varname>$host_address</varname> are set to
44466 the identity of the remote host, and the variables <varname>$sending_ip_address</varname> and
44467 <varname>$sending_port</varname> are set to the local IP address and port number that are being
44468 used. These variables can be used to generate different values for different
44469 servers or different local IP addresses. For example, if you want the string
44470 that is used for <option>helo_data</option> to be obtained by a DNS lookup of the outgoing
44471 interface address, you could use this:
44472 </para>
44473 <literallayout class="monospaced">
44474 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
44475   {$primary_hostname}}
44476 </literallayout>
44477 <para>
44478 The use of <option>helo_data</option> applies both to sending messages and when doing
44479 callouts.
44480 </para>
44481 <para>
44482 <indexterm role="option">
44483 <primary><option>hosts</option></primary>
44484 </indexterm>
44485 </para>
44486 <informaltable frame="all">
44487 <tgroup cols="4" colsep="0" rowsep="0">
44488 <colspec colwidth="8*" align="left"/>
44489 <colspec colwidth="6*" align="center"/>
44490 <colspec colwidth="6*" align="center"/>
44491 <colspec colwidth="6*" align="right"/>
44492 <tbody>
44493 <row>
44494 <entry><option>hosts</option></entry>
44495 <entry>Use: <emphasis>smtp</emphasis></entry>
44496 <entry>Type: <emphasis>string list</emphasis>&dagger;<emphasis></emphasis></entry>
44497 <entry>Default: <emphasis>unset</emphasis></entry>
44498 </row>
44499 </tbody>
44500 </tgroup>
44501 </informaltable>
44502 <para>
44503 Hosts are associated with an address by a router such as <command>dnslookup</command>, which
44504 finds the hosts by looking up the address domain in the DNS, or by
44505 <command>manualroute</command>, which has lists of hosts in its configuration. However,
44506 email addresses can be passed to the <command>smtp</command> transport by any router, and not
44507 all of them can provide an associated list of hosts.
44508 </para>
44509 <para>
44510 The <option>hosts</option> option specifies a list of hosts to be used if the address being
44511 processed does not have any hosts associated with it. The hosts specified by
44512 <option>hosts</option> are also used, whether or not the address has its own hosts, if
44513 <option>hosts_override</option> is set.
44514 </para>
44515 <para>
44516 The string is first expanded, before being interpreted as a colon-separated
44517 list of host names or IP addresses, possibly including port numbers. The
44518 separator may be changed to something other than colon, as described in section
44519 <xref linkend="SECTlistconstruct"/>. Each individual item in the list is the same as an
44520 item in a <option>route_list</option> setting for the <command>manualroute</command> router, as described
44521 in section <xref linkend="SECTformatonehostitem"/>. However, note that the <literal>/MX</literal> facility
44522 of the <command>manualroute</command> router is not available here.
44523 </para>
44524 <para>
44525 If the expansion fails, delivery is deferred. Unless the failure was caused by
44526 the inability to complete a lookup, the error is logged to the panic log as
44527 well as the main log. Host names are looked up either by searching directly for
44528 address records in the DNS or by calling <function>gethostbyname()</function> (or
44529 <function>getipnodebyname()</function> when available), depending on the setting of the
44530 <option>gethostbyname</option> option. When Exim is compiled with IPv6 support, if a host
44531 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
44532 address are used.
44533 </para>
44534 <para>
44535 During delivery, the hosts are tried in order, subject to their retry status,
44536 unless <option>hosts_randomize</option> is set.
44537 </para>
44538 <para>
44539 <indexterm role="option">
44540 <primary><option>hosts_avoid_esmtp</option></primary>
44541 </indexterm>
44542 </para>
44543 <informaltable frame="all">
44544 <tgroup cols="4" colsep="0" rowsep="0">
44545 <colspec colwidth="8*" align="left"/>
44546 <colspec colwidth="6*" align="center"/>
44547 <colspec colwidth="6*" align="center"/>
44548 <colspec colwidth="6*" align="right"/>
44549 <tbody>
44550 <row>
44551 <entry><option>hosts_avoid_esmtp</option></entry>
44552 <entry>Use: <emphasis>smtp</emphasis></entry>
44553 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
44554 <entry>Default: <emphasis>unset</emphasis></entry>
44555 </row>
44556 </tbody>
44557 </tgroup>
44558 </informaltable>
44559 <para>
44560 <indexterm role="concept">
44561 <primary>ESMTP, avoiding use of</primary>
44562 </indexterm>
44563 <indexterm role="concept">
44564 <primary>HELO</primary>
44565 <secondary>forcing use of</secondary>
44566 </indexterm>
44567 <indexterm role="concept">
44568 <primary>EHLO</primary>
44569 <secondary>avoiding use of</secondary>
44570 </indexterm>
44571 <indexterm role="concept">
44572 <primary>PIPELINING</primary>
44573 <secondary>avoiding the use of</secondary>
44574 </indexterm>
44575 This option is for use with broken hosts that announce ESMTP facilities (for
44576 example, PIPELINING) and then fail to implement them properly. When a host
44577 matches <option>hosts_avoid_esmtp</option>, Exim sends HELO rather than EHLO at the
44578 start of the SMTP session. This means that it cannot use any of the ESMTP
44579 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
44580 </para>
44581 <para>
44582 <indexterm role="option">
44583 <primary><option>hosts_avoid_pipelining</option></primary>
44584 </indexterm>
44585 </para>
44586 <informaltable frame="all">
44587 <tgroup cols="4" colsep="0" rowsep="0">
44588 <colspec colwidth="8*" align="left"/>
44589 <colspec colwidth="6*" align="center"/>
44590 <colspec colwidth="6*" align="center"/>
44591 <colspec colwidth="6*" align="right"/>
44592 <tbody>
44593 <row>
44594 <entry><option>hosts_avoid_pipelining</option></entry>
44595 <entry>Use: <emphasis>smtp</emphasis></entry>
44596 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
44597 <entry>Default: <emphasis>unset</emphasis></entry>
44598 </row>
44599 </tbody>
44600 </tgroup>
44601 </informaltable>
44602 <para>
44603 <indexterm role="concept">
44604 <primary>PIPELINING</primary>
44605 <secondary>avoiding the use of</secondary>
44606 </indexterm>
44607 Exim will not use the SMTP PIPELINING extension when delivering to any host
44608 that matches this list, even if the server host advertises PIPELINING support.
44609 </para>
44610 <para>
44611 <indexterm role="option">
44612 <primary><option>hosts_avoid_tls</option></primary>
44613 </indexterm>
44614 </para>
44615 <informaltable frame="all">
44616 <tgroup cols="4" colsep="0" rowsep="0">
44617 <colspec colwidth="8*" align="left"/>
44618 <colspec colwidth="6*" align="center"/>
44619 <colspec colwidth="6*" align="center"/>
44620 <colspec colwidth="6*" align="right"/>
44621 <tbody>
44622 <row>
44623 <entry><option>hosts_avoid_tls</option></entry>
44624 <entry>Use: <emphasis>smtp</emphasis></entry>
44625 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
44626 <entry>Default: <emphasis>unset</emphasis></entry>
44627 </row>
44628 </tbody>
44629 </tgroup>
44630 </informaltable>
44631 <para>
44632 <indexterm role="concept">
44633 <primary>TLS</primary>
44634 <secondary>avoiding for certain hosts</secondary>
44635 </indexterm>
44636 Exim will not try to start a TLS session when delivering to any host that
44637 matches this list. See chapter <xref linkend="CHAPTLS"/> for details of TLS.
44638 </para>
44639 <para>
44640 <indexterm role="option">
44641 <primary><option>hosts_verify_avoid_tls</option></primary>
44642 </indexterm>
44643 </para>
44644 <informaltable frame="all">
44645 <tgroup cols="4" colsep="0" rowsep="0">
44646 <colspec colwidth="8*" align="left"/>
44647 <colspec colwidth="6*" align="center"/>
44648 <colspec colwidth="6*" align="center"/>
44649 <colspec colwidth="6*" align="right"/>
44650 <tbody>
44651 <row>
44652 <entry><option>hosts_verify_avoid_tls</option></entry>
44653 <entry>Use: <emphasis>smtp</emphasis></entry>
44654 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
44655 <entry>Default: <emphasis>*</emphasis></entry>
44656 </row>
44657 </tbody>
44658 </tgroup>
44659 </informaltable>
44660 <para>
44661 <indexterm role="concept">
44662 <primary>TLS</primary>
44663 <secondary>avoiding for certain hosts</secondary>
44664 </indexterm>
44665 Exim will not try to start a TLS session for a verify callout,
44666 or when delivering in cutthrough mode,
44667 to any host that matches this list.
44668 Note that the default is to not use TLS.
44669 </para>
44670 <para>
44671 <indexterm role="option">
44672 <primary><option>hosts_max_try</option></primary>
44673 </indexterm>
44674 </para>
44675 <informaltable frame="all">
44676 <tgroup cols="4" colsep="0" rowsep="0">
44677 <colspec colwidth="8*" align="left"/>
44678 <colspec colwidth="6*" align="center"/>
44679 <colspec colwidth="6*" align="center"/>
44680 <colspec colwidth="6*" align="right"/>
44681 <tbody>
44682 <row>
44683 <entry><option>hosts_max_try</option></entry>
44684 <entry>Use: <emphasis>smtp</emphasis></entry>
44685 <entry>Type: <emphasis>integer</emphasis></entry>
44686 <entry>Default: <emphasis>5</emphasis></entry>
44687 </row>
44688 </tbody>
44689 </tgroup>
44690 </informaltable>
44691 <para>
44692 <indexterm role="concept">
44693 <primary>host</primary>
44694 <secondary>maximum number to try</secondary>
44695 </indexterm>
44696 <indexterm role="concept">
44697 <primary>limit</primary>
44698 <secondary>number of hosts tried</secondary>
44699 </indexterm>
44700 <indexterm role="concept">
44701 <primary>limit</primary>
44702 <secondary>number of MX tried</secondary>
44703 </indexterm>
44704 <indexterm role="concept">
44705 <primary>MX record</primary>
44706 <secondary>maximum tried</secondary>
44707 </indexterm>
44708 This option limits the number of IP addresses that are tried for any one
44709 delivery in cases where there are temporary delivery errors. Section
44710 <xref linkend="SECTvalhosmax"/> describes in detail how the value of this option is used.
44711 </para>
44712 <para>
44713 <indexterm role="option">
44714 <primary><option>hosts_max_try_hardlimit</option></primary>
44715 </indexterm>
44716 </para>
44717 <informaltable frame="all">
44718 <tgroup cols="4" colsep="0" rowsep="0">
44719 <colspec colwidth="8*" align="left"/>
44720 <colspec colwidth="6*" align="center"/>
44721 <colspec colwidth="6*" align="center"/>
44722 <colspec colwidth="6*" align="right"/>
44723 <tbody>
44724 <row>
44725 <entry><option>hosts_max_try_hardlimit</option></entry>
44726 <entry>Use: <emphasis>smtp</emphasis></entry>
44727 <entry>Type: <emphasis>integer</emphasis></entry>
44728 <entry>Default: <emphasis>50</emphasis></entry>
44729 </row>
44730 </tbody>
44731 </tgroup>
44732 </informaltable>
44733 <para>
44734 This is an additional check on the maximum number of IP addresses that Exim
44735 tries for any one delivery. Section <xref linkend="SECTvalhosmax"/> describes its use and
44736 why it exists.
44737 </para>
44738 <para>
44739 <indexterm role="option">
44740 <primary><option>hosts_nopass_tls</option></primary>
44741 </indexterm>
44742 </para>
44743 <informaltable frame="all">
44744 <tgroup cols="4" colsep="0" rowsep="0">
44745 <colspec colwidth="8*" align="left"/>
44746 <colspec colwidth="6*" align="center"/>
44747 <colspec colwidth="6*" align="center"/>
44748 <colspec colwidth="6*" align="right"/>
44749 <tbody>
44750 <row>
44751 <entry><option>hosts_nopass_tls</option></entry>
44752 <entry>Use: <emphasis>smtp</emphasis></entry>
44753 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
44754 <entry>Default: <emphasis>unset</emphasis></entry>
44755 </row>
44756 </tbody>
44757 </tgroup>
44758 </informaltable>
44759 <para>
44760 <indexterm role="concept">
44761 <primary>TLS</primary>
44762 <secondary>passing connection</secondary>
44763 </indexterm>
44764 <indexterm role="concept">
44765 <primary>multiple SMTP deliveries</primary>
44766 </indexterm>
44767 <indexterm role="concept">
44768 <primary>TLS</primary>
44769 <secondary>multiple message deliveries</secondary>
44770 </indexterm>
44771 For any host that matches this list, a connection on which a TLS session has
44772 been started will not be passed to a new delivery process for sending another
44773 message on the same connection. See section <xref linkend="SECTmulmessam"/> for an
44774 explanation of when this might be needed.
44775 </para>
44776 <para>
44777 <indexterm role="option">
44778 <primary><option>hosts_override</option></primary>
44779 </indexterm>
44780 </para>
44781 <informaltable frame="all">
44782 <tgroup cols="4" colsep="0" rowsep="0">
44783 <colspec colwidth="8*" align="left"/>
44784 <colspec colwidth="6*" align="center"/>
44785 <colspec colwidth="6*" align="center"/>
44786 <colspec colwidth="6*" align="right"/>
44787 <tbody>
44788 <row>
44789 <entry><option>hosts_override</option></entry>
44790 <entry>Use: <emphasis>smtp</emphasis></entry>
44791 <entry>Type: <emphasis>boolean</emphasis></entry>
44792 <entry>Default: <emphasis>false</emphasis></entry>
44793 </row>
44794 </tbody>
44795 </tgroup>
44796 </informaltable>
44797 <para>
44798 If this option is set and the <option>hosts</option> option is also set, any hosts that are
44799 attached to the address are ignored, and instead the hosts specified by the
44800 <option>hosts</option> option are always used. This option does not apply to
44801 <option>fallback_hosts</option>.
44802 </para>
44803 <para>
44804 <indexterm role="option">
44805 <primary><option>hosts_randomize</option></primary>
44806 </indexterm>
44807 </para>
44808 <informaltable frame="all">
44809 <tgroup cols="4" colsep="0" rowsep="0">
44810 <colspec colwidth="8*" align="left"/>
44811 <colspec colwidth="6*" align="center"/>
44812 <colspec colwidth="6*" align="center"/>
44813 <colspec colwidth="6*" align="right"/>
44814 <tbody>
44815 <row>
44816 <entry><option>hosts_randomize</option></entry>
44817 <entry>Use: <emphasis>smtp</emphasis></entry>
44818 <entry>Type: <emphasis>boolean</emphasis></entry>
44819 <entry>Default: <emphasis>false</emphasis></entry>
44820 </row>
44821 </tbody>
44822 </tgroup>
44823 </informaltable>
44824 <para>
44825 <indexterm role="concept">
44826 <primary>randomized host list</primary>
44827 </indexterm>
44828 <indexterm role="concept">
44829 <primary>host</primary>
44830 <secondary>list of; randomized</secondary>
44831 </indexterm>
44832 <indexterm role="concept">
44833 <primary>fallback</primary>
44834 <secondary>randomized hosts</secondary>
44835 </indexterm>
44836 If this option is set, and either the list of hosts is taken from the
44837 <option>hosts</option> or the <option>fallback_hosts</option> option, or the hosts supplied by the router
44838 were not obtained from MX records (this includes fallback hosts from the
44839 router), and were not randomized by the router, the order of trying the hosts
44840 is randomized each time the transport runs. Randomizing the order of a host
44841 list can be used to do crude load sharing.
44842 </para>
44843 <para>
44844 When <option>hosts_randomize</option> is true, a host list may be split into groups whose
44845 order is separately randomized. This makes it possible to set up MX-like
44846 behaviour. The boundaries between groups are indicated by an item that is just
44847 <literal>+</literal> in the host list. For example:
44848 </para>
44849 <literallayout class="monospaced">
44850 hosts = host1:host2:host3:+:host4:host5
44851 </literallayout>
44852 <para>
44853 The order of the first three hosts and the order of the last two hosts is
44854 randomized for each use, but the first three always end up before the last two.
44855 If <option>hosts_randomize</option> is not set, a <literal>+</literal> item in the list is ignored.
44856 </para>
44857 <para>
44858 <indexterm role="option">
44859 <primary><option>hosts_require_auth</option></primary>
44860 </indexterm>
44861 </para>
44862 <informaltable frame="all">
44863 <tgroup cols="4" colsep="0" rowsep="0">
44864 <colspec colwidth="8*" align="left"/>
44865 <colspec colwidth="6*" align="center"/>
44866 <colspec colwidth="6*" align="center"/>
44867 <colspec colwidth="6*" align="right"/>
44868 <tbody>
44869 <row>
44870 <entry><option>hosts_require_auth</option></entry>
44871 <entry>Use: <emphasis>smtp</emphasis></entry>
44872 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
44873 <entry>Default: <emphasis>unset</emphasis></entry>
44874 </row>
44875 </tbody>
44876 </tgroup>
44877 </informaltable>
44878 <para>
44879 <indexterm role="concept">
44880 <primary>authentication</primary>
44881 <secondary>required by client</secondary>
44882 </indexterm>
44883 This option provides a list of servers for which authentication must succeed
44884 before Exim will try to transfer a message. If authentication fails for
44885 servers which are not in this list, Exim tries to send unauthenticated. If
44886 authentication fails for one of these servers, delivery is deferred. This
44887 temporary error is detectable in the retry rules, so it can be turned into a
44888 hard failure if required. See also <option>hosts_try_auth</option>, and chapter
44889 <xref linkend="CHAPSMTPAUTH"/> for details of authentication.
44890 </para>
44891 <para>
44892 <indexterm role="option">
44893 <primary><option>hosts_request_ocsp</option></primary>
44894 </indexterm>
44895 </para>
44896 <informaltable frame="all">
44897 <tgroup cols="4" colsep="0" rowsep="0">
44898 <colspec colwidth="8*" align="left"/>
44899 <colspec colwidth="6*" align="center"/>
44900 <colspec colwidth="6*" align="center"/>
44901 <colspec colwidth="6*" align="right"/>
44902 <tbody>
44903 <row>
44904 <entry><option>hosts_request_ocsp</option></entry>
44905 <entry>Use: <emphasis>smtp</emphasis></entry>
44906 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
44907 <entry>Default: <emphasis>*</emphasis></entry>
44908 </row>
44909 </tbody>
44910 </tgroup>
44911 </informaltable>
44912 <para>
44913 <indexterm role="concept">
44914 <primary>TLS</primary>
44915 <secondary>requiring for certain servers</secondary>
44916 </indexterm>
44917 Exim will request a Certificate Status on a
44918 TLS session for any host that matches this list.
44919 <option>tls_verify_certificates</option> should also be set for the transport.
44920 </para>
44921 <para>
44922 <indexterm role="option">
44923 <primary><option>hosts_require_ocsp</option></primary>
44924 </indexterm>
44925 </para>
44926 <informaltable frame="all">
44927 <tgroup cols="4" colsep="0" rowsep="0">
44928 <colspec colwidth="8*" align="left"/>
44929 <colspec colwidth="6*" align="center"/>
44930 <colspec colwidth="6*" align="center"/>
44931 <colspec colwidth="6*" align="right"/>
44932 <tbody>
44933 <row>
44934 <entry><option>hosts_require_ocsp</option></entry>
44935 <entry>Use: <emphasis>smtp</emphasis></entry>
44936 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
44937 <entry>Default: <emphasis>unset</emphasis></entry>
44938 </row>
44939 </tbody>
44940 </tgroup>
44941 </informaltable>
44942 <para>
44943 <indexterm role="concept">
44944 <primary>TLS</primary>
44945 <secondary>requiring for certain servers</secondary>
44946 </indexterm>
44947 Exim will request, and check for a valid Certificate Status being given, on a
44948 TLS session for any host that matches this list.
44949 <option>tls_verify_certificates</option> should also be set for the transport.
44950 </para>
44951 <para>
44952 <indexterm role="option">
44953 <primary><option>hosts_require_tls</option></primary>
44954 </indexterm>
44955 </para>
44956 <informaltable frame="all">
44957 <tgroup cols="4" colsep="0" rowsep="0">
44958 <colspec colwidth="8*" align="left"/>
44959 <colspec colwidth="6*" align="center"/>
44960 <colspec colwidth="6*" align="center"/>
44961 <colspec colwidth="6*" align="right"/>
44962 <tbody>
44963 <row>
44964 <entry><option>hosts_require_tls</option></entry>
44965 <entry>Use: <emphasis>smtp</emphasis></entry>
44966 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
44967 <entry>Default: <emphasis>unset</emphasis></entry>
44968 </row>
44969 </tbody>
44970 </tgroup>
44971 </informaltable>
44972 <para>
44973 <indexterm role="concept">
44974 <primary>TLS</primary>
44975 <secondary>requiring for certain servers</secondary>
44976 </indexterm>
44977 Exim will insist on using a TLS session when delivering to any host that
44978 matches this list. See chapter <xref linkend="CHAPTLS"/> for details of TLS.
44979 <emphasis role="bold">Note</emphasis>: This option affects outgoing mail only. To insist on TLS for
44980 incoming messages, use an appropriate ACL.
44981 </para>
44982 <para>
44983 <indexterm role="option">
44984 <primary><option>hosts_try_auth</option></primary>
44985 </indexterm>
44986 </para>
44987 <informaltable frame="all">
44988 <tgroup cols="4" colsep="0" rowsep="0">
44989 <colspec colwidth="8*" align="left"/>
44990 <colspec colwidth="6*" align="center"/>
44991 <colspec colwidth="6*" align="center"/>
44992 <colspec colwidth="6*" align="right"/>
44993 <tbody>
44994 <row>
44995 <entry><option>hosts_try_auth</option></entry>
44996 <entry>Use: <emphasis>smtp</emphasis></entry>
44997 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
44998 <entry>Default: <emphasis>unset</emphasis></entry>
44999 </row>
45000 </tbody>
45001 </tgroup>
45002 </informaltable>
45003 <para>
45004 <indexterm role="concept">
45005 <primary>authentication</primary>
45006 <secondary>optional in client</secondary>
45007 </indexterm>
45008 This option provides a list of servers to which, provided they announce
45009 authentication support, Exim will attempt to authenticate as a client when it
45010 connects. If authentication fails, Exim will try to transfer the message
45011 unauthenticated. See also <option>hosts_require_auth</option>, and chapter
45012 <xref linkend="CHAPSMTPAUTH"/> for details of authentication.
45013 </para>
45014 <para>
45015 <indexterm role="option">
45016 <primary><option>hosts_try_prdr</option></primary>
45017 </indexterm>
45018 </para>
45019 <informaltable frame="all">
45020 <tgroup cols="4" colsep="0" rowsep="0">
45021 <colspec colwidth="8*" align="left"/>
45022 <colspec colwidth="6*" align="center"/>
45023 <colspec colwidth="6*" align="center"/>
45024 <colspec colwidth="6*" align="right"/>
45025 <tbody>
45026 <row>
45027 <entry><option>hosts_try_prdr</option></entry>
45028 <entry>Use: <emphasis>smtp</emphasis></entry>
45029 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
45030 <entry>Default: <emphasis>unset</emphasis></entry>
45031 </row>
45032 </tbody>
45033 </tgroup>
45034 </informaltable>
45035 <para>
45036 <indexterm role="concept">
45037 <primary>PRDR</primary>
45038 <secondary>enabling, optional in client</secondary>
45039 </indexterm>
45040 This option provides a list of servers to which, provided they announce
45041 PRDR support, Exim will attempt to negotiate PRDR
45042 for multi-recipient messages.
45043 </para>
45044 <para>
45045 <indexterm role="option">
45046 <primary><option>interface</option></primary>
45047 </indexterm>
45048 </para>
45049 <informaltable frame="all">
45050 <tgroup cols="4" colsep="0" rowsep="0">
45051 <colspec colwidth="8*" align="left"/>
45052 <colspec colwidth="6*" align="center"/>
45053 <colspec colwidth="6*" align="center"/>
45054 <colspec colwidth="6*" align="right"/>
45055 <tbody>
45056 <row>
45057 <entry><option>interface</option></entry>
45058 <entry>Use: <emphasis>smtp</emphasis></entry>
45059 <entry>Type: <emphasis>string list</emphasis>&dagger;<emphasis></emphasis></entry>
45060 <entry>Default: <emphasis>unset</emphasis></entry>
45061 </row>
45062 </tbody>
45063 </tgroup>
45064 </informaltable>
45065 <para>
45066 <indexterm role="concept">
45067 <primary>bind IP address</primary>
45068 </indexterm>
45069 <indexterm role="concept">
45070 <primary>IP address</primary>
45071 <secondary>binding</secondary>
45072 </indexterm>
45073 <indexterm role="variable">
45074 <primary><varname>$host</varname></primary>
45075 </indexterm>
45076 <indexterm role="variable">
45077 <primary><varname>$host_address</varname></primary>
45078 </indexterm>
45079 This option specifies which interface to bind to when making an outgoing SMTP
45080 call. The value is an IP address, not an interface name such as
45081 <literal>eth0</literal>. Do not confuse this with the interface address that was used when a
45082 message was received, which is in <varname>$received_ip_address</varname>, formerly known as
45083 <varname>$interface_address</varname>. The name was changed to minimize confusion with the
45084 outgoing interface address. There is no variable that contains an outgoing
45085 interface address because, unless it is set by this option, its value is
45086 unknown.
45087 </para>
45088 <para>
45089 During the expansion of the <option>interface</option> option the variables <varname>$host</varname> and
45090 <varname>$host_address</varname> refer to the host to which a connection is about to be made
45091 during the expansion of the string. Forced expansion failure, or an empty
45092 string result causes the option to be ignored. Otherwise, after expansion, the
45093 string must be a list of IP addresses, colon-separated by default, but the
45094 separator can be changed in the usual way. For example:
45095 </para>
45096 <literallayout class="monospaced">
45097 interface = &lt;; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
45098 </literallayout>
45099 <para>
45100 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
45101 connection. If none of them are the correct type, the option is ignored. If
45102 <option>interface</option> is not set, or is ignored, the system&#x2019;s IP functions choose which
45103 interface to use if the host has more than one.
45104 </para>
45105 <para>
45106 <indexterm role="option">
45107 <primary><option>keepalive</option></primary>
45108 </indexterm>
45109 </para>
45110 <informaltable frame="all">
45111 <tgroup cols="4" colsep="0" rowsep="0">
45112 <colspec colwidth="8*" align="left"/>
45113 <colspec colwidth="6*" align="center"/>
45114 <colspec colwidth="6*" align="center"/>
45115 <colspec colwidth="6*" align="right"/>
45116 <tbody>
45117 <row>
45118 <entry><option>keepalive</option></entry>
45119 <entry>Use: <emphasis>smtp</emphasis></entry>
45120 <entry>Type: <emphasis>boolean</emphasis></entry>
45121 <entry>Default: <emphasis>true</emphasis></entry>
45122 </row>
45123 </tbody>
45124 </tgroup>
45125 </informaltable>
45126 <para>
45127 <indexterm role="concept">
45128 <primary>keepalive</primary>
45129 <secondary>on outgoing connection</secondary>
45130 </indexterm>
45131 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
45132 connections. When set, it causes the kernel to probe idle connections
45133 periodically, by sending packets with <quote>old</quote> sequence numbers. The other end
45134 of the connection should send a acknowledgment if the connection is still okay
45135 or a reset if the connection has been aborted. The reason for doing this is
45136 that it has the beneficial effect of freeing up certain types of connection
45137 that can get stuck when the remote host is disconnected without tidying up the
45138 TCP/IP call properly. The keepalive mechanism takes several hours to detect
45139 unreachable hosts.
45140 </para>
45141 <para>
45142 <indexterm role="option">
45143 <primary><option>lmtp_ignore_quota</option></primary>
45144 </indexterm>
45145 </para>
45146 <informaltable frame="all">
45147 <tgroup cols="4" colsep="0" rowsep="0">
45148 <colspec colwidth="8*" align="left"/>
45149 <colspec colwidth="6*" align="center"/>
45150 <colspec colwidth="6*" align="center"/>
45151 <colspec colwidth="6*" align="right"/>
45152 <tbody>
45153 <row>
45154 <entry><option>lmtp_ignore_quota</option></entry>
45155 <entry>Use: <emphasis>smtp</emphasis></entry>
45156 <entry>Type: <emphasis>boolean</emphasis></entry>
45157 <entry>Default: <emphasis>false</emphasis></entry>
45158 </row>
45159 </tbody>
45160 </tgroup>
45161 </informaltable>
45162 <para>
45163 <indexterm role="concept">
45164 <primary>LMTP</primary>
45165 <secondary>ignoring quota errors</secondary>
45166 </indexterm>
45167 If this option is set true when the <option>protocol</option> option is set to <quote>lmtp</quote>, the
45168 string <literal>IGNOREQUOTA</literal> is added to RCPT commands, provided that the LMTP server
45169 has advertised support for IGNOREQUOTA in its response to the LHLO command.
45170 </para>
45171 <para>
45172 <indexterm role="option">
45173 <primary><option>max_rcpt</option></primary>
45174 </indexterm>
45175 </para>
45176 <informaltable frame="all">
45177 <tgroup cols="4" colsep="0" rowsep="0">
45178 <colspec colwidth="8*" align="left"/>
45179 <colspec colwidth="6*" align="center"/>
45180 <colspec colwidth="6*" align="center"/>
45181 <colspec colwidth="6*" align="right"/>
45182 <tbody>
45183 <row>
45184 <entry><option>max_rcpt</option></entry>
45185 <entry>Use: <emphasis>smtp</emphasis></entry>
45186 <entry>Type: <emphasis>integer</emphasis></entry>
45187 <entry>Default: <emphasis>100</emphasis></entry>
45188 </row>
45189 </tbody>
45190 </tgroup>
45191 </informaltable>
45192 <para>
45193 <indexterm role="concept">
45194 <primary>RCPT</primary>
45195 <secondary>maximum number of outgoing</secondary>
45196 </indexterm>
45197 This option limits the number of RCPT commands that are sent in a single
45198 SMTP message transaction. Each set of addresses is treated independently, and
45199 so can cause parallel connections to the same host if <option>remote_max_parallel</option>
45200 permits this.
45201 </para>
45202 <para>
45203 <indexterm role="option">
45204 <primary><option>multi_domain</option></primary>
45205 </indexterm>
45206 </para>
45207 <informaltable frame="all">
45208 <tgroup cols="4" colsep="0" rowsep="0">
45209 <colspec colwidth="8*" align="left"/>
45210 <colspec colwidth="6*" align="center"/>
45211 <colspec colwidth="6*" align="center"/>
45212 <colspec colwidth="6*" align="right"/>
45213 <tbody>
45214 <row>
45215 <entry><option>multi_domain</option></entry>
45216 <entry>Use: <emphasis>smtp</emphasis></entry>
45217 <entry>Type: <emphasis>boolean</emphasis></entry>
45218 <entry>Default: <emphasis>true</emphasis></entry>
45219 </row>
45220 </tbody>
45221 </tgroup>
45222 </informaltable>
45223 <para>
45224 <indexterm role="variable">
45225 <primary><varname>$domain</varname></primary>
45226 </indexterm>
45227 When this option is set, the <command>smtp</command> transport can handle a number of
45228 addresses containing a mixture of different domains provided they all resolve
45229 to the same list of hosts. Turning the option off restricts the transport to
45230 handling only one domain at a time. This is useful if you want to use
45231 <varname>$domain</varname> in an expansion for the transport, because it is set only when there
45232 is a single domain involved in a remote delivery.
45233 </para>
45234 <para>
45235 <indexterm role="option">
45236 <primary><option>port</option></primary>
45237 </indexterm>
45238 </para>
45239 <informaltable frame="all">
45240 <tgroup cols="4" colsep="0" rowsep="0">
45241 <colspec colwidth="8*" align="left"/>
45242 <colspec colwidth="6*" align="center"/>
45243 <colspec colwidth="6*" align="center"/>
45244 <colspec colwidth="6*" align="right"/>
45245 <tbody>
45246 <row>
45247 <entry><option>port</option></entry>
45248 <entry>Use: <emphasis>smtp</emphasis></entry>
45249 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
45250 <entry>Default: <emphasis>see below</emphasis></entry>
45251 </row>
45252 </tbody>
45253 </tgroup>
45254 </informaltable>
45255 <para>
45256 <indexterm role="concept">
45257 <primary>port</primary>
45258 <secondary>sending TCP/IP</secondary>
45259 </indexterm>
45260 <indexterm role="concept">
45261 <primary>TCP/IP</primary>
45262 <secondary>setting outgoing port</secondary>
45263 </indexterm>
45264 This option specifies the TCP/IP port on the server to which Exim connects.
45265 <emphasis role="bold">Note:</emphasis> Do not confuse this with the port that was used when a message was
45266 received, which is in <varname>$received_port</varname>, formerly known as <varname>$interface_port</varname>.
45267 The name was changed to minimize confusion with the outgoing port. There is no
45268 variable that contains an outgoing port.
45269 </para>
45270 <para>
45271 If the value of this option begins with a digit it is taken as a port number;
45272 otherwise it is looked up using <function>getservbyname()</function>. The default value is
45273 normally <quote>smtp</quote>, but if <option>protocol</option> is set to <quote>lmtp</quote>, the default is
45274 <quote>lmtp</quote>. If the expansion fails, or if a port number cannot be found, delivery
45275 is deferred.
45276 </para>
45277 <para>
45278 <indexterm role="option">
45279 <primary><option>protocol</option></primary>
45280 </indexterm>
45281 </para>
45282 <informaltable frame="all">
45283 <tgroup cols="4" colsep="0" rowsep="0">
45284 <colspec colwidth="8*" align="left"/>
45285 <colspec colwidth="6*" align="center"/>
45286 <colspec colwidth="6*" align="center"/>
45287 <colspec colwidth="6*" align="right"/>
45288 <tbody>
45289 <row>
45290 <entry><option>protocol</option></entry>
45291 <entry>Use: <emphasis>smtp</emphasis></entry>
45292 <entry>Type: <emphasis>string</emphasis></entry>
45293 <entry>Default: <emphasis>smtp</emphasis></entry>
45294 </row>
45295 </tbody>
45296 </tgroup>
45297 </informaltable>
45298 <para>
45299 <indexterm role="concept">
45300 <primary>LMTP</primary>
45301 <secondary>over TCP/IP</secondary>
45302 </indexterm>
45303 <indexterm role="concept">
45304 <primary>ssmtp protocol</primary>
45305 <secondary>outbound</secondary>
45306 </indexterm>
45307 <indexterm role="concept">
45308 <primary>TLS</primary>
45309 <secondary>SSL-on-connect outbound</secondary>
45310 </indexterm>
45311 <indexterm role="variable">
45312 <primary><varname>$port</varname></primary>
45313 </indexterm>
45314 If this option is set to <quote>lmtp</quote> instead of <quote>smtp</quote>, the default value for
45315 the <option>port</option> option changes to <quote>lmtp</quote>, and the transport operates the LMTP
45316 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
45317 deliveries into closed message stores. Exim also has support for running LMTP
45318 over a pipe to a local process &ndash; see chapter <xref linkend="CHAPLMTP"/>.
45319 </para>
45320 <para>
45321 If this option is set to <quote>smtps</quote>, the default vaule for the <option>port</option> option
45322 changes to <quote>smtps</quote>, and the transport initiates TLS immediately after
45323 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
45324 The Internet standards bodies strongly discourage use of this mode.
45325 </para>
45326 <para>
45327 <indexterm role="option">
45328 <primary><option>retry_include_ip_address</option></primary>
45329 </indexterm>
45330 </para>
45331 <informaltable frame="all">
45332 <tgroup cols="4" colsep="0" rowsep="0">
45333 <colspec colwidth="8*" align="left"/>
45334 <colspec colwidth="6*" align="center"/>
45335 <colspec colwidth="6*" align="center"/>
45336 <colspec colwidth="6*" align="right"/>
45337 <tbody>
45338 <row>
45339 <entry><option>retry_include_ip_address</option></entry>
45340 <entry>Use: <emphasis>smtp</emphasis></entry>
45341 <entry>Type: <emphasis>boolean</emphasis></entry>
45342 <entry>Default: <emphasis>true</emphasis></entry>
45343 </row>
45344 </tbody>
45345 </tgroup>
45346 </informaltable>
45347 <para>
45348 Exim normally includes both the host name and the IP address in the key it
45349 constructs for indexing retry data after a temporary delivery failure. This
45350 means that when one of several IP addresses for a host is failing, it gets
45351 tried periodically (controlled by the retry rules), but use of the other IP
45352 addresses is not affected.
45353 </para>
45354 <para>
45355 However, in some dialup environments hosts are assigned a different IP address
45356 each time they connect. In this situation the use of the IP address as part of
45357 the retry key leads to undesirable behaviour. Setting this option false causes
45358 Exim to use only the host name. This should normally be done on a separate
45359 instance of the <command>smtp</command> transport, set up specially to handle the dialup
45360 hosts.
45361 </para>
45362 <para>
45363 <indexterm role="option">
45364 <primary><option>serialize_hosts</option></primary>
45365 </indexterm>
45366 </para>
45367 <informaltable frame="all">
45368 <tgroup cols="4" colsep="0" rowsep="0">
45369 <colspec colwidth="8*" align="left"/>
45370 <colspec colwidth="6*" align="center"/>
45371 <colspec colwidth="6*" align="center"/>
45372 <colspec colwidth="6*" align="right"/>
45373 <tbody>
45374 <row>
45375 <entry><option>serialize_hosts</option></entry>
45376 <entry>Use: <emphasis>smtp</emphasis></entry>
45377 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis></emphasis></entry>
45378 <entry>Default: <emphasis>unset</emphasis></entry>
45379 </row>
45380 </tbody>
45381 </tgroup>
45382 </informaltable>
45383 <para>
45384 <indexterm role="concept">
45385 <primary>serializing connections</primary>
45386 </indexterm>
45387 <indexterm role="concept">
45388 <primary>host</primary>
45389 <secondary>serializing connections</secondary>
45390 </indexterm>
45391 Because Exim operates in a distributed manner, if several messages for the same
45392 host arrive at around the same time, more than one simultaneous connection to
45393 the remote host can occur. This is not usually a problem except when there is a
45394 slow link between the hosts. In that situation it may be helpful to restrict
45395 Exim to one connection at a time. This can be done by setting
45396 <option>serialize_hosts</option> to match the relevant hosts.
45397 </para>
45398 <para>
45399 <indexterm role="concept">
45400 <primary>hints database</primary>
45401 <secondary>serializing deliveries to a host</secondary>
45402 </indexterm>
45403 Exim implements serialization by means of a hints database in which a record is
45404 written whenever a process connects to one of the restricted hosts. The record
45405 is deleted when the connection is completed. Obviously there is scope for
45406 records to get left lying around if there is a system or program crash. To
45407 guard against this, Exim ignores any records that are more than six hours old.
45408 </para>
45409 <para>
45410 If you set up this kind of serialization, you should also arrange to delete the
45411 relevant hints database whenever your system reboots. The names of the files
45412 start with <filename>misc</filename> and they are kept in the <filename>spool/db</filename> directory. There
45413 may be one or two files, depending on the type of DBM in use. The same files
45414 are used for ETRN serialization.
45415 </para>
45416 <para>
45417 <indexterm role="option">
45418 <primary><option>size_addition</option></primary>
45419 </indexterm>
45420 </para>
45421 <informaltable frame="all">
45422 <tgroup cols="4" colsep="0" rowsep="0">
45423 <colspec colwidth="8*" align="left"/>
45424 <colspec colwidth="6*" align="center"/>
45425 <colspec colwidth="6*" align="center"/>
45426 <colspec colwidth="6*" align="right"/>
45427 <tbody>
45428 <row>
45429 <entry><option>size_addition</option></entry>
45430 <entry>Use: <emphasis>smtp</emphasis></entry>
45431 <entry>Type: <emphasis>integer</emphasis></entry>
45432 <entry>Default: <emphasis>1024</emphasis></entry>
45433 </row>
45434 </tbody>
45435 </tgroup>
45436 </informaltable>
45437 <para>
45438 <indexterm role="concept">
45439 <primary>SMTP</primary>
45440 <secondary>SIZE</secondary>
45441 </indexterm>
45442 <indexterm role="concept">
45443 <primary>message</primary>
45444 <secondary>size issue for transport filter</secondary>
45445 </indexterm>
45446 <indexterm role="concept">
45447 <primary>size</primary>
45448 <secondary>of message</secondary>
45449 </indexterm>
45450 <indexterm role="concept">
45451 <primary>transport</primary>
45452 <secondary>filter</secondary>
45453 </indexterm>
45454 <indexterm role="concept">
45455 <primary>filter</primary>
45456 <secondary>transport filter</secondary>
45457 </indexterm>
45458 If a remote SMTP server indicates that it supports the SIZE option of the
45459 MAIL command, Exim uses this to pass over the message size at the start of
45460 an SMTP transaction. It adds the value of <option>size_addition</option> to the value it
45461 sends, to allow for headers and other text that may be added during delivery by
45462 configuration options or in a transport filter. It may be necessary to increase
45463 this if a lot of text is added to messages.
45464 </para>
45465 <para>
45466 Alternatively, if the value of <option>size_addition</option> is set negative, it disables
45467 the use of the SIZE option altogether.
45468 </para>
45469 <para>
45470 <indexterm role="option">
45471 <primary><option>tls_certificate</option></primary>
45472 </indexterm>
45473 </para>
45474 <informaltable frame="all">
45475 <tgroup cols="4" colsep="0" rowsep="0">
45476 <colspec colwidth="8*" align="left"/>
45477 <colspec colwidth="6*" align="center"/>
45478 <colspec colwidth="6*" align="center"/>
45479 <colspec colwidth="6*" align="right"/>
45480 <tbody>
45481 <row>
45482 <entry><option>tls_certificate</option></entry>
45483 <entry>Use: <emphasis>smtp</emphasis></entry>
45484 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
45485 <entry>Default: <emphasis>unset</emphasis></entry>
45486 </row>
45487 </tbody>
45488 </tgroup>
45489 </informaltable>
45490 <para>
45491 <indexterm role="concept">
45492 <primary>TLS</primary>
45493 <secondary>client certificate, location of</secondary>
45494 </indexterm>
45495 <indexterm role="concept">
45496 <primary>certificate</primary>
45497 <secondary>client, location of</secondary>
45498 </indexterm>
45499 <indexterm role="variable">
45500 <primary><varname>$host</varname></primary>
45501 </indexterm>
45502 <indexterm role="variable">
45503 <primary><varname>$host_address</varname></primary>
45504 </indexterm>
45505 The value of this option must be the absolute path to a file which contains the
45506 client&#x2019;s certificate, for possible use when sending a message over an encrypted
45507 connection. The values of <varname>$host</varname> and <varname>$host_address</varname> are set to the name and
45508 address of the server during the expansion. See chapter <xref linkend="CHAPTLS"/> for
45509 details of TLS.
45510 </para>
45511 <para>
45512 <emphasis role="bold">Note</emphasis>: This option must be set if you want Exim to be able to use a TLS
45513 certificate when sending messages as a client. The global option of the same
45514 name specifies the certificate for Exim as a server; it is not automatically
45515 assumed that the same certificate should be used when Exim is operating as a
45516 client.
45517 </para>
45518 <para>
45519 <indexterm role="option">
45520 <primary><option>tls_crl</option></primary>
45521 </indexterm>
45522 </para>
45523 <informaltable frame="all">
45524 <tgroup cols="4" colsep="0" rowsep="0">
45525 <colspec colwidth="8*" align="left"/>
45526 <colspec colwidth="6*" align="center"/>
45527 <colspec colwidth="6*" align="center"/>
45528 <colspec colwidth="6*" align="right"/>
45529 <tbody>
45530 <row>
45531 <entry><option>tls_crl</option></entry>
45532 <entry>Use: <emphasis>smtp</emphasis></entry>
45533 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
45534 <entry>Default: <emphasis>unset</emphasis></entry>
45535 </row>
45536 </tbody>
45537 </tgroup>
45538 </informaltable>
45539 <para>
45540 <indexterm role="concept">
45541 <primary>TLS</primary>
45542 <secondary>client certificate revocation list</secondary>
45543 </indexterm>
45544 <indexterm role="concept">
45545 <primary>certificate</primary>
45546 <secondary>revocation list for client</secondary>
45547 </indexterm>
45548 This option specifies a certificate revocation list. The expanded value must
45549 be the name of a file that contains a CRL in PEM format.
45550 </para>
45551 <para>
45552 <indexterm role="option">
45553 <primary><option>tls_dh_min_bits</option></primary>
45554 </indexterm>
45555 </para>
45556 <informaltable frame="all">
45557 <tgroup cols="4" colsep="0" rowsep="0">
45558 <colspec colwidth="8*" align="left"/>
45559 <colspec colwidth="6*" align="center"/>
45560 <colspec colwidth="6*" align="center"/>
45561 <colspec colwidth="6*" align="right"/>
45562 <tbody>
45563 <row>
45564 <entry><option>tls_dh_min_bits</option></entry>
45565 <entry>Use: <emphasis>smtp</emphasis></entry>
45566 <entry>Type: <emphasis>integer</emphasis></entry>
45567 <entry>Default: <emphasis>1024</emphasis></entry>
45568 </row>
45569 </tbody>
45570 </tgroup>
45571 </informaltable>
45572 <para>
45573 <indexterm role="concept">
45574 <primary>TLS</primary>
45575 <secondary>Diffie-Hellman minimum acceptable size</secondary>
45576 </indexterm>
45577 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
45578 key agreement is negotiated, the server will provide a large prime number
45579 for use.  This option establishes the minimum acceptable size of that number.
45580 If the parameter offered by the server is too small, then the TLS handshake
45581 will fail.
45582 </para>
45583 <para>
45584 Only supported when using GnuTLS.
45585 </para>
45586 <para>
45587 <indexterm role="option">
45588 <primary><option>tls_privatekey</option></primary>
45589 </indexterm>
45590 </para>
45591 <informaltable frame="all">
45592 <tgroup cols="4" colsep="0" rowsep="0">
45593 <colspec colwidth="8*" align="left"/>
45594 <colspec colwidth="6*" align="center"/>
45595 <colspec colwidth="6*" align="center"/>
45596 <colspec colwidth="6*" align="right"/>
45597 <tbody>
45598 <row>
45599 <entry><option>tls_privatekey</option></entry>
45600 <entry>Use: <emphasis>smtp</emphasis></entry>
45601 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
45602 <entry>Default: <emphasis>unset</emphasis></entry>
45603 </row>
45604 </tbody>
45605 </tgroup>
45606 </informaltable>
45607 <para>
45608 <indexterm role="concept">
45609 <primary>TLS</primary>
45610 <secondary>client private key, location of</secondary>
45611 </indexterm>
45612 <indexterm role="variable">
45613 <primary><varname>$host</varname></primary>
45614 </indexterm>
45615 <indexterm role="variable">
45616 <primary><varname>$host_address</varname></primary>
45617 </indexterm>
45618 The value of this option must be the absolute path to a file which contains the
45619 client&#x2019;s private key. This is used when sending a message over an encrypted
45620 connection using a client certificate. The values of <varname>$host</varname> and
45621 <varname>$host_address</varname> are set to the name and address of the server during the
45622 expansion. If this option is unset, or the expansion is forced to fail, or the
45623 result is an empty string, the private key is assumed to be in the same file as
45624 the certificate. See chapter <xref linkend="CHAPTLS"/> for details of TLS.
45625 </para>
45626 <para>
45627 <indexterm role="option">
45628 <primary><option>tls_require_ciphers</option></primary>
45629 </indexterm>
45630 </para>
45631 <informaltable frame="all">
45632 <tgroup cols="4" colsep="0" rowsep="0">
45633 <colspec colwidth="8*" align="left"/>
45634 <colspec colwidth="6*" align="center"/>
45635 <colspec colwidth="6*" align="center"/>
45636 <colspec colwidth="6*" align="right"/>
45637 <tbody>
45638 <row>
45639 <entry><option>tls_require_ciphers</option></entry>
45640 <entry>Use: <emphasis>smtp</emphasis></entry>
45641 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
45642 <entry>Default: <emphasis>unset</emphasis></entry>
45643 </row>
45644 </tbody>
45645 </tgroup>
45646 </informaltable>
45647 <para>
45648 <indexterm role="concept">
45649 <primary>TLS</primary>
45650 <secondary>requiring specific ciphers</secondary>
45651 </indexterm>
45652 <indexterm role="concept">
45653 <primary>cipher</primary>
45654 <secondary>requiring specific</secondary>
45655 </indexterm>
45656 <indexterm role="variable">
45657 <primary><varname>$host</varname></primary>
45658 </indexterm>
45659 <indexterm role="variable">
45660 <primary><varname>$host_address</varname></primary>
45661 </indexterm>
45662 The value of this option must be a list of permitted cipher suites, for use
45663 when setting up an outgoing encrypted connection. (There is a global option of
45664 the same name for controlling incoming connections.) The values of <varname>$host</varname> and
45665 <varname>$host_address</varname> are set to the name and address of the server during the
45666 expansion. See chapter <xref linkend="CHAPTLS"/> for details of TLS; note that this option
45667 is used in different ways by OpenSSL and GnuTLS (see sections
45668 <xref linkend="SECTreqciphssl"/> and <xref linkend="SECTreqciphgnu"/>). For GnuTLS, the order of the
45669 ciphers is a preference order.
45670 </para>
45671 <para>
45672 <indexterm role="option">
45673 <primary><option>tls_sni</option></primary>
45674 </indexterm>
45675 </para>
45676 <informaltable frame="all">
45677 <tgroup cols="4" colsep="0" rowsep="0">
45678 <colspec colwidth="8*" align="left"/>
45679 <colspec colwidth="6*" align="center"/>
45680 <colspec colwidth="6*" align="center"/>
45681 <colspec colwidth="6*" align="right"/>
45682 <tbody>
45683 <row>
45684 <entry><option>tls_sni</option></entry>
45685 <entry>Use: <emphasis>smtp</emphasis></entry>
45686 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
45687 <entry>Default: <emphasis>unset</emphasis></entry>
45688 </row>
45689 </tbody>
45690 </tgroup>
45691 </informaltable>
45692 <para>
45693 <indexterm role="concept">
45694 <primary>TLS</primary>
45695 <secondary>Server Name Indication</secondary>
45696 </indexterm>
45697 <indexterm role="variable">
45698 <primary><varname>$tls_sni</varname></primary>
45699 </indexterm>
45700 If this option is set then it sets the $tls_out_sni variable and causes any
45701 TLS session to pass this value as the Server Name Indication extension to
45702 the remote side, which can be used by the remote side to select an appropriate
45703 certificate and private key for the session.
45704 </para>
45705 <para>
45706 See <xref linkend="SECTtlssni"/> for more information.
45707 </para>
45708 <para>
45709 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
45710 TLS extensions.
45711 </para>
45712 <para>
45713 <indexterm role="option">
45714 <primary><option>tls_tempfail_tryclear</option></primary>
45715 </indexterm>
45716 </para>
45717 <informaltable frame="all">
45718 <tgroup cols="4" colsep="0" rowsep="0">
45719 <colspec colwidth="8*" align="left"/>
45720 <colspec colwidth="6*" align="center"/>
45721 <colspec colwidth="6*" align="center"/>
45722 <colspec colwidth="6*" align="right"/>
45723 <tbody>
45724 <row>
45725 <entry><option>tls_tempfail_tryclear</option></entry>
45726 <entry>Use: <emphasis>smtp</emphasis></entry>
45727 <entry>Type: <emphasis>boolean</emphasis></entry>
45728 <entry>Default: <emphasis>true</emphasis></entry>
45729 </row>
45730 </tbody>
45731 </tgroup>
45732 </informaltable>
45733 <para>
45734 <indexterm role="concept">
45735 <primary>4<emphasis>xx</emphasis> responses</primary>
45736 <secondary>to STARTTLS</secondary>
45737 </indexterm>
45738 When the server host is not in <option>hosts_require_tls</option>, and there is a problem in
45739 setting up a TLS session, this option determines whether or not Exim should try
45740 to deliver the message unencrypted. If it is set false, delivery to the
45741 current host is deferred; if there are other hosts, they are tried. If this
45742 option is set true, Exim attempts to deliver unencrypted after a 4<emphasis>xx</emphasis>
45743 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
45744 TLS negotiation fails, Exim closes the current connection (because it is in an
45745 unknown state), opens a new one to the same host, and then tries the delivery
45746 in clear.
45747 </para>
45748 <para>
45749 <indexterm role="option">
45750 <primary><option>tls_try_verify_hosts</option></primary>
45751 </indexterm>
45752 </para>
45753 <informaltable frame="all">
45754 <tgroup cols="4" colsep="0" rowsep="0">
45755 <colspec colwidth="8*" align="left"/>
45756 <colspec colwidth="6*" align="center"/>
45757 <colspec colwidth="6*" align="center"/>
45758 <colspec colwidth="6*" align="right"/>
45759 <tbody>
45760 <row>
45761 <entry><option>tls_try_verify_hosts</option></entry>
45762 <entry>Use: <emphasis>smtp</emphasis></entry>
45763 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis> unset</emphasis></entry>
45764 <entry>Default: <emphasis></emphasis></entry>
45765 </row>
45766 </tbody>
45767 </tgroup>
45768 </informaltable>
45769 <para>
45770 <indexterm role="concept">
45771 <primary>TLS</primary>
45772 <secondary>server certificate verification</secondary>
45773 </indexterm>
45774 <indexterm role="concept">
45775 <primary>certificate</primary>
45776 <secondary>verification of server</secondary>
45777 </indexterm>
45778 This option gives a list of hosts for which, on encrypted connections,
45779 certificate verification will be tried but need not succeed.
45780 The <option>tls_verify_certificates</option> option must also be set.
45781 Note that unless the host is in this list
45782 TLS connections will be denied to hosts using self-signed certificates
45783 when <option>tls_verify_certificates</option> is set.
45784 The <varname>$tls_out_certificate_verified</varname> variable is set when
45785 certificate verification succeeds.
45786 </para>
45787 <para>
45788 <indexterm role="option">
45789 <primary><option>tls_verify_certificates</option></primary>
45790 </indexterm>
45791 </para>
45792 <informaltable frame="all">
45793 <tgroup cols="4" colsep="0" rowsep="0">
45794 <colspec colwidth="8*" align="left"/>
45795 <colspec colwidth="6*" align="center"/>
45796 <colspec colwidth="6*" align="center"/>
45797 <colspec colwidth="6*" align="right"/>
45798 <tbody>
45799 <row>
45800 <entry><option>tls_verify_certificates</option></entry>
45801 <entry>Use: <emphasis>smtp</emphasis></entry>
45802 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
45803 <entry>Default: <emphasis>unset</emphasis></entry>
45804 </row>
45805 </tbody>
45806 </tgroup>
45807 </informaltable>
45808 <para>
45809 <indexterm role="concept">
45810 <primary>TLS</primary>
45811 <secondary>server certificate verification</secondary>
45812 </indexterm>
45813 <indexterm role="concept">
45814 <primary>certificate</primary>
45815 <secondary>verification of server</secondary>
45816 </indexterm>
45817 <indexterm role="variable">
45818 <primary><varname>$host</varname></primary>
45819 </indexterm>
45820 <indexterm role="variable">
45821 <primary><varname>$host_address</varname></primary>
45822 </indexterm>
45823 The value of this option must be the absolute path to a file containing
45824 permitted server certificates, for use when setting up an encrypted connection.
45825 Alternatively, if you are using OpenSSL, you can set
45826 <option>tls_verify_certificates</option> to the name of a directory containing certificate
45827 files. This does not work with GnuTLS; the option must be set to the name of a
45828 single file if you are using GnuTLS. The values of <varname>$host</varname> and
45829 <varname>$host_address</varname> are set to the name and address of the server during the
45830 expansion of this option. See chapter <xref linkend="CHAPTLS"/> for details of TLS.
45831 </para>
45832 <para>
45833 For back-compatability,
45834 if neither tls_verify_hosts nor tls_try_verify_hosts are set
45835 and certificate verification fails the TLS connection is closed.
45836 </para>
45837 <para>
45838 <indexterm role="option">
45839 <primary><option>tls_verify_hosts</option></primary>
45840 </indexterm>
45841 </para>
45842 <informaltable frame="all">
45843 <tgroup cols="4" colsep="0" rowsep="0">
45844 <colspec colwidth="8*" align="left"/>
45845 <colspec colwidth="6*" align="center"/>
45846 <colspec colwidth="6*" align="center"/>
45847 <colspec colwidth="6*" align="right"/>
45848 <tbody>
45849 <row>
45850 <entry><option>tls_verify_hosts</option></entry>
45851 <entry>Use: <emphasis>smtp</emphasis></entry>
45852 <entry>Type: <emphasis>host list</emphasis>&dagger;<emphasis> unset</emphasis></entry>
45853 <entry>Default: <emphasis></emphasis></entry>
45854 </row>
45855 </tbody>
45856 </tgroup>
45857 </informaltable>
45858 <para>
45859 <indexterm role="concept">
45860 <primary>TLS</primary>
45861 <secondary>server certificate verification</secondary>
45862 </indexterm>
45863 <indexterm role="concept">
45864 <primary>certificate</primary>
45865 <secondary>verification of server</secondary>
45866 </indexterm>
45867 This option gives a list of hosts for which. on encrypted connections,
45868 certificate verification must succeed.
45869 The <option>tls_verify_certificates</option> option must also be set.
45870 If both this option and <option>tls_try_verify_hosts</option> are unset
45871 operation is as if this option selected all hosts.
45872 </para>
45873 </section>
45874 <section id="SECTvalhosmax">
45875 <title>How the limits for the number of hosts to try are used</title>
45876 <para>
45877 <indexterm role="concept">
45878 <primary>host</primary>
45879 <secondary>maximum number to try</secondary>
45880 </indexterm>
45881 <indexterm role="concept">
45882 <primary>limit</primary>
45883 <secondary>hosts; maximum number tried</secondary>
45884 </indexterm>
45885 There are two options that are concerned with the number of hosts that are
45886 tried when an SMTP delivery takes place. They are <option>hosts_max_try</option> and
45887 <option>hosts_max_try_hardlimit</option>.
45888 </para>
45889 <para>
45890 The <option>hosts_max_try</option> option limits the number of hosts that are tried
45891 for a single delivery. However, despite the term <quote>host</quote> in its name, the
45892 option actually applies to each IP address independently. In other words, a
45893 multihomed host is treated as several independent hosts, just as it is for
45894 retrying.
45895 </para>
45896 <para>
45897 Many of the larger ISPs have multiple MX records which often point to
45898 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
45899 created as a result of routing one of these domains.
45900 </para>
45901 <para>
45902 Trying every single IP address on such a long list does not seem sensible; if
45903 several at the top of the list fail, it is reasonable to assume there is some
45904 problem that is likely to affect all of them. Roughly speaking, the value of
45905 <option>hosts_max_try</option> is the maximum number that are tried before deferring the
45906 delivery. However, the logic cannot be quite that simple.
45907 </para>
45908 <para>
45909 Firstly, IP addresses that are skipped because their retry times have not
45910 arrived do not count, and in addition, addresses that are past their retry
45911 limits are also not counted, even when they are tried. This means that when
45912 some IP addresses are past their retry limits, more than the value of
45913 <option>hosts_max_retry</option> may be tried. The reason for this behaviour is to ensure
45914 that all IP addresses are considered before timing out an email address (but
45915 see below for an exception).
45916 </para>
45917 <para>
45918 Secondly, when the <option>hosts_max_try</option> limit is reached, Exim looks down the host
45919 list to see if there is a subsequent host with a different (higher valued) MX.
45920 If there is, that host is considered next, and the current IP address is used
45921 but not counted. This behaviour helps in the case of a domain with a retry rule
45922 that hardly ever delays any hosts, as is now explained:
45923 </para>
45924 <para>
45925 Consider the case of a long list of hosts with one MX value, and a few with a
45926 higher MX value. If <option>hosts_max_try</option> is small (the default is 5) only a few
45927 hosts at the top of the list are tried at first. With the default retry rule,
45928 which specifies increasing retry times, the higher MX hosts are eventually
45929 tried when those at the top of the list are skipped because they have not
45930 reached their retry times.
45931 </para>
45932 <para>
45933 However, it is common practice to put a fixed short retry time on domains for
45934 large ISPs, on the grounds that their servers are rarely down for very long.
45935 Unfortunately, these are exactly the domains that tend to resolve to long lists
45936 of hosts. The short retry time means that the lowest MX hosts are tried every
45937 time. The attempts may be in a different order because of random sorting, but
45938 without the special MX check, the higher MX hosts would never be tried until
45939 all the lower MX hosts had timed out (which might be several days), because
45940 there are always some lower MX hosts that have reached their retry times. With
45941 the special check, Exim considers at least one IP address from each MX value at
45942 every delivery attempt, even if the <option>hosts_max_try</option> limit has already been
45943 reached.
45944 </para>
45945 <para>
45946 The above logic means that <option>hosts_max_try</option> is not a hard limit, and in
45947 particular, Exim normally eventually tries all the IP addresses before timing
45948 out an email address. When <option>hosts_max_try</option> was implemented, this seemed a
45949 reasonable thing to do. Recently, however, some lunatic DNS configurations have
45950 been set up with hundreds of IP addresses for some domains. It can
45951 take a very long time indeed for an address to time out in these cases.
45952 </para>
45953 <para>
45954 The <option>hosts_max_try_hardlimit</option> option was added to help with this problem.
45955 Exim never tries more than this number of IP addresses; if it hits this limit
45956 and they are all timed out, the email address is bounced, even though not all
45957 possible IP addresses have been tried.
45958 <indexterm role="concept" startref="IIDsmttra1" class="endofrange"/>
45959 <indexterm role="concept" startref="IIDsmttra2" class="endofrange"/>
45960 </para>
45961 </section>
45962 </chapter>
45963
45964 <chapter id="CHAPrewrite">
45965 <title>Address rewriting</title>
45966 <para>
45967 <indexterm role="concept" id="IIDaddrew" class="startofrange">
45968 <primary>rewriting</primary>
45969 <secondary>addresses</secondary>
45970 </indexterm>
45971 There are some circumstances in which Exim automatically rewrites domains in
45972 addresses. The two most common are when an address is given without a domain
45973 (referred to as an <quote>unqualified address</quote>) or when an address contains an
45974 abbreviated domain that is expanded by DNS lookup.
45975 </para>
45976 <para>
45977 Unqualified envelope addresses are accepted only for locally submitted
45978 messages, or for messages that are received from hosts matching
45979 <option>sender_unqualified_hosts</option> or <option>recipient_unqualified_hosts</option>, as
45980 appropriate. Unqualified addresses in header lines are qualified if they are in
45981 locally submitted messages, or messages from hosts that are permitted to send
45982 unqualified envelope addresses. Otherwise, unqualified addresses in header
45983 lines are neither qualified nor rewritten.
45984 </para>
45985 <para>
45986 One situation in which Exim does <emphasis>not</emphasis> automatically rewrite a domain is
45987 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
45988 such a domain should be rewritten using the <quote>canonical</quote> name, and some MTAs
45989 do this. The new RFCs do not contain this suggestion.
45990 </para>
45991 <section id="SECID147">
45992 <title>Explicitly configured address rewriting</title>
45993 <para>
45994 This chapter describes the rewriting rules that can be used in the
45995 main rewrite section of the configuration file, and also in the generic
45996 <option>headers_rewrite</option> option that can be set on any transport.
45997 </para>
45998 <para>
45999 Some people believe that configured address rewriting is a Mortal Sin.
46000 Others believe that life is not possible without it. Exim provides the
46001 facility; you do not have to use it.
46002 </para>
46003 <para>
46004 The main rewriting rules that appear in the <quote>rewrite</quote> section of the
46005 configuration file are applied to addresses in incoming messages, both envelope
46006 addresses and addresses in header lines. Each rule specifies the types of
46007 address to which it applies.
46008 </para>
46009 <para>
46010 Whether or not addresses in header lines are rewritten depends on the origin of
46011 the headers and the type of rewriting. Global rewriting, that is, rewriting
46012 rules from the rewrite section of the configuration file, is applied only to
46013 those headers that were received with the message. Header lines that are added
46014 by ACLs or by a system filter or by individual routers or transports (which
46015 are specific to individual recipient addresses) are not rewritten by the global
46016 rules.
46017 </para>
46018 <para>
46019 Rewriting at transport time, by means of the <option>headers_rewrite</option> option,
46020 applies all headers except those added by routers and transports. That is, as
46021 well as the headers that were received with the message, it also applies to
46022 headers that were added by an ACL or a system filter.
46023 </para>
46024 <para>
46025 In general, rewriting addresses from your own system or domain has some
46026 legitimacy. Rewriting other addresses should be done only with great care and
46027 in special circumstances. The author of Exim believes that rewriting should be
46028 used sparingly, and mainly for <quote>regularizing</quote> addresses in your own domains.
46029 Although it can sometimes be used as a routing tool, this is very strongly
46030 discouraged.
46031 </para>
46032 <para>
46033 There are two commonly encountered circumstances where rewriting is used, as
46034 illustrated by these examples:
46035 </para>
46036 <itemizedlist>
46037 <listitem>
46038 <para>
46039 The company whose domain is <emphasis>hitch.fict.example</emphasis> has a number of hosts that
46040 exchange mail with each other behind a firewall, but there is only a single
46041 gateway to the outer world. The gateway rewrites <emphasis>*.hitch.fict.example</emphasis> as
46042 <emphasis>hitch.fict.example</emphasis> when sending mail off-site.
46043 </para>
46044 </listitem>
46045 <listitem>
46046 <para>
46047 A host rewrites the local parts of its own users so that, for example,
46048 <emphasis>fp42@hitch.fict.example</emphasis> becomes <emphasis>Ford.Prefect@hitch.fict.example</emphasis>.
46049 </para>
46050 </listitem>
46051 </itemizedlist>
46052 </section>
46053 <section id="SECID148">
46054 <title>When does rewriting happen?</title>
46055 <para>
46056 <indexterm role="concept">
46057 <primary>rewriting</primary>
46058 <secondary>timing of</secondary>
46059 </indexterm>
46060 <indexterm role="concept">
46061 <primary>access control lists (ACLs)</primary>
46062 <secondary>rewriting addresses in</secondary>
46063 </indexterm>
46064 Configured address rewriting can take place at several different stages of a
46065 message&#x2019;s processing.
46066 </para>
46067 <para>
46068 <indexterm role="variable">
46069 <primary><varname>$sender_address</varname></primary>
46070 </indexterm>
46071 At the start of an ACL for MAIL, the sender address may have been rewritten
46072 by a special SMTP-time rewrite rule (see section <xref linkend="SECTrewriteS"/>), but no
46073 ordinary rewrite rules have yet been applied. If, however, the sender address
46074 is verified in the ACL, it is rewritten before verification, and remains
46075 rewritten thereafter. The subsequent value of <varname>$sender_address</varname> is the
46076 rewritten address. This also applies if sender verification happens in a
46077 RCPT ACL. Otherwise, when the sender address is not verified, it is
46078 rewritten as soon as a message&#x2019;s header lines have been received.
46079 </para>
46080 <para>
46081 <indexterm role="variable">
46082 <primary><varname>$domain</varname></primary>
46083 </indexterm>
46084 <indexterm role="variable">
46085 <primary><varname>$local_part</varname></primary>
46086 </indexterm>
46087 Similarly, at the start of an ACL for RCPT, the current recipient&#x2019;s address
46088 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
46089 rewrite rules have yet been applied to it. However, the behaviour is different
46090 from the sender address when a recipient is verified. The address is rewritten
46091 for the verification, but the rewriting is not remembered at this stage. The
46092 value of <varname>$local_part</varname> and <varname>$domain</varname> after verification are always the same
46093 as they were before (that is, they contain the unrewritten &ndash; except for
46094 SMTP-time rewriting &ndash; address).
46095 </para>
46096 <para>
46097 As soon as a message&#x2019;s header lines have been received, all the envelope
46098 recipient addresses are permanently rewritten, and rewriting is also applied to
46099 the addresses in the header lines (if configured). This happens before adding
46100 any header lines that were specified in MAIL or RCPT ACLs, and
46101 <indexterm role="concept">
46102 <primary><function>local_scan()</function> function</primary>
46103 <secondary>address rewriting; timing of</secondary>
46104 </indexterm>
46105 before the DATA ACL and <function>local_scan()</function> functions are run.
46106 </para>
46107 <para>
46108 When an address is being routed, either for delivery or for verification,
46109 rewriting is applied immediately to child addresses that are generated by
46110 redirection, unless <option>no_rewrite</option> is set on the router.
46111 </para>
46112 <para>
46113 <indexterm role="concept">
46114 <primary>envelope sender</primary>
46115 <secondary>rewriting at transport time</secondary>
46116 </indexterm>
46117 <indexterm role="concept">
46118 <primary>rewriting</primary>
46119 <secondary>at transport time</secondary>
46120 </indexterm>
46121 <indexterm role="concept">
46122 <primary>header lines</primary>
46123 <secondary>rewriting at transport time</secondary>
46124 </indexterm>
46125 At transport time, additional rewriting of addresses in header lines can be
46126 specified by setting the generic <option>headers_rewrite</option> option on a transport.
46127 This option contains rules that are identical in form to those in the rewrite
46128 section of the configuration file. They are applied to the original message
46129 header lines and any that were added by ACLs or a system filter. They are not
46130 applied to header lines that are added by routers or the transport.
46131 </para>
46132 <para>
46133 The outgoing envelope sender can be rewritten by means of the <option>return_path</option>
46134 transport option. However, it is not possible to rewrite envelope recipients at
46135 transport time.
46136 </para>
46137 </section>
46138 <section id="SECID149">
46139 <title>Testing the rewriting rules that apply on input</title>
46140 <para>
46141 <indexterm role="concept">
46142 <primary>rewriting</primary>
46143 <secondary>testing</secondary>
46144 </indexterm>
46145 <indexterm role="concept">
46146 <primary>testing</primary>
46147 <secondary>rewriting</secondary>
46148 </indexterm>
46149 Exim&#x2019;s input rewriting configuration appears in a part of the run time
46150 configuration file headed by <quote>begin rewrite</quote>. It can be tested by the
46151 <option>-brw</option> command line option. This takes an address (which can be a full RFC
46152 2822 address) as its argument. The output is a list of how the address would be
46153 transformed by the rewriting rules for each of the different places it might
46154 appear in an incoming message, that is, for each different header and for the
46155 envelope sender and recipient fields. For example,
46156 </para>
46157 <literallayout class="monospaced">
46158 exim -brw ph10@exim.workshop.example
46159 </literallayout>
46160 <para>
46161 might produce the output
46162 </para>
46163 <literallayout class="monospaced">
46164 sender: Philip.Hazel@exim.workshop.example
46165 from: Philip.Hazel@exim.workshop.example
46166 to: ph10@exim.workshop.example
46167 cc: ph10@exim.workshop.example
46168 bcc: ph10@exim.workshop.example
46169 reply-to: Philip.Hazel@exim.workshop.example
46170 env-from: Philip.Hazel@exim.workshop.example
46171 env-to: ph10@exim.workshop.example
46172 </literallayout>
46173 <para>
46174 which shows that rewriting has been set up for that address when used in any of
46175 the source fields, but not when it appears as a recipient address. At the
46176 present time, there is no equivalent way of testing rewriting rules that are
46177 set for a particular transport.
46178 </para>
46179 </section>
46180 <section id="SECID150">
46181 <title>Rewriting rules</title>
46182 <para>
46183 <indexterm role="concept">
46184 <primary>rewriting</primary>
46185 <secondary>rules</secondary>
46186 </indexterm>
46187 The rewrite section of the configuration file consists of lines of rewriting
46188 rules in the form
46189 </para>
46190 <literallayout>
46191 &lt;<emphasis>source pattern</emphasis>&gt;  &lt;<emphasis>replacement</emphasis>&gt;  &lt;<emphasis>flags</emphasis>&gt;
46192 </literallayout>
46193 <para>
46194 Rewriting rules that are specified for the <option>headers_rewrite</option> generic
46195 transport option are given as a colon-separated list. Each item in the list
46196 takes the same form as a line in the main rewriting configuration (except that
46197 any colons must be doubled, of course).
46198 </para>
46199 <para>
46200 The formats of source patterns and replacement strings are described below.
46201 Each is terminated by white space, unless enclosed in double quotes, in which
46202 case normal quoting conventions apply inside the quotes. The flags are single
46203 characters which may appear in any order. Spaces and tabs between them are
46204 ignored.
46205 </para>
46206 <para>
46207 For each address that could potentially be rewritten, the rules are scanned in
46208 order, and replacements for the address from earlier rules can themselves be
46209 replaced by later rules (but see the <quote>q</quote> and <quote>R</quote> flags).
46210 </para>
46211 <para>
46212 The order in which addresses are rewritten is undefined, may change between
46213 releases, and must not be relied on, with one exception: when a message is
46214 received, the envelope sender is always rewritten first, before any header
46215 lines are rewritten. For example, the replacement string for a rewrite of an
46216 address in <emphasis>To:</emphasis> must not assume that the message&#x2019;s address in <emphasis>From:</emphasis> has
46217 (or has not) already been rewritten. However, a rewrite of <emphasis>From:</emphasis> may assume
46218 that the envelope sender has already been rewritten.
46219 </para>
46220 <para>
46221 <indexterm role="variable">
46222 <primary><varname>$domain</varname></primary>
46223 </indexterm>
46224 <indexterm role="variable">
46225 <primary><varname>$local_part</varname></primary>
46226 </indexterm>
46227 The variables <varname>$local_part</varname> and <varname>$domain</varname> can be used in the replacement
46228 string to refer to the address that is being rewritten. Note that lookup-driven
46229 rewriting can be done by a rule of the form
46230 </para>
46231 <literallayout class="monospaced">
46232 *@*   ${lookup ...
46233 </literallayout>
46234 <para>
46235 where the lookup key uses <varname>$1</varname> and <varname>$2</varname> or <varname>$local_part</varname> and <varname>$domain</varname> to
46236 refer to the address that is being rewritten.
46237 </para>
46238 </section>
46239 <section id="SECID151">
46240 <title>Rewriting patterns</title>
46241 <para>
46242 <indexterm role="concept">
46243 <primary>rewriting</primary>
46244 <secondary>patterns</secondary>
46245 </indexterm>
46246 <indexterm role="concept">
46247 <primary>address list</primary>
46248 <secondary>in a rewriting pattern</secondary>
46249 </indexterm>
46250 The source pattern in a rewriting rule is any item which may appear in an
46251 address list (see section <xref linkend="SECTaddresslist"/>). It is in fact processed as a
46252 single-item address list, which means that it is expanded before being tested
46253 against the address. As always, if you use a regular expression as a pattern,
46254 you must take care to escape dollar and backslash characters, or use the <literal>\N</literal>
46255 facility to suppress string expansion within the regular expression.
46256 </para>
46257 <para>
46258 Domains in patterns should be given in lower case. Local parts in patterns are
46259 case-sensitive. If you want to do case-insensitive matching of local parts, you
46260 can use a regular expression that starts with <literal>^(?i)</literal>.
46261 </para>
46262 <para>
46263 <indexterm role="concept">
46264 <primary>numerical variables (<varname>$1</varname> <varname>$2</varname> etc)</primary>
46265 <secondary>in rewriting rules</secondary>
46266 </indexterm>
46267 After matching, the numerical variables <varname>$1</varname>, <varname>$2</varname>, etc. may be set,
46268 depending on the type of match which occurred. These can be used in the
46269 replacement string to insert portions of the incoming address. <varname>$0</varname> always
46270 refers to the complete incoming address. When a regular expression is used, the
46271 numerical variables are set from its capturing subexpressions. For other types
46272 of pattern they are set as follows:
46273 </para>
46274 <itemizedlist>
46275 <listitem>
46276 <para>
46277 If a local part or domain starts with an asterisk, the numerical variables
46278 refer to the character strings matched by asterisks, with <varname>$1</varname> associated with
46279 the first asterisk, and <varname>$2</varname> with the second, if present. For example, if the
46280 pattern
46281 </para>
46282 <literallayout class="monospaced">
46283 *queen@*.fict.example
46284 </literallayout>
46285 <para>
46286 is matched against the address <emphasis>hearts-queen@wonderland.fict.example</emphasis> then
46287 </para>
46288 <literallayout class="monospaced">
46289 $0 = hearts-queen@wonderland.fict.example
46290 $1 = hearts-
46291 $2 = wonderland
46292 </literallayout>
46293 <para>
46294 Note that if the local part does not start with an asterisk, but the domain
46295 does, it is <varname>$1</varname> that contains the wild part of the domain.
46296 </para>
46297 </listitem>
46298 <listitem>
46299 <para>
46300 If the domain part of the pattern is a partial lookup, the wild and fixed parts
46301 of the domain are placed in the next available numerical variables. Suppose,
46302 for example, that the address <emphasis>foo@bar.baz.example</emphasis> is processed by a
46303 rewriting rule of the form
46304 </para>
46305 <literallayout>
46306 <literal>*@partial-dbm;/some/dbm/file</literal>    &lt;<emphasis>replacement string</emphasis>&gt;
46307 </literallayout>
46308 <para>
46309 and the key in the file that matches the domain is <literal>*.baz.example</literal>. Then
46310 </para>
46311 <literallayout class="monospaced">
46312 $1 = foo
46313 $2 = bar
46314 $3 = baz.example
46315 </literallayout>
46316 <para>
46317 If the address <emphasis>foo@baz.example</emphasis> is looked up, this matches the same
46318 wildcard file entry, and in this case <varname>$2</varname> is set to the empty string, but
46319 <varname>$3</varname> is still set to <emphasis>baz.example</emphasis>. If a non-wild key is matched in a
46320 partial lookup, <varname>$2</varname> is again set to the empty string and <varname>$3</varname> is set to the
46321 whole domain. For non-partial domain lookups, no numerical variables are set.
46322 </para>
46323 </listitem>
46324 </itemizedlist>
46325 </section>
46326 <section id="SECID152">
46327 <title>Rewriting replacements</title>
46328 <para>
46329 <indexterm role="concept">
46330 <primary>rewriting</primary>
46331 <secondary>replacements</secondary>
46332 </indexterm>
46333 If the replacement string for a rule is a single asterisk, addresses that
46334 match the pattern and the flags are <emphasis>not</emphasis> rewritten, and no subsequent
46335 rewriting rules are scanned. For example,
46336 </para>
46337 <literallayout class="monospaced">
46338 hatta@lookingglass.fict.example  *  f
46339 </literallayout>
46340 <para>
46341 specifies that <emphasis>hatta@lookingglass.fict.example</emphasis> is never to be rewritten in
46342 <emphasis>From:</emphasis> headers.
46343 </para>
46344 <para>
46345 <indexterm role="variable">
46346 <primary><varname>$domain</varname></primary>
46347 </indexterm>
46348 <indexterm role="variable">
46349 <primary><varname>$local_part</varname></primary>
46350 </indexterm>
46351 If the replacement string is not a single asterisk, it is expanded, and must
46352 yield a fully qualified address. Within the expansion, the variables
46353 <varname>$local_part</varname> and <varname>$domain</varname> refer to the address that is being rewritten.
46354 Any letters they contain retain their original case &ndash; they are not lower
46355 cased. The numerical variables are set up according to the type of pattern that
46356 matched the address, as described above. If the expansion is forced to fail by
46357 the presence of <quote>fail</quote> in a conditional or lookup item, rewriting by the
46358 current rule is abandoned, but subsequent rules may take effect. Any other
46359 expansion failure causes the entire rewriting operation to be abandoned, and an
46360 entry written to the panic log.
46361 </para>
46362 </section>
46363 <section id="SECID153">
46364 <title>Rewriting flags</title>
46365 <para>
46366 There are three different kinds of flag that may appear on rewriting rules:
46367 </para>
46368 <itemizedlist>
46369 <listitem>
46370 <para>
46371 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
46372 c, f, h, r, s, t.
46373 </para>
46374 </listitem>
46375 <listitem>
46376 <para>
46377 A flag that specifies rewriting at SMTP time: S.
46378 </para>
46379 </listitem>
46380 <listitem>
46381 <para>
46382 Flags that control the rewriting process: Q, q, R, w.
46383 </para>
46384 </listitem>
46385 </itemizedlist>
46386 <para>
46387 For rules that are part of the <option>headers_rewrite</option> generic transport option,
46388 E, F, T, and S are not permitted.
46389 </para>
46390 </section>
46391 <section id="SECID154">
46392 <title>Flags specifying which headers and envelope addresses to rewrite</title>
46393 <para>
46394 <indexterm role="concept">
46395 <primary>rewriting</primary>
46396 <secondary>flags</secondary>
46397 </indexterm>
46398 If none of the following flag letters, nor the <quote>S</quote> flag (see section
46399 <xref linkend="SECTrewriteS"/>) are present, a main rewriting rule applies to all headers
46400 and to both the sender and recipient fields of the envelope, whereas a
46401 transport-time rewriting rule just applies to all headers. Otherwise, the
46402 rewriting rule is skipped unless the relevant addresses are being processed.
46403 </para>
46404 <literallayout>
46405 <literal>E</literal>       rewrite all envelope fields
46406 <literal>F</literal>       rewrite the envelope From field
46407 <literal>T</literal>       rewrite the envelope To field
46408 <literal>b</literal>       rewrite the <emphasis>Bcc:</emphasis> header
46409 <literal>c</literal>       rewrite the <emphasis>Cc:</emphasis> header
46410 <literal>f</literal>       rewrite the <emphasis>From:</emphasis> header
46411 <literal>h</literal>       rewrite all headers
46412 <literal>r</literal>       rewrite the <emphasis>Reply-To:</emphasis> header
46413 <literal>s</literal>       rewrite the <emphasis>Sender:</emphasis> header
46414 <literal>t</literal>       rewrite the <emphasis>To:</emphasis> header
46415 </literallayout>
46416 <para>
46417 "All headers" means all of the headers listed above that can be selected
46418 individually, plus their <emphasis>Resent-</emphasis> versions. It does not include
46419 other headers such as <emphasis>Subject:</emphasis> etc.
46420 </para>
46421 <para>
46422 You should be particularly careful about rewriting <emphasis>Sender:</emphasis> headers, and
46423 restrict this to special known cases in your own domains.
46424 </para>
46425 </section>
46426 <section id="SECTrewriteS">
46427 <title>The SMTP-time rewriting flag</title>
46428 <para>
46429 <indexterm role="concept">
46430 <primary>SMTP</primary>
46431 <secondary>rewriting malformed addresses</secondary>
46432 </indexterm>
46433 <indexterm role="concept">
46434 <primary>RCPT</primary>
46435 <secondary>rewriting argument of</secondary>
46436 </indexterm>
46437 <indexterm role="concept">
46438 <primary>MAIL</primary>
46439 <secondary>rewriting argument of</secondary>
46440 </indexterm>
46441 The rewrite flag <quote>S</quote> specifies a rewrite of incoming envelope addresses at
46442 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
46443 before any other processing; even before syntax checking. The pattern is
46444 required to be a regular expression, and it is matched against the whole of the
46445 data for the command, including any surrounding angle brackets.
46446 </para>
46447 <para>
46448 <indexterm role="variable">
46449 <primary><varname>$domain</varname></primary>
46450 </indexterm>
46451 <indexterm role="variable">
46452 <primary><varname>$local_part</varname></primary>
46453 </indexterm>
46454 This form of rewrite rule allows for the handling of addresses that are not
46455 compliant with RFCs 2821 and 2822 (for example, <quote>bang paths</quote> in batched SMTP
46456 input). Because the input is not required to be a syntactically valid address,
46457 the variables <varname>$local_part</varname> and <varname>$domain</varname> are not available during the
46458 expansion of the replacement string. The result of rewriting replaces the
46459 original address in the MAIL or RCPT command.
46460 </para>
46461 </section>
46462 <section id="SECID155">
46463 <title>Flags controlling the rewriting process</title>
46464 <para>
46465 There are four flags which control the way the rewriting process works. These
46466 take effect only when a rule is invoked, that is, when the address is of the
46467 correct type (matches the flags) and matches the pattern:
46468 </para>
46469 <itemizedlist>
46470 <listitem>
46471 <para>
46472 If the <quote>Q</quote> flag is set on a rule, the rewritten address is permitted to be an
46473 unqualified local part. It is qualified with <option>qualify_recipient</option>. In the
46474 absence of <quote>Q</quote> the rewritten address must always include a domain.
46475 </para>
46476 </listitem>
46477 <listitem>
46478 <para>
46479 If the <quote>q</quote> flag is set on a rule, no further rewriting rules are considered,
46480 even if no rewriting actually takes place because of a <quote>fail</quote> in the
46481 expansion. The <quote>q</quote> flag is not effective if the address is of the wrong type
46482 (does not match the flags) or does not match the pattern.
46483 </para>
46484 </listitem>
46485 <listitem>
46486 <para>
46487 The <quote>R</quote> flag causes a successful rewriting rule to be re-applied to the new
46488 address, up to ten times. It can be combined with the <quote>q</quote> flag, to stop
46489 rewriting once it fails to match (after at least one successful rewrite).
46490 </para>
46491 </listitem>
46492 <listitem>
46493 <para>
46494 <indexterm role="concept">
46495 <primary>rewriting</primary>
46496 <secondary>whole addresses</secondary>
46497 </indexterm>
46498 When an address in a header is rewritten, the rewriting normally applies only
46499 to the working part of the address, with any comments and RFC 2822 <quote>phrase</quote>
46500 left unchanged. For example, rewriting might change
46501 </para>
46502 <literallayout class="monospaced">
46503 From: Ford Prefect &lt;fp42@restaurant.hitch.fict.example&gt;
46504 </literallayout>
46505 <para>
46506 into
46507 </para>
46508 <literallayout class="monospaced">
46509 From: Ford Prefect &lt;prefectf@hitch.fict.example&gt;
46510 </literallayout>
46511 <para>
46512 <indexterm role="concept">
46513 <primary>RFC 2047</primary>
46514 </indexterm>
46515 Sometimes there is a need to replace the whole address item, and this can be
46516 done by adding the flag letter <quote>w</quote> to a rule. If this is set on a rule that
46517 causes an address in a header line to be rewritten, the entire address is
46518 replaced, not just the working part. The replacement must be a complete RFC
46519 2822 address, including the angle brackets if necessary. If text outside angle
46520 brackets contains a character whose value is greater than 126 or less than 32
46521 (except for tab), the text is encoded according to RFC 2047. The character set
46522 is taken from <option>headers_charset</option>, which defaults to ISO-8859-1.
46523 </para>
46524 <para>
46525 When the <quote>w</quote> flag is set on a rule that causes an envelope address to be
46526 rewritten, all but the working part of the replacement address is discarded.
46527 </para>
46528 </listitem>
46529 </itemizedlist>
46530 </section>
46531 <section id="SECID156">
46532 <title>Rewriting examples</title>
46533 <para>
46534 Here is an example of the two common rewriting paradigms:
46535 </para>
46536 <literallayout class="monospaced">
46537 *@*.hitch.fict.example  $1@hitch.fict.example
46538 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
46539                      {$value}fail}@hitch.fict.example bctfrF
46540 </literallayout>
46541 <para>
46542 Note the use of <quote>fail</quote> in the lookup expansion in the second rule, forcing
46543 the string expansion to fail if the lookup does not succeed. In this context it
46544 has the effect of leaving the original address unchanged, but Exim goes on to
46545 consider subsequent rewriting rules, if any, because the <quote>q</quote> flag is not
46546 present in that rule. An alternative to <quote>fail</quote> would be to supply <varname>$1</varname>
46547 explicitly, which would cause the rewritten address to be the same as before,
46548 at the cost of a small bit of processing. Not supplying either of these is an
46549 error, since the rewritten address would then contain no local part.
46550 </para>
46551 <para>
46552 The first example above replaces the domain with a superior, more general
46553 domain. This may not be desirable for certain local parts. If the rule
46554 </para>
46555 <literallayout class="monospaced">
46556 root@*.hitch.fict.example  *
46557 </literallayout>
46558 <para>
46559 were inserted before the first rule, rewriting would be suppressed for the
46560 local part <emphasis>root</emphasis> at any domain ending in <emphasis>hitch.fict.example</emphasis>.
46561 </para>
46562 <para>
46563 Rewriting can be made conditional on a number of tests, by making use of
46564 <varname>${if</varname> in the expansion item. For example, to apply a rewriting rule only to
46565 messages that originate outside the local host:
46566 </para>
46567 <literallayout class="monospaced">
46568 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
46569                          {$1@hitch.fict.example}fail}"
46570 </literallayout>
46571 <para>
46572 The replacement string is quoted in this example because it contains white
46573 space.
46574 </para>
46575 <para>
46576 <indexterm role="concept">
46577 <primary>rewriting</primary>
46578 <secondary>bang paths</secondary>
46579 </indexterm>
46580 <indexterm role="concept">
46581 <primary>bang paths</primary>
46582 <secondary>rewriting</secondary>
46583 </indexterm>
46584 Exim does not handle addresses in the form of <quote>bang paths</quote>. If it sees such
46585 an address it treats it as an unqualified local part which it qualifies with
46586 the local qualification domain (if the source of the message is local or if the
46587 remote host is permitted to send unqualified addresses). Rewriting can
46588 sometimes be used to handle simple bang paths with a fixed number of
46589 components. For example, the rule
46590 </para>
46591 <literallayout class="monospaced">
46592 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
46593 </literallayout>
46594 <para>
46595 rewrites a two-component bang path <emphasis>host.name!user</emphasis> as the domain address
46596 <emphasis>user@host.name</emphasis>. However, there is a security implication in using this as
46597 a global rewriting rule for envelope addresses. It can provide a backdoor
46598 method for using your system as a relay, because the incoming addresses appear
46599 to be local. If the bang path addresses are received via SMTP, it is safer to
46600 use the <quote>S</quote> flag to rewrite them as they are received, so that relay checking
46601 can be done on the rewritten addresses.
46602 <indexterm role="concept" startref="IIDaddrew" class="endofrange"/>
46603 </para>
46604 </section>
46605 </chapter>
46606
46607 <chapter id="CHAPretry">
46608 <title>Retry configuration</title>
46609 <para>
46610 <indexterm role="concept" id="IIDretconf1" class="startofrange">
46611 <primary>retry</primary>
46612 <secondary>configuration, description of</secondary>
46613 </indexterm>
46614 <indexterm role="concept" id="IIDregconf2" class="startofrange">
46615 <primary>configuration file</primary>
46616 <secondary>retry section</secondary>
46617 </indexterm>
46618 The <quote>retry</quote> section of the runtime configuration file contains a list of
46619 retry rules that control how often Exim tries to deliver messages that cannot
46620 be delivered at the first attempt. If there are no retry rules (the section is
46621 empty or not present), there are no retries. In this situation, temporary
46622 errors are treated as permanent. The default configuration contains a single,
46623 general-purpose retry rule (see section <xref linkend="SECID57"/>). The <option>-brt</option> command
46624 line option can be used to test which retry rule will be used for a given
46625 address, domain and error.
46626 </para>
46627 <para>
46628 The most common cause of retries is temporary failure to deliver to a remote
46629 host because the host is down, or inaccessible because of a network problem.
46630 Exim&#x2019;s retry processing in this case is applied on a per-host (strictly, per IP
46631 address) basis, not on a per-message basis. Thus, if one message has recently
46632 been delayed, delivery of a new message to the same host is not immediately
46633 tried, but waits for the host&#x2019;s retry time to arrive. If the <option>retry_defer</option>
46634 log selector is set, the message
46635 <indexterm role="concept">
46636 <primary>retry</primary>
46637 <secondary>time not reached</secondary>
46638 </indexterm>
46639 <quote>retry time not reached</quote> is written to the main log whenever a delivery is
46640 skipped for this reason. Section <xref linkend="SECToutSMTPerr"/> contains more details of
46641 the handling of errors during remote deliveries.
46642 </para>
46643 <para>
46644 Retry processing applies to routing as well as to delivering, except as covered
46645 in the next paragraph. The retry rules do not distinguish between these
46646 actions. It is not possible, for example, to specify different behaviour for
46647 failures to route the domain <emphasis>snark.fict.example</emphasis> and failures to deliver to
46648 the host <emphasis>snark.fict.example</emphasis>. I didn&#x2019;t think anyone would ever need this
46649 added complication, so did not implement it. However, although they share the
46650 same retry rule, the actual retry times for routing and transporting a given
46651 domain are maintained independently.
46652 </para>
46653 <para>
46654 When a delivery is not part of a queue run (typically an immediate delivery on
46655 receipt of a message), the routers are always run, and local deliveries are
46656 always attempted, even if retry times are set for them. This makes for better
46657 behaviour if one particular message is causing problems (for example, causing
46658 quota overflow, or provoking an error in a filter file). If such a delivery
46659 suffers a temporary failure, the retry data is updated as normal, and
46660 subsequent delivery attempts from queue runs occur only when the retry time for
46661 the local address is reached.
46662 </para>
46663 <section id="SECID157">
46664 <title>Changing retry rules</title>
46665 <para>
46666 If you change the retry rules in your configuration, you should consider
46667 whether or not to delete the retry data that is stored in Exim&#x2019;s spool area in
46668 files with names like <filename>db/retry</filename>. Deleting any of Exim&#x2019;s hints files is
46669 always safe; that is why they are called <quote>hints</quote>.
46670 </para>
46671 <para>
46672 The hints retry data contains suggested retry times based on the previous
46673 rules. In the case of a long-running problem with a remote host, it might
46674 record the fact that the host has timed out. If your new rules increase the
46675 timeout time for such a host, you should definitely remove the old retry data
46676 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
46677 messages that it should now be retaining.
46678 </para>
46679 </section>
46680 <section id="SECID158">
46681 <title>Format of retry rules</title>
46682 <para>
46683 <indexterm role="concept">
46684 <primary>retry</primary>
46685 <secondary>rules</secondary>
46686 </indexterm>
46687 Each retry rule occupies one line and consists of three or four parts,
46688 separated by white space: a pattern, an error name, an optional list of sender
46689 addresses, and a list of retry parameters. The pattern and sender lists must be
46690 enclosed in double quotes if they contain white space. The rules are searched
46691 in order until one is found where the pattern, error name, and sender list (if
46692 present) match the failing host or address, the error that occurred, and the
46693 message&#x2019;s sender, respectively.
46694 </para>
46695 <para>
46696 The pattern is any single item that may appear in an address list (see section
46697 <xref linkend="SECTaddresslist"/>). It is in fact processed as a one-item address list,
46698 which means that it is expanded before being tested against the address that
46699 has been delayed. A negated address list item is permitted. Address
46700 list processing treats a plain domain name as if it were preceded by <quote>*@</quote>,
46701 which makes it possible for many retry rules to start with just a domain. For
46702 example,
46703 </para>
46704 <literallayout class="monospaced">
46705 lookingglass.fict.example        *  F,24h,30m;
46706 </literallayout>
46707 <para>
46708 provides a rule for any address in the <emphasis>lookingglass.fict.example</emphasis> domain,
46709 whereas
46710 </para>
46711 <literallayout class="monospaced">
46712 alice@lookingglass.fict.example  *  F,24h,30m;
46713 </literallayout>
46714 <para>
46715 applies only to temporary failures involving the local part <option>alice</option>.
46716 In practice, almost all rules start with a domain name pattern without a local
46717 part.
46718 </para>
46719 <para>
46720 <indexterm role="concept">
46721 <primary>regular expressions</primary>
46722 <secondary>in retry rules</secondary>
46723 </indexterm>
46724 <emphasis role="bold">Warning</emphasis>: If you use a regular expression in a retry rule pattern, it
46725 must match a complete address, not just a domain, because that is how regular
46726 expressions work in address lists.
46727 </para>
46728 <literallayout>
46729 <literal>^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2</literal>     <option>Wrong</option>
46730 <literal>^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2</literal>     <option>Right</option>
46731 </literallayout>
46732 </section>
46733 <section id="SECID159">
46734 <title>Choosing which retry rule to use for address errors</title>
46735 <para>
46736 When Exim is looking for a retry rule after a routing attempt has failed (for
46737 example, after a DNS timeout), each line in the retry configuration is tested
46738 against the complete address only if <option>retry_use_local_part</option> is set for the
46739 router. Otherwise, only the domain is used, except when matching against a
46740 regular expression, when the local part of the address is replaced with <quote>*</quote>.
46741 A domain on its own can match a domain pattern, or a pattern that starts with
46742 <quote>*@</quote>. By default, <option>retry_use_local_part</option> is true for routers where
46743 <option>check_local_user</option> is true, and false for other routers.
46744 </para>
46745 <para>
46746 Similarly, when Exim is looking for a retry rule after a local delivery has
46747 failed (for example, after a mailbox full error), each line in the retry
46748 configuration is tested against the complete address only if
46749 <option>retry_use_local_part</option> is set for the transport (it defaults true for all
46750 local transports).
46751 </para>
46752 <para>
46753 <indexterm role="concept">
46754 <primary>4<emphasis>xx</emphasis> responses</primary>
46755 <secondary>retry rules for</secondary>
46756 </indexterm>
46757 However, when Exim is looking for a retry rule after a remote delivery attempt
46758 suffers an address error (a 4<emphasis>xx</emphasis> SMTP response for a recipient address), the
46759 whole address is always used as the key when searching the retry rules. The
46760 rule that is found is used to create a retry time for the combination of the
46761 failing address and the message&#x2019;s sender. It is the combination of sender and
46762 recipient that is delayed in subsequent queue runs until its retry time is
46763 reached. You can delay the recipient without regard to the sender by setting
46764 <option>address_retry_include_sender</option> false in the <command>smtp</command> transport but this can
46765 lead to problems with servers that regularly issue 4<emphasis>xx</emphasis> responses to RCPT
46766 commands.
46767 </para>
46768 </section>
46769 <section id="SECID160">
46770 <title>Choosing which retry rule to use for host and message errors</title>
46771 <para>
46772 For a temporary error that is not related to an individual address (for
46773 example, a connection timeout), each line in the retry configuration is checked
46774 twice. First, the name of the remote host is used as a domain name (preceded by
46775 <quote>*@</quote> when matching a regular expression). If this does not match the line,
46776 the domain from the email address is tried in a similar fashion. For example,
46777 suppose the MX records for <emphasis>a.b.c.example</emphasis> are
46778 </para>
46779 <literallayout class="monospaced">
46780 a.b.c.example  MX  5  x.y.z.example
46781                MX  6  p.q.r.example
46782                MX  7  m.n.o.example
46783 </literallayout>
46784 <para>
46785 and the retry rules are
46786 </para>
46787 <literallayout class="monospaced">
46788 p.q.r.example    *      F,24h,30m;
46789 a.b.c.example    *      F,4d,45m;
46790 </literallayout>
46791 <para>
46792 and a delivery to the host <emphasis>x.y.z.example</emphasis> suffers a connection failure. The
46793 first rule matches neither the host nor the domain, so Exim looks at the second
46794 rule. This does not match the host, but it does match the domain, so it is used
46795 to calculate the retry time for the host <emphasis>x.y.z.example</emphasis>. Meanwhile, Exim
46796 tries to deliver to <emphasis>p.q.r.example</emphasis>. If this also suffers a host error, the
46797 first retry rule is used, because it matches the host.
46798 </para>
46799 <para>
46800 In other words, temporary failures to deliver to host <emphasis>p.q.r.example</emphasis> use the
46801 first rule to determine retry times, but for all the other hosts for the domain
46802 <emphasis>a.b.c.example</emphasis>, the second rule is used. The second rule is also used if
46803 routing to <emphasis>a.b.c.example</emphasis> suffers a temporary failure.
46804 </para>
46805 <para>
46806 <emphasis role="bold">Note</emphasis>: The host name is used when matching the patterns, not its IP address.
46807 However, if a message is routed directly to an IP address without the use of a
46808 host name, for example, if a <command>manualroute</command> router contains a setting such as:
46809 </para>
46810 <literallayout class="monospaced">
46811 route_list = *.a.example  192.168.34.23
46812 </literallayout>
46813 <para>
46814 then the <quote>host name</quote> that is used when searching for a retry rule is the
46815 textual form of the IP address.
46816 </para>
46817 </section>
46818 <section id="SECID161">
46819 <title>Retry rules for specific errors</title>
46820 <para>
46821 <indexterm role="concept">
46822 <primary>retry</primary>
46823 <secondary>specific errors; specifying</secondary>
46824 </indexterm>
46825 The second field in a retry rule is the name of a particular error, or an
46826 asterisk, which matches any error. The errors that can be tested for are:
46827 </para>
46828 <variablelist>
46829 <varlistentry>
46830 <term><option>auth_failed</option></term>
46831 <listitem>
46832 <para>
46833 Authentication failed when trying to send to a host in the
46834 <option>hosts_require_auth</option> list in an <command>smtp</command> transport.
46835 </para>
46836 </listitem></varlistentry>
46837 <varlistentry>
46838 <term><option>data_4xx</option></term>
46839 <listitem>
46840 <para>
46841 A 4<emphasis>xx</emphasis> error was received for an outgoing DATA command, either immediately
46842 after the command, or after sending the message&#x2019;s data.
46843 </para>
46844 </listitem></varlistentry>
46845 <varlistentry>
46846 <term><option>mail_4xx</option></term>
46847 <listitem>
46848 <para>
46849 A 4<emphasis>xx</emphasis> error was received for an outgoing MAIL command.
46850 </para>
46851 </listitem></varlistentry>
46852 <varlistentry>
46853 <term><option>rcpt_4xx</option></term>
46854 <listitem>
46855 <para>
46856 A 4<emphasis>xx</emphasis> error was received for an outgoing RCPT command.
46857 </para>
46858 </listitem></varlistentry>
46859 </variablelist>
46860 <para>
46861 For the three 4<emphasis>xx</emphasis> errors, either the first or both of the x&#x2019;s can be given
46862 as specific digits, for example: <literal>mail_45x</literal> or <literal>rcpt_436</literal>. For example, to
46863 recognize 452 errors given to RCPT commands for addresses in a certain domain,
46864 and have retries every ten minutes with a one-hour timeout, you could set up a
46865 retry rule of this form:
46866 </para>
46867 <literallayout class="monospaced">
46868 the.domain.name  rcpt_452   F,1h,10m
46869 </literallayout>
46870 <para>
46871 These errors apply to both outgoing SMTP (the <command>smtp</command> transport) and outgoing
46872 LMTP (either the <command>lmtp</command> transport, or the <command>smtp</command> transport in LMTP mode).
46873 </para>
46874 <variablelist>
46875 <varlistentry>
46876 <term><option>lost_connection</option></term>
46877 <listitem>
46878 <para>
46879 A server unexpectedly closed the SMTP connection. There may, of course,
46880 legitimate reasons for this (host died, network died), but if it repeats a lot
46881 for the same host, it indicates something odd.
46882 </para>
46883 </listitem></varlistentry>
46884 <varlistentry>
46885 <term><option>refused_MX</option></term>
46886 <listitem>
46887 <para>
46888 A connection to a host obtained from an MX record was refused.
46889 </para>
46890 </listitem></varlistentry>
46891 <varlistentry>
46892 <term><option>refused_A</option></term>
46893 <listitem>
46894 <para>
46895 A connection to a host not obtained from an MX record was refused.
46896 </para>
46897 </listitem></varlistentry>
46898 <varlistentry>
46899 <term><option>refused</option></term>
46900 <listitem>
46901 <para>
46902 A connection was refused.
46903 </para>
46904 </listitem></varlistentry>
46905 <varlistentry>
46906 <term><option>timeout_connect_MX</option></term>
46907 <listitem>
46908 <para>
46909 A connection attempt to a host obtained from an MX record timed out.
46910 </para>
46911 </listitem></varlistentry>
46912 <varlistentry>
46913 <term><option>timeout_connect_A</option></term>
46914 <listitem>
46915 <para>
46916 A connection attempt to a host not obtained from an MX record timed out.
46917 </para>
46918 </listitem></varlistentry>
46919 <varlistentry>
46920 <term><option>timeout_connect</option></term>
46921 <listitem>
46922 <para>
46923 A connection attempt timed out.
46924 </para>
46925 </listitem></varlistentry>
46926 <varlistentry>
46927 <term><option>timeout_MX</option></term>
46928 <listitem>
46929 <para>
46930 There was a timeout while connecting or during an SMTP session with a host
46931 obtained from an MX record.
46932 </para>
46933 </listitem></varlistentry>
46934 <varlistentry>
46935 <term><option>timeout_A</option></term>
46936 <listitem>
46937 <para>
46938 There was a timeout while connecting or during an SMTP session with a host not
46939 obtained from an MX record.
46940 </para>
46941 </listitem></varlistentry>
46942 <varlistentry>
46943 <term><option>timeout</option></term>
46944 <listitem>
46945 <para>
46946 There was a timeout while connecting or during an SMTP session.
46947 </para>
46948 </listitem></varlistentry>
46949 <varlistentry>
46950 <term><option>tls_required</option></term>
46951 <listitem>
46952 <para>
46953 The server was required to use TLS (it matched <option>hosts_require_tls</option> in the
46954 <command>smtp</command> transport), but either did not offer TLS, or it responded with 4<emphasis>xx</emphasis>
46955 to STARTTLS, or there was a problem setting up the TLS connection.
46956 </para>
46957 </listitem></varlistentry>
46958 <varlistentry>
46959 <term><option>quota</option></term>
46960 <listitem>
46961 <para>
46962 A mailbox quota was exceeded in a local delivery by the <command>appendfile</command>
46963 transport.
46964 </para>
46965 </listitem></varlistentry>
46966 <varlistentry>
46967 <term><option>quota_</option>&lt;<emphasis>time</emphasis>&gt;</term>
46968 <listitem>
46969 <para>
46970 <indexterm role="concept">
46971 <primary>quota</primary>
46972 <secondary>error testing in retry rule</secondary>
46973 </indexterm>
46974 <indexterm role="concept">
46975 <primary>retry</primary>
46976 <secondary>quota error testing</secondary>
46977 </indexterm>
46978 A mailbox quota was exceeded in a local delivery by the <command>appendfile</command>
46979 transport, and the mailbox has not been accessed for &lt;<emphasis>time</emphasis>&gt;. For example,
46980 <emphasis>quota_4d</emphasis> applies to a quota error when the mailbox has not been accessed
46981 for four days.
46982 </para>
46983 </listitem></varlistentry>
46984 </variablelist>
46985 <para>
46986 <indexterm role="concept">
46987 <primary>mailbox</primary>
46988 <secondary>time of last read</secondary>
46989 </indexterm>
46990 The idea of <option>quota_</option>&lt;<emphasis>time</emphasis>&gt; is to make it possible to have shorter
46991 timeouts when the mailbox is full and is not being read by its owner. Ideally,
46992 it should be based on the last time that the user accessed the mailbox.
46993 However, it is not always possible to determine this. Exim uses the following
46994 heuristic rules:
46995 </para>
46996 <itemizedlist>
46997 <listitem>
46998 <para>
46999 If the mailbox is a single file, the time of last access (the <quote>atime</quote>) is
47000 used. As no new messages are being delivered (because the mailbox is over
47001 quota), Exim does not access the file, so this is the time of last user access.
47002 </para>
47003 </listitem>
47004 <listitem>
47005 <para>
47006 <indexterm role="concept">
47007 <primary>maildir format</primary>
47008 <secondary>time of last read</secondary>
47009 </indexterm>
47010 For a maildir delivery, the time of last modification of the <filename>new</filename>
47011 subdirectory is used. As the mailbox is over quota, no new files are created in
47012 the <filename>new</filename> subdirectory, because no new messages are being delivered. Any
47013 change to the <filename>new</filename> subdirectory is therefore assumed to be the result of an
47014 MUA moving a new message to the <filename>cur</filename> directory when it is first read. The
47015 time that is used is therefore the last time that the user read a new message.
47016 </para>
47017 </listitem>
47018 <listitem>
47019 <para>
47020 For other kinds of multi-file mailbox, the time of last access cannot be
47021 obtained, so a retry rule that uses this type of error field is never matched.
47022 </para>
47023 </listitem>
47024 </itemizedlist>
47025 <para>
47026 The quota errors apply both to system-enforced quotas and to Exim&#x2019;s own quota
47027 mechanism in the <command>appendfile</command> transport. The <emphasis>quota</emphasis> error also applies
47028 when a local delivery is deferred because a partition is full (the ENOSPC
47029 error).
47030 </para>
47031 </section>
47032 <section id="SECID162">
47033 <title>Retry rules for specified senders</title>
47034 <para>
47035 <indexterm role="concept">
47036 <primary>retry</primary>
47037 <secondary>rules; sender-specific</secondary>
47038 </indexterm>
47039 You can specify retry rules that apply only when the failing message has a
47040 specific sender. In particular, this can be used to define retry rules that
47041 apply only to bounce messages. The third item in a retry rule can be of this
47042 form:
47043 </para>
47044 <literallayout>
47045 <literal>senders=</literal>&lt;<emphasis>address list</emphasis>&gt;
47046 </literallayout>
47047 <para>
47048 The retry timings themselves are then the fourth item. For example:
47049 </para>
47050 <literallayout class="monospaced">
47051 *   rcpt_4xx   senders=:   F,1h,30m
47052 </literallayout>
47053 <para>
47054 matches recipient 4<emphasis>xx</emphasis> errors for bounce messages sent to any address at any
47055 host. If the address list contains white space, it must be enclosed in quotes.
47056 For example:
47057 </para>
47058 <literallayout class="monospaced">
47059 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
47060 </literallayout>
47061 <para>
47062 <emphasis role="bold">Warning</emphasis>: This facility can be unhelpful if it is used for host errors
47063 (which do not depend on the recipient). The reason is that the sender is used
47064 only to match the retry rule. Once the rule has been found for a host error,
47065 its contents are used to set a retry time for the host, and this will apply to
47066 all messages, not just those with specific senders.
47067 </para>
47068 <para>
47069 When testing retry rules using <option>-brt</option>, you can supply a sender using the
47070 <option>-f</option> command line option, like this:
47071 </para>
47072 <literallayout class="monospaced">
47073 exim -f "" -brt user@dom.ain
47074 </literallayout>
47075 <para>
47076 If you do not set <option>-f</option> with <option>-brt</option>, a retry rule that contains a senders
47077 list is never matched.
47078 </para>
47079 </section>
47080 <section id="SECID163">
47081 <title>Retry parameters</title>
47082 <para>
47083 <indexterm role="concept">
47084 <primary>retry</primary>
47085 <secondary>parameters in rules</secondary>
47086 </indexterm>
47087 The third (or fourth, if a senders list is present) field in a retry rule is a
47088 sequence of retry parameter sets, separated by semicolons. Each set consists of
47089 </para>
47090 <literallayout>
47091 &lt;<emphasis>letter</emphasis>&gt;,&lt;<emphasis>cutoff time</emphasis>&gt;,&lt;<emphasis>arguments</emphasis>&gt;
47092 </literallayout>
47093 <para>
47094 The letter identifies the algorithm for computing a new retry time; the cutoff
47095 time is the time beyond which this algorithm no longer applies, and the
47096 arguments vary the algorithm&#x2019;s action. The cutoff time is measured from the
47097 time that the first failure for the domain (combined with the local part if
47098 relevant) was detected, not from the time the message was received.
47099 </para>
47100 <para>
47101 <indexterm role="concept">
47102 <primary>retry</primary>
47103 <secondary>algorithms</secondary>
47104 </indexterm>
47105 <indexterm role="concept">
47106 <primary>retry</primary>
47107 <secondary>fixed intervals</secondary>
47108 </indexterm>
47109 <indexterm role="concept">
47110 <primary>retry</primary>
47111 <secondary>increasing intervals</secondary>
47112 </indexterm>
47113 <indexterm role="concept">
47114 <primary>retry</primary>
47115 <secondary>random intervals</secondary>
47116 </indexterm>
47117 The available algorithms are:
47118 </para>
47119 <itemizedlist>
47120 <listitem>
47121 <para>
47122 <emphasis>F</emphasis>: retry at fixed intervals. There is a single time parameter specifying
47123 the interval.
47124 </para>
47125 </listitem>
47126 <listitem>
47127 <para>
47128 <emphasis>G</emphasis>: retry at geometrically increasing intervals. The first argument
47129 specifies a starting value for the interval, and the second a multiplier, which
47130 is used to increase the size of the interval at each retry.
47131 </para>
47132 </listitem>
47133 <listitem>
47134 <para>
47135 <emphasis>H</emphasis>: retry at randomized intervals. The arguments are as for <emphasis>G</emphasis>. For each
47136 retry, the previous interval is multiplied by the factor in order to get a
47137 maximum for the next interval. The minimum interval is the first argument of
47138 the parameter, and an actual interval is chosen randomly between them. Such a
47139 rule has been found to be helpful in cluster configurations when all the
47140 members of the cluster restart at once, and may therefore synchronize their
47141 queue processing times.
47142 </para>
47143 </listitem>
47144 </itemizedlist>
47145 <para>
47146 When computing the next retry time, the algorithm definitions are scanned in
47147 order until one whose cutoff time has not yet passed is reached. This is then
47148 used to compute a new retry time that is later than the current time. In the
47149 case of fixed interval retries, this simply means adding the interval to the
47150 current time. For geometrically increasing intervals, retry intervals are
47151 computed from the rule&#x2019;s parameters until one that is greater than the previous
47152 interval is found. The main configuration variable
47153 <indexterm role="concept">
47154 <primary>limit</primary>
47155 <secondary>retry interval</secondary>
47156 </indexterm>
47157 <indexterm role="concept">
47158 <primary>retry</primary>
47159 <secondary>interval, maximum</secondary>
47160 </indexterm>
47161 <indexterm role="option">
47162 <primary><option>retry_interval_max</option></primary>
47163 </indexterm>
47164 <option>retry_interval_max</option> limits the maximum interval between retries. It
47165 cannot be set greater than <literal>24h</literal>, which is its default value.
47166 </para>
47167 <para>
47168 A single remote domain may have a number of hosts associated with it, and each
47169 host may have more than one IP address. Retry algorithms are selected on the
47170 basis of the domain name, but are applied to each IP address independently. If,
47171 for example, a host has two IP addresses and one is unusable, Exim will
47172 generate retry times for it and will not try to use it until its next retry
47173 time comes. Thus the good IP address is likely to be tried first most of the
47174 time.
47175 </para>
47176 <para>
47177 <indexterm role="concept">
47178 <primary>hints database</primary>
47179 <secondary>use for retrying</secondary>
47180 </indexterm>
47181 Retry times are hints rather than promises. Exim does not make any attempt to
47182 run deliveries exactly at the computed times. Instead, a queue runner process
47183 starts delivery processes for delayed messages periodically, and these attempt
47184 new deliveries only for those addresses that have passed their next retry time.
47185 If a new message arrives for a deferred address, an immediate delivery attempt
47186 occurs only if the address has passed its retry time. In the absence of new
47187 messages, the minimum time between retries is the interval between queue runner
47188 processes. There is not much point in setting retry times of five minutes if
47189 your queue runners happen only once an hour, unless there are a significant
47190 number of incoming messages (which might be the case on a system that is
47191 sending everything to a smart host, for example).
47192 </para>
47193 <para>
47194 The data in the retry hints database can be inspected by using the
47195 <emphasis>exim_dumpdb</emphasis> or <emphasis>exim_fixdb</emphasis> utility programs (see chapter
47196 <xref linkend="CHAPutils"/>). The latter utility can also be used to change the data. The
47197 <emphasis>exinext</emphasis> utility script can be used to find out what the next retry times
47198 are for the hosts associated with a particular mail domain, and also for local
47199 deliveries that have been deferred.
47200 </para>
47201 </section>
47202 <section id="SECID164">
47203 <title>Retry rule examples</title>
47204 <para>
47205 Here are some example retry rules:
47206 </para>
47207 <literallayout class="monospaced">
47208 alice@wonderland.fict.example quota_5d  F,7d,3h
47209 wonderland.fict.example       quota_5d
47210 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
47211 lookingglass.fict.example     *         F,24h,30m;
47212 *                 refused_A   F,2h,20m;
47213 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
47214 </literallayout>
47215 <para>
47216 The first rule sets up special handling for mail to
47217 <emphasis>alice@wonderland.fict.example</emphasis> when there is an over-quota error and the
47218 mailbox has not been read for at least 5 days. Retries continue every three
47219 hours for 7 days. The second rule handles over-quota errors for all other local
47220 parts at <emphasis>wonderland.fict.example</emphasis>; the absence of a local part has the same
47221 effect as supplying <quote>*@</quote>. As no retry algorithms are supplied, messages that
47222 fail are bounced immediately if the mailbox has not been read for at least 5
47223 days.
47224 </para>
47225 <para>
47226 The third rule handles all other errors at <emphasis>wonderland.fict.example</emphasis>; retries
47227 happen every 15 minutes for an hour, then with geometrically increasing
47228 intervals until two days have passed since a delivery first failed. After the
47229 first hour there is a delay of one hour, then two hours, then four hours, and
47230 so on (this is a rather extreme example).
47231 </para>
47232 <para>
47233 The fourth rule controls retries for the domain <emphasis>lookingglass.fict.example</emphasis>.
47234 They happen every 30 minutes for 24 hours only. The remaining two rules handle
47235 all other domains, with special action for connection refusal from hosts that
47236 were not obtained from an MX record.
47237 </para>
47238 <para>
47239 The final rule in a retry configuration should always have asterisks in the
47240 first two fields so as to provide a general catch-all for any addresses that do
47241 not have their own special handling. This example tries every 15 minutes for 2
47242 hours, then with intervals starting at one hour and increasing by a factor of
47243 1.5 up to 16 hours, then every 8 hours up to 5 days.
47244 </para>
47245 </section>
47246 <section id="SECID165">
47247 <title>Timeout of retry data</title>
47248 <para>
47249 <indexterm role="concept">
47250 <primary>timeout</primary>
47251 <secondary>of retry data</secondary>
47252 </indexterm>
47253 <indexterm role="option">
47254 <primary><option>retry_data_expire</option></primary>
47255 </indexterm>
47256 <indexterm role="concept">
47257 <primary>hints database</primary>
47258 <secondary>data expiry</secondary>
47259 </indexterm>
47260 <indexterm role="concept">
47261 <primary>retry</primary>
47262 <secondary>timeout of data</secondary>
47263 </indexterm>
47264 Exim timestamps the data that it writes to its retry hints database. When it
47265 consults the data during a delivery it ignores any that is older than the value
47266 set in <option>retry_data_expire</option> (default 7 days). If, for example, a host hasn&#x2019;t
47267 been tried for 7 days, Exim will try to deliver to it immediately a message
47268 arrives, and if that fails, it will calculate a retry time as if it were
47269 failing for the first time.
47270 </para>
47271 <para>
47272 This improves the behaviour for messages routed to rarely-used hosts such as MX
47273 backups. If such a host was down at one time, and happens to be down again when
47274 Exim tries a month later, using the old retry data would imply that it had been
47275 down all the time, which is not a justified assumption.
47276 </para>
47277 <para>
47278 If a host really is permanently dead, this behaviour causes a burst of retries
47279 every now and again, but only if messages routed to it are rare. If there is a
47280 message at least once every 7 days the retry data never expires.
47281 </para>
47282 </section>
47283 <section id="SECID166">
47284 <title>Long-term failures</title>
47285 <para>
47286 <indexterm role="concept">
47287 <primary>delivery failure, long-term</primary>
47288 </indexterm>
47289 <indexterm role="concept">
47290 <primary>retry</primary>
47291 <secondary>after long-term failure</secondary>
47292 </indexterm>
47293 Special processing happens when an email address has been failing for so long
47294 that the cutoff time for the last algorithm is reached. For example, using the
47295 default retry rule:
47296 </para>
47297 <literallayout class="monospaced">
47298 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
47299 </literallayout>
47300 <para>
47301 the cutoff time is four days. Reaching the retry cutoff is independent of how
47302 long any specific message has been failing; it is the length of continuous
47303 failure for the recipient address that counts.
47304 </para>
47305 <para>
47306 When the cutoff time is reached for a local delivery, or for all the IP
47307 addresses associated with a remote delivery, a subsequent delivery failure
47308 causes Exim to give up on the address, and a bounce message is generated.
47309 In order to cater for new messages that use the failing address, a next retry
47310 time is still computed from the final algorithm, and is used as follows:
47311 </para>
47312 <para>
47313 For local deliveries, one delivery attempt is always made for any subsequent
47314 messages. If this delivery fails, the address fails immediately. The
47315 post-cutoff retry time is not used.
47316 </para>
47317 <para>
47318 If the delivery is remote, there are two possibilities, controlled by the
47319 <indexterm role="option">
47320 <primary><option>delay_after_cutoff</option></primary>
47321 </indexterm>
47322 <option>delay_after_cutoff</option> option of the <command>smtp</command> transport. The option is true by
47323 default. Until the post-cutoff retry time for one of the IP addresses is
47324 reached, the failing email address is bounced immediately, without a delivery
47325 attempt taking place. After that time, one new delivery attempt is made to
47326 those IP addresses that are past their retry times, and if that still fails,
47327 the address is bounced and new retry times are computed.
47328 </para>
47329 <para>
47330 In other words, when all the hosts for a given email address have been failing
47331 for a long time, Exim bounces rather then defers until one of the hosts&#x2019; retry
47332 times is reached. Then it tries once, and bounces if that attempt fails. This
47333 behaviour ensures that few resources are wasted in repeatedly trying to deliver
47334 to a broken destination, but if the host does recover, Exim will eventually
47335 notice.
47336 </para>
47337 <para>
47338 If <option>delay_after_cutoff</option> is set false, Exim behaves differently. If all IP
47339 addresses are past their final cutoff time, Exim tries to deliver to those IP
47340 addresses that have not been tried since the message arrived. If there are
47341 no suitable IP addresses, or if they all fail, the address is bounced. In other
47342 words, it does not delay when a new message arrives, but tries the expired
47343 addresses immediately, unless they have been tried since the message arrived.
47344 If there is a continuous stream of messages for the failing domains, setting
47345 <option>delay_after_cutoff</option> false means that there will be many more attempts to
47346 deliver to permanently failing IP addresses than when <option>delay_after_cutoff</option> is
47347 true.
47348 </para>
47349 </section>
47350 <section id="SECID167">
47351 <title>Deliveries that work intermittently</title>
47352 <para>
47353 <indexterm role="concept">
47354 <primary>retry</primary>
47355 <secondary>intermittently working deliveries</secondary>
47356 </indexterm>
47357 Some additional logic is needed to cope with cases where a host is
47358 intermittently available, or when a message has some attribute that prevents
47359 its delivery when others to the same address get through. In this situation,
47360 because some messages are successfully delivered, the <quote>retry clock</quote> for the
47361 host or address keeps getting reset by the successful deliveries, and so
47362 failing messages remain on the queue for ever because the cutoff time is never
47363 reached.
47364 </para>
47365 <para>
47366 Two exceptional actions are applied to prevent this happening. The first
47367 applies to errors that are related to a message rather than a remote host.
47368 Section <xref linkend="SECToutSMTPerr"/> has a discussion of the different kinds of error;
47369 examples of message-related errors are 4<emphasis>xx</emphasis> responses to MAIL or DATA
47370 commands, and quota failures. For this type of error, if a message&#x2019;s arrival
47371 time is earlier than the <quote>first failed</quote> time for the error, the earlier time
47372 is used when scanning the retry rules to decide when to try next and when to
47373 time out the address.
47374 </para>
47375 <para>
47376 The exceptional second action applies in all cases. If a message has been on
47377 the queue for longer than the cutoff time of any applicable retry rule for a
47378 given address, a delivery is attempted for that address, even if it is not yet
47379 time, and if this delivery fails, the address is timed out. A new retry time is
47380 not computed in this case, so that other messages for the same address are
47381 considered immediately.
47382 <indexterm role="concept" startref="IIDretconf1" class="endofrange"/>
47383 <indexterm role="concept" startref="IIDregconf2" class="endofrange"/>
47384 </para>
47385 </section>
47386 </chapter>
47387
47388 <chapter id="CHAPSMTPAUTH">
47389 <title>SMTP authentication</title>
47390 <para>
47391 <indexterm role="concept" id="IIDauthconf1" class="startofrange">
47392 <primary>SMTP</primary>
47393 <secondary>authentication configuration</secondary>
47394 </indexterm>
47395 <indexterm role="concept" id="IIDauthconf2" class="startofrange">
47396 <primary>authentication</primary>
47397 </indexterm>
47398 The <quote>authenticators</quote> section of Exim&#x2019;s run time configuration is concerned
47399 with SMTP authentication. This facility is an extension to the SMTP protocol,
47400 described in RFC 2554, which allows a client SMTP host to authenticate itself
47401 to a server. This is a common way for a server to recognize clients that are
47402 permitted to use it as a relay. SMTP authentication is not of relevance to the
47403 transfer of mail between servers that have no managerial connection with each
47404 other.
47405 </para>
47406 <para>
47407 <indexterm role="concept">
47408 <primary>AUTH</primary>
47409 <secondary>description of</secondary>
47410 </indexterm>
47411 Very briefly, the way SMTP authentication works is as follows:
47412 </para>
47413 <itemizedlist>
47414 <listitem>
47415 <para>
47416 The server advertises a number of authentication <emphasis>mechanisms</emphasis> in response to
47417 the client&#x2019;s EHLO command.
47418 </para>
47419 </listitem>
47420 <listitem>
47421 <para>
47422 The client issues an AUTH command, naming a specific mechanism. The command
47423 may, optionally, contain some authentication data.
47424 </para>
47425 </listitem>
47426 <listitem>
47427 <para>
47428 The server may issue one or more <emphasis>challenges</emphasis>, to which the client must send
47429 appropriate responses. In simple authentication mechanisms, the challenges are
47430 just prompts for user names and passwords. The server does not have to issue
47431 any challenges &ndash; in some mechanisms the relevant data may all be transmitted
47432 with the AUTH command.
47433 </para>
47434 </listitem>
47435 <listitem>
47436 <para>
47437 The server either accepts or denies authentication.
47438 </para>
47439 </listitem>
47440 <listitem>
47441 <para>
47442 If authentication succeeds, the client may optionally make use of the AUTH
47443 option on the MAIL command to pass an authenticated sender in subsequent
47444 mail transactions. Authentication lasts for the remainder of the SMTP
47445 connection.
47446 </para>
47447 </listitem>
47448 <listitem>
47449 <para>
47450 If authentication fails, the client may give up, or it may try a different
47451 authentication mechanism, or it may try transferring mail over the
47452 unauthenticated connection.
47453 </para>
47454 </listitem>
47455 </itemizedlist>
47456 <para>
47457 If you are setting up a client, and want to know which authentication
47458 mechanisms the server supports, you can use Telnet to connect to port 25 (the
47459 SMTP port) on the server, and issue an EHLO command. The response to this
47460 includes the list of supported mechanisms. For example:
47461 </para>
47462 <literallayout>
47463 <literal>$ </literal><emphasis role="bold"><literal>telnet server.example 25</literal></emphasis>
47464 <literal>Trying 192.168.34.25...</literal>
47465 <literal>Connected to server.example.</literal>
47466 <literal>Escape character is &#x0027;^]&#x0027;.</literal>
47467 <literal>220 server.example ESMTP Exim 4.20 ...</literal>
47468 <emphasis role="bold"><literal>ehlo client.example</literal></emphasis>
47469 <literal>250-server.example Hello client.example [10.8.4.5]</literal>
47470 <literal>250-SIZE 52428800</literal>
47471 <literal>250-PIPELINING</literal>
47472 <literal>250-AUTH PLAIN</literal>
47473 <literal>250 HELP</literal>
47474 </literallayout>
47475 <para>
47476 The second-last line of this example output shows that the server supports
47477 authentication using the PLAIN mechanism. In Exim, the different authentication
47478 mechanisms are configured by specifying <emphasis>authenticator</emphasis> drivers. Like the
47479 routers and transports, which authenticators are included in the binary is
47480 controlled by build-time definitions. The following are currently available,
47481 included by setting
47482 </para>
47483 <literallayout class="monospaced">
47484 AUTH_CRAM_MD5=yes
47485 AUTH_CYRUS_SASL=yes
47486 AUTH_DOVECOT=yes
47487 AUTH_GSASL=yes
47488 AUTH_HEIMDAL_GSSAPI=yes
47489 AUTH_PLAINTEXT=yes
47490 AUTH_SPA=yes
47491 </literallayout>
47492 <para>
47493 in <filename>Local/Makefile</filename>, respectively. The first of these supports the CRAM-MD5
47494 authentication mechanism (RFC 2195), and the second provides an interface to
47495 the Cyrus SASL authentication library.
47496 The third is an interface to Dovecot&#x2019;s authentication system, delegating the
47497 work via a socket interface.
47498 The fourth provides an interface to the GNU SASL authentication library, which
47499 provides mechanisms but typically not data sources.
47500 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
47501 supporting setting a server keytab.
47502 The sixth can be configured to support
47503 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
47504 not formally documented, but used by several MUAs. The seventh authenticator
47505 supports Microsoft&#x2019;s <emphasis>Secure Password Authentication</emphasis> mechanism.
47506 </para>
47507 <para>
47508 The authenticators are configured using the same syntax as other drivers (see
47509 section <xref linkend="SECTfordricon"/>). If no authenticators are required, no
47510 authentication section need be present in the configuration file. Each
47511 authenticator can in principle have both server and client functions. When Exim
47512 is receiving SMTP mail, it is acting as a server; when it is sending out
47513 messages over SMTP, it is acting as a client. Authenticator configuration
47514 options are provided for use in both these circumstances.
47515 </para>
47516 <para>
47517 To make it clear which options apply to which situation, the prefixes
47518 <option>server_</option> and <option>client_</option> are used on option names that are specific to
47519 either the server or the client function, respectively. Server and client
47520 functions are disabled if none of their options are set. If an authenticator is
47521 to be used for both server and client functions, a single definition, using
47522 both sets of options, is required. For example:
47523 </para>
47524 <literallayout class="monospaced">
47525 cram:
47526   driver = cram_md5
47527   public_name = CRAM-MD5
47528   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
47529   client_name = ph10
47530   client_secret = secret2
47531 </literallayout>
47532 <para>
47533 The <option>server_</option> option is used when Exim is acting as a server, and the
47534 <option>client_</option> options when it is acting as a client.
47535 </para>
47536 <para>
47537 Descriptions of the individual authenticators are given in subsequent chapters.
47538 The remainder of this chapter covers the generic options for the
47539 authenticators, followed by general discussion of the way authentication works
47540 in Exim.
47541 </para>
47542 <para>
47543 <emphasis role="bold">Beware:</emphasis> the meaning of <varname>$auth1</varname>, <varname>$auth2</varname>, ... varies on a per-driver and
47544 per-mechanism basis.  Please read carefully to determine which variables hold
47545 account labels such as usercodes and which hold passwords or other
47546 authenticating data.
47547 </para>
47548 <para>
47549 Note that some mechanisms support two different identifiers for accounts: the
47550 <emphasis>authentication id</emphasis> and the <emphasis>authorization id</emphasis>.  The contractions <emphasis>authn</emphasis>
47551 and <emphasis>authz</emphasis> are commonly encountered.  The American spelling is standard here.
47552 Conceptually, authentication data such as passwords are tied to the identifier
47553 used to authenticate; servers may have rules to permit one user to act as a
47554 second user, so that after login the session is treated as though that second
47555 user had logged in.  That second user is the <emphasis>authorization id</emphasis>.  A robust
47556 configuration might confirm that the <emphasis>authz</emphasis> field is empty or matches the
47557 <emphasis>authn</emphasis> field.  Often this is just ignored.  The <emphasis>authn</emphasis> can be considered
47558 as verified data, the <emphasis>authz</emphasis> as an unverified request which the server might
47559 choose to honour.
47560 </para>
47561 <para>
47562 A <emphasis>realm</emphasis> is a text string, typically a domain name, presented by a server
47563 to a client to help it select an account and credentials to use.  In some
47564 mechanisms, the client and server provably agree on the realm, but clients
47565 typically can not treat the realm as secure data to be blindly trusted.
47566 </para>
47567 <section id="SECID168">
47568 <title>Generic options for authenticators</title>
47569 <para>
47570 <indexterm role="concept">
47571 <primary>authentication</primary>
47572 <secondary>generic options</secondary>
47573 </indexterm>
47574 <indexterm role="concept">
47575 <primary>options</primary>
47576 <secondary>generic; for authenticators</secondary>
47577 </indexterm>
47578 </para>
47579 <para>
47580 <indexterm role="option">
47581 <primary><option>client_condition</option></primary>
47582 </indexterm>
47583 </para>
47584 <informaltable frame="all">
47585 <tgroup cols="4" colsep="0" rowsep="0">
47586 <colspec colwidth="8*" align="left"/>
47587 <colspec colwidth="6*" align="center"/>
47588 <colspec colwidth="6*" align="center"/>
47589 <colspec colwidth="6*" align="right"/>
47590 <tbody>
47591 <row>
47592 <entry><option>client_condition</option></entry>
47593 <entry>Use: <emphasis>authenticators</emphasis></entry>
47594 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
47595 <entry>Default: <emphasis>unset</emphasis></entry>
47596 </row>
47597 </tbody>
47598 </tgroup>
47599 </informaltable>
47600 <para>
47601 When Exim is authenticating as a client, it skips any authenticator whose
47602 <option>client_condition</option> expansion yields <quote>0</quote>, <quote>no</quote>, or <quote>false</quote>. This can be
47603 used, for example, to skip plain text authenticators when the connection is not
47604 encrypted by a setting such as:
47605 </para>
47606 <literallayout class="monospaced">
47607 client_condition = ${if !eq{$tls_out_cipher}{}}
47608 </literallayout>
47609 <para>
47610 <indexterm role="option">
47611 <primary><option>client_set_id</option></primary>
47612 </indexterm>
47613 </para>
47614 <informaltable frame="all">
47615 <tgroup cols="4" colsep="0" rowsep="0">
47616 <colspec colwidth="8*" align="left"/>
47617 <colspec colwidth="6*" align="center"/>
47618 <colspec colwidth="6*" align="center"/>
47619 <colspec colwidth="6*" align="right"/>
47620 <tbody>
47621 <row>
47622 <entry><option>client_set_id</option></entry>
47623 <entry>Use: <emphasis>authenticators</emphasis></entry>
47624 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
47625 <entry>Default: <emphasis>unset</emphasis></entry>
47626 </row>
47627 </tbody>
47628 </tgroup>
47629 </informaltable>
47630 <para>
47631 When client authentication succeeds, this condition is expanded; the
47632 result is used in the log lines for outbound messasges.
47633 Typically it will be the user name used for authentication.
47634 </para>
47635 <para>
47636 <indexterm role="option">
47637 <primary><option>driver</option></primary>
47638 </indexterm>
47639 </para>
47640 <informaltable frame="all">
47641 <tgroup cols="4" colsep="0" rowsep="0">
47642 <colspec colwidth="8*" align="left"/>
47643 <colspec colwidth="6*" align="center"/>
47644 <colspec colwidth="6*" align="center"/>
47645 <colspec colwidth="6*" align="right"/>
47646 <tbody>
47647 <row>
47648 <entry><option>driver</option></entry>
47649 <entry>Use: <emphasis>authenticators</emphasis></entry>
47650 <entry>Type: <emphasis>string</emphasis></entry>
47651 <entry>Default: <emphasis>unset</emphasis></entry>
47652 </row>
47653 </tbody>
47654 </tgroup>
47655 </informaltable>
47656 <para>
47657 This option must always be set. It specifies which of the available
47658 authenticators is to be used.
47659 </para>
47660 <para>
47661 <indexterm role="option">
47662 <primary><option>public_name</option></primary>
47663 </indexterm>
47664 </para>
47665 <informaltable frame="all">
47666 <tgroup cols="4" colsep="0" rowsep="0">
47667 <colspec colwidth="8*" align="left"/>
47668 <colspec colwidth="6*" align="center"/>
47669 <colspec colwidth="6*" align="center"/>
47670 <colspec colwidth="6*" align="right"/>
47671 <tbody>
47672 <row>
47673 <entry><option>public_name</option></entry>
47674 <entry>Use: <emphasis>authenticators</emphasis></entry>
47675 <entry>Type: <emphasis>string</emphasis></entry>
47676 <entry>Default: <emphasis>unset</emphasis></entry>
47677 </row>
47678 </tbody>
47679 </tgroup>
47680 </informaltable>
47681 <para>
47682 This option specifies the name of the authentication mechanism that the driver
47683 implements, and by which it is known to the outside world. These names should
47684 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
47685 but Exim in fact matches them caselessly. If <option>public_name</option> is not set, it
47686 defaults to the driver&#x2019;s instance name.
47687 </para>
47688 <para>
47689 <indexterm role="option">
47690 <primary><option>server_advertise_condition</option></primary>
47691 </indexterm>
47692 </para>
47693 <informaltable frame="all">
47694 <tgroup cols="4" colsep="0" rowsep="0">
47695 <colspec colwidth="8*" align="left"/>
47696 <colspec colwidth="6*" align="center"/>
47697 <colspec colwidth="6*" align="center"/>
47698 <colspec colwidth="6*" align="right"/>
47699 <tbody>
47700 <row>
47701 <entry><option>server_advertise_condition</option></entry>
47702 <entry>Use: <emphasis>authenticators</emphasis></entry>
47703 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
47704 <entry>Default: <emphasis>unset</emphasis></entry>
47705 </row>
47706 </tbody>
47707 </tgroup>
47708 </informaltable>
47709 <para>
47710 When a server is about to advertise an authentication mechanism, the condition
47711 is expanded. If it yields the empty string, <quote>0</quote>, <quote>no</quote>, or <quote>false</quote>, the
47712 mechanism is not advertised.
47713 If the expansion fails, the mechanism is not advertised. If the failure was not
47714 forced, and was not caused by a lookup defer, the incident is logged.
47715 See section <xref linkend="SECTauthexiser"/> below for further discussion.
47716 </para>
47717 <para>
47718 <indexterm role="option">
47719 <primary><option>server_condition</option></primary>
47720 </indexterm>
47721 </para>
47722 <informaltable frame="all">
47723 <tgroup cols="4" colsep="0" rowsep="0">
47724 <colspec colwidth="8*" align="left"/>
47725 <colspec colwidth="6*" align="center"/>
47726 <colspec colwidth="6*" align="center"/>
47727 <colspec colwidth="6*" align="right"/>
47728 <tbody>
47729 <row>
47730 <entry><option>server_condition</option></entry>
47731 <entry>Use: <emphasis>authenticators</emphasis></entry>
47732 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
47733 <entry>Default: <emphasis>unset</emphasis></entry>
47734 </row>
47735 </tbody>
47736 </tgroup>
47737 </informaltable>
47738 <para>
47739 This option must be set for a <option>plaintext</option> server authenticator, where it
47740 is used directly to control authentication. See section <xref linkend="SECTplainserver"/>
47741 for details.
47742 </para>
47743 <para>
47744 For the <command>gsasl</command> authenticator, this option is required for various
47745 mechanisms; see chapter <xref linkend="CHAPgsasl"/> for details.
47746 </para>
47747 <para>
47748 For the other authenticators, <option>server_condition</option> can be used as an additional
47749 authentication or authorization mechanism that is applied after the other
47750 authenticator conditions succeed. If it is set, it is expanded when the
47751 authenticator would otherwise return a success code. If the expansion is forced
47752 to fail, authentication fails. Any other expansion failure causes a temporary
47753 error code to be returned. If the result of a successful expansion is an empty
47754 string, <quote>0</quote>, <quote>no</quote>, or <quote>false</quote>, authentication fails. If the result of the
47755 expansion is <quote>1</quote>, <quote>yes</quote>, or <quote>true</quote>, authentication succeeds. For any
47756 other result, a temporary error code is returned, with the expanded string as
47757 the error text.
47758 </para>
47759 <para>
47760 <indexterm role="option">
47761 <primary><option>server_debug_print</option></primary>
47762 </indexterm>
47763 </para>
47764 <informaltable frame="all">
47765 <tgroup cols="4" colsep="0" rowsep="0">
47766 <colspec colwidth="8*" align="left"/>
47767 <colspec colwidth="6*" align="center"/>
47768 <colspec colwidth="6*" align="center"/>
47769 <colspec colwidth="6*" align="right"/>
47770 <tbody>
47771 <row>
47772 <entry><option>server_debug_print</option></entry>
47773 <entry>Use: <emphasis>authenticators</emphasis></entry>
47774 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
47775 <entry>Default: <emphasis>unset</emphasis></entry>
47776 </row>
47777 </tbody>
47778 </tgroup>
47779 </informaltable>
47780 <para>
47781 If this option is set and authentication debugging is enabled (see the <option>-d</option>
47782 command line option), the string is expanded and included in the debugging
47783 output when the authenticator is run as a server. This can help with checking
47784 out the values of variables.
47785 If expansion of the string fails, the error message is written to the debugging
47786 output, and Exim carries on processing.
47787 </para>
47788 <para>
47789 <indexterm role="option">
47790 <primary><option>server_set_id</option></primary>
47791 </indexterm>
47792 </para>
47793 <informaltable frame="all">
47794 <tgroup cols="4" colsep="0" rowsep="0">
47795 <colspec colwidth="8*" align="left"/>
47796 <colspec colwidth="6*" align="center"/>
47797 <colspec colwidth="6*" align="center"/>
47798 <colspec colwidth="6*" align="right"/>
47799 <tbody>
47800 <row>
47801 <entry><option>server_set_id</option></entry>
47802 <entry>Use: <emphasis>authenticators</emphasis></entry>
47803 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
47804 <entry>Default: <emphasis>unset</emphasis></entry>
47805 </row>
47806 </tbody>
47807 </tgroup>
47808 </informaltable>
47809 <para>
47810 <indexterm role="variable">
47811 <primary><varname>$authenticated_id</varname></primary>
47812 </indexterm>
47813 When an Exim server successfully authenticates a client, this string is
47814 expanded using data from the authentication, and preserved for any incoming
47815 messages in the variable <varname>$authenticated_id</varname>. It is also included in the log
47816 lines for incoming messages. For example, a user/password authenticator
47817 configuration might preserve the user name that was used to authenticate, and
47818 refer to it subsequently during delivery of the message.
47819 If expansion fails, the option is ignored.
47820 </para>
47821 <para>
47822 <indexterm role="option">
47823 <primary><option>server_mail_auth_condition</option></primary>
47824 </indexterm>
47825 </para>
47826 <informaltable frame="all">
47827 <tgroup cols="4" colsep="0" rowsep="0">
47828 <colspec colwidth="8*" align="left"/>
47829 <colspec colwidth="6*" align="center"/>
47830 <colspec colwidth="6*" align="center"/>
47831 <colspec colwidth="6*" align="right"/>
47832 <tbody>
47833 <row>
47834 <entry><option>server_mail_auth_condition</option></entry>
47835 <entry>Use: <emphasis>authenticators</emphasis></entry>
47836 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
47837 <entry>Default: <emphasis>unset</emphasis></entry>
47838 </row>
47839 </tbody>
47840 </tgroup>
47841 </informaltable>
47842 <para>
47843 This option allows a server to discard authenticated sender addresses supplied
47844 as part of MAIL commands in SMTP connections that are authenticated by the
47845 driver on which <option>server_mail_auth_condition</option> is set. The option is not used
47846 as part of the authentication process; instead its (unexpanded) value is
47847 remembered for later use.
47848 How it is used is described in the following section.
47849 </para>
47850 </section>
47851 <section id="SECTauthparamail">
47852 <title>The AUTH parameter on MAIL commands</title>
47853 <para>
47854 <indexterm role="concept">
47855 <primary>authentication</primary>
47856 <secondary>sender; authenticated</secondary>
47857 </indexterm>
47858 <indexterm role="concept">
47859 <primary>AUTH</primary>
47860 <secondary>on MAIL command</secondary>
47861 </indexterm>
47862 When a client supplied an AUTH= item on a MAIL command, Exim applies
47863 the following checks before accepting it as the authenticated sender of the
47864 message:
47865 </para>
47866 <itemizedlist>
47867 <listitem>
47868 <para>
47869 If the connection is not using extended SMTP (that is, HELO was used rather
47870 than EHLO), the use of AUTH= is a syntax error.
47871 </para>
47872 </listitem>
47873 <listitem>
47874 <para>
47875 If the value of the AUTH= parameter is <quote>&lt;&gt;</quote>, it is ignored.
47876 </para>
47877 </listitem>
47878 <listitem>
47879 <para>
47880 <indexterm role="variable">
47881 <primary><varname>$authenticated_sender</varname></primary>
47882 </indexterm>
47883 If <option>acl_smtp_mailauth</option> is defined, the ACL it specifies is run. While it is
47884 running, the value of <varname>$authenticated_sender</varname> is set to the value obtained
47885 from the AUTH= parameter. If the ACL does not yield <quote>accept</quote>, the value of
47886 <varname>$authenticated_sender</varname> is deleted. The <option>acl_smtp_mailauth</option> ACL may not
47887 return <quote>drop</quote> or <quote>discard</quote>. If it defers, a temporary error code (451) is
47888 given for the MAIL command.
47889 </para>
47890 </listitem>
47891 <listitem>
47892 <para>
47893 If <option>acl_smtp_mailauth</option> is not defined, the value of the AUTH= parameter
47894 is accepted and placed in <varname>$authenticated_sender</varname> only if the client has
47895 authenticated.
47896 </para>
47897 </listitem>
47898 <listitem>
47899 <para>
47900 If the AUTH= value was accepted by either of the two previous rules, and
47901 the client has authenticated, and the authenticator has a setting for the
47902 <option>server_mail_auth_condition</option>, the condition is checked at this point. The
47903 valued that was saved from the authenticator is expanded. If the expansion
47904 fails, or yields an empty string, <quote>0</quote>, <quote>no</quote>, or <quote>false</quote>, the value of
47905 <varname>$authenticated_sender</varname> is deleted. If the expansion yields any other value,
47906 the value of <varname>$authenticated_sender</varname> is retained and passed on with the
47907 message.
47908 </para>
47909 </listitem>
47910 </itemizedlist>
47911 <para>
47912 When <varname>$authenticated_sender</varname> is set for a message, it is passed on to other
47913 hosts to which Exim authenticates as a client. Do not confuse this value with
47914 <varname>$authenticated_id</varname>, which is a string obtained from the authentication
47915 process, and which is not usually a complete email address.
47916 </para>
47917 <para>
47918 <indexterm role="variable">
47919 <primary><varname>$sender_address</varname></primary>
47920 </indexterm>
47921 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
47922 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
47923 therefore make use of <varname>$authenticated_sender</varname>. The converse is not true: the
47924 value of <varname>$sender_address</varname> is not yet set up when the <option>acl_smtp_mailauth</option>
47925 ACL is run.
47926 </para>
47927 </section>
47928 <section id="SECTauthexiser">
47929 <title>Authentication on an Exim server</title>
47930 <para>
47931 <indexterm role="concept">
47932 <primary>authentication</primary>
47933 <secondary>on an Exim server</secondary>
47934 </indexterm>
47935 When Exim receives an EHLO command, it advertises the public names of those
47936 authenticators that are configured as servers, subject to the following
47937 conditions:
47938 </para>
47939 <itemizedlist>
47940 <listitem>
47941 <para>
47942 The client host must match <option>auth_advertise_hosts</option> (default *).
47943 </para>
47944 </listitem>
47945 <listitem>
47946 <para>
47947 It the <option>server_advertise_condition</option> option is set, its expansion must not
47948 yield the empty string, <quote>0</quote>, <quote>no</quote>, or <quote>false</quote>.
47949 </para>
47950 </listitem>
47951 </itemizedlist>
47952 <para>
47953 The order in which the authenticators are defined controls the order in which
47954 the mechanisms are advertised.
47955 </para>
47956 <para>
47957 Some mail clients (for example, some versions of Netscape) require the user to
47958 provide a name and password for authentication whenever AUTH is advertised,
47959 even though authentication may not in fact be needed (for example, Exim may be
47960 set up to allow unconditional relaying from the client by an IP address check).
47961 You can make such clients more friendly by not advertising AUTH to them.
47962 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
47963 that runs for RCPT) to relay without authentication, you should set
47964 </para>
47965 <literallayout class="monospaced">
47966 auth_advertise_hosts = ! 10.9.8.0/24
47967 </literallayout>
47968 <para>
47969 so that no authentication mechanisms are advertised to them.
47970 </para>
47971 <para>
47972 The <option>server_advertise_condition</option> controls the advertisement of individual
47973 authentication mechanisms. For example, it can be used to restrict the
47974 advertisement of a particular mechanism to encrypted connections, by a setting
47975 such as:
47976 </para>
47977 <literallayout class="monospaced">
47978 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
47979 </literallayout>
47980 <para>
47981 <indexterm role="variable">
47982 <primary><varname>$tls_in_cipher</varname></primary>
47983 </indexterm>
47984 If the session is encrypted, <varname>$tls_in_cipher</varname> is not empty, and so the expansion
47985 yields <quote>yes</quote>, which allows the advertisement to happen.
47986 </para>
47987 <para>
47988 When an Exim server receives an AUTH command from a client, it rejects it
47989 immediately if AUTH was not advertised in response to an earlier EHLO
47990 command. This is the case if
47991 </para>
47992 <itemizedlist>
47993 <listitem>
47994 <para>
47995 The client host does not match <option>auth_advertise_hosts</option>; or
47996 </para>
47997 </listitem>
47998 <listitem>
47999 <para>
48000 No authenticators are configured with server options; or
48001 </para>
48002 </listitem>
48003 <listitem>
48004 <para>
48005 Expansion of <option>server_advertise_condition</option> blocked the advertising of all the
48006 server authenticators.
48007 </para>
48008 </listitem>
48009 </itemizedlist>
48010 <para>
48011 Otherwise, Exim runs the ACL specified by <option>acl_smtp_auth</option> in order
48012 to decide whether to accept the command. If <option>acl_smtp_auth</option> is not set,
48013 AUTH is accepted from any client host.
48014 </para>
48015 <para>
48016 If AUTH is not rejected by the ACL, Exim searches its configuration for a
48017 server authentication mechanism that was advertised in response to EHLO and
48018 that matches the one named in the AUTH command. If it finds one, it runs
48019 the appropriate authentication protocol, and authentication either succeeds or
48020 fails. If there is no matching advertised mechanism, the AUTH command is
48021 rejected with a 504 error.
48022 </para>
48023 <para>
48024 <indexterm role="variable">
48025 <primary><varname>$received_protocol</varname></primary>
48026 </indexterm>
48027 <indexterm role="variable">
48028 <primary><varname>$sender_host_authenticated</varname></primary>
48029 </indexterm>
48030 When a message is received from an authenticated host, the value of
48031 <varname>$received_protocol</varname> is set to <quote>esmtpa</quote> or <quote>esmtpsa</quote> instead of <quote>esmtp</quote>
48032 or <quote>esmtps</quote>, and <varname>$sender_host_authenticated</varname> contains the name (not the
48033 public name) of the authenticator driver that successfully authenticated the
48034 client from which the message was received. This variable is empty if there was
48035 no successful authentication.
48036 </para>
48037 </section>
48038 <section id="SECID169">
48039 <title>Testing server authentication</title>
48040 <para>
48041 <indexterm role="concept">
48042 <primary>authentication</primary>
48043 <secondary>testing a server</secondary>
48044 </indexterm>
48045 <indexterm role="concept">
48046 <primary>AUTH</primary>
48047 <secondary>testing a server</secondary>
48048 </indexterm>
48049 <indexterm role="concept">
48050 <primary>base64 encoding</primary>
48051 <secondary>creating authentication test data</secondary>
48052 </indexterm>
48053 Exim&#x2019;s <option>-bh</option> option can be useful for testing server authentication
48054 configurations. The data for the AUTH command has to be sent using base64
48055 encoding. A quick way to produce such data for testing is the following Perl
48056 script:
48057 </para>
48058 <literallayout class="monospaced">
48059 use MIME::Base64;
48060 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
48061 </literallayout>
48062 <para>
48063 <indexterm role="concept">
48064 <primary>binary zero</primary>
48065 <secondary>in authentication data</secondary>
48066 </indexterm>
48067 This interprets its argument as a Perl string, and then encodes it. The
48068 interpretation as a Perl string allows binary zeros, which are required for
48069 some kinds of authentication, to be included in the data. For example, a
48070 command line to run this script on such data might be
48071 </para>
48072 <literallayout class="monospaced">
48073 encode '\0user\0password'
48074 </literallayout>
48075 <para>
48076 Note the use of single quotes to prevent the shell interpreting the
48077 backslashes, so that they can be interpreted by Perl to specify characters
48078 whose code value is zero.
48079 </para>
48080 <para>
48081 <emphasis role="bold">Warning 1</emphasis>: If either of the user or password strings starts with an octal
48082 digit, you must use three zeros instead of one after the leading backslash. If
48083 you do not, the octal digit that starts your string will be incorrectly
48084 interpreted as part of the code for the first character.
48085 </para>
48086 <para>
48087 <emphasis role="bold">Warning 2</emphasis>: If there are characters in the strings that Perl interprets
48088 specially, you must use a Perl escape to prevent them being misinterpreted. For
48089 example, a command such as
48090 </para>
48091 <literallayout class="monospaced">
48092 encode '\0user@domain.com\0pas$$word'
48093 </literallayout>
48094 <para>
48095 gives an incorrect answer because of the unescaped <quote>@</quote> and <quote>$</quote> characters.
48096 </para>
48097 <para>
48098 If you have the <option>mimencode</option> command installed, another way to do produce
48099 base64-encoded strings is to run the command
48100 </para>
48101 <literallayout class="monospaced">
48102 echo -e -n `\0user\0password' | mimencode
48103 </literallayout>
48104 <para>
48105 The <option>-e</option> option of <option>echo</option> enables the interpretation of backslash escapes
48106 in the argument, and the <option>-n</option> option specifies no newline at the end of its
48107 output. However, not all versions of <option>echo</option> recognize these options, so you
48108 should check your version before relying on this suggestion.
48109 </para>
48110 </section>
48111 <section id="SECID170">
48112 <title>Authentication by an Exim client</title>
48113 <para>
48114 <indexterm role="concept">
48115 <primary>authentication</primary>
48116 <secondary>on an Exim client</secondary>
48117 </indexterm>
48118 The <command>smtp</command> transport has two options called <option>hosts_require_auth</option> and
48119 <option>hosts_try_auth</option>. When the <command>smtp</command> transport connects to a server that
48120 announces support for authentication, and the host matches an entry in either
48121 of these options, Exim (as a client) tries to authenticate as follows:
48122 </para>
48123 <itemizedlist>
48124 <listitem>
48125 <para>
48126 For each authenticator that is configured as a client, in the order in which
48127 they are defined in the configuration, it searches the authentication
48128 mechanisms announced by the server for one whose name matches the public name
48129 of the authenticator.
48130 </para>
48131 </listitem>
48132 <listitem>
48133 <para>
48134 <indexterm role="variable">
48135 <primary><varname>$host</varname></primary>
48136 </indexterm>
48137 <indexterm role="variable">
48138 <primary><varname>$host_address</varname></primary>
48139 </indexterm>
48140 When it finds one that matches, it runs the authenticator&#x2019;s client code. The
48141 variables <varname>$host</varname> and <varname>$host_address</varname> are available for any string expansions
48142 that the client might do. They are set to the server&#x2019;s name and IP address. If
48143 any expansion is forced to fail, the authentication attempt is abandoned, and
48144 Exim moves on to the next authenticator. Otherwise an expansion failure causes
48145 delivery to be deferred.
48146 </para>
48147 </listitem>
48148 <listitem>
48149 <para>
48150 If the result of the authentication attempt is a temporary error or a timeout,
48151 Exim abandons trying to send the message to the host for the moment. It will
48152 try again later. If there are any backup hosts available, they are tried in the
48153 usual way.
48154 </para>
48155 </listitem>
48156 <listitem>
48157 <para>
48158 If the response to authentication is a permanent error (5<emphasis>xx</emphasis> code), Exim
48159 carries on searching the list of authenticators and tries another one if
48160 possible. If all authentication attempts give permanent errors, or if there are
48161 no attempts because no mechanisms match (or option expansions force failure),
48162 what happens depends on whether the host matches <option>hosts_require_auth</option> or
48163 <option>hosts_try_auth</option>. In the first case, a temporary error is generated, and
48164 delivery is deferred. The error can be detected in the retry rules, and thereby
48165 turned into a permanent error if you wish. In the second case, Exim tries to
48166 deliver the message unauthenticated.
48167 </para>
48168 </listitem>
48169 </itemizedlist>
48170 <para>
48171 <indexterm role="concept">
48172 <primary>AUTH</primary>
48173 <secondary>on MAIL command</secondary>
48174 </indexterm>
48175 When Exim has authenticated itself to a remote server, it adds the AUTH
48176 parameter to the MAIL commands it sends, if it has an authenticated sender for
48177 the message. If the message came from a remote host, the authenticated sender
48178 is the one that was receiving on an incoming MAIL command, provided that the
48179 incoming connection was authenticated and the <option>server_mail_auth</option> condition
48180 allowed the authenticated sender to be retained. If a local process calls Exim
48181 to send a message, the sender address that is built from the login name and
48182 <option>qualify_domain</option> is treated as authenticated. However, if the
48183 <option>authenticated_sender</option> option is set on the <command>smtp</command> transport, it overrides
48184 the authenticated sender that was received with the message.
48185 <indexterm role="concept" startref="IIDauthconf1" class="endofrange"/>
48186 <indexterm role="concept" startref="IIDauthconf2" class="endofrange"/>
48187 </para>
48188 </section>
48189 </chapter>
48190
48191 <chapter id="CHAPplaintext">
48192 <title>The plaintext authenticator</title>
48193 <para>
48194 <indexterm role="concept" id="IIDplaiauth1" class="startofrange">
48195 <primary><command>plaintext</command> authenticator</primary>
48196 </indexterm>
48197 <indexterm role="concept" id="IIDplaiauth2" class="startofrange">
48198 <primary>authenticators</primary>
48199 <secondary><command>plaintext</command></secondary>
48200 </indexterm>
48201 The <command>plaintext</command> authenticator can be configured to support the PLAIN and
48202 LOGIN authentication mechanisms, both of which transfer authentication data as
48203 plain (unencrypted) text (though base64 encoded). The use of plain text is a
48204 security risk; you are strongly advised to insist on the use of SMTP encryption
48205 (see chapter <xref linkend="CHAPTLS"/>) if you use the PLAIN or LOGIN mechanisms. If you do
48206 use unencrypted plain text, you should not use the same passwords for SMTP
48207 connections as you do for login accounts.
48208 </para>
48209 <section id="SECID171">
48210 <title>Plaintext options</title>
48211 <para>
48212 <indexterm role="concept">
48213 <primary>options</primary>
48214 <secondary><command>plaintext</command> authenticator (server)</secondary>
48215 </indexterm>
48216 When configured as a server, <command>plaintext</command> uses the following options:
48217 </para>
48218 <para>
48219 <indexterm role="option">
48220 <primary><option>server_condition</option></primary>
48221 </indexterm>
48222 </para>
48223 <informaltable frame="all">
48224 <tgroup cols="4" colsep="0" rowsep="0">
48225 <colspec colwidth="8*" align="left"/>
48226 <colspec colwidth="6*" align="center"/>
48227 <colspec colwidth="6*" align="center"/>
48228 <colspec colwidth="6*" align="right"/>
48229 <tbody>
48230 <row>
48231 <entry><option>server_condition</option></entry>
48232 <entry>Use: <emphasis>authenticators</emphasis></entry>
48233 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
48234 <entry>Default: <emphasis>unset</emphasis></entry>
48235 </row>
48236 </tbody>
48237 </tgroup>
48238 </informaltable>
48239 <para>
48240 This is actually a global authentication option, but it must be set in order to
48241 configure the <command>plaintext</command> driver as a server. Its use is described below.
48242 </para>
48243 <para>
48244 <indexterm role="option">
48245 <primary><option>server_prompts</option></primary>
48246 </indexterm>
48247 </para>
48248 <informaltable frame="all">
48249 <tgroup cols="4" colsep="0" rowsep="0">
48250 <colspec colwidth="8*" align="left"/>
48251 <colspec colwidth="6*" align="center"/>
48252 <colspec colwidth="6*" align="center"/>
48253 <colspec colwidth="6*" align="right"/>
48254 <tbody>
48255 <row>
48256 <entry><option>server_prompts</option></entry>
48257 <entry>Use: <emphasis>plaintext</emphasis></entry>
48258 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
48259 <entry>Default: <emphasis>unset</emphasis></entry>
48260 </row>
48261 </tbody>
48262 </tgroup>
48263 </informaltable>
48264 <para>
48265 The contents of this option, after expansion, must be a colon-separated list of
48266 prompt strings. If expansion fails, a temporary authentication rejection is
48267 given.
48268 </para>
48269 </section>
48270 <section id="SECTplainserver">
48271 <title>Using plaintext in a server</title>
48272 <para>
48273 <indexterm role="concept">
48274 <primary>AUTH</primary>
48275 <secondary>in <command>plaintext</command> authenticator</secondary>
48276 </indexterm>
48277 <indexterm role="concept">
48278 <primary>binary zero</primary>
48279 <secondary>in <command>plaintext</command> authenticator</secondary>
48280 </indexterm>
48281 <indexterm role="concept">
48282 <primary>numerical variables (<varname>$1</varname> <varname>$2</varname> etc)</primary>
48283 <secondary>in <command>plaintext</command> authenticator</secondary>
48284 </indexterm>
48285 <indexterm role="variable">
48286 <primary><varname>$auth1</varname>, <varname>$auth2</varname>, etc</primary>
48287 </indexterm>
48288 <indexterm role="concept">
48289 <primary>base64 encoding</primary>
48290 <secondary>in <command>plaintext</command> authenticator</secondary>
48291 </indexterm>
48292 </para>
48293 <para>
48294 When running as a server, <command>plaintext</command> performs the authentication test by
48295 expanding a string. The data sent by the client with the AUTH command, or in
48296 response to subsequent prompts, is base64 encoded, and so may contain any byte
48297 values when decoded. If any data is supplied with the command, it is treated as
48298 a list of strings, separated by NULs (binary zeros), the first three of which
48299 are placed in the expansion variables <varname>$auth1</varname>, <varname>$auth2</varname>, and <varname>$auth3</varname>
48300 (neither LOGIN nor PLAIN uses more than three strings).
48301 </para>
48302 <para>
48303 For compatibility with previous releases of Exim, the values are also placed in
48304 the expansion variables <varname>$1</varname>, <varname>$2</varname>, and <varname>$3</varname>. However, the use of these
48305 variables for this purpose is now deprecated, as it can lead to confusion in
48306 string expansions that also use them for other things.
48307 </para>
48308 <para>
48309 If there are more strings in <option>server_prompts</option> than the number of strings
48310 supplied with the AUTH command, the remaining prompts are used to obtain more
48311 data. Each response from the client may be a list of NUL-separated strings.
48312 </para>
48313 <para>
48314 <indexterm role="variable">
48315 <primary><varname>$authenticated_id</varname></primary>
48316 </indexterm>
48317 Once a sufficient number of data strings have been received,
48318 <option>server_condition</option> is expanded. If the expansion is forced to fail,
48319 authentication fails. Any other expansion failure causes a temporary error code
48320 to be returned. If the result of a successful expansion is an empty string,
48321 <quote>0</quote>, <quote>no</quote>, or <quote>false</quote>, authentication fails. If the result of the
48322 expansion is <quote>1</quote>, <quote>yes</quote>, or <quote>true</quote>, authentication succeeds and the
48323 generic <option>server_set_id</option> option is expanded and saved in <varname>$authenticated_id</varname>.
48324 For any other result, a temporary error code is returned, with the expanded
48325 string as the error text
48326 </para>
48327 <para>
48328 <emphasis role="bold">Warning</emphasis>: If you use a lookup in the expansion to find the user&#x2019;s
48329 password, be sure to make the authentication fail if the user is unknown.
48330 There are good and bad examples at the end of the next section.
48331 </para>
48332 </section>
48333 <section id="SECID172">
48334 <title>The PLAIN authentication mechanism</title>
48335 <para>
48336 <indexterm role="concept">
48337 <primary>PLAIN authentication mechanism</primary>
48338 </indexterm>
48339 <indexterm role="concept">
48340 <primary>authentication</primary>
48341 <secondary>PLAIN mechanism</secondary>
48342 </indexterm>
48343 <indexterm role="concept">
48344 <primary>binary zero</primary>
48345 <secondary>in <command>plaintext</command> authenticator</secondary>
48346 </indexterm>
48347 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
48348 sent as one item of data (that is, one combined string containing two NUL
48349 separators). The data is sent either as part of the AUTH command, or
48350 subsequently in response to an empty prompt from the server.
48351 </para>
48352 <para>
48353 The second and third strings are a user name and a corresponding password.
48354 Using a single fixed user name and password as an example, this could be
48355 configured as follows:
48356 </para>
48357 <literallayout class="monospaced">
48358 fixed_plain:
48359   driver = plaintext
48360   public_name = PLAIN
48361   server_prompts = :
48362   server_condition = \
48363     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
48364   server_set_id = $auth2
48365 </literallayout>
48366 <para>
48367 Note that the default result strings from <option>if</option> (<quote>true</quote> or an empty string)
48368 are exactly what we want here, so they need not be specified. Obviously, if the
48369 password contains expansion-significant characters such as dollar, backslash,
48370 or closing brace, they have to be escaped.
48371 </para>
48372 <para>
48373 The <option>server_prompts</option> setting specifies a single, empty prompt (empty items at
48374 the end of a string list are ignored). If all the data comes as part of the
48375 AUTH command, as is commonly the case, the prompt is not used. This
48376 authenticator is advertised in the response to EHLO as
48377 </para>
48378 <literallayout class="monospaced">
48379 250-AUTH PLAIN
48380 </literallayout>
48381 <para>
48382 and a client host can authenticate itself by sending the command
48383 </para>
48384 <literallayout class="monospaced">
48385 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
48386 </literallayout>
48387 <para>
48388 As this contains three strings (more than the number of prompts), no further
48389 data is required from the client. Alternatively, the client may just send
48390 </para>
48391 <literallayout class="monospaced">
48392 AUTH PLAIN
48393 </literallayout>
48394 <para>
48395 to initiate authentication, in which case the server replies with an empty
48396 prompt. The client must respond with the combined data string.
48397 </para>
48398 <para>
48399 The data string is base64 encoded, as required by the RFC. This example,
48400 when decoded, is &lt;<emphasis>NUL</emphasis>&gt;<literal>username</literal>&lt;<emphasis>NUL</emphasis>&gt;<literal>mysecret</literal>, where &lt;<emphasis>NUL</emphasis>&gt;
48401 represents a zero byte. This is split up into three strings, the first of which
48402 is empty. The <option>server_condition</option> option in the authenticator checks that the
48403 second two are <literal>username</literal> and <literal>mysecret</literal> respectively.
48404 </para>
48405 <para>
48406 Having just one fixed user name and password, as in this example, is not very
48407 realistic, though for a small organization with only a handful of
48408 authenticating clients it could make sense.
48409 </para>
48410 <para>
48411 A more sophisticated instance of this authenticator could use the user name in
48412 <varname>$auth2</varname> to look up a password in a file or database, and maybe do an encrypted
48413 comparison (see <option>crypteq</option> in chapter <xref linkend="CHAPexpand"/>). Here is a example of
48414 this approach, where the passwords are looked up in a DBM file. <emphasis role="bold">Warning</emphasis>:
48415 This is an incorrect example:
48416 </para>
48417 <literallayout class="monospaced">
48418 server_condition = \
48419   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
48420 </literallayout>
48421 <para>
48422 The expansion uses the user name (<varname>$auth2</varname>) as the key to look up a password,
48423 which it then compares to the supplied password (<varname>$auth3</varname>). Why is this example
48424 incorrect? It works fine for existing users, but consider what happens if a
48425 non-existent user name is given. The lookup fails, but as no success/failure
48426 strings are given for the lookup, it yields an empty string. Thus, to defeat
48427 the authentication, all a client has to do is to supply a non-existent user
48428 name and an empty password. The correct way of writing this test is:
48429 </para>
48430 <literallayout class="monospaced">
48431 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
48432   {${if eq{$value}{$auth3}}} {false}}
48433 </literallayout>
48434 <para>
48435 In this case, if the lookup succeeds, the result is checked; if the lookup
48436 fails, <quote>false</quote> is returned and authentication fails. If <option>crypteq</option> is being
48437 used instead of <option>eq</option>, the first example is in fact safe, because <option>crypteq</option>
48438 always fails if its second argument is empty. However, the second way of
48439 writing the test makes the logic clearer.
48440 </para>
48441 </section>
48442 <section id="SECID173">
48443 <title>The LOGIN authentication mechanism</title>
48444 <para>
48445 <indexterm role="concept">
48446 <primary>LOGIN authentication mechanism</primary>
48447 </indexterm>
48448 <indexterm role="concept">
48449 <primary>authentication</primary>
48450 <secondary>LOGIN mechanism</secondary>
48451 </indexterm>
48452 The LOGIN authentication mechanism is not documented in any RFC, but is in use
48453 in a number of programs. No data is sent with the AUTH command. Instead, a
48454 user name and password are supplied separately, in response to prompts. The
48455 plaintext authenticator can be configured to support this as in this example:
48456 </para>
48457 <literallayout class="monospaced">
48458 fixed_login:
48459   driver = plaintext
48460   public_name = LOGIN
48461   server_prompts = User Name : Password
48462   server_condition = \
48463     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
48464   server_set_id = $auth1
48465 </literallayout>
48466 <para>
48467 Because of the way plaintext operates, this authenticator accepts data supplied
48468 with the AUTH command (in contravention of the specification of LOGIN), but
48469 if the client does not supply it (as is the case for LOGIN clients), the prompt
48470 strings are used to obtain two data items.
48471 </para>
48472 <para>
48473 Some clients are very particular about the precise text of the prompts. For
48474 example, Outlook Express is reported to recognize only <quote>Username:</quote> and
48475 <quote>Password:</quote>. Here is an example of a LOGIN authenticator that uses those
48476 strings. It uses the <option>ldapauth</option> expansion condition to check the user
48477 name and password by binding to an LDAP server:
48478 </para>
48479 <literallayout class="monospaced">
48480 login:
48481   driver = plaintext
48482   public_name = LOGIN
48483   server_prompts = Username:: : Password::
48484   server_condition = ${if and{{ \
48485     !eq{}{$auth1} }{ \
48486     ldapauth{\
48487       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
48488       pass=${quote:$auth2} \
48489       ldap://ldap.example.org/} }} }
48490   server_set_id = uid=$auth1,ou=people,o=example.org
48491 </literallayout>
48492 <para>
48493 We have to check that the username is not empty before using it, because LDAP
48494 does not permit empty DN components. We must also use the <option>quote_ldap_dn</option>
48495 operator to correctly quote the DN for authentication. However, the basic
48496 <option>quote</option> operator, rather than any of the LDAP quoting operators, is the
48497 correct one to use for the password, because quoting is needed only to make
48498 the password conform to the Exim syntax. At the LDAP level, the password is an
48499 uninterpreted string.
48500 </para>
48501 </section>
48502 <section id="SECID174">
48503 <title>Support for different kinds of authentication</title>
48504 <para>
48505 A number of string expansion features are provided for the purpose of
48506 interfacing to different ways of user authentication. These include checking
48507 traditionally encrypted passwords from <filename>/etc/passwd</filename> (or equivalent), PAM,
48508 Radius, <option>ldapauth</option>, <emphasis>pwcheck</emphasis>, and <emphasis>saslauthd</emphasis>. For details see section
48509 <xref linkend="SECTexpcond"/>.
48510 </para>
48511 </section>
48512 <section id="SECID175">
48513 <title>Using plaintext in a client</title>
48514 <para>
48515 <indexterm role="concept">
48516 <primary>options</primary>
48517 <secondary><command>plaintext</command> authenticator (client)</secondary>
48518 </indexterm>
48519 The <command>plaintext</command> authenticator has two client options:
48520 </para>
48521 <para>
48522 <indexterm role="option">
48523 <primary><option>client_ignore_invalid_base64</option></primary>
48524 </indexterm>
48525 </para>
48526 <informaltable frame="all">
48527 <tgroup cols="4" colsep="0" rowsep="0">
48528 <colspec colwidth="8*" align="left"/>
48529 <colspec colwidth="6*" align="center"/>
48530 <colspec colwidth="6*" align="center"/>
48531 <colspec colwidth="6*" align="right"/>
48532 <tbody>
48533 <row>
48534 <entry><option>client_ignore_invalid_base64</option></entry>
48535 <entry>Use: <emphasis>plaintext</emphasis></entry>
48536 <entry>Type: <emphasis>boolean</emphasis></entry>
48537 <entry>Default: <emphasis>false</emphasis></entry>
48538 </row>
48539 </tbody>
48540 </tgroup>
48541 </informaltable>
48542 <para>
48543 If the client receives a server prompt that is not a valid base64 string,
48544 authentication is abandoned by default. However, if this option is set true,
48545 the error in the challenge is ignored and the client sends the response as
48546 usual.
48547 </para>
48548 <para>
48549 <indexterm role="option">
48550 <primary><option>client_send</option></primary>
48551 </indexterm>
48552 </para>
48553 <informaltable frame="all">
48554 <tgroup cols="4" colsep="0" rowsep="0">
48555 <colspec colwidth="8*" align="left"/>
48556 <colspec colwidth="6*" align="center"/>
48557 <colspec colwidth="6*" align="center"/>
48558 <colspec colwidth="6*" align="right"/>
48559 <tbody>
48560 <row>
48561 <entry><option>client_send</option></entry>
48562 <entry>Use: <emphasis>plaintext</emphasis></entry>
48563 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
48564 <entry>Default: <emphasis>unset</emphasis></entry>
48565 </row>
48566 </tbody>
48567 </tgroup>
48568 </informaltable>
48569 <para>
48570 The string is a colon-separated list of authentication data strings. Each
48571 string is independently expanded before being sent to the server. The first
48572 string is sent with the AUTH command; any more strings are sent in response
48573 to prompts from the server. Before each string is expanded, the value of the
48574 most recent prompt is placed in the next <varname>$auth</varname>&lt;<emphasis>n</emphasis>&gt; variable, starting
48575 with <varname>$auth1</varname> for the first prompt. Up to three prompts are stored in this
48576 way. Thus, the prompt that is received in response to sending the first string
48577 (with the AUTH command) can be used in the expansion of the second string, and
48578 so on. If an invalid base64 string is received when
48579 <option>client_ignore_invalid_base64</option> is set, an empty string is put in the
48580 <varname>$auth</varname>&lt;<emphasis>n</emphasis>&gt; variable.
48581 </para>
48582 <para>
48583 <emphasis role="bold">Note</emphasis>: You cannot use expansion to create multiple strings, because
48584 splitting takes priority and happens first.
48585 </para>
48586 <para>
48587 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
48588 the data, further processing is applied to each string before it is sent. If
48589 there are any single circumflex characters in the string, they are converted to
48590 NULs. Should an actual circumflex be required as data, it must be doubled in
48591 the string.
48592 </para>
48593 <para>
48594 This is an example of a client configuration that implements the PLAIN
48595 authentication mechanism with a fixed user name and password:
48596 </para>
48597 <literallayout class="monospaced">
48598 fixed_plain:
48599   driver = plaintext
48600   public_name = PLAIN
48601   client_send = ^username^mysecret
48602 </literallayout>
48603 <para>
48604 The lack of colons means that the entire text is sent with the AUTH
48605 command, with the circumflex characters converted to NULs. A similar example
48606 that uses the LOGIN mechanism is:
48607 </para>
48608 <literallayout class="monospaced">
48609 fixed_login:
48610   driver = plaintext
48611   public_name = LOGIN
48612   client_send = : username : mysecret
48613 </literallayout>
48614 <para>
48615 The initial colon means that the first string is empty, so no data is sent with
48616 the AUTH command itself. The remaining strings are sent in response to
48617 prompts.
48618 <indexterm role="concept" startref="IIDplaiauth1" class="endofrange"/>
48619 <indexterm role="concept" startref="IIDplaiauth2" class="endofrange"/>
48620 </para>
48621 </section>
48622 </chapter>
48623
48624 <chapter id="CHID9">
48625 <title>The cram_md5 authenticator</title>
48626 <para>
48627 <indexterm role="concept" id="IIDcramauth1" class="startofrange">
48628 <primary><command>cram_md5</command> authenticator</primary>
48629 </indexterm>
48630 <indexterm role="concept" id="IIDcramauth2" class="startofrange">
48631 <primary>authenticators</primary>
48632 <secondary><command>cram_md5</command></secondary>
48633 </indexterm>
48634 <indexterm role="concept">
48635 <primary>CRAM-MD5 authentication mechanism</primary>
48636 </indexterm>
48637 <indexterm role="concept">
48638 <primary>authentication</primary>
48639 <secondary>CRAM-MD5 mechanism</secondary>
48640 </indexterm>
48641 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
48642 sends a challenge string to the client, and the response consists of a user
48643 name and the CRAM-MD5 digest of the challenge string combined with a secret
48644 string (password) which is known to both server and client. Thus, the secret
48645 is not sent over the network as plain text, which makes this authenticator more
48646 secure than <command>plaintext</command>. However, the downside is that the secret has to be
48647 available in plain text at either end.
48648 </para>
48649 <section id="SECID176">
48650 <title>Using cram_md5 as a server</title>
48651 <para>
48652 <indexterm role="concept">
48653 <primary>options</primary>
48654 <secondary><command>cram_md5</command> authenticator (server)</secondary>
48655 </indexterm>
48656 This authenticator has one server option, which must be set to configure the
48657 authenticator as a server:
48658 </para>
48659 <para>
48660 <indexterm role="option">
48661 <primary><option>server_secret</option></primary>
48662 </indexterm>
48663 </para>
48664 <informaltable frame="all">
48665 <tgroup cols="4" colsep="0" rowsep="0">
48666 <colspec colwidth="8*" align="left"/>
48667 <colspec colwidth="6*" align="center"/>
48668 <colspec colwidth="6*" align="center"/>
48669 <colspec colwidth="6*" align="right"/>
48670 <tbody>
48671 <row>
48672 <entry><option>server_secret</option></entry>
48673 <entry>Use: <emphasis>cram_md5</emphasis></entry>
48674 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
48675 <entry>Default: <emphasis>unset</emphasis></entry>
48676 </row>
48677 </tbody>
48678 </tgroup>
48679 </informaltable>
48680 <para>
48681 <indexterm role="concept">
48682 <primary>numerical variables (<varname>$1</varname> <varname>$2</varname> etc)</primary>
48683 <secondary>in <command>cram_md5</command> authenticator</secondary>
48684 </indexterm>
48685 When the server receives the client&#x2019;s response, the user name is placed in
48686 the expansion variable <varname>$auth1</varname>, and <option>server_secret</option> is expanded to
48687 obtain the password for that user. The server then computes the CRAM-MD5 digest
48688 that the client should have sent, and checks that it received the correct
48689 string. If the expansion of <option>server_secret</option> is forced to fail, authentication
48690 fails. If the expansion fails for some other reason, a temporary error code is
48691 returned to the client.
48692 </para>
48693 <para>
48694 For compatibility with previous releases of Exim, the user name is also placed
48695 in <varname>$1</varname>. However, the use of this variables for this purpose is now
48696 deprecated, as it can lead to confusion in string expansions that also use
48697 numeric variables for other things.
48698 </para>
48699 <para>
48700 For example, the following authenticator checks that the user name given by the
48701 client is <quote>ph10</quote>, and if so, uses <quote>secret</quote> as the password. For any other
48702 user name, authentication fails.
48703 </para>
48704 <literallayout class="monospaced">
48705 fixed_cram:
48706   driver = cram_md5
48707   public_name = CRAM-MD5
48708   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
48709   server_set_id = $auth1
48710 </literallayout>
48711 <para>
48712 <indexterm role="variable">
48713 <primary><varname>$authenticated_id</varname></primary>
48714 </indexterm>
48715 If authentication succeeds, the setting of <option>server_set_id</option> preserves the user
48716 name in <varname>$authenticated_id</varname>. A more typical configuration might look up the
48717 secret string in a file, using the user name as the key. For example:
48718 </para>
48719 <literallayout class="monospaced">
48720 lookup_cram:
48721   driver = cram_md5
48722   public_name = CRAM-MD5
48723   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
48724                   {$value}fail}
48725   server_set_id = $auth1
48726 </literallayout>
48727 <para>
48728 Note that this expansion explicitly forces failure if the lookup fails
48729 because <varname>$auth1</varname> contains an unknown user name.
48730 </para>
48731 <para>
48732 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
48733 using the relevant libraries, you need to know the realm to specify in the
48734 lookup and then ask for the <quote>userPassword</quote> attribute for that user in that
48735 realm, with:
48736 </para>
48737 <literallayout class="monospaced">
48738 cyrusless_crammd5:
48739   driver = cram_md5
48740   public_name = CRAM-MD5
48741   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
48742                   dbmjz{/etc/sasldb2}}
48743   server_set_id = $auth1
48744 </literallayout>
48745 </section>
48746 <section id="SECID177">
48747 <title>Using cram_md5 as a client</title>
48748 <para>
48749 <indexterm role="concept">
48750 <primary>options</primary>
48751 <secondary><command>cram_md5</command> authenticator (client)</secondary>
48752 </indexterm>
48753 When used as a client, the <command>cram_md5</command> authenticator has two options:
48754 </para>
48755 <para>
48756 <indexterm role="option">
48757 <primary><option>client_name</option></primary>
48758 </indexterm>
48759 </para>
48760 <informaltable frame="all">
48761 <tgroup cols="4" colsep="0" rowsep="0">
48762 <colspec colwidth="8*" align="left"/>
48763 <colspec colwidth="6*" align="center"/>
48764 <colspec colwidth="6*" align="center"/>
48765 <colspec colwidth="6*" align="right"/>
48766 <tbody>
48767 <row>
48768 <entry><option>client_name</option></entry>
48769 <entry>Use: <emphasis>cram_md5</emphasis></entry>
48770 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
48771 <entry>Default: <emphasis>the primary host name</emphasis></entry>
48772 </row>
48773 </tbody>
48774 </tgroup>
48775 </informaltable>
48776 <para>
48777 This string is expanded, and the result used as the user name data when
48778 computing the response to the server&#x2019;s challenge.
48779 </para>
48780 <para>
48781 <indexterm role="option">
48782 <primary><option>client_secret</option></primary>
48783 </indexterm>
48784 </para>
48785 <informaltable frame="all">
48786 <tgroup cols="4" colsep="0" rowsep="0">
48787 <colspec colwidth="8*" align="left"/>
48788 <colspec colwidth="6*" align="center"/>
48789 <colspec colwidth="6*" align="center"/>
48790 <colspec colwidth="6*" align="right"/>
48791 <tbody>
48792 <row>
48793 <entry><option>client_secret</option></entry>
48794 <entry>Use: <emphasis>cram_md5</emphasis></entry>
48795 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
48796 <entry>Default: <emphasis>unset</emphasis></entry>
48797 </row>
48798 </tbody>
48799 </tgroup>
48800 </informaltable>
48801 <para>
48802 This option must be set for the authenticator to work as a client. Its value is
48803 expanded and the result used as the secret string when computing the response.
48804 </para>
48805 <para>
48806 <indexterm role="variable">
48807 <primary><varname>$host</varname></primary>
48808 </indexterm>
48809 <indexterm role="variable">
48810 <primary><varname>$host_address</varname></primary>
48811 </indexterm>
48812 Different user names and secrets can be used for different servers by referring
48813 to <varname>$host</varname> or <varname>$host_address</varname> in the options. Forced failure of either
48814 expansion string is treated as an indication that this authenticator is not
48815 prepared to handle this case. Exim moves on to the next configured client
48816 authenticator. Any other expansion failure causes Exim to give up trying to
48817 send the message to the current server.
48818 </para>
48819 <para>
48820 A simple example configuration of a <command>cram_md5</command> authenticator, using fixed
48821 strings, is:
48822 </para>
48823 <literallayout class="monospaced">
48824 fixed_cram:
48825   driver = cram_md5
48826   public_name = CRAM-MD5
48827   client_name = ph10
48828   client_secret = secret
48829 </literallayout>
48830 <para>
48831 <indexterm role="concept" startref="IIDcramauth1" class="endofrange"/>
48832 <indexterm role="concept" startref="IIDcramauth2" class="endofrange"/>
48833 </para>
48834 </section>
48835 </chapter>
48836
48837 <chapter id="CHID10">
48838 <title>The cyrus_sasl authenticator</title>
48839 <para>
48840 <indexterm role="concept" id="IIDcyrauth1" class="startofrange">
48841 <primary><command>cyrus_sasl</command> authenticator</primary>
48842 </indexterm>
48843 <indexterm role="concept" id="IIDcyrauth2" class="startofrange">
48844 <primary>authenticators</primary>
48845 <secondary><command>cyrus_sasl</command></secondary>
48846 </indexterm>
48847 <indexterm role="concept">
48848 <primary>Cyrus</primary>
48849 <secondary>SASL library</secondary>
48850 </indexterm>
48851 <indexterm role="concept">
48852 <primary>Kerberos</primary>
48853 </indexterm>
48854 The code for this authenticator was provided by Matthew Byng-Maddick of A L
48855 Digital Ltd (<emphasis role="bold"><ulink url="http://www.aldigital.co.uk">http://www.aldigital.co.uk</ulink></emphasis>).
48856 </para>
48857 <para>
48858 The <command>cyrus_sasl</command> authenticator provides server support for the Cyrus SASL
48859 library implementation of the RFC 2222 (<quote>Simple Authentication and Security
48860 Layer</quote>). This library supports a number of authentication mechanisms,
48861 including PLAIN and LOGIN, but also several others that Exim does not support
48862 directly. In particular, there is support for Kerberos authentication.
48863 </para>
48864 <para>
48865 The <command>cyrus_sasl</command> authenticator provides a gatewaying mechanism directly to
48866 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
48867 then so can the <command>cyrus_sasl</command> authenticator. By default it uses the public
48868 name of the driver to determine which mechanism to support.
48869 </para>
48870 <para>
48871 Where access to some kind of secret file is required, for example in GSSAPI
48872 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
48873 user, and that the Cyrus SASL library has no way of escalating privileges
48874 by default. You may also find you need to set environment variables,
48875 depending on the driver you are using.
48876 </para>
48877 <para>
48878 The application name provided by Exim is <quote>exim</quote>, so various SASL options may
48879 be set in <filename>exim.conf</filename> in your SASL directory. If you are using GSSAPI for
48880 Kerberos, note that because of limitations in the GSSAPI interface,
48881 changing the server keytab might need to be communicated down to the Kerberos
48882 layer independently. The mechanism for doing so is dependent upon the Kerberos
48883 implementation.
48884 </para>
48885 <para>
48886 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
48887 may be set to point to an alternative keytab file. Exim will pass this
48888 variable through from its own inherited environment when started as root or the
48889 Exim user. The keytab file needs to be readable by the Exim user.
48890 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
48891 environment variable.  In practice, for those releases, the Cyrus authenticator
48892 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
48893 the <command>heimdal_gssapi</command> authenticator, described in chapter <xref linkend="CHAPheimdalgss"/>
48894 </para>
48895 <section id="SECID178">
48896 <title>Using cyrus_sasl as a server</title>
48897 <para>
48898 The <command>cyrus_sasl</command> authenticator has four private options. It puts the username
48899 (on a successful authentication) into <varname>$auth1</varname>. For compatibility with
48900 previous releases of Exim, the username is also placed in <varname>$1</varname>. However, the
48901 use of this variable for this purpose is now deprecated, as it can lead to
48902 confusion in string expansions that also use numeric variables for other
48903 things.
48904 </para>
48905 <para>
48906 <indexterm role="option">
48907 <primary><option>server_hostname</option></primary>
48908 </indexterm>
48909 </para>
48910 <informaltable frame="all">
48911 <tgroup cols="4" colsep="0" rowsep="0">
48912 <colspec colwidth="8*" align="left"/>
48913 <colspec colwidth="6*" align="center"/>
48914 <colspec colwidth="6*" align="center"/>
48915 <colspec colwidth="6*" align="right"/>
48916 <tbody>
48917 <row>
48918 <entry><option>server_hostname</option></entry>
48919 <entry>Use: <emphasis>cyrus_sasl</emphasis></entry>
48920 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
48921 <entry>Default: <emphasis>see below</emphasis></entry>
48922 </row>
48923 </tbody>
48924 </tgroup>
48925 </informaltable>
48926 <para>
48927 This option selects the hostname that is used when communicating with the
48928 library. The default value is <literal>$primary_hostname</literal>. It is up to the underlying
48929 SASL plug-in what it does with this data.
48930 </para>
48931 <para>
48932 <indexterm role="option">
48933 <primary><option>server_mech</option></primary>
48934 </indexterm>
48935 </para>
48936 <informaltable frame="all">
48937 <tgroup cols="4" colsep="0" rowsep="0">
48938 <colspec colwidth="8*" align="left"/>
48939 <colspec colwidth="6*" align="center"/>
48940 <colspec colwidth="6*" align="center"/>
48941 <colspec colwidth="6*" align="right"/>
48942 <tbody>
48943 <row>
48944 <entry><option>server_mech</option></entry>
48945 <entry>Use: <emphasis>cyrus_sasl</emphasis></entry>
48946 <entry>Type: <emphasis>string</emphasis></entry>
48947 <entry>Default: <emphasis>see below</emphasis></entry>
48948 </row>
48949 </tbody>
48950 </tgroup>
48951 </informaltable>
48952 <para>
48953 This option selects the authentication mechanism this driver should use. The
48954 default is the value of the generic <option>public_name</option> option. This option allows
48955 you to use a different underlying mechanism from the advertised name. For
48956 example:
48957 </para>
48958 <literallayout class="monospaced">
48959 sasl:
48960   driver = cyrus_sasl
48961   public_name = X-ANYTHING
48962   server_mech = CRAM-MD5
48963   server_set_id = $auth1
48964 </literallayout>
48965 <para>
48966 <indexterm role="option">
48967 <primary><option>server_realm</option></primary>
48968 </indexterm>
48969 </para>
48970 <informaltable frame="all">
48971 <tgroup cols="4" colsep="0" rowsep="0">
48972 <colspec colwidth="8*" align="left"/>
48973 <colspec colwidth="6*" align="center"/>
48974 <colspec colwidth="6*" align="center"/>
48975 <colspec colwidth="6*" align="right"/>
48976 <tbody>
48977 <row>
48978 <entry><option>server_realm</option></entry>
48979 <entry>Use: <emphasis>cyrus_sasl</emphasis></entry>
48980 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
48981 <entry>Default: <emphasis>unset</emphasis></entry>
48982 </row>
48983 </tbody>
48984 </tgroup>
48985 </informaltable>
48986 <para>
48987 This specifies the SASL realm that the server claims to be in.
48988 </para>
48989 <para>
48990 <indexterm role="option">
48991 <primary><option>server_service</option></primary>
48992 </indexterm>
48993 </para>
48994 <informaltable frame="all">
48995 <tgroup cols="4" colsep="0" rowsep="0">
48996 <colspec colwidth="8*" align="left"/>
48997 <colspec colwidth="6*" align="center"/>
48998 <colspec colwidth="6*" align="center"/>
48999 <colspec colwidth="6*" align="right"/>
49000 <tbody>
49001 <row>
49002 <entry><option>server_service</option></entry>
49003 <entry>Use: <emphasis>cyrus_sasl</emphasis></entry>
49004 <entry>Type: <emphasis>string</emphasis></entry>
49005 <entry>Default: <emphasis><literal>smtp</literal></emphasis></entry>
49006 </row>
49007 </tbody>
49008 </tgroup>
49009 </informaltable>
49010 <para>
49011 This is the SASL service that the server claims to implement.
49012 </para>
49013 <para>
49014 For straightforward cases, you do not need to set any of the authenticator&#x2019;s
49015 private options. All you need to do is to specify an appropriate mechanism as
49016 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
49017 PLAIN, you could have two authenticators as follows:
49018 </para>
49019 <literallayout class="monospaced">
49020 sasl_cram_md5:
49021   driver = cyrus_sasl
49022   public_name = CRAM-MD5
49023   server_set_id = $auth1
49024
49025 sasl_plain:
49026   driver = cyrus_sasl
49027   public_name = PLAIN
49028   server_set_id = $auth2
49029 </literallayout>
49030 <para>
49031 Cyrus SASL does implement the LOGIN authentication method, even though it is
49032 not a standard method. It is disabled by default in the source distribution,
49033 but it is present in many binary distributions.
49034 <indexterm role="concept" startref="IIDcyrauth1" class="endofrange"/>
49035 <indexterm role="concept" startref="IIDcyrauth2" class="endofrange"/>
49036 </para>
49037 </section>
49038 </chapter>
49039
49040 <chapter id="CHAPdovecot">
49041 <title>The dovecot authenticator</title>
49042 <para>
49043 <indexterm role="concept" id="IIDdcotauth1" class="startofrange">
49044 <primary><command>dovecot</command> authenticator</primary>
49045 </indexterm>
49046 <indexterm role="concept" id="IIDdcotauth2" class="startofrange">
49047 <primary>authenticators</primary>
49048 <secondary><command>dovecot</command></secondary>
49049 </indexterm>
49050 This authenticator is an interface to the authentication facility of the
49051 Dovecot POP/IMAP server, which can support a number of authentication methods.
49052 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
49053 to use the same mechanisms for SMTP authentication. This is a server
49054 authenticator only. There is only one option:
49055 </para>
49056 <para>
49057 <indexterm role="option">
49058 <primary><option>server_socket</option></primary>
49059 </indexterm>
49060 </para>
49061 <informaltable frame="all">
49062 <tgroup cols="4" colsep="0" rowsep="0">
49063 <colspec colwidth="8*" align="left"/>
49064 <colspec colwidth="6*" align="center"/>
49065 <colspec colwidth="6*" align="center"/>
49066 <colspec colwidth="6*" align="right"/>
49067 <tbody>
49068 <row>
49069 <entry><option>server_socket</option></entry>
49070 <entry>Use: <emphasis>dovecot</emphasis></entry>
49071 <entry>Type: <emphasis>string</emphasis></entry>
49072 <entry>Default: <emphasis>unset</emphasis></entry>
49073 </row>
49074 </tbody>
49075 </tgroup>
49076 </informaltable>
49077 <para>
49078 This option must specify the socket that is the interface to Dovecot
49079 authentication. The <option>public_name</option> option must specify an authentication
49080 mechanism that Dovecot is configured to support. You can have several
49081 authenticators for different mechanisms. For example:
49082 </para>
49083 <literallayout class="monospaced">
49084 dovecot_plain:
49085   driver = dovecot
49086   public_name = PLAIN
49087   server_socket = /var/run/dovecot/auth-client
49088   server_set_id = $auth1
49089
49090 dovecot_ntlm:
49091   driver = dovecot
49092   public_name = NTLM
49093   server_socket = /var/run/dovecot/auth-client
49094   server_set_id = $auth1
49095 </literallayout>
49096 <para>
49097 If the SMTP connection is encrypted, or if <varname>$sender_host_address</varname> is equal to
49098 <varname>$received_ip_address</varname> (that is, the connection is local), the <quote>secured</quote>
49099 option is passed in the Dovecot authentication command. If, for a TLS
49100 connection, a client certificate has been verified, the <quote>valid-client-cert</quote>
49101 option is passed. When authentication succeeds, the identity of the user
49102 who authenticated is placed in <varname>$auth1</varname>.
49103 <indexterm role="concept" startref="IIDdcotauth1" class="endofrange"/>
49104 <indexterm role="concept" startref="IIDdcotauth2" class="endofrange"/>
49105 </para>
49106 </chapter>
49107
49108 <chapter id="CHAPgsasl">
49109 <title>The gsasl authenticator</title>
49110 <para>
49111 <indexterm role="concept" id="IIDgsaslauth1" class="startofrange">
49112 <primary><command>gsasl</command> authenticator</primary>
49113 </indexterm>
49114 <indexterm role="concept" id="IIDgsaslauth2" class="startofrange">
49115 <primary>authenticators</primary>
49116 <secondary><command>gsasl</command></secondary>
49117 </indexterm>
49118 <indexterm role="concept">
49119 <primary>authentication</primary>
49120 <secondary>GNU SASL</secondary>
49121 </indexterm>
49122 <indexterm role="concept">
49123 <primary>authentication</primary>
49124 <secondary>SASL</secondary>
49125 </indexterm>
49126 <indexterm role="concept">
49127 <primary>authentication</primary>
49128 <secondary>EXTERNAL</secondary>
49129 </indexterm>
49130 <indexterm role="concept">
49131 <primary>authentication</primary>
49132 <secondary>ANONYMOUS</secondary>
49133 </indexterm>
49134 <indexterm role="concept">
49135 <primary>authentication</primary>
49136 <secondary>PLAIN</secondary>
49137 </indexterm>
49138 <indexterm role="concept">
49139 <primary>authentication</primary>
49140 <secondary>LOGIN</secondary>
49141 </indexterm>
49142 <indexterm role="concept">
49143 <primary>authentication</primary>
49144 <secondary>DIGEST-MD5</secondary>
49145 </indexterm>
49146 <indexterm role="concept">
49147 <primary>authentication</primary>
49148 <secondary>CRAM-MD5</secondary>
49149 </indexterm>
49150 <indexterm role="concept">
49151 <primary>authentication</primary>
49152 <secondary>SCRAM-SHA-1</secondary>
49153 </indexterm>
49154 The <command>gsasl</command> authenticator provides server integration for the GNU SASL
49155 library and the mechanisms it provides.  This is new as of the 4.80 release
49156 and there are a few areas where the library does not let Exim smoothly
49157 scale to handle future authentication mechanisms, so no guarantee can be
49158 made that any particular new authentication mechanism will be supported
49159 without code changes in Exim.
49160 </para>
49161 <para>
49162 <indexterm role="option">
49163 <primary><option>server_channelbinding</option></primary>
49164 </indexterm>
49165 </para>
49166 <informaltable frame="all">
49167 <tgroup cols="4" colsep="0" rowsep="0">
49168 <colspec colwidth="8*" align="left"/>
49169 <colspec colwidth="6*" align="center"/>
49170 <colspec colwidth="6*" align="center"/>
49171 <colspec colwidth="6*" align="right"/>
49172 <tbody>
49173 <row>
49174 <entry><option>server_channelbinding</option></entry>
49175 <entry>Use: <emphasis>gsasl</emphasis></entry>
49176 <entry>Type: <emphasis>boolean</emphasis></entry>
49177 <entry>Default: <emphasis>false</emphasis></entry>
49178 </row>
49179 </tbody>
49180 </tgroup>
49181 </informaltable>
49182 <para>
49183 Some authentication mechanisms are able to use external context at both ends
49184 of the session to bind the authentication to that context, and fail the
49185 authentication process if that context differs.  Specifically, some TLS
49186 ciphersuites can provide identifying information about the cryptographic
49187 context.
49188 </para>
49189 <para>
49190 This means that certificate identity and verification becomes a non-issue,
49191 as a man-in-the-middle attack will cause the correct client and server to
49192 see different identifiers and authentication will fail.
49193 </para>
49194 <para>
49195 This is currently only supported when using the GnuTLS library.  This is
49196 only usable by mechanisms which support "channel binding"; at time of
49197 writing, that&#x2019;s the SCRAM family.
49198 </para>
49199 <para>
49200 This defaults off to ensure smooth upgrade across Exim releases, in case
49201 this option causes some clients to start failing.  Some future release
49202 of Exim may switch the default to be true.
49203 </para>
49204 <para>
49205 <indexterm role="option">
49206 <primary><option>server_hostname</option></primary>
49207 </indexterm>
49208 </para>
49209 <informaltable frame="all">
49210 <tgroup cols="4" colsep="0" rowsep="0">
49211 <colspec colwidth="8*" align="left"/>
49212 <colspec colwidth="6*" align="center"/>
49213 <colspec colwidth="6*" align="center"/>
49214 <colspec colwidth="6*" align="right"/>
49215 <tbody>
49216 <row>
49217 <entry><option>server_hostname</option></entry>
49218 <entry>Use: <emphasis>gsasl</emphasis></entry>
49219 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
49220 <entry>Default: <emphasis>see below</emphasis></entry>
49221 </row>
49222 </tbody>
49223 </tgroup>
49224 </informaltable>
49225 <para>
49226 This option selects the hostname that is used when communicating with the
49227 library. The default value is <literal>$primary_hostname</literal>.
49228 Some mechanisms will use this data.
49229 </para>
49230 <para>
49231 <indexterm role="option">
49232 <primary><option>server_mech</option></primary>
49233 </indexterm>
49234 </para>
49235 <informaltable frame="all">
49236 <tgroup cols="4" colsep="0" rowsep="0">
49237 <colspec colwidth="8*" align="left"/>
49238 <colspec colwidth="6*" align="center"/>
49239 <colspec colwidth="6*" align="center"/>
49240 <colspec colwidth="6*" align="right"/>
49241 <tbody>
49242 <row>
49243 <entry><option>server_mech</option></entry>
49244 <entry>Use: <emphasis>gsasl</emphasis></entry>
49245 <entry>Type: <emphasis>string</emphasis></entry>
49246 <entry>Default: <emphasis>see below</emphasis></entry>
49247 </row>
49248 </tbody>
49249 </tgroup>
49250 </informaltable>
49251 <para>
49252 This option selects the authentication mechanism this driver should use. The
49253 default is the value of the generic <option>public_name</option> option. This option allows
49254 you to use a different underlying mechanism from the advertised name. For
49255 example:
49256 </para>
49257 <literallayout class="monospaced">
49258 sasl:
49259   driver = gsasl
49260   public_name = X-ANYTHING
49261   server_mech = CRAM-MD5
49262   server_set_id = $auth1
49263 </literallayout>
49264 <para>
49265 <indexterm role="option">
49266 <primary><option>server_password</option></primary>
49267 </indexterm>
49268 </para>
49269 <informaltable frame="all">
49270 <tgroup cols="4" colsep="0" rowsep="0">
49271 <colspec colwidth="8*" align="left"/>
49272 <colspec colwidth="6*" align="center"/>
49273 <colspec colwidth="6*" align="center"/>
49274 <colspec colwidth="6*" align="right"/>
49275 <tbody>
49276 <row>
49277 <entry><option>server_password</option></entry>
49278 <entry>Use: <emphasis>gsasl</emphasis></entry>
49279 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
49280 <entry>Default: <emphasis>unset</emphasis></entry>
49281 </row>
49282 </tbody>
49283 </tgroup>
49284 </informaltable>
49285 <para>
49286 Various mechanisms need access to the cleartext password on the server, so
49287 that proof-of-possession can be demonstrated on the wire, without sending
49288 the password itself.
49289 </para>
49290 <para>
49291 The data available for lookup varies per mechanism.
49292 In all cases, <varname>$auth1</varname> is set to the <emphasis>authentication id</emphasis>.
49293 The <varname>$auth2</varname> variable will always be the <emphasis>authorization id</emphasis> (<emphasis>authz</emphasis>)
49294 if available, else the empty string.
49295 The <varname>$auth3</varname> variable will always be the <emphasis>realm</emphasis> if available,
49296 else the empty string.
49297 </para>
49298 <para>
49299 A forced failure will cause authentication to defer.
49300 </para>
49301 <para>
49302 If using this option, it may make sense to set the <option>server_condition</option>
49303 option to be simply "true".
49304 </para>
49305 <para>
49306 <indexterm role="option">
49307 <primary><option>server_realm</option></primary>
49308 </indexterm>
49309 </para>
49310 <informaltable frame="all">
49311 <tgroup cols="4" colsep="0" rowsep="0">
49312 <colspec colwidth="8*" align="left"/>
49313 <colspec colwidth="6*" align="center"/>
49314 <colspec colwidth="6*" align="center"/>
49315 <colspec colwidth="6*" align="right"/>
49316 <tbody>
49317 <row>
49318 <entry><option>server_realm</option></entry>
49319 <entry>Use: <emphasis>gsasl</emphasis></entry>
49320 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
49321 <entry>Default: <emphasis>unset</emphasis></entry>
49322 </row>
49323 </tbody>
49324 </tgroup>
49325 </informaltable>
49326 <para>
49327 This specifies the SASL realm that the server claims to be in.
49328 Some mechanisms will use this data.
49329 </para>
49330 <para>
49331 <indexterm role="option">
49332 <primary><option>server_scram_iter</option></primary>
49333 </indexterm>
49334 </para>
49335 <informaltable frame="all">
49336 <tgroup cols="4" colsep="0" rowsep="0">
49337 <colspec colwidth="8*" align="left"/>
49338 <colspec colwidth="6*" align="center"/>
49339 <colspec colwidth="6*" align="center"/>
49340 <colspec colwidth="6*" align="right"/>
49341 <tbody>
49342 <row>
49343 <entry><option>server_scram_iter</option></entry>
49344 <entry>Use: <emphasis>gsasl</emphasis></entry>
49345 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
49346 <entry>Default: <emphasis>unset</emphasis></entry>
49347 </row>
49348 </tbody>
49349 </tgroup>
49350 </informaltable>
49351 <para>
49352 This option provides data for the SCRAM family of mechanisms.
49353 <varname>$auth1</varname> is not available at evaluation time.
49354 (This may change, as we receive feedback on use)
49355 </para>
49356 <para>
49357 <indexterm role="option">
49358 <primary><option>server_scram_salt</option></primary>
49359 </indexterm>
49360 </para>
49361 <informaltable frame="all">
49362 <tgroup cols="4" colsep="0" rowsep="0">
49363 <colspec colwidth="8*" align="left"/>
49364 <colspec colwidth="6*" align="center"/>
49365 <colspec colwidth="6*" align="center"/>
49366 <colspec colwidth="6*" align="right"/>
49367 <tbody>
49368 <row>
49369 <entry><option>server_scram_salt</option></entry>
49370 <entry>Use: <emphasis>gsasl</emphasis></entry>
49371 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
49372 <entry>Default: <emphasis>unset</emphasis></entry>
49373 </row>
49374 </tbody>
49375 </tgroup>
49376 </informaltable>
49377 <para>
49378 This option provides data for the SCRAM family of mechanisms.
49379 <varname>$auth1</varname> is not available at evaluation time.
49380 (This may change, as we receive feedback on use)
49381 </para>
49382 <para>
49383 <indexterm role="option">
49384 <primary><option>server_service</option></primary>
49385 </indexterm>
49386 </para>
49387 <informaltable frame="all">
49388 <tgroup cols="4" colsep="0" rowsep="0">
49389 <colspec colwidth="8*" align="left"/>
49390 <colspec colwidth="6*" align="center"/>
49391 <colspec colwidth="6*" align="center"/>
49392 <colspec colwidth="6*" align="right"/>
49393 <tbody>
49394 <row>
49395 <entry><option>server_service</option></entry>
49396 <entry>Use: <emphasis>gsasl</emphasis></entry>
49397 <entry>Type: <emphasis>string</emphasis></entry>
49398 <entry>Default: <emphasis><literal>smtp</literal></emphasis></entry>
49399 </row>
49400 </tbody>
49401 </tgroup>
49402 </informaltable>
49403 <para>
49404 This is the SASL service that the server claims to implement.
49405 Some mechanisms will use this data.
49406 </para>
49407 <section id="SECTgsaslauthvar">
49408 <title><command>gsasl</command> auth variables</title>
49409 <para>
49410 <indexterm role="variable">
49411 <primary><varname>$auth1</varname>, <varname>$auth2</varname>, etc</primary>
49412 </indexterm>
49413 These may be set when evaluating specific options, as detailed above.
49414 They will also be set when evaluating <option>server_condition</option>.
49415 </para>
49416 <para>
49417 Unless otherwise stated below, the <command>gsasl</command> integration will use the following
49418 meanings for these variables:
49419 </para>
49420 <itemizedlist>
49421 <listitem>
49422 <para>
49423 <indexterm role="variable">
49424 <primary><varname>$auth1</varname></primary>
49425 </indexterm>
49426 <varname>$auth1</varname>: the <emphasis>authentication id</emphasis>
49427 </para>
49428 </listitem>
49429 <listitem>
49430 <para>
49431 <indexterm role="variable">
49432 <primary><varname>$auth2</varname></primary>
49433 </indexterm>
49434 <varname>$auth2</varname>: the <emphasis>authorization id</emphasis>
49435 </para>
49436 </listitem>
49437 <listitem>
49438 <para>
49439 <indexterm role="variable">
49440 <primary><varname>$auth3</varname></primary>
49441 </indexterm>
49442 <varname>$auth3</varname>: the <emphasis>realm</emphasis>
49443 </para>
49444 </listitem>
49445 </itemizedlist>
49446 <para>
49447 On a per-mechanism basis:
49448 </para>
49449 <itemizedlist>
49450 <listitem>
49451 <para>
49452 <indexterm role="concept">
49453 <primary>authentication</primary>
49454 <secondary>EXTERNAL</secondary>
49455 </indexterm>
49456 EXTERNAL: only <varname>$auth1</varname> is set, to the possibly empty <emphasis>authorization id</emphasis>;
49457 the <option>server_condition</option> option must be present.
49458 </para>
49459 </listitem>
49460 <listitem>
49461 <para>
49462 <indexterm role="concept">
49463 <primary>authentication</primary>
49464 <secondary>ANONYMOUS</secondary>
49465 </indexterm>
49466 ANONYMOUS: only <varname>$auth1</varname> is set, to the possibly empty <emphasis>anonymous token</emphasis>;
49467 the <option>server_condition</option> option must be present.
49468 </para>
49469 </listitem>
49470 <listitem>
49471 <para>
49472 <indexterm role="concept">
49473 <primary>authentication</primary>
49474 <secondary>GSSAPI</secondary>
49475 </indexterm>
49476 GSSAPI: <varname>$auth1</varname> will be set to the <emphasis>GSSAPI Display Name</emphasis>;
49477 <varname>$auth2</varname> will be set to the <emphasis>authorization id</emphasis>,
49478 the <option>server_condition</option> option must be present.
49479 </para>
49480 </listitem>
49481 </itemizedlist>
49482 <para>
49483 An <emphasis>anonymous token</emphasis> is something passed along as an unauthenticated
49484 identifier; this is analogous to FTP anonymous authentication passing an
49485 email address, or software-identifier@, as the "password".
49486 </para>
49487 <para>
49488 An example showing the password having the realm specified in the callback
49489 and demonstrating a Cyrus SASL to GSASL migration approach is:
49490 </para>
49491 <literallayout class="monospaced">
49492 gsasl_cyrusless_crammd5:
49493   driver = gsasl
49494   public_name = CRAM-MD5
49495   server_realm = imap.example.org
49496   server_password = ${lookup{$auth1:$auth3:userPassword}\
49497                     dbmjz{/etc/sasldb2}{$value}fail}
49498   server_set_id = ${quote:$auth1}
49499   server_condition = yes
49500 </literallayout>
49501 </section>
49502 </chapter>
49503
49504 <chapter id="CHAPheimdalgss">
49505 <title>The heimdal_gssapi authenticator</title>
49506 <para>
49507 <indexterm role="concept" id="IIDheimdalgssauth1" class="startofrange">
49508 <primary><command>heimdal_gssapi</command> authenticator</primary>
49509 </indexterm>
49510 <indexterm role="concept" id="IIDheimdalgssauth2" class="startofrange">
49511 <primary>authenticators</primary>
49512 <secondary><command>heimdal_gssapi</command></secondary>
49513 </indexterm>
49514 <indexterm role="concept">
49515 <primary>authentication</primary>
49516 <secondary>GSSAPI</secondary>
49517 </indexterm>
49518 <indexterm role="concept">
49519 <primary>authentication</primary>
49520 <secondary>Kerberos</secondary>
49521 </indexterm>
49522 The <command>heimdal_gssapi</command> authenticator provides server integration for the
49523 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
49524 reliably.
49525 </para>
49526 <para>
49527 <indexterm role="option">
49528 <primary><option>server_hostname</option></primary>
49529 </indexterm>
49530 </para>
49531 <informaltable frame="all">
49532 <tgroup cols="4" colsep="0" rowsep="0">
49533 <colspec colwidth="8*" align="left"/>
49534 <colspec colwidth="6*" align="center"/>
49535 <colspec colwidth="6*" align="center"/>
49536 <colspec colwidth="6*" align="right"/>
49537 <tbody>
49538 <row>
49539 <entry><option>server_hostname</option></entry>
49540 <entry>Use: <emphasis>heimdal_gssapi</emphasis></entry>
49541 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
49542 <entry>Default: <emphasis>see below</emphasis></entry>
49543 </row>
49544 </tbody>
49545 </tgroup>
49546 </informaltable>
49547 <para>
49548 This option selects the hostname that is used, with <option>server_service</option>,
49549 for constructing the GSS server name, as a <emphasis>GSS_C_NT_HOSTBASED_SERVICE</emphasis>
49550 identifier.  The default value is <literal>$primary_hostname</literal>.
49551 </para>
49552 <para>
49553 <indexterm role="option">
49554 <primary><option>server_keytab</option></primary>
49555 </indexterm>
49556 </para>
49557 <informaltable frame="all">
49558 <tgroup cols="4" colsep="0" rowsep="0">
49559 <colspec colwidth="8*" align="left"/>
49560 <colspec colwidth="6*" align="center"/>
49561 <colspec colwidth="6*" align="center"/>
49562 <colspec colwidth="6*" align="right"/>
49563 <tbody>
49564 <row>
49565 <entry><option>server_keytab</option></entry>
49566 <entry>Use: <emphasis>heimdal_gssapi</emphasis></entry>
49567 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
49568 <entry>Default: <emphasis>unset</emphasis></entry>
49569 </row>
49570 </tbody>
49571 </tgroup>
49572 </informaltable>
49573 <para>
49574 If set, then Heimdal will not use the system default keytab (typically
49575 <filename>/etc/krb5.keytab</filename>) but instead the pathname given in this option.
49576 The value should be a pathname, with no <quote>file:</quote> prefix.
49577 </para>
49578 <para>
49579 <indexterm role="option">
49580 <primary><option>server_service</option></primary>
49581 </indexterm>
49582 </para>
49583 <informaltable frame="all">
49584 <tgroup cols="4" colsep="0" rowsep="0">
49585 <colspec colwidth="8*" align="left"/>
49586 <colspec colwidth="6*" align="center"/>
49587 <colspec colwidth="6*" align="center"/>
49588 <colspec colwidth="6*" align="right"/>
49589 <tbody>
49590 <row>
49591 <entry><option>server_service</option></entry>
49592 <entry>Use: <emphasis>heimdal_gssapi</emphasis></entry>
49593 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
49594 <entry>Default: <emphasis>smtp</emphasis></entry>
49595 </row>
49596 </tbody>
49597 </tgroup>
49598 </informaltable>
49599 <para>
49600 This option specifies the service identifier used, in conjunction with
49601 <option>server_hostname</option>, for building the identifer for finding credentials
49602 from the keytab.
49603 </para>
49604 <section id="SECTheimdalgssauthvar">
49605 <title><command>heimdal_gssapi</command> auth variables</title>
49606 <para>
49607 Beware that these variables will typically include a realm, thus will appear
49608 to be roughly like an email address already.  The <emphasis>authzid</emphasis> in <varname>$auth2</varname> is
49609 not verified, so a malicious client can set it to anything.
49610 </para>
49611 <para>
49612 The <varname>$auth1</varname> field should be safely trustable as a value from the Key
49613 Distribution Center.  Note that these are not quite email addresses.
49614 Each identifier is for a role, and so the left-hand-side may include a
49615 role suffix.  For instance, <quote>joe/admin@EXAMPLE.ORG</quote>.
49616 </para>
49617 <para>
49618 <indexterm role="variable">
49619 <primary><varname>$auth1</varname>, <varname>$auth2</varname>, etc</primary>
49620 </indexterm>
49621 </para>
49622 <itemizedlist>
49623 <listitem>
49624 <para>
49625 <indexterm role="variable">
49626 <primary><varname>$auth1</varname></primary>
49627 </indexterm>
49628 <varname>$auth1</varname>: the <emphasis>authentication id</emphasis>, set to the GSS Display Name.
49629 </para>
49630 </listitem>
49631 <listitem>
49632 <para>
49633 <indexterm role="variable">
49634 <primary><varname>$auth2</varname></primary>
49635 </indexterm>
49636 <varname>$auth2</varname>: the <emphasis>authorization id</emphasis>, sent within SASL encapsulation after
49637 authentication.  If that was empty, this will also be set to the
49638 GSS Display Name.
49639 </para>
49640 </listitem>
49641 </itemizedlist>
49642 </section>
49643 </chapter>
49644
49645 <chapter id="CHAPspa">
49646 <title>The spa authenticator</title>
49647 <para>
49648 <indexterm role="concept" id="IIDspaauth1" class="startofrange">
49649 <primary><command>spa</command> authenticator</primary>
49650 </indexterm>
49651 <indexterm role="concept" id="IIDspaauth2" class="startofrange">
49652 <primary>authenticators</primary>
49653 <secondary><command>spa</command></secondary>
49654 </indexterm>
49655 <indexterm role="concept">
49656 <primary>authentication</primary>
49657 <secondary>Microsoft Secure Password</secondary>
49658 </indexterm>
49659 <indexterm role="concept">
49660 <primary>authentication</primary>
49661 <secondary>NTLM</secondary>
49662 </indexterm>
49663 <indexterm role="concept">
49664 <primary>Microsoft Secure Password Authentication</primary>
49665 </indexterm>
49666 <indexterm role="concept">
49667 <primary>NTLM authentication</primary>
49668 </indexterm>
49669 The <command>spa</command> authenticator provides client support for Microsoft&#x2019;s <emphasis>Secure
49670 Password Authentication</emphasis> mechanism,
49671 which is also sometimes known as NTLM (NT LanMan). The code for client side of
49672 this authenticator was contributed by Marc Prud&#x2019;hommeaux, and much of it is
49673 taken from the Samba project (<emphasis role="bold"><ulink url="http://www.samba.org">http://www.samba.org</ulink></emphasis>). The code for the
49674 server side was subsequently contributed by Tom Kistner. The mechanism works as
49675 follows:
49676 </para>
49677 <itemizedlist>
49678 <listitem>
49679 <para>
49680 After the AUTH command has been accepted, the client sends an SPA
49681 authentication request based on the user name and optional domain.
49682 </para>
49683 </listitem>
49684 <listitem>
49685 <para>
49686 The server sends back a challenge.
49687 </para>
49688 </listitem>
49689 <listitem>
49690 <para>
49691 The client builds a challenge response which makes use of the user&#x2019;s password
49692 and sends it to the server, which then accepts or rejects it.
49693 </para>
49694 </listitem>
49695 </itemizedlist>
49696 <para>
49697 Encryption is used to protect the password in transit.
49698 </para>
49699 <section id="SECID179">
49700 <title>Using spa as a server</title>
49701 <para>
49702 <indexterm role="concept">
49703 <primary>options</primary>
49704 <secondary><command>spa</command> authenticator (server)</secondary>
49705 </indexterm>
49706 The <command>spa</command> authenticator has just one server option:
49707 </para>
49708 <para>
49709 <indexterm role="option">
49710 <primary><option>server_password</option></primary>
49711 </indexterm>
49712 </para>
49713 <informaltable frame="all">
49714 <tgroup cols="4" colsep="0" rowsep="0">
49715 <colspec colwidth="8*" align="left"/>
49716 <colspec colwidth="6*" align="center"/>
49717 <colspec colwidth="6*" align="center"/>
49718 <colspec colwidth="6*" align="right"/>
49719 <tbody>
49720 <row>
49721 <entry><option>server_password</option></entry>
49722 <entry>Use: <emphasis>spa</emphasis></entry>
49723 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
49724 <entry>Default: <emphasis>unset</emphasis></entry>
49725 </row>
49726 </tbody>
49727 </tgroup>
49728 </informaltable>
49729 <para>
49730 <indexterm role="concept">
49731 <primary>numerical variables (<varname>$1</varname> <varname>$2</varname> etc)</primary>
49732 <secondary>in <command>spa</command> authenticator</secondary>
49733 </indexterm>
49734 This option is expanded, and the result must be the cleartext password for the
49735 authenticating user, whose name is at this point in <varname>$auth1</varname>. For
49736 compatibility with previous releases of Exim, the user name is also placed in
49737 <varname>$1</varname>. However, the use of this variable for this purpose is now deprecated, as
49738 it can lead to confusion in string expansions that also use numeric variables
49739 for other things. For example:
49740 </para>
49741 <literallayout class="monospaced">
49742 spa:
49743   driver = spa
49744   public_name = NTLM
49745   server_password = \
49746     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
49747 </literallayout>
49748 <para>
49749 If the expansion is forced to fail, authentication fails. Any other expansion
49750 failure causes a temporary error code to be returned.
49751 </para>
49752 </section>
49753 <section id="SECID180">
49754 <title>Using spa as a client</title>
49755 <para>
49756 <indexterm role="concept">
49757 <primary>options</primary>
49758 <secondary><command>spa</command> authenticator (client)</secondary>
49759 </indexterm>
49760 The <command>spa</command> authenticator has the following client options:
49761 </para>
49762 <para>
49763 <indexterm role="option">
49764 <primary><option>client_domain</option></primary>
49765 </indexterm>
49766 </para>
49767 <informaltable frame="all">
49768 <tgroup cols="4" colsep="0" rowsep="0">
49769 <colspec colwidth="8*" align="left"/>
49770 <colspec colwidth="6*" align="center"/>
49771 <colspec colwidth="6*" align="center"/>
49772 <colspec colwidth="6*" align="right"/>
49773 <tbody>
49774 <row>
49775 <entry><option>client_domain</option></entry>
49776 <entry>Use: <emphasis>spa</emphasis></entry>
49777 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
49778 <entry>Default: <emphasis>unset</emphasis></entry>
49779 </row>
49780 </tbody>
49781 </tgroup>
49782 </informaltable>
49783 <para>
49784 This option specifies an optional domain for the authentication.
49785 </para>
49786 <para>
49787 <indexterm role="option">
49788 <primary><option>client_password</option></primary>
49789 </indexterm>
49790 </para>
49791 <informaltable frame="all">
49792 <tgroup cols="4" colsep="0" rowsep="0">
49793 <colspec colwidth="8*" align="left"/>
49794 <colspec colwidth="6*" align="center"/>
49795 <colspec colwidth="6*" align="center"/>
49796 <colspec colwidth="6*" align="right"/>
49797 <tbody>
49798 <row>
49799 <entry><option>client_password</option></entry>
49800 <entry>Use: <emphasis>spa</emphasis></entry>
49801 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
49802 <entry>Default: <emphasis>unset</emphasis></entry>
49803 </row>
49804 </tbody>
49805 </tgroup>
49806 </informaltable>
49807 <para>
49808 This option specifies the user&#x2019;s password, and must be set.
49809 </para>
49810 <para>
49811 <indexterm role="option">
49812 <primary><option>client_username</option></primary>
49813 </indexterm>
49814 </para>
49815 <informaltable frame="all">
49816 <tgroup cols="4" colsep="0" rowsep="0">
49817 <colspec colwidth="8*" align="left"/>
49818 <colspec colwidth="6*" align="center"/>
49819 <colspec colwidth="6*" align="center"/>
49820 <colspec colwidth="6*" align="right"/>
49821 <tbody>
49822 <row>
49823 <entry><option>client_username</option></entry>
49824 <entry>Use: <emphasis>spa</emphasis></entry>
49825 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
49826 <entry>Default: <emphasis>unset</emphasis></entry>
49827 </row>
49828 </tbody>
49829 </tgroup>
49830 </informaltable>
49831 <para>
49832 This option specifies the user name, and must be set. Here is an example of a
49833 configuration of this authenticator for use with the mail servers at
49834 <emphasis>msn.com</emphasis>:
49835 </para>
49836 <literallayout class="monospaced">
49837 msn:
49838   driver = spa
49839   public_name = MSN
49840   client_username = msn/msn_username
49841   client_password = msn_plaintext_password
49842   client_domain = DOMAIN_OR_UNSET
49843 </literallayout>
49844 <para>
49845 <indexterm role="concept" startref="IIDspaauth1" class="endofrange"/>
49846 <indexterm role="concept" startref="IIDspaauth2" class="endofrange"/>
49847 </para>
49848 </section>
49849 </chapter>
49850
49851 <chapter id="CHAPTLS">
49852 <title>Encrypted SMTP connections using TLS/SSL</title>
49853 <titleabbrev>Encrypted SMTP connections</titleabbrev>
49854 <para>
49855 <indexterm role="concept" id="IIDencsmtp1" class="startofrange">
49856 <primary>encryption</primary>
49857 <secondary>on SMTP connection</secondary>
49858 </indexterm>
49859 <indexterm role="concept" id="IIDencsmtp2" class="startofrange">
49860 <primary>SMTP</primary>
49861 <secondary>encryption</secondary>
49862 </indexterm>
49863 <indexterm role="concept">
49864 <primary>TLS</primary>
49865 <secondary>on SMTP connection</secondary>
49866 </indexterm>
49867 <indexterm role="concept">
49868 <primary>OpenSSL</primary>
49869 </indexterm>
49870 <indexterm role="concept">
49871 <primary>GnuTLS</primary>
49872 </indexterm>
49873 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
49874 Sockets Layer), is implemented by making use of the OpenSSL library or the
49875 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
49876 cryptographic code in the Exim distribution itself for implementing TLS. In
49877 order to use this feature you must install OpenSSL or GnuTLS, and then build a
49878 version of Exim that includes TLS support (see section <xref linkend="SECTinctlsssl"/>).
49879 You also need to understand the basic concepts of encryption at a managerial
49880 level, and in particular, the way that public keys, private keys, and
49881 certificates are used.
49882 </para>
49883 <para>
49884 RFC 3207 defines how SMTP connections can make use of encryption. Once a
49885 connection is established, the client issues a STARTTLS command. If the
49886 server accepts this, the client and the server negotiate an encryption
49887 mechanism. If the negotiation succeeds, the data that subsequently passes
49888 between them is encrypted.
49889 </para>
49890 <para>
49891 Exim&#x2019;s ACLs can detect whether the current SMTP session is encrypted or not,
49892 and if so, what cipher suite is in use, whether the client supplied a
49893 certificate, and whether or not that certificate was verified. This makes it
49894 possible for an Exim server to deny or accept certain commands based on the
49895 encryption state.
49896 </para>
49897 <para>
49898 <emphasis role="bold">Warning</emphasis>: Certain types of firewall and certain anti-virus products can
49899 disrupt TLS connections. You need to turn off SMTP scanning for these products
49900 in order to get TLS to work.
49901 </para>
49902 <section id="SECID284">
49903 <title>Support for the legacy <quote>ssmtp</quote> (aka <quote>smtps</quote>) protocol</title>
49904 <para>
49905 <indexterm role="concept">
49906 <primary>ssmtp protocol</primary>
49907 </indexterm>
49908 <indexterm role="concept">
49909 <primary>smtps protocol</primary>
49910 </indexterm>
49911 <indexterm role="concept">
49912 <primary>SMTP</primary>
49913 <secondary>ssmtp protocol</secondary>
49914 </indexterm>
49915 <indexterm role="concept">
49916 <primary>SMTP</primary>
49917 <secondary>smtps protocol</secondary>
49918 </indexterm>
49919 Early implementations of encrypted SMTP used a different TCP port from normal
49920 SMTP, and expected an encryption negotiation to start immediately, instead of
49921 waiting for a STARTTLS command from the client using the standard SMTP
49922 port. The protocol was called <quote>ssmtp</quote> or <quote>smtps</quote>, and port 465 was
49923 allocated for this purpose.
49924 </para>
49925 <para>
49926 This approach was abandoned when encrypted SMTP was standardized, but there are
49927 still some legacy clients that use it. Exim supports these clients by means of
49928 the <option>tls_on_connect_ports</option> global option. Its value must be a list of port
49929 numbers; the most common use is expected to be:
49930 </para>
49931 <literallayout class="monospaced">
49932 tls_on_connect_ports = 465
49933 </literallayout>
49934 <para>
49935 The port numbers specified by this option apply to all SMTP connections, both
49936 via the daemon and via <emphasis>inetd</emphasis>. You still need to specify all the ports that
49937 the daemon uses (by setting <option>daemon_smtp_ports</option> or <option>local_interfaces</option> or
49938 the <option>-oX</option> command line option) because <option>tls_on_connect_ports</option> does not add
49939 an extra port &ndash; rather, it specifies different behaviour on a port that is
49940 defined elsewhere.
49941 </para>
49942 <para>
49943 There is also a <option>-tls-on-connect</option> command line option. This overrides
49944 <option>tls_on_connect_ports</option>; it forces the legacy behaviour for all ports.
49945 </para>
49946 </section>
49947 <section id="SECTopenvsgnu">
49948 <title>OpenSSL vs GnuTLS</title>
49949 <para>
49950 <indexterm role="concept">
49951 <primary>TLS</primary>
49952 <secondary>OpenSSL <emphasis>vs</emphasis> GnuTLS</secondary>
49953 </indexterm>
49954 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
49955 followed later, when the first versions of GnuTLS were released. To build Exim
49956 to use GnuTLS, you need to set
49957 </para>
49958 <literallayout class="monospaced">
49959 USE_GNUTLS=yes
49960 </literallayout>
49961 <para>
49962 in Local/Makefile, in addition to
49963 </para>
49964 <literallayout class="monospaced">
49965 SUPPORT_TLS=yes
49966 </literallayout>
49967 <para>
49968 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
49969 include files and libraries for GnuTLS can be found.
49970 </para>
49971 <para>
49972 There are some differences in usage when using GnuTLS instead of OpenSSL:
49973 </para>
49974 <itemizedlist>
49975 <listitem>
49976 <para>
49977 The <option>tls_verify_certificates</option> option must contain the name of a file, not the
49978 name of a directory (for OpenSSL it can be either).
49979 </para>
49980 </listitem>
49981 <listitem>
49982 <para>
49983 The default value for <option>tls_dhparam</option> differs for historical reasons.
49984 </para>
49985 </listitem>
49986 <listitem>
49987 <para>
49988 <indexterm role="variable">
49989 <primary><varname>$tls_in_peerdn</varname></primary>
49990 </indexterm>
49991 <indexterm role="variable">
49992 <primary><varname>$tls_out_peerdn</varname></primary>
49993 </indexterm>
49994 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
49995 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
49996 affects the value of the <varname>$tls_in_peerdn</varname> and <varname>$tls_out_peerdn</varname> variables.
49997 </para>
49998 </listitem>
49999 <listitem>
50000 <para>
50001 OpenSSL identifies cipher suites using hyphens as separators, for example:
50002 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
50003 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
50004 in a cipher list. To make life simpler, Exim changes underscores to hyphens
50005 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
50006 to handle its own older variants) when processing lists of cipher suites in the
50007 <option>tls_require_ciphers</option> options (the global option and the <command>smtp</command> transport
50008 option).
50009 </para>
50010 </listitem>
50011 <listitem>
50012 <para>
50013 The <option>tls_require_ciphers</option> options operate differently, as described in the
50014 sections <xref linkend="SECTreqciphssl"/> and <xref linkend="SECTreqciphgnu"/>.
50015 </para>
50016 </listitem>
50017 <listitem>
50018 <para>
50019 The <option>tls_dh_min_bits</option> SMTP transport option is only honoured by GnuTLS.
50020 When using OpenSSL, this option is ignored.
50021 (If an API is found to let OpenSSL be configured in this way,
50022 let the Exim Maintainers know and we&#x2019;ll likely use it).
50023 </para>
50024 </listitem>
50025 <listitem>
50026 <para>
50027 Some other recently added features may only be available in one or the other.
50028 This should be documented with the feature.  If the documentation does not
50029 explicitly state that the feature is infeasible in the other TLS
50030 implementation, then patches are welcome.
50031 </para>
50032 </listitem>
50033 </itemizedlist>
50034 </section>
50035 <section id="SECTgnutlsparam">
50036 <title>GnuTLS parameter computation</title>
50037 <para>
50038 This section only applies if <option>tls_dhparam</option> is set to <literal>historic</literal> or to
50039 an explicit path; if the latter, then the text about generation still applies,
50040 but not the chosen filename.
50041 By default, as of Exim 4.80 a hard-coded D-H prime is used.
50042 See the documentation of <option>tls_dhparam</option> for more information.
50043 </para>
50044 <para>
50045 GnuTLS uses D-H parameters that may take a substantial amount of time
50046 to compute. It is unreasonable to re-compute them for every TLS session.
50047 Therefore, Exim keeps this data in a file in its spool directory, called
50048 <filename>gnutls-params-NNNN</filename> for some value of NNNN, corresponding to the number
50049 of bits requested.
50050 The file is owned by the Exim user and is readable only by
50051 its owner. Every Exim process that start up GnuTLS reads the D-H
50052 parameters from this file. If the file does not exist, the first Exim process
50053 that needs it computes the data and writes it to a temporary file which is
50054 renamed once it is complete. It does not matter if several Exim processes do
50055 this simultaneously (apart from wasting a few resources). Once a file is in
50056 place, new Exim processes immediately start using it.
50057 </para>
50058 <para>
50059 For maximum security, the parameters that are stored in this file should be
50060 recalculated periodically, the frequency depending on your paranoia level.
50061 If you are avoiding using the fixed D-H primes published in RFCs, then you
50062 are concerned about some advanced attacks and will wish to do this; if you do
50063 not regenerate then you might as well stick to the standard primes.
50064 </para>
50065 <para>
50066 Arranging this is easy in principle; just delete the file when you want new
50067 values to be computed. However, there may be a problem. The calculation of new
50068 parameters needs random numbers, and these are obtained from <filename>/dev/random</filename>.
50069 If the system is not very active, <filename>/dev/random</filename> may delay returning data
50070 until enough randomness (entropy) is available. This may cause Exim to hang for
50071 a substantial amount of time, causing timeouts on incoming connections.
50072 </para>
50073 <para>
50074 The solution is to generate the parameters externally to Exim. They are stored
50075 in <filename>gnutls-params-N</filename> in PEM format, which means that they can be
50076 generated externally using the <command>certtool</command> command that is part of GnuTLS.
50077 </para>
50078 <para>
50079 To replace the parameters with new ones, instead of deleting the file
50080 and letting Exim re-create it, you can generate new parameters using
50081 <command>certtool</command> and, when this has been done, replace Exim&#x2019;s cache file by
50082 renaming. The relevant commands are something like this:
50083 </para>
50084 <literallayout class="monospaced">
50085 # ls
50086 [ look for file; assume gnutls-params-2236 is the most recent ]
50087 # rm -f new-params
50088 # touch new-params
50089 # chown exim:exim new-params
50090 # chmod 0600 new-params
50091 # certtool --generate-dh-params --bits 2236 &gt;&gt;new-params
50092 # openssl dhparam -noout -text -in new-params | head
50093 [ check the first line, make sure it's not more than 2236;
50094   if it is, then go back to the start ("rm") and repeat
50095   until the size generated is at most the size requested ]
50096 # chmod 0400 new-params
50097 # mv new-params gnutls-params-2236
50098 </literallayout>
50099 <para>
50100 If Exim never has to generate the parameters itself, the possibility of
50101 stalling is removed.
50102 </para>
50103 <para>
50104 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
50105 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
50106 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
50107 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
50108 and Exim does so.  This attempt to remove Exim from TLS policy decisions
50109 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
50110 of the NSS library.  Thus Exim gains the <option>tls_dh_max_bits</option> global option,
50111 which applies to all D-H usage, client or server.  If the value returned by
50112 GnuTLS is greater than <option>tls_dh_max_bits</option> then the value will be clamped down
50113 to <option>tls_dh_max_bits</option>.  The default value has been set at the current NSS
50114 limit, which is still much higher than Exim historically used.
50115 </para>
50116 <para>
50117 The filename and bits used will change as the GnuTLS maintainers change the
50118 value for their parameter <literal>GNUTLS_SEC_PARAM_NORMAL</literal>, as clamped by
50119 <option>tls_dh_max_bits</option>.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
50120 2432 bits, while NSS is limited to 2236 bits.
50121 </para>
50122 <para>
50123 In fact, the requested value will be *lower* than <option>tls_dh_max_bits</option>, to
50124 increase the chance of the generated prime actually being within acceptable
50125 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
50126 procedure above.  There is no sane procedure available to Exim to double-check
50127 the size of the generated prime, so it might still be too large.
50128 </para>
50129 </section>
50130 <section id="SECTreqciphssl">
50131 <title>Requiring specific ciphers in OpenSSL</title>
50132 <para>
50133 <indexterm role="concept">
50134 <primary>TLS</primary>
50135 <secondary>requiring specific ciphers (OpenSSL)</secondary>
50136 </indexterm>
50137 <indexterm role="option">
50138 <primary><option>tls_require_ciphers</option></primary>
50139 <secondary>OpenSSL</secondary>
50140 </indexterm>
50141 There is a function in the OpenSSL library that can be passed a list of cipher
50142 suites before the cipher negotiation takes place. This specifies which ciphers
50143 are acceptable. The list is colon separated and may contain names like
50144 DES-CBC3-SHA. Exim passes the expanded value of <option>tls_require_ciphers</option>
50145 directly to this function call.
50146 Many systems will install the OpenSSL manual-pages, so you may have
50147 <emphasis>ciphers(1)</emphasis> available to you.
50148 The following quotation from the OpenSSL
50149 documentation specifies what forms of item are allowed in the cipher string:
50150 </para>
50151 <itemizedlist>
50152 <listitem>
50153 <para>
50154 It can consist of a single cipher suite such as RC4-SHA.
50155 </para>
50156 </listitem>
50157 <listitem>
50158 <para>
50159 It can represent a list of cipher suites containing a certain algorithm,
50160 or cipher suites of a certain type. For example SHA1 represents all
50161 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
50162 SSL v3 algorithms.
50163 </para>
50164 </listitem>
50165 <listitem>
50166 <para>
50167 Lists of cipher suites can be combined in a single cipher string using
50168 the + character. This is used as a logical and operation. For example
50169 SHA1+DES represents all cipher suites containing the SHA1 and the DES
50170 algorithms.
50171 </para>
50172 </listitem>
50173 </itemizedlist>
50174 <para>
50175 Each cipher string can be optionally preceded by one of the characters <literal>!</literal>,
50176 <literal>-</literal> or <literal>+</literal>.
50177 </para>
50178 <itemizedlist>
50179 <listitem>
50180 <para>
50181 If <literal>!</literal> is used, the ciphers are permanently deleted from the list. The
50182 ciphers deleted can never reappear in the list even if they are explicitly
50183 stated.
50184 </para>
50185 </listitem>
50186 <listitem>
50187 <para>
50188 If <literal>-</literal> is used, the ciphers are deleted from the list, but some or all
50189 of the ciphers can be added again by later options.
50190 </para>
50191 </listitem>
50192 <listitem>
50193 <para>
50194 If <literal>+</literal> is used, the ciphers are moved to the end of the list. This
50195 option does not add any new ciphers; it just moves matching existing ones.
50196 </para>
50197 </listitem>
50198 </itemizedlist>
50199 <para>
50200 If none of these characters is present, the string is interpreted as
50201 a list of ciphers to be appended to the current preference list. If the list
50202 includes any ciphers already present they will be ignored: that is, they will
50203 not be moved to the end of the list.
50204 </para>
50205 <para>
50206 The OpenSSL <emphasis>ciphers(1)</emphasis> command may be used to test the results of a given
50207 string:
50208 </para>
50209 <literallayout class="monospaced">
50210 # note single-quotes to get ! past any shell history expansion
50211 $ openssl ciphers 'HIGH:!MD5:!SHA1'
50212 </literallayout>
50213 <para>
50214 This example will let the library defaults be permitted on the MX port, where
50215 there&#x2019;s probably no identity verification anyway, but ups the ante on the
50216 submission ports where the administrator might have some influence on the
50217 choice of clients used:
50218 </para>
50219 <literallayout class="monospaced">
50220 # OpenSSL variant; see man ciphers(1)
50221 tls_require_ciphers = ${if =={$received_port}{25}\
50222                            {DEFAULT}\
50223                            {HIGH:!MD5:!SHA1}}
50224 </literallayout>
50225 </section>
50226 <section id="SECTreqciphgnu">
50227 <title>Requiring specific ciphers or other parameters in GnuTLS</title>
50228 <para>
50229 <indexterm role="concept">
50230 <primary>GnuTLS</primary>
50231 <secondary>specifying parameters for</secondary>
50232 </indexterm>
50233 <indexterm role="concept">
50234 <primary>TLS</primary>
50235 <secondary>specifying ciphers (GnuTLS)</secondary>
50236 </indexterm>
50237 <indexterm role="concept">
50238 <primary>TLS</primary>
50239 <secondary>specifying key exchange methods (GnuTLS)</secondary>
50240 </indexterm>
50241 <indexterm role="concept">
50242 <primary>TLS</primary>
50243 <secondary>specifying MAC algorithms (GnuTLS)</secondary>
50244 </indexterm>
50245 <indexterm role="concept">
50246 <primary>TLS</primary>
50247 <secondary>specifying protocols (GnuTLS)</secondary>
50248 </indexterm>
50249 <indexterm role="concept">
50250 <primary>TLS</primary>
50251 <secondary>specifying priority string (GnuTLS)</secondary>
50252 </indexterm>
50253 <indexterm role="option">
50254 <primary><option>tls_require_ciphers</option></primary>
50255 <secondary>GnuTLS</secondary>
50256 </indexterm>
50257 The GnuTLS library allows the caller to provide a "priority string", documented
50258 as part of the <function>gnutls_priority_init</function> function.  This is very similar to the
50259 ciphersuite specification in OpenSSL.
50260 </para>
50261 <para>
50262 The <option>tls_require_ciphers</option> option is treated as the GnuTLS priority string.
50263 </para>
50264 <para>
50265 The <option>tls_require_ciphers</option> option is available both as an global option,
50266 controlling how Exim behaves as a server, and also as an option of the
50267 <command>smtp</command> transport, controlling how Exim behaves as a client.  In both cases
50268 the value is string expanded.  The resulting string is not an Exim list and
50269 the string is given to the GnuTLS library, so that Exim does not need to be
50270 aware of future feature enhancements of GnuTLS.
50271 </para>
50272 <para>
50273 Documentation of the strings accepted may be found in the GnuTLS manual, under
50274 "Priority strings".  This is online as
50275 <emphasis role="bold"><ulink url="http://www.gnutls.org/manual/html_node/Priority-Strings.html">http://www.gnutls.org/manual/html_node/Priority-Strings.html</ulink></emphasis>,
50276 but beware that this relates to GnuTLS 3, which may be newer than the version
50277 installed on your system.  If you are using GnuTLS 3,
50278 <emphasis role="bold"><ulink url="http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string">then the example code</ulink></emphasis>
50279 on that site can be used to test a given string.
50280 </para>
50281 <para>
50282 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
50283 additional options, "<option>gnutls_require_kx</option>", "<option>gnutls_require_mac</option>" and
50284 "<option>gnutls_require_protocols</option>".  <option>tls_require_ciphers</option> was an Exim list.
50285 </para>
50286 <para>
50287 This example will let the library defaults be permitted on the MX port, where
50288 there&#x2019;s probably no identity verification anyway, and lowers security further
50289 by increasing compatibility; but this ups the ante on the submission ports
50290 where the administrator might have some influence on the choice of clients
50291 used:
50292 </para>
50293 <literallayout class="monospaced">
50294 # GnuTLS variant
50295 tls_require_ciphers = ${if =={$received_port}{25}\
50296                            {NORMAL:%COMPAT}\
50297                            {SECURE128}}
50298 </literallayout>
50299 </section>
50300 <section id="SECID182">
50301 <title>Configuring an Exim server to use TLS</title>
50302 <para>
50303 <indexterm role="concept">
50304 <primary>TLS</primary>
50305 <secondary>configuring an Exim server</secondary>
50306 </indexterm>
50307 When Exim has been built with TLS support, it advertises the availability of
50308 the STARTTLS command to client hosts that match <option>tls_advertise_hosts</option>,
50309 but not to any others. The default value of this option is unset, which means
50310 that STARTTLS is not advertised at all. This default is chosen because you
50311 need to set some other options in order to make TLS available, and also it is
50312 sensible for systems that want to use TLS only as a client.
50313 </para>
50314 <para>
50315 If a client issues a STARTTLS command and there is some configuration
50316 problem in the server, the command is rejected with a 454 error. If the client
50317 persists in trying to issue SMTP commands, all except QUIT are rejected
50318 with the error
50319 </para>
50320 <literallayout class="monospaced">
50321 554 Security failure
50322 </literallayout>
50323 <para>
50324 If a STARTTLS command is issued within an existing TLS session, it is
50325 rejected with a 554 error code.
50326 </para>
50327 <para>
50328 To enable TLS operations on a server, you must set <option>tls_advertise_hosts</option> to
50329 match some hosts. You can, of course, set it to * to match all hosts.
50330 However, this is not all you need to do. TLS sessions to a server won&#x2019;t work
50331 without some further configuration at the server end.
50332 </para>
50333 <para>
50334 It is rumoured that all existing clients that support TLS/SSL use RSA
50335 encryption. To make this work you need to set, in the server,
50336 </para>
50337 <literallayout class="monospaced">
50338 tls_certificate = /some/file/name
50339 tls_privatekey = /some/file/name
50340 </literallayout>
50341 <para>
50342 These options are, in fact, expanded strings, so you can make them depend on
50343 the identity of the client that is connected if you wish. The first file
50344 contains the server&#x2019;s X509 certificate, and the second contains the private key
50345 that goes with it. These files need to be readable by the Exim user, and must
50346 always be given as full path names. They can be the same file if both the
50347 certificate and the key are contained within it. If <option>tls_privatekey</option> is not
50348 set, or if its expansion is forced to fail or results in an empty string, this
50349 is assumed to be the case. The certificate file may also contain intermediate
50350 certificates that need to be sent to the client to enable it to authenticate
50351 the server&#x2019;s certificate.
50352 </para>
50353 <para>
50354 If you do not understand about certificates and keys, please try to find a
50355 source of this background information, which is not Exim-specific. (There are a
50356 few comments below in section <xref linkend="SECTcerandall"/>.)
50357 </para>
50358 <para>
50359 <emphasis role="bold">Note</emphasis>: These options do not apply when Exim is operating as a client &ndash;
50360 they apply only in the case of a server. If you need to use a certificate in an
50361 Exim client, you must set the options of the same names in an <command>smtp</command>
50362 transport.
50363 </para>
50364 <para>
50365 With just these options, an Exim server will be able to use TLS. It does not
50366 require the client to have a certificate (but see below for how to insist on
50367 this). There is one other option that may be needed in other situations. If
50368 </para>
50369 <literallayout class="monospaced">
50370 tls_dhparam = /some/file/name
50371 </literallayout>
50372 <para>
50373 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
50374 with the parameters contained in the file.
50375 Set this to <literal>none</literal> to disable use of DH entirely, by making no prime
50376 available:
50377 </para>
50378 <literallayout class="monospaced">
50379 tls_dhparam = none
50380 </literallayout>
50381 <para>
50382 This may also be set to a string identifying a standard prime to be used for
50383 DH; if it is set to <literal>default</literal> or, for OpenSSL, is unset, then the prime
50384 used is <literal>ike23</literal>.  There are a few standard primes available, see the
50385 documentation for <option>tls_dhparam</option> for the complete list.
50386 </para>
50387 <para>
50388 See the command
50389 </para>
50390 <literallayout class="monospaced">
50391 openssl dhparam
50392 </literallayout>
50393 <para>
50394 for a way of generating file data.
50395 </para>
50396 <para>
50397 The strings supplied for these three options are expanded every time a client
50398 host connects. It is therefore possible to use different certificates and keys
50399 for different hosts, if you so wish, by making use of the client&#x2019;s IP address
50400 in <varname>$sender_host_address</varname> to control the expansion. If a string expansion is
50401 forced to fail, Exim behaves as if the option is not set.
50402 </para>
50403 <para>
50404 <indexterm role="concept">
50405 <primary>cipher</primary>
50406 <secondary>logging</secondary>
50407 </indexterm>
50408 <indexterm role="concept">
50409 <primary>log</primary>
50410 <secondary>TLS cipher</secondary>
50411 </indexterm>
50412 <indexterm role="variable">
50413 <primary><varname>$tls_in_cipher</varname></primary>
50414 </indexterm>
50415 The variable <varname>$tls_in_cipher</varname> is set to the cipher suite that was negotiated for
50416 an incoming TLS connection. It is included in the <emphasis>Received:</emphasis> header of an
50417 incoming message (by default &ndash; you can, of course, change this), and it is
50418 also included in the log line that records a message&#x2019;s arrival, keyed by
50419 <quote>X=</quote>, unless the <option>tls_cipher</option> log selector is turned off. The <option>encrypted</option>
50420 condition can be used to test for specific cipher suites in ACLs.
50421 </para>
50422 <para>
50423 Once TLS has been established, the ACLs that run for subsequent SMTP commands
50424 can check the name of the cipher suite and vary their actions accordingly. The
50425 cipher suite names vary, depending on which TLS library is being used. For
50426 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
50427 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
50428 documentation for more details.
50429 </para>
50430 <para>
50431 For outgoing SMTP deliveries, <varname>$tls_out_cipher</varname> is used and logged
50432 (again depending on the <option>tls_cipher</option> log selector).
50433 </para>
50434 </section>
50435 <section id="SECID183">
50436 <title>Requesting and verifying client certificates</title>
50437 <para>
50438 <indexterm role="concept">
50439 <primary>certificate</primary>
50440 <secondary>verification of client</secondary>
50441 </indexterm>
50442 <indexterm role="concept">
50443 <primary>TLS</primary>
50444 <secondary>client certificate verification</secondary>
50445 </indexterm>
50446 If you want an Exim server to request a certificate when negotiating a TLS
50447 session with a client, you must set either <option>tls_verify_hosts</option> or
50448 <option>tls_try_verify_hosts</option>. You can, of course, set either of them to * to
50449 apply to all TLS connections. For any host that matches one of these options,
50450 Exim requests a certificate as part of the setup of the TLS session. The
50451 contents of the certificate are verified by comparing it with a list of
50452 expected certificates. These must be available in a file or,
50453 for OpenSSL only (not GnuTLS), a directory, identified by
50454 <option>tls_verify_certificates</option>.
50455 </para>
50456 <para>
50457 A file can contain multiple certificates, concatenated end to end. If a
50458 directory is used
50459 (OpenSSL only),
50460 each certificate must be in a separate file, with a name (or a symbolic link)
50461 of the form &lt;<emphasis>hash</emphasis>&gt;.0, where &lt;<emphasis>hash</emphasis>&gt; is a hash value constructed from the
50462 certificate. You can compute the relevant hash by running the command
50463 </para>
50464 <literallayout class="monospaced">
50465 openssl x509 -hash -noout -in /cert/file
50466 </literallayout>
50467 <para>
50468 where <filename>/cert/file</filename> contains a single certificate.
50469 </para>
50470 <para>
50471 The difference between <option>tls_verify_hosts</option> and <option>tls_try_verify_hosts</option> is
50472 what happens if the client does not supply a certificate, or if the certificate
50473 does not match any of the certificates in the collection named by
50474 <option>tls_verify_certificates</option>. If the client matches <option>tls_verify_hosts</option>, the
50475 attempt to set up a TLS session is aborted, and the incoming connection is
50476 dropped. If the client matches <option>tls_try_verify_hosts</option>, the (encrypted) SMTP
50477 session continues. ACLs that run for subsequent SMTP commands can detect the
50478 fact that no certificate was verified, and vary their actions accordingly. For
50479 example, you can insist on a certificate before accepting a message for
50480 relaying, but not when the message is destined for local delivery.
50481 </para>
50482 <para>
50483 <indexterm role="variable">
50484 <primary><varname>$tls_in_peerdn</varname></primary>
50485 </indexterm>
50486 When a client supplies a certificate (whether it verifies or not), the value of
50487 the Distinguished Name of the certificate is made available in the variable
50488 <varname>$tls_in_peerdn</varname> during subsequent processing of the message.
50489 </para>
50490 <para>
50491 <indexterm role="concept">
50492 <primary>log</primary>
50493 <secondary>distinguished name</secondary>
50494 </indexterm>
50495 Because it is often a long text string, it is not included in the log line or
50496 <emphasis>Received:</emphasis> header by default. You can arrange for it to be logged, keyed by
50497 <quote>DN=</quote>, by setting the <option>tls_peerdn</option> log selector, and you can use
50498 <option>received_header_text</option> to change the <emphasis>Received:</emphasis> header. When no
50499 certificate is supplied, <varname>$tls_in_peerdn</varname> is empty.
50500 </para>
50501 </section>
50502 <section id="SECID184">
50503 <title>Revoked certificates</title>
50504 <para>
50505 <indexterm role="concept">
50506 <primary>TLS</primary>
50507 <secondary>revoked certificates</secondary>
50508 </indexterm>
50509 <indexterm role="concept">
50510 <primary>revocation list</primary>
50511 </indexterm>
50512 <indexterm role="concept">
50513 <primary>certificate</primary>
50514 <secondary>revocation list</secondary>
50515 </indexterm>
50516 <indexterm role="concept">
50517 <primary>OCSP</primary>
50518 <secondary>stapling</secondary>
50519 </indexterm>
50520 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
50521 certificates are revoked. If you have such a list, you can pass it to an Exim
50522 server using the global option called <option>tls_crl</option> and to an Exim client using
50523 an identically named option for the <command>smtp</command> transport. In each case, the value
50524 of the option is expanded and must then be the name of a file that contains a
50525 CRL in PEM format.
50526 The downside is that clients have to periodically re-download a potentially huge
50527 file from every certificate authority the know of.
50528 </para>
50529 <para>
50530 The way with most moving parts at query time is Online Certificate
50531 Status Protocol (OCSP), where the client verifies the certificate
50532 against an OCSP server run by the CA.  This lets the CA track all
50533 usage of the certs.  It requires running software with access to the
50534 private key of the CA, to sign the responses to the OCSP queries.  OCSP
50535 is based on HTTP and can be proxied accordingly.
50536 </para>
50537 <para>
50538 The only widespread OCSP server implementation (known to this writer)
50539 comes as part of OpenSSL and aborts on an invalid request, such as
50540 connecting to the port and then disconnecting.  This requires
50541 re-entering the passphrase each time some random client does this.
50542 </para>
50543 <para>
50544 The third way is OCSP Stapling; in this, the server using a certificate
50545 issued by the CA periodically requests an OCSP proof of validity from
50546 the OCSP server, then serves it up inline as part of the TLS
50547 negotiation.   This approach adds no extra round trips, does not let the
50548 CA track users, scales well with number of certs issued by the CA and is
50549 resilient to temporary OCSP server failures, as long as the server
50550 starts retrying to fetch an OCSP proof some time before its current
50551 proof expires.  The downside is that it requires server support.
50552 </para>
50553 <para>
50554 Unless Exim is built with the support disabled,
50555 or with GnuTLS earlier than version 3.1.3,
50556 support for OCSP stapling is included.
50557 </para>
50558 <para>
50559 There is a global option called <option>tls_ocsp_file</option>.
50560 The file specified therein is expected to be in DER format, and contain
50561 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
50562 option will be re-expanded for SNI, if the <option>tls_certificate</option> option
50563 contains <literal>tls_in_sni</literal>, as per other TLS options.
50564 </para>
50565 <para>
50566 Exim does not at this time implement any support for fetching a new OCSP
50567 proof.  The burden is on the administrator to handle this, outside of
50568 Exim.  The file specified should be replaced atomically, so that the
50569 contents are always valid.  Exim will expand the <option>tls_ocsp_file</option> option
50570 on each connection, so a new file will be handled transparently on the
50571 next connection.
50572 </para>
50573 <para>
50574 When built with OpenSSL Exim will check for a valid next update timestamp
50575 in the OCSP proof; if not present, or if the proof has expired, it will be
50576 ignored.
50577 </para>
50578 <para>
50579 For the client to be able to verify the stapled OCSP the server must
50580 also supply, in its stapled information, any intermediate
50581 certificates for the chain leading to the OCSP proof from the signer
50582 of the server certificate.  There may be zero or one such. These
50583 intermediate certificates should be added to the server OCSP stapling
50584 file named by <option>tls_ocsp_file</option>.
50585 </para>
50586 <para>
50587 Note that the proof only covers the terminal server certificate,
50588 not any of the chain from CA to it.
50589 </para>
50590 <literallayout class="monospaced">
50591   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
50592   OCSP server is supplied.  The server URL may be included in the
50593   server certificate, if the CA is helpful.
50594
50595   One failure mode seen was the OCSP Signer cert expiring before the end
50596   of validity of the OCSP proof. The checking done by Exim/OpenSSL
50597   noted this as invalid overall, but the re-fetch script did not.
50598 </literallayout>
50599 </section>
50600 <section id="SECID185">
50601 <title>Configuring an Exim client to use TLS</title>
50602 <para>
50603 <indexterm role="concept">
50604 <primary>cipher</primary>
50605 <secondary>logging</secondary>
50606 </indexterm>
50607 <indexterm role="concept">
50608 <primary>log</primary>
50609 <secondary>TLS cipher</secondary>
50610 </indexterm>
50611 <indexterm role="concept">
50612 <primary>log</primary>
50613 <secondary>distinguished name</secondary>
50614 </indexterm>
50615 <indexterm role="concept">
50616 <primary>TLS</primary>
50617 <secondary>configuring an Exim client</secondary>
50618 </indexterm>
50619 The <option>tls_cipher</option> and <option>tls_peerdn</option> log selectors apply to outgoing SMTP
50620 deliveries as well as to incoming, the latter one causing logging of the
50621 server certificate&#x2019;s DN. The remaining client configuration for TLS is all
50622 within the <command>smtp</command> transport.
50623 </para>
50624 <para>
50625 It is not necessary to set any options to have TLS work in the <command>smtp</command>
50626 transport. If Exim is built with TLS support, and TLS is advertised by a
50627 server, the <command>smtp</command> transport always tries to start a TLS session. However,
50628 this can be prevented by setting <option>hosts_avoid_tls</option> (an option of the
50629 transport) to a list of server hosts for which TLS should not be used.
50630 </para>
50631 <para>
50632 If you do not want Exim to attempt to send messages unencrypted when an attempt
50633 to set up an encrypted connection fails in any way, you can set
50634 <option>hosts_require_tls</option> to a list of hosts for which encryption is mandatory. For
50635 those hosts, delivery is always deferred if an encrypted connection cannot be
50636 set up. If there are any other hosts for the address, they are tried in the
50637 usual way.
50638 </para>
50639 <para>
50640 When the server host is not in <option>hosts_require_tls</option>, Exim may try to deliver
50641 the message unencrypted. It always does this if the response to STARTTLS is
50642 a 5<emphasis>xx</emphasis> code. For a temporary error code, or for a failure to negotiate a TLS
50643 session after a success response code, what happens is controlled by the
50644 <option>tls_tempfail_tryclear</option> option of the <command>smtp</command> transport. If it is false,
50645 delivery to this host is deferred, and other hosts (if available) are tried. If
50646 it is true, Exim attempts to deliver unencrypted after a 4<emphasis>xx</emphasis> response to
50647 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
50648 negotiation fails, Exim closes the current connection (because it is in an
50649 unknown state), opens a new one to the same host, and then tries the delivery
50650 unencrypted.
50651 </para>
50652 <para>
50653 The <option>tls_certificate</option> and <option>tls_privatekey</option> options of the <command>smtp</command>
50654 transport provide the client with a certificate, which is passed to the server
50655 if it requests it. If the server is Exim, it will request a certificate only if
50656 <option>tls_verify_hosts</option> or <option>tls_try_verify_hosts</option> matches the client.
50657 </para>
50658 <para>
50659 If the <option>tls_verify_certificates</option> option is set on the <command>smtp</command> transport, it
50660 must name a file or,
50661 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
50662 expected server certificates. The client verifies the server&#x2019;s certificate
50663 against this collection, taking into account any revoked certificates that are
50664 in the list defined by <option>tls_crl</option>.
50665 Failure to verify fails the TLS connection unless either of the
50666 <option>tls_verify_hosts</option> or <option>tls_try_verify_hosts</option> options are set.
50667 </para>
50668 <para>
50669 The <option>tls_verify_hosts</option> and <option>tls_try_verify_hosts</option> options restrict
50670 certificate verification to the listed servers.  Verification either must
50671 or need not succeed respectively.
50672 </para>
50673 <para>
50674 The <command>smtp</command> transport has two OCSP-related options:
50675 <option>hosts_require_ocsp</option>; a host-list for which a Certificate Status
50676 is requested and required for the connection to proceed.  The default
50677 value is empty.
50678 <option>hosts_request_ocsp</option>; a host-list for which (additionally)
50679 a Certificate Status is requested (but not necessarily verified).  The default
50680 value is "*" meaning that requests are made unless configured
50681 otherwise.
50682 </para>
50683 <para>
50684 The host(s) should also be in <option>hosts_require_tls</option>, and
50685 <option>tls_verify_certificates</option> configured for the transport,
50686 for OCSP to be relevant.
50687 </para>
50688 <para>
50689 If
50690 <option>tls_require_ciphers</option> is set on the <command>smtp</command> transport, it must contain a
50691 list of permitted cipher suites. If either of these checks fails, delivery to
50692 the current host is abandoned, and the <command>smtp</command> transport tries to deliver to
50693 alternative hosts, if any.
50694 </para>
50695 <para>
50696  <emphasis role="bold">Note</emphasis>:
50697 These options must be set in the <command>smtp</command> transport for Exim to use TLS when it
50698 is operating as a client. Exim does not assume that a server certificate (set
50699 by the global options of the same name) should also be used when operating as a
50700 client.
50701 </para>
50702 <para>
50703 <indexterm role="variable">
50704 <primary><varname>$host</varname></primary>
50705 </indexterm>
50706 <indexterm role="variable">
50707 <primary><varname>$host_address</varname></primary>
50708 </indexterm>
50709 All the TLS options in the <command>smtp</command> transport are expanded before use, with
50710 <varname>$host</varname> and <varname>$host_address</varname> containing the name and address of the server to
50711 which the client is connected. Forced failure of an expansion causes Exim to
50712 behave as if the relevant option were unset.
50713 </para>
50714 <para>
50715 <indexterm role="variable">
50716 <primary><varname>$tls_out_bits</varname></primary>
50717 </indexterm>
50718 <indexterm role="variable">
50719 <primary><varname>$tls_out_cipher</varname></primary>
50720 </indexterm>
50721 <indexterm role="variable">
50722 <primary><varname>$tls_out_peerdn</varname></primary>
50723 </indexterm>
50724 <indexterm role="variable">
50725 <primary><varname>$tls_out_sni</varname></primary>
50726 </indexterm>
50727 Before an SMTP connection is established, the
50728 <varname>$tls_out_bits</varname>, <varname>$tls_out_cipher</varname>, <varname>$tls_out_peerdn</varname> and <varname>$tls_out_sni</varname>
50729 variables are emptied. (Until the first connection, they contain the values
50730 that were set when the message was received.) If STARTTLS is subsequently
50731 successfully obeyed, these variables are set to the relevant values for the
50732 outgoing connection.
50733 </para>
50734 </section>
50735 <section id="SECTtlssni">
50736 <title>Use of TLS Server Name Indication</title>
50737 <para>
50738 <indexterm role="concept">
50739 <primary>TLS</primary>
50740 <secondary>Server Name Indication</secondary>
50741 </indexterm>
50742 <indexterm role="variable">
50743 <primary><varname>$tls_in_sni</varname></primary>
50744 </indexterm>
50745 <indexterm role="option">
50746 <primary><option>tls_in_sni</option></primary>
50747 </indexterm>
50748 With TLS1.0 or above, there is an extension mechanism by which extra
50749 information can be included at various points in the protocol.  One of these
50750 extensions, documented in RFC 6066 (and before that RFC 4366) is
50751 <quote>Server Name Indication</quote>, commonly <quote>SNI</quote>.  This extension is sent by the
50752 client in the initial handshake, so that the server can examine the servername
50753 within and possibly choose to use different certificates and keys (and more)
50754 for this session.
50755 </para>
50756 <para>
50757 This is analagous to HTTP&#x2019;s <quote>Host:</quote> header, and is the main mechanism by
50758 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
50759 address.
50760 </para>
50761 <para>
50762 With SMTP to MX, there are the same problems here as in choosing the identity
50763 against which to validate a certificate: you can&#x2019;t rely on insecure DNS to
50764 provide the identity which you then cryptographically verify.  So this will
50765 be of limited use in that environment.
50766 </para>
50767 <para>
50768 With SMTP to Submission, there is a well-defined hostname which clients are
50769 connecting to and can validate certificates against.  Thus clients <emphasis role="bold">can</emphasis>
50770 choose to include this information in the TLS negotiation.  If this becomes
50771 wide-spread, then hosters can choose to present different certificates to
50772 different clients.  Or even negotiate different cipher suites.
50773 </para>
50774 <para>
50775 The <option>tls_sni</option> option on an SMTP transport is an expanded string; the result,
50776 if not empty, will be sent on a TLS session as part of the handshake.  There&#x2019;s
50777 nothing more to it.  Choosing a sensible value not derived insecurely is the
50778 only point of caution.  The <varname>$tls_out_sni</varname> variable will be set to this string
50779 for the lifetime of the client connection (including during authentication).
50780 </para>
50781 <para>
50782 Except during SMTP client sessions, if <varname>$tls_in_sni</varname> is set then it is a string
50783 received from a client.
50784 It can be logged with the <option>log_selector</option> item <literal>+tls_sni</literal>.
50785 </para>
50786 <para>
50787 If the string <literal>tls_in_sni</literal> appears in the main section&#x2019;s <option>tls_certificate</option>
50788 option (prior to expansion) then the following options will be re-expanded
50789 during TLS session handshake, to permit alternative values to be chosen:
50790 </para>
50791 <itemizedlist>
50792 <listitem>
50793 <para>
50794 <indexterm role="variable">
50795 <primary><option>tls_certificate</option></primary>
50796 </indexterm>
50797 <option>tls_certificate</option>
50798 </para>
50799 </listitem>
50800 <listitem>
50801 <para>
50802 <indexterm role="variable">
50803 <primary><option>tls_crl</option></primary>
50804 </indexterm>
50805 <option>tls_crl</option>
50806 </para>
50807 </listitem>
50808 <listitem>
50809 <para>
50810 <indexterm role="variable">
50811 <primary><option>tls_privatekey</option></primary>
50812 </indexterm>
50813 <option>tls_privatekey</option>
50814 </para>
50815 </listitem>
50816 <listitem>
50817 <para>
50818 <indexterm role="variable">
50819 <primary><option>tls_verify_certificates</option></primary>
50820 </indexterm>
50821 <option>tls_verify_certificates</option>
50822 </para>
50823 </listitem>
50824 <listitem>
50825 <para>
50826 <indexterm role="variable">
50827 <primary><option>tls_ocsp_file</option></primary>
50828 </indexterm>
50829 <option>tls_verify_certificates</option>
50830 </para>
50831 </listitem>
50832 </itemizedlist>
50833 <para>
50834 Great care should be taken to deal with matters of case, various injection
50835 attacks in the string (<literal>../</literal> or SQL), and ensuring that a valid filename
50836 can always be referenced; it is important to remember that <varname>$tls_sni</varname> is
50837 arbitrary unverified data provided prior to authentication.
50838 </para>
50839 <para>
50840 The Exim developers are proceeding cautiously and so far no other TLS options
50841 are re-expanded.
50842 </para>
50843 <para>
50844 When Exim is built againt OpenSSL, OpenSSL must have been built with support
50845 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
50846 enable-tlsext in EXTRACONFIGURE.  If you invoke <command>openssl s_client -h</command> and
50847 see <literal>-servername</literal> in the output, then OpenSSL has support.
50848 </para>
50849 <para>
50850 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
50851 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
50852 built, then you have SNI support).
50853 </para>
50854 </section>
50855 <section id="SECTmulmessam">
50856 <title>Multiple messages on the same encrypted TCP/IP connection</title>
50857 <para>
50858 <indexterm role="concept">
50859 <primary>multiple SMTP deliveries with TLS</primary>
50860 </indexterm>
50861 <indexterm role="concept">
50862 <primary>TLS</primary>
50863 <secondary>multiple message deliveries</secondary>
50864 </indexterm>
50865 Exim sends multiple messages down the same TCP/IP connection by starting up
50866 an entirely new delivery process for each message, passing the socket from
50867 one process to the next. This implementation does not fit well with the use
50868 of TLS, because there is quite a lot of state information associated with a TLS
50869 connection, not just a socket identification. Passing all the state information
50870 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
50871 session before passing the socket to a new process. The new process may then
50872 try to start a new TLS session, and if successful, may try to re-authenticate
50873 if AUTH is in use, before sending the next message.
50874 </para>
50875 <para>
50876 The RFC is not clear as to whether or not an SMTP session continues in clear
50877 after TLS has been shut down, or whether TLS may be restarted again later, as
50878 just described. However, if the server is Exim, this shutdown and
50879 reinitialization works. It is not known which (if any) other servers operate
50880 successfully if the client closes a TLS session and continues with unencrypted
50881 SMTP, but there are certainly some that do not work. For such servers, Exim
50882 should not pass the socket to another process, because the failure of the
50883 subsequent attempt to use it would cause Exim to record a temporary host error,
50884 and delay other deliveries to that host.
50885 </para>
50886 <para>
50887 To test for this case, Exim sends an EHLO command to the server after
50888 closing down the TLS session. If this fails in any way, the connection is
50889 closed instead of being passed to a new delivery process, but no retry
50890 information is recorded.
50891 </para>
50892 <para>
50893 There is also a manual override; you can set <option>hosts_nopass_tls</option> on the
50894 <command>smtp</command> transport to match those hosts for which Exim should not pass
50895 connections to new processes if TLS has been used.
50896 </para>
50897 </section>
50898 <section id="SECTcerandall">
50899 <title>Certificates and all that</title>
50900 <para>
50901 <indexterm role="concept">
50902 <primary>certificate</primary>
50903 <secondary>references to discussion</secondary>
50904 </indexterm>
50905 In order to understand fully how TLS works, you need to know about
50906 certificates, certificate signing, and certificate authorities. This is not the
50907 place to give a tutorial, especially as I do not know very much about it
50908 myself. Some helpful introduction can be found in the FAQ for the SSL addition
50909 to Apache, currently at
50910 </para>
50911 <literallayout>
50912 <emphasis role="bold"><ulink url="http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24">http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24</ulink></emphasis>
50913 </literallayout>
50914 <para>
50915 Other parts of the <emphasis>modssl</emphasis> documentation are also helpful, and have
50916 links to further files.
50917 Eric Rescorla&#x2019;s book, <emphasis>SSL and TLS</emphasis>, published by Addison-Wesley (ISBN
50918 0-201-61598-3), contains both introductory and more in-depth descriptions.
50919 Some sample programs taken from the book are available from
50920 </para>
50921 <literallayout>
50922 <emphasis role="bold"><ulink url="http://www.rtfm.com/openssl-examples/">http://www.rtfm.com/openssl-examples/</ulink></emphasis>
50923 </literallayout>
50924 </section>
50925 <section id="SECID186">
50926 <title>Certificate chains</title>
50927 <para>
50928 The file named by <option>tls_certificate</option> may contain more than one
50929 certificate. This is useful in the case where the certificate that is being
50930 sent is validated by an intermediate certificate which the other end does
50931 not have. Multiple certificates must be in the correct order in the file.
50932 First the host&#x2019;s certificate itself, then the first intermediate
50933 certificate to validate the issuer of the host certificate, then the next
50934 intermediate certificate to validate the issuer of the first intermediate
50935 certificate, and so on, until finally (optionally) the root certificate.
50936 The root certificate must already be trusted by the recipient for
50937 validation to succeed, of course, but if it&#x2019;s not preinstalled, sending the
50938 root certificate along with the rest makes it available for the user to
50939 install if the receiving end is a client MUA that can interact with a user.
50940 </para>
50941 <para>
50942 Note that certificates using MD5 are unlikely to work on today&#x2019;s Internet;
50943 even if your libraries allow loading them for use in Exim when acting as a
50944 server, increasingly clients will not accept such certificates.  The error
50945 diagnostics in such a case can be frustratingly vague.
50946 </para>
50947 </section>
50948 <section id="SECID187">
50949 <title>Self-signed certificates</title>
50950 <para>
50951 <indexterm role="concept">
50952 <primary>certificate</primary>
50953 <secondary>self-signed</secondary>
50954 </indexterm>
50955 You can create a self-signed certificate using the <emphasis>req</emphasis> command provided
50956 with OpenSSL, like this:
50957 </para>
50958 <literallayout class="monospaced">
50959 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
50960             -days 9999 -nodes
50961 </literallayout>
50962 <para>
50963 <filename>file1</filename> and <filename>file2</filename> can be the same file; the key and the certificate are
50964 delimited and so can be identified independently. The <option>-days</option> option
50965 specifies a period for which the certificate is valid. The <option>-nodes</option> option is
50966 important: if you do not set it, the key is encrypted with a passphrase
50967 that you are prompted for, and any use that is made of the key causes more
50968 prompting for the passphrase. This is not helpful if you are going to use
50969 this certificate and key in an MTA, where prompting is not possible.
50970 </para>
50971 <para>
50972 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
50973 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
50974 the above command might produce a date in the past.  Think carefully about
50975 the lifetime of the systems you&#x2019;re deploying, and either reduce the duration
50976 of the certificate or reconsider your platform deployment.  (At time of
50977 writing, reducing the duration is the most likely choice, but the inexorable
50978 progression of time takes us steadily towards an era where this will not
50979 be a sensible resolution).
50980 </para>
50981 <para>
50982 A self-signed certificate made in this way is sufficient for testing, and
50983 may be adequate for all your requirements if you are mainly interested in
50984 encrypting transfers, and not in secure identification.
50985 </para>
50986 <para>
50987 However, many clients require that the certificate presented by the server be a
50988 user (also called <quote>leaf</quote> or <quote>site</quote>) certificate, and not a self-signed
50989 certificate. In this situation, the self-signed certificate described above
50990 must be installed on the client host as a trusted root <emphasis>certification
50991 authority</emphasis> (CA), and the certificate used by Exim must be a user certificate
50992 signed with that self-signed certificate.
50993 </para>
50994 <para>
50995 For information on creating self-signed CA certificates and using them to sign
50996 user certificates, see the <emphasis>General implementation overview</emphasis> chapter of the
50997 Open-source PKI book, available online at
50998 <emphasis role="bold"><ulink url="http://ospkibook.sourceforge.net/">http://ospkibook.sourceforge.net/</ulink></emphasis>.
50999 <indexterm role="concept" startref="IIDencsmtp1" class="endofrange"/>
51000 <indexterm role="concept" startref="IIDencsmtp2" class="endofrange"/>
51001 </para>
51002 </section>
51003 </chapter>
51004
51005 <chapter id="CHAPACL">
51006 <title>Access control lists</title>
51007 <para>
51008 <indexterm role="concept" id="IIDacl" class="startofrange">
51009 <primary>access control lists (ACLs)</primary>
51010 <secondary>description</secondary>
51011 </indexterm>
51012 <indexterm role="concept">
51013 <primary>control of incoming mail</primary>
51014 </indexterm>
51015 <indexterm role="concept">
51016 <primary>message</primary>
51017 <secondary>controlling incoming</secondary>
51018 </indexterm>
51019 <indexterm role="concept">
51020 <primary>policy control</primary>
51021 <secondary>access control lists</secondary>
51022 </indexterm>
51023 Access Control Lists (ACLs) are defined in a separate section of the run time
51024 configuration file, headed by <quote>begin acl</quote>. Each ACL definition starts with a
51025 name, terminated by a colon. Here is a complete ACL section that contains just
51026 one very small ACL:
51027 </para>
51028 <literallayout class="monospaced">
51029 begin acl
51030 small_acl:
51031   accept   hosts = one.host.only
51032 </literallayout>
51033 <para>
51034 You can have as many lists as you like in the ACL section, and the order in
51035 which they appear does not matter. The lists are self-terminating.
51036 </para>
51037 <para>
51038 The majority of ACLs are used to control Exim&#x2019;s behaviour when it receives
51039 certain SMTP commands. This applies both to incoming TCP/IP connections, and
51040 when a local process submits a message using SMTP by specifying the <option>-bs</option>
51041 option. The most common use is for controlling which recipients are accepted
51042 in incoming messages. In addition, you can define an ACL that is used to check
51043 local non-SMTP messages. The default configuration file contains an example of
51044 a realistic ACL for checking RCPT commands. This is discussed in chapter
51045 <xref linkend="CHAPdefconfil"/>.
51046 </para>
51047 <section id="SECID188">
51048 <title>Testing ACLs</title>
51049 <para>
51050 The <option>-bh</option> command line option provides a way of testing your ACL
51051 configuration locally by running a fake SMTP session with which you interact.
51052 The host <emphasis>relay-test.mail-abuse.org</emphasis> provides a service for checking your
51053 relaying configuration (see section <xref linkend="SECTcheralcon"/> for more details).
51054 </para>
51055 </section>
51056 <section id="SECID189">
51057 <title>Specifying when ACLs are used</title>
51058 <para>
51059 <indexterm role="concept">
51060 <primary>access control lists (ACLs)</primary>
51061 <secondary>options for specifying</secondary>
51062 </indexterm>
51063 In order to cause an ACL to be used, you have to name it in one of the relevant
51064 options in the main part of the configuration. These options are:
51065 <indexterm role="concept">
51066 <primary>AUTH</primary>
51067 <secondary>ACL for</secondary>
51068 </indexterm>
51069 <indexterm role="concept">
51070 <primary>DATA</primary>
51071 <secondary>ACLs for</secondary>
51072 </indexterm>
51073 <indexterm role="concept">
51074 <primary>ETRN</primary>
51075 <secondary>ACL for</secondary>
51076 </indexterm>
51077 <indexterm role="concept">
51078 <primary>EXPN</primary>
51079 <secondary>ACL for</secondary>
51080 </indexterm>
51081 <indexterm role="concept">
51082 <primary>HELO</primary>
51083 <secondary>ACL for</secondary>
51084 </indexterm>
51085 <indexterm role="concept">
51086 <primary>EHLO</primary>
51087 <secondary>ACL for</secondary>
51088 </indexterm>
51089 <indexterm role="concept">
51090 <primary>MAIL</primary>
51091 <secondary>ACL for</secondary>
51092 </indexterm>
51093 <indexterm role="concept">
51094 <primary>QUIT, ACL for</primary>
51095 </indexterm>
51096 <indexterm role="concept">
51097 <primary>RCPT</primary>
51098 <secondary>ACL for</secondary>
51099 </indexterm>
51100 <indexterm role="concept">
51101 <primary>STARTTLS, ACL for</primary>
51102 </indexterm>
51103 <indexterm role="concept">
51104 <primary>VRFY</primary>
51105 <secondary>ACL for</secondary>
51106 </indexterm>
51107 <indexterm role="concept">
51108 <primary>SMTP</primary>
51109 <secondary>connection, ACL for</secondary>
51110 </indexterm>
51111 <indexterm role="concept">
51112 <primary>non-SMTP messages</primary>
51113 <secondary>ACLs for</secondary>
51114 </indexterm>
51115 <indexterm role="concept">
51116 <primary>MIME content scanning</primary>
51117 <secondary>ACL for</secondary>
51118 </indexterm>
51119 <indexterm role="concept">
51120 <primary>PRDR</primary>
51121 <secondary>ACL for</secondary>
51122 </indexterm>
51123 </para>
51124 <informaltable frame="none">
51125 <tgroup cols="2" colsep="0" rowsep="0">
51126 <colspec colwidth="140pt" align="left"/>
51127 <colspec colwidth="254pt" align="left"/>
51128 <tbody>
51129 <row>
51130 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>acl_not_smtp</option></entry>
51131 <entry>ACL for non-SMTP messages</entry>
51132 </row>
51133 <row>
51134 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>acl_not_smtp_mime</option></entry>
51135 <entry>ACL for non-SMTP MIME parts</entry>
51136 </row>
51137 <row>
51138 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>acl_not_smtp_start</option></entry>
51139 <entry>ACL at start of non-SMTP message</entry>
51140 </row>
51141 <row>
51142 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>acl_smtp_auth</option></entry>
51143 <entry>ACL for AUTH</entry>
51144 </row>
51145 <row>
51146 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>acl_smtp_connect</option></entry>
51147 <entry>ACL for start of SMTP connection</entry>
51148 </row>
51149 <row>
51150 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>acl_smtp_data</option></entry>
51151 <entry>ACL after DATA is complete</entry>
51152 </row>
51153 <row>
51154 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>acl_smtp_data_prdr</option></entry>
51155 <entry>ACL for each recipient, after DATA is complete</entry>
51156 </row>
51157 <row>
51158 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>acl_smtp_etrn</option></entry>
51159 <entry>ACL for ETRN</entry>
51160 </row>
51161 <row>
51162 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>acl_smtp_expn</option></entry>
51163 <entry>ACL for EXPN</entry>
51164 </row>
51165 <row>
51166 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>acl_smtp_helo</option></entry>
51167 <entry>ACL for HELO or EHLO</entry>
51168 </row>
51169 <row>
51170 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>acl_smtp_mail</option></entry>
51171 <entry>ACL for MAIL</entry>
51172 </row>
51173 <row>
51174 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>acl_smtp_mailauth</option></entry>
51175 <entry>ACL for the AUTH parameter of MAIL</entry>
51176 </row>
51177 <row>
51178 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>acl_smtp_mime</option></entry>
51179 <entry>ACL for content-scanning MIME parts</entry>
51180 </row>
51181 <row>
51182 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>acl_smtp_notquit</option></entry>
51183 <entry>ACL for non-QUIT terminations</entry>
51184 </row>
51185 <row>
51186 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>acl_smtp_predata</option></entry>
51187 <entry>ACL at start of DATA command</entry>
51188 </row>
51189 <row>
51190 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>acl_smtp_quit</option></entry>
51191 <entry>ACL for QUIT</entry>
51192 </row>
51193 <row>
51194 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>acl_smtp_rcpt</option></entry>
51195 <entry>ACL for RCPT</entry>
51196 </row>
51197 <row>
51198 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>acl_smtp_starttls</option></entry>
51199 <entry>ACL for STARTTLS</entry>
51200 </row>
51201 <row>
51202 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<option>acl_smtp_vrfy</option></entry>
51203 <entry>ACL for VRFY</entry>
51204 </row>
51205 </tbody>
51206 </tgroup>
51207 </informaltable>
51208 <para>
51209 For example, if you set
51210 </para>
51211 <literallayout class="monospaced">
51212 acl_smtp_rcpt = small_acl
51213 </literallayout>
51214 <para>
51215 the little ACL defined above is used whenever Exim receives a RCPT command
51216 in an SMTP dialogue. The majority of policy tests on incoming messages can be
51217 done when RCPT commands arrive. A rejection of RCPT should cause the
51218 sending MTA to give up on the recipient address contained in the RCPT
51219 command, whereas rejection at other times may cause the client MTA to keep on
51220 trying to deliver the message. It is therefore recommended that you do as much
51221 testing as possible at RCPT time.
51222 </para>
51223 </section>
51224 <section id="SECID190">
51225 <title>The non-SMTP ACLs</title>
51226 <para>
51227 <indexterm role="concept">
51228 <primary>non-SMTP messages</primary>
51229 <secondary>ACLs for</secondary>
51230 </indexterm>
51231 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
51232 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
51233 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
51234 the state of the SMTP connection such as encryption and authentication) are not
51235 relevant and are forbidden in these ACLs. However, the sender and recipients
51236 are known, so the <option>senders</option> and <option>sender_domains</option> conditions and the
51237 <varname>$sender_address</varname> and <varname>$recipients</varname> variables can be used. Variables such as
51238 <varname>$authenticated_sender</varname> are also available. You can specify added header lines
51239 in any of these ACLs.
51240 </para>
51241 <para>
51242 The <option>acl_not_smtp_start</option> ACL is run right at the start of receiving a
51243 non-SMTP message, before any of the message has been read. (This is the
51244 analogue of the <option>acl_smtp_predata</option> ACL for SMTP input.) In the case of
51245 batched SMTP input, it runs after the DATA command has been reached. The
51246 result of this ACL is ignored; it cannot be used to reject a message. If you
51247 really need to, you could set a value in an ACL variable here and reject based
51248 on that in the <option>acl_not_smtp</option> ACL. However, this ACL can be used to set
51249 controls, and in particular, it can be used to set
51250 </para>
51251 <literallayout class="monospaced">
51252 control = suppress_local_fixups
51253 </literallayout>
51254 <para>
51255 This cannot be used in the other non-SMTP ACLs because by the time they are
51256 run, it is too late.
51257 </para>
51258 <para>
51259 The <option>acl_not_smtp_mime</option> ACL is available only when Exim is compiled with the
51260 content-scanning extension. For details, see chapter <xref linkend="CHAPexiscan"/>.
51261 </para>
51262 <para>
51263 The <option>acl_not_smtp</option> ACL is run just before the <function>local_scan()</function> function. Any
51264 kind of rejection is treated as permanent, because there is no way of sending a
51265 temporary error for these kinds of message.
51266 </para>
51267 </section>
51268 <section id="SECID191">
51269 <title>The SMTP connect ACL</title>
51270 <para>
51271 <indexterm role="concept">
51272 <primary>SMTP</primary>
51273 <secondary>connection, ACL for</secondary>
51274 </indexterm>
51275 <indexterm role="option">
51276 <primary><option>smtp_banner</option></primary>
51277 </indexterm>
51278 The ACL test specified by <option>acl_smtp_connect</option> happens at the start of an SMTP
51279 session, after the test specified by <option>host_reject_connection</option> (which is now
51280 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
51281 accepted by an <option>accept</option> verb that has a <option>message</option> modifier, the contents of
51282 the message override the banner message that is otherwise specified by the
51283 <option>smtp_banner</option> option.
51284 </para>
51285 </section>
51286 <section id="SECID192">
51287 <title>The EHLO/HELO ACL</title>
51288 <para>
51289 <indexterm role="concept">
51290 <primary>EHLO</primary>
51291 <secondary>ACL for</secondary>
51292 </indexterm>
51293 <indexterm role="concept">
51294 <primary>HELO</primary>
51295 <secondary>ACL for</secondary>
51296 </indexterm>
51297 The ACL test specified by <option>acl_smtp_helo</option> happens when the client issues an
51298 EHLO or HELO command, after the tests specified by <option>helo_accept_junk_hosts</option>,
51299 <option>helo_allow_chars</option>, <option>helo_verify_hosts</option>, and <option>helo_try_verify_hosts</option>.
51300 Note that a client may issue more than one EHLO or HELO command in an SMTP
51301 session, and indeed is required to issue a new EHLO or HELO after successfully
51302 setting up encryption following a STARTTLS command.
51303 </para>
51304 <para>
51305 If the command is accepted by an <option>accept</option> verb that has a <option>message</option>
51306 modifier, the message may not contain more than one line (it will be truncated
51307 at the first newline and a panic logged if it does). Such a message cannot
51308 affect the EHLO options that are listed on the second and subsequent lines of
51309 an EHLO response.
51310 </para>
51311 </section>
51312 <section id="SECID193">
51313 <title>The DATA ACLs</title>
51314 <para>
51315 <indexterm role="concept">
51316 <primary>DATA</primary>
51317 <secondary>ACLs for</secondary>
51318 </indexterm>
51319 Two ACLs are associated with the DATA command, because it is two-stage
51320 command, with two responses being sent to the client.
51321 When the DATA command is received, the ACL defined by <option>acl_smtp_predata</option>
51322 is obeyed. This gives you control after all the RCPT commands, but before
51323 the message itself is received. It offers the opportunity to give a negative
51324 response to the DATA command before the data is transmitted. Header lines
51325 added by MAIL or RCPT ACLs are not visible at this time, but any that
51326 are defined here are visible when the <option>acl_smtp_data</option> ACL is run.
51327 </para>
51328 <para>
51329 You cannot test the contents of the message, for example, to verify addresses
51330 in the headers, at RCPT time or when the DATA command is received. Such
51331 tests have to appear in the ACL that is run after the message itself has been
51332 received, before the final response to the DATA command is sent. This is
51333 the ACL specified by <option>acl_smtp_data</option>, which is the second ACL that is
51334 associated with the DATA command.
51335 </para>
51336 <para>
51337 For both of these ACLs, it is not possible to reject individual recipients. An
51338 error response rejects the entire message. Unfortunately, it is known that some
51339 MTAs do not treat hard (5<emphasis>xx</emphasis>) responses to the DATA command (either
51340 before or after the data) correctly &ndash; they keep the message on their queues
51341 and try again later, but that is their problem, though it does waste some of
51342 your resources.
51343 </para>
51344 <para>
51345 The <option>acl_smtp_data</option> ACL is run after
51346 the <option>acl_smtp_data_prdr</option>,
51347 the <option>acl_smtp_dkim</option>
51348 and the <option>acl_smtp_mime</option> ACLs.
51349 </para>
51350 </section>
51351 <section id="SECTDKIMACL">
51352 <title>The SMTP DKIM ACL</title>
51353 <para>
51354 The <option>acl_smtp_dkim</option> ACL is available only when Exim is compiled with DKIM support
51355 enabled (which is the default).
51356 </para>
51357 <para>
51358 The ACL test specified by <option>acl_smtp_dkim</option> happens after a message has been
51359 received, and is executed for each DKIM signature found in a message.  If not
51360 otherwise specified, the default action is to accept.
51361 </para>
51362 <para>
51363 This ACL is evaluated before <option>acl_smtp_mime</option> and <option>acl_smtp_data</option>.
51364 </para>
51365 <para>
51366 For details on the operation of DKIM, see chapter <xref linkend="CHAPdkim"/>.
51367 </para>
51368 </section>
51369 <section id="SECID194">
51370 <title>The SMTP MIME ACL</title>
51371 <para>
51372 The <option>acl_smtp_mime</option> option is available only when Exim is compiled with the
51373 content-scanning extension. For details, see chapter <xref linkend="CHAPexiscan"/>.
51374 </para>
51375 <para>
51376 This ACL is evaluated after <option>acl_smtp_dkim</option> but before <option>acl_smtp_data</option>.
51377 </para>
51378 </section>
51379 <section id="SECTPRDRACL">
51380 <title>The SMTP PRDR ACL</title>
51381 <para>
51382 <indexterm role="option">
51383 <primary><option>prdr_enable</option></primary>
51384 </indexterm>
51385 The <option>acl_smtp_data_prdr</option> ACL is available only when Exim is compiled
51386 with PRDR support enabled (which is the default).
51387 It becomes active only when the PRDR feature is negotiated between
51388 client and server for a message, and more than one recipient
51389 has been accepted.
51390 </para>
51391 <para>
51392 The ACL test specfied by <option>acl_smtp_data_prdr</option> happens after a message
51393 has been recieved, and is executed for each recipient of the message.
51394 The test may accept or deny for inividual recipients.
51395 The <option>acl_smtp_data</option> will still be called after this ACL and
51396 can reject the message overall, even if this ACL has accepted it
51397 for some or all recipients.
51398 </para>
51399 <para>
51400 PRDR may be used to support per-user content filtering.  Without it
51401 one must defer any recipient after the first that has a different
51402 content-filter configuration.  With PRDR, the RCPT-time check
51403 for this can be disabled when the MAIL-time $smtp_command included
51404 "PRDR".  Any required difference in behaviour of the main DATA-time
51405 ACL should however depend on the PRDR-time ACL having run, as Exim
51406 will avoid doing so in some situations (eg.  single-recipient mails).
51407 </para>
51408 <para>
51409 See also the <option>prdr_enable</option> global option
51410 and the <option>hosts_try_prdr</option> smtp transport option.
51411 </para>
51412 <para>
51413 This ACL is evaluated after <option>acl_smtp_dkim</option> but before <option>acl_smtp_data</option>.
51414 If the ACL is not defined, processing completes as if
51415 the feature was not requested by the client.
51416 </para>
51417 </section>
51418 <section id="SECTQUITACL">
51419 <title>The QUIT ACL</title>
51420 <para>
51421 <indexterm role="concept">
51422 <primary>QUIT, ACL for</primary>
51423 </indexterm>
51424 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
51425 does not affect the response code to QUIT, which is always 221. Thus, the ACL
51426 does not in fact control any access. For this reason, the only verbs that are
51427 permitted are <option>accept</option> and <option>warn</option>.
51428 </para>
51429 <para>
51430 This ACL can be used for tasks such as custom logging at the end of an SMTP
51431 session. For example, you can use ACL variables in other ACLs to count
51432 messages, recipients, etc., and log the totals at QUIT time using one or
51433 more <option>logwrite</option> modifiers on a <option>warn</option> verb.
51434 </para>
51435 <para>
51436 <emphasis role="bold">Warning</emphasis>: Only the <varname>$acl_c</varname><emphasis>x</emphasis> variables can be used for this, because
51437 the <varname>$acl_m</varname><emphasis>x</emphasis> variables are reset at the end of each incoming message.
51438 </para>
51439 <para>
51440 You do not need to have a final <option>accept</option>, but if you do, you can use a
51441 <option>message</option> modifier to specify custom text that is sent as part of the 221
51442 response to QUIT.
51443 </para>
51444 <para>
51445 This ACL is run only for a <quote>normal</quote> QUIT. For certain kinds of disastrous
51446 failure (for example, failure to open a log file, or when Exim is bombing out
51447 because it has detected an unrecoverable error), all SMTP commands from the
51448 client are given temporary error responses until QUIT is received or the
51449 connection is closed. In these special cases, the QUIT ACL does not run.
51450 </para>
51451 </section>
51452 <section id="SECTNOTQUITACL">
51453 <title>The not-QUIT ACL</title>
51454 <para>
51455 <indexterm role="variable">
51456 <primary><varname>$acl_smtp_notquit</varname></primary>
51457 </indexterm>
51458 The not-QUIT ACL, specified by <option>acl_smtp_notquit</option>, is run in most cases when
51459 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
51460 trouble, such as being unable to write to its log files, this ACL is not run,
51461 because it might try to do things (such as write to log files) that make the
51462 situation even worse.
51463 </para>
51464 <para>
51465 Like the QUIT ACL, this ACL is provided to make it possible to do customized
51466 logging or to gather statistics, and its outcome is ignored. The <option>delay</option>
51467 modifier is forbidden in this ACL, and the only permitted verbs are <option>accept</option>
51468 and <option>warn</option>.
51469 </para>
51470 <para>
51471 <indexterm role="variable">
51472 <primary><varname>$smtp_notquit_reason</varname></primary>
51473 </indexterm>
51474 When the not-QUIT ACL is running, the variable <varname>$smtp_notquit_reason</varname> is set
51475 to a string that indicates the reason for the termination of the SMTP
51476 connection. The possible values are:
51477 </para>
51478 <informaltable frame="none">
51479 <tgroup cols="2" colsep="0" rowsep="0">
51480 <colspec colwidth="196pt" align="left"/>
51481 <colspec colwidth="254pt" align="left"/>
51482 <tbody>
51483 <row>
51484 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<literal>acl-drop</literal></entry>
51485 <entry>Another ACL issued a <option>drop</option> command</entry>
51486 </row>
51487 <row>
51488 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<literal>bad-commands</literal></entry>
51489 <entry>Too many unknown or non-mail commands</entry>
51490 </row>
51491 <row>
51492 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<literal>command-timeout</literal></entry>
51493 <entry>Timeout while reading SMTP commands</entry>
51494 </row>
51495 <row>
51496 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<literal>connection-lost</literal></entry>
51497 <entry>The SMTP connection has been lost</entry>
51498 </row>
51499 <row>
51500 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<literal>data-timeout</literal></entry>
51501 <entry>Timeout while reading message data</entry>
51502 </row>
51503 <row>
51504 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<literal>local-scan-error</literal></entry>
51505 <entry>The <function>local_scan()</function> function crashed</entry>
51506 </row>
51507 <row>
51508 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<literal>local-scan-timeout</literal></entry>
51509 <entry>The <function>local_scan()</function> function timed out</entry>
51510 </row>
51511 <row>
51512 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<literal>signal-exit</literal></entry>
51513 <entry>SIGTERM or SIGINT</entry>
51514 </row>
51515 <row>
51516 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<literal>synchronization-error</literal></entry>
51517 <entry>SMTP synchronization error</entry>
51518 </row>
51519 <row>
51520 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<literal>tls-failed</literal></entry>
51521 <entry>TLS failed to start</entry>
51522 </row>
51523 </tbody>
51524 </tgroup>
51525 </informaltable>
51526 <para>
51527 In most cases when an SMTP connection is closed without having received QUIT,
51528 Exim sends an SMTP response message before actually closing the connection.
51529 With the exception of the <literal>acl-drop</literal> case, the default message can be
51530 overridden by the <option>message</option> modifier in the not-QUIT ACL. In the case of a
51531 <option>drop</option> verb in another ACL, it is the message from the other ACL that is
51532 used.
51533 </para>
51534 </section>
51535 <section id="SECID195">
51536 <title>Finding an ACL to use</title>
51537 <para>
51538 <indexterm role="concept">
51539 <primary>access control lists (ACLs)</primary>
51540 <secondary>finding which to use</secondary>
51541 </indexterm>
51542 The value of an <option>acl_smtp_</option><emphasis>xxx</emphasis> option is expanded before use, so
51543 you can use different ACLs in different circumstances. For example,
51544 </para>
51545 <literallayout class="monospaced">
51546 acl_smtp_rcpt = ${if ={25}{$interface_port} \
51547                      {acl_check_rcpt} {acl_check_rcpt_submit} }
51548 </literallayout>
51549 <para>
51550 In the default configuration file there are some example settings for
51551 providing an RFC 4409 message submission service on port 587 and a
51552 non-standard <quote>smtps</quote> service on port 465. You can use a string
51553 expansion like this to choose an ACL for MUAs on these ports which is
51554 more appropriate for this purpose than the default ACL on port 25.
51555 </para>
51556 <para>
51557 The expanded string does not have to be the name of an ACL in the
51558 configuration file; there are other possibilities. Having expanded the
51559 string, Exim searches for an ACL as follows:
51560 </para>
51561 <itemizedlist>
51562 <listitem>
51563 <para>
51564 If the string begins with a slash, Exim uses it as a file name, and reads its
51565 contents as an ACL. The lines are processed in the same way as lines in the
51566 Exim configuration file. In particular, continuation lines are supported, blank
51567 lines are ignored, as are lines whose first non-whitespace character is <quote>#</quote>.
51568 If the file does not exist or cannot be read, an error occurs (typically
51569 causing a temporary failure of whatever caused the ACL to be run). For example:
51570 </para>
51571 <literallayout class="monospaced">
51572 acl_smtp_data = /etc/acls/\
51573   ${lookup{$sender_host_address}lsearch\
51574   {/etc/acllist}{$value}{default}}
51575 </literallayout>
51576 <para>
51577 This looks up an ACL file to use on the basis of the host&#x2019;s IP address, falling
51578 back to a default if the lookup fails. If an ACL is successfully read from a
51579 file, it is retained in memory for the duration of the Exim process, so that it
51580 can be re-used without having to re-read the file.
51581 </para>
51582 </listitem>
51583 <listitem>
51584 <para>
51585 If the string does not start with a slash, and does not contain any spaces,
51586 Exim searches the ACL section of the configuration for an ACL whose name
51587 matches the string.
51588 </para>
51589 </listitem>
51590 <listitem>
51591 <para>
51592 If no named ACL is found, or if the string contains spaces, Exim parses
51593 the string as an inline ACL. This can save typing in cases where you just
51594 want to have something like
51595 </para>
51596 <literallayout class="monospaced">
51597 acl_smtp_vrfy = accept
51598 </literallayout>
51599 <para>
51600 in order to allow free use of the VRFY command. Such a string may contain
51601 newlines; it is processed in the same way as an ACL that is read from a file.
51602 </para>
51603 </listitem>
51604 </itemizedlist>
51605 </section>
51606 <section id="SECID196">
51607 <title>ACL return codes</title>
51608 <para>
51609 <indexterm role="concept">
51610 <primary>access control lists (ACLs)</primary>
51611 <secondary>return codes</secondary>
51612 </indexterm>
51613 Except for the QUIT ACL, which does not affect the SMTP return code (see
51614 section <xref linkend="SECTQUITACL"/> above), the result of running an ACL is either
51615 <quote>accept</quote> or <quote>deny</quote>, or, if some test cannot be completed (for example, if a
51616 database is down), <quote>defer</quote>. These results cause 2<emphasis>xx</emphasis>, 5<emphasis>xx</emphasis>, and 4<emphasis>xx</emphasis>
51617 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
51618 <quote>error</quote>, occurs when there is an error such as invalid syntax in the ACL.
51619 This also causes a 4<emphasis>xx</emphasis> return code.
51620 </para>
51621 <para>
51622 For the non-SMTP ACL, <quote>defer</quote> and <quote>error</quote> are treated in the same way as
51623 <quote>deny</quote>, because there is no mechanism for passing temporary errors to the
51624 submitters of non-SMTP messages.
51625 </para>
51626 <para>
51627 ACLs that are relevant to message reception may also return <quote>discard</quote>. This
51628 has the effect of <quote>accept</quote>, but causes either the entire message or an
51629 individual recipient address to be discarded. In other words, it is a
51630 blackholing facility. Use it with care.
51631 </para>
51632 <para>
51633 If the ACL for MAIL returns <quote>discard</quote>, all recipients are discarded, and no
51634 ACL is run for subsequent RCPT commands. The effect of <quote>discard</quote> in a
51635 RCPT ACL is to discard just the one recipient address. If there are no
51636 recipients left when the message&#x2019;s data is received, the DATA ACL is not
51637 run. A <quote>discard</quote> return from the DATA or the non-SMTP ACL discards all the
51638 remaining recipients. The <quote>discard</quote> return is not permitted for the
51639 <option>acl_smtp_predata</option> ACL.
51640 </para>
51641 <para>
51642 <indexterm role="concept">
51643 <primary><function>local_scan()</function> function</primary>
51644 <secondary>when all recipients discarded</secondary>
51645 </indexterm>
51646 The <function>local_scan()</function> function is always run, even if there are no remaining
51647 recipients; it may create new recipients.
51648 </para>
51649 </section>
51650 <section id="SECID197">
51651 <title>Unset ACL options</title>
51652 <para>
51653 <indexterm role="concept">
51654 <primary>access control lists (ACLs)</primary>
51655 <secondary>unset options</secondary>
51656 </indexterm>
51657 The default actions when any of the <option>acl_</option><emphasis>xxx</emphasis> options are unset are not
51658 all the same. <emphasis role="bold">Note</emphasis>: These defaults apply only when the relevant ACL is
51659 not defined at all. For any defined ACL, the default action when control
51660 reaches the end of the ACL statements is <quote>deny</quote>.
51661 </para>
51662 <para>
51663 For <option>acl_smtp_quit</option> and <option>acl_not_smtp_start</option> there is no default because
51664 these two are ACLs that are used only for their side effects. They cannot be
51665 used to accept or reject anything.
51666 </para>
51667 <para>
51668 For <option>acl_not_smtp</option>, <option>acl_smtp_auth</option>, <option>acl_smtp_connect</option>,
51669 <option>acl_smtp_data</option>, <option>acl_smtp_helo</option>, <option>acl_smtp_mail</option>, <option>acl_smtp_mailauth</option>,
51670 <option>acl_smtp_mime</option>, <option>acl_smtp_predata</option>, and <option>acl_smtp_starttls</option>, the action
51671 when the ACL is not defined is <quote>accept</quote>.
51672 </para>
51673 <para>
51674 For the others (<option>acl_smtp_etrn</option>, <option>acl_smtp_expn</option>, <option>acl_smtp_rcpt</option>, and
51675 <option>acl_smtp_vrfy</option>), the action when the ACL is not defined is <quote>deny</quote>.
51676 This means that <option>acl_smtp_rcpt</option> must be defined in order to receive any
51677 messages over an SMTP connection. For an example, see the ACL in the default
51678 configuration file.
51679 </para>
51680 </section>
51681 <section id="SECID198">
51682 <title>Data for message ACLs</title>
51683 <para>
51684 <indexterm role="concept">
51685 <primary>access control lists (ACLs)</primary>
51686 <secondary>data for message ACL</secondary>
51687 </indexterm>
51688 <indexterm role="variable">
51689 <primary><varname>$domain</varname></primary>
51690 </indexterm>
51691 <indexterm role="variable">
51692 <primary><varname>$local_part</varname></primary>
51693 </indexterm>
51694 <indexterm role="variable">
51695 <primary><varname>$sender_address</varname></primary>
51696 </indexterm>
51697 <indexterm role="variable">
51698 <primary><varname>$sender_host_address</varname></primary>
51699 </indexterm>
51700 <indexterm role="variable">
51701 <primary><varname>$smtp_command</varname></primary>
51702 </indexterm>
51703 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
51704 that contain information about the host and the message&#x2019;s sender (for example,
51705 <varname>$sender_host_address</varname> and <varname>$sender_address</varname>) are set, and can be used in ACL
51706 statements. In the case of RCPT (but not MAIL or DATA), <varname>$domain</varname> and
51707 <varname>$local_part</varname> are set from the argument address. The entire SMTP command
51708 is available in <varname>$smtp_command</varname>.
51709 </para>
51710 <para>
51711 When an ACL for the AUTH parameter of MAIL is running, the variables that
51712 contain information about the host are set, but <varname>$sender_address</varname> is not yet
51713 set. Section <xref linkend="SECTauthparamail"/> contains a discussion of this parameter and
51714 how it is used.
51715 </para>
51716 <para>
51717 <indexterm role="variable">
51718 <primary><varname>$message_size</varname></primary>
51719 </indexterm>
51720 The <varname>$message_size</varname> variable is set to the value of the SIZE parameter on
51721 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
51722 that parameter is not given. The value is updated to the true message size by
51723 the time the final DATA ACL is run (after the message data has been
51724 received).
51725 </para>
51726 <para>
51727 <indexterm role="variable">
51728 <primary><varname>$rcpt_count</varname></primary>
51729 </indexterm>
51730 <indexterm role="variable">
51731 <primary><varname>$recipients_count</varname></primary>
51732 </indexterm>
51733 The <varname>$rcpt_count</varname> variable increases by one for each RCPT command received.
51734 The <varname>$recipients_count</varname> variable increases by one each time a RCPT command is
51735 accepted, so while an ACL for RCPT is being processed, it contains the number
51736 of previously accepted recipients. At DATA time (for both the DATA ACLs),
51737 <varname>$rcpt_count</varname> contains the total number of RCPT commands, and
51738 <varname>$recipients_count</varname> contains the total number of accepted recipients.
51739 </para>
51740 </section>
51741 <section id="SECTdatfornon">
51742 <title>Data for non-message ACLs</title>
51743 <para>
51744 <indexterm role="concept">
51745 <primary>access control lists (ACLs)</primary>
51746 <secondary>data for non-message ACL</secondary>
51747 </indexterm>
51748 <indexterm role="variable">
51749 <primary><varname>$smtp_command_argument</varname></primary>
51750 </indexterm>
51751 <indexterm role="variable">
51752 <primary><varname>$smtp_command</varname></primary>
51753 </indexterm>
51754 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
51755 the remainder of the SMTP command line is placed in <varname>$smtp_command_argument</varname>,
51756 and the entire SMTP command is available in <varname>$smtp_command</varname>.
51757 These variables can be tested using a <option>condition</option> condition. For example,
51758 here is an ACL for use with AUTH, which insists that either the session is
51759 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
51760 does not permit authentication methods that use cleartext passwords on
51761 unencrypted connections.
51762 </para>
51763 <literallayout class="monospaced">
51764 acl_check_auth:
51765   accept encrypted = *
51766   accept condition = ${if eq{${uc:$smtp_command_argument}}\
51767                      {CRAM-MD5}}
51768   deny   message   = TLS encryption or CRAM-MD5 required
51769 </literallayout>
51770 <para>
51771 (Another way of applying this restriction is to arrange for the authenticators
51772 that use cleartext passwords not to be advertised when the connection is not
51773 encrypted. You can use the generic <option>server_advertise_condition</option> authenticator
51774 option to do this.)
51775 </para>
51776 </section>
51777 <section id="SECID199">
51778 <title>Format of an ACL</title>
51779 <para>
51780 <indexterm role="concept">
51781 <primary>access control lists (ACLs)</primary>
51782 <secondary>format of</secondary>
51783 </indexterm>
51784 <indexterm role="concept">
51785 <primary>access control lists (ACLs)</primary>
51786 <secondary>verbs, definition of</secondary>
51787 </indexterm>
51788 An individual ACL consists of a number of statements. Each statement starts
51789 with a verb, optionally followed by a number of conditions and <quote>modifiers</quote>.
51790 Modifiers can change the way the verb operates, define error and log messages,
51791 set variables, insert delays, and vary the processing of accepted messages.
51792 </para>
51793 <para>
51794 If all the conditions are met, the verb is obeyed. The same condition may be
51795 used (with different arguments) more than once in the same statement. This
51796 provides a means of specifying an <quote>and</quote> conjunction between conditions. For
51797 example:
51798 </para>
51799 <literallayout class="monospaced">
51800 deny  dnslists = list1.example
51801 dnslists = list2.example
51802 </literallayout>
51803 <para>
51804 If there are no conditions, the verb is always obeyed. Exim stops evaluating
51805 the conditions and modifiers when it reaches a condition that fails. What
51806 happens then depends on the verb (and in one case, on a special modifier). Not
51807 all the conditions make sense at every testing point. For example, you cannot
51808 test a sender address in the ACL that is run for a VRFY command.
51809 </para>
51810 </section>
51811 <section id="SECID200">
51812 <title>ACL verbs</title>
51813 <para>
51814 The ACL verbs are as follows:
51815 </para>
51816 <itemizedlist>
51817 <listitem>
51818 <para>
51819 <indexterm role="concept">
51820 <primary><option>accept</option> ACL verb</primary>
51821 </indexterm>
51822 <option>accept</option>: If all the conditions are met, the ACL returns <quote>accept</quote>. If any
51823 of the conditions are not met, what happens depends on whether <option>endpass</option>
51824 appears among the conditions (for syntax see below). If the failing condition
51825 is before <option>endpass</option>, control is passed to the next ACL statement; if it is
51826 after <option>endpass</option>, the ACL returns <quote>deny</quote>. Consider this statement, used to
51827 check a RCPT command:
51828 </para>
51829 <literallayout class="monospaced">
51830 accept domains = +local_domains
51831 endpass
51832 verify = recipient
51833 </literallayout>
51834 <para>
51835 If the recipient domain does not match the <option>domains</option> condition, control
51836 passes to the next statement. If it does match, the recipient is verified, and
51837 the command is accepted if verification succeeds. However, if verification
51838 fails, the ACL yields <quote>deny</quote>, because the failing condition is after
51839 <option>endpass</option>.
51840 </para>
51841 <para>
51842 The <option>endpass</option> feature has turned out to be confusing to many people, so its
51843 use is not recommended nowadays. It is always possible to rewrite an ACL so
51844 that <option>endpass</option> is not needed, and it is no longer used in the default
51845 configuration.
51846 </para>
51847 <para>
51848 <indexterm role="concept">
51849 <primary><option>message</option> ACL modifier</primary>
51850 <secondary>with <option>accept</option></secondary>
51851 </indexterm>
51852 If a <option>message</option> modifier appears on an <option>accept</option> statement, its action
51853 depends on whether or not <option>endpass</option> is present. In the absence of <option>endpass</option>
51854 (when an <option>accept</option> verb either accepts or passes control to the next
51855 statement), <option>message</option> can be used to vary the message that is sent when an
51856 SMTP command is accepted. For example, in a RCPT ACL you could have:
51857 </para>
51858 <literallayout>
51859 <literal>accept  </literal>&lt;<emphasis>some conditions</emphasis>&gt;
51860 <literal>        message = OK, I will allow you through today</literal>
51861 </literallayout>
51862 <para>
51863 You can specify an SMTP response code, optionally followed by an <quote>extended
51864 response code</quote> at the start of the message, but the first digit must be the
51865 same as would be sent by default, which is 2 for an <option>accept</option> verb.
51866 </para>
51867 <para>
51868 If <option>endpass</option> is present in an <option>accept</option> statement, <option>message</option> specifies
51869 an error message that is used when access is denied. This behaviour is retained
51870 for backward compatibility, but current <quote>best practice</quote> is to avoid the use
51871 of <option>endpass</option>.
51872 </para>
51873 </listitem>
51874 <listitem>
51875 <para>
51876 <indexterm role="concept">
51877 <primary><option>defer</option> ACL verb</primary>
51878 </indexterm>
51879 <option>defer</option>: If all the conditions are true, the ACL returns <quote>defer</quote> which, in
51880 an SMTP session, causes a 4<emphasis>xx</emphasis> response to be given. For a non-SMTP ACL,
51881 <option>defer</option> is the same as <option>deny</option>, because there is no way of sending a
51882 temporary error. For a RCPT command, <option>defer</option> is much the same as using a
51883 <command>redirect</command> router and <literal>:defer:</literal> while verifying, but the <option>defer</option> verb can
51884 be used in any ACL, and even for a recipient it might be a simpler approach.
51885 </para>
51886 </listitem>
51887 <listitem>
51888 <para>
51889 <indexterm role="concept">
51890 <primary><option>deny</option> ACL verb</primary>
51891 </indexterm>
51892 <option>deny</option>: If all the conditions are met, the ACL returns <quote>deny</quote>. If any of
51893 the conditions are not met, control is passed to the next ACL statement. For
51894 example,
51895 </para>
51896 <literallayout class="monospaced">
51897 deny dnslists = blackholes.mail-abuse.org
51898 </literallayout>
51899 <para>
51900 rejects commands from hosts that are on a DNS black list.
51901 </para>
51902 </listitem>
51903 <listitem>
51904 <para>
51905 <indexterm role="concept">
51906 <primary><option>discard</option> ACL verb</primary>
51907 </indexterm>
51908 <option>discard</option>: This verb behaves like <option>accept</option>, except that it returns
51909 <quote>discard</quote> from the ACL instead of <quote>accept</quote>. It is permitted only on ACLs
51910 that are concerned with receiving messages. When all the conditions are true,
51911 the sending entity receives a <quote>success</quote> response. However, <option>discard</option> causes
51912 recipients to be discarded. If it is used in an ACL for RCPT, just the one
51913 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
51914 message&#x2019;s recipients are discarded. Recipients that are discarded before DATA
51915 do not appear in the log line when the <option>received_recipients</option> log selector is set.
51916 </para>
51917 <para>
51918 If the <option>log_message</option> modifier is set when <option>discard</option> operates,
51919 its contents are added to the line that is automatically written to the log.
51920 The <option>message</option> modifier operates exactly as it does for <option>accept</option>.
51921 </para>
51922 </listitem>
51923 <listitem>
51924 <para>
51925 <indexterm role="concept">
51926 <primary><option>drop</option> ACL verb</primary>
51927 </indexterm>
51928 <option>drop</option>: This verb behaves like <option>deny</option>, except that an SMTP connection is
51929 forcibly closed after the 5<emphasis>xx</emphasis> error message has been sent. For example:
51930 </para>
51931 <literallayout class="monospaced">
51932 drop   message   = I don't take more than 20 RCPTs
51933        condition = ${if &gt; {$rcpt_count}{20}}
51934 </literallayout>
51935 <para>
51936 There is no difference between <option>deny</option> and <option>drop</option> for the connect-time ACL.
51937 The connection is always dropped after sending a 550 response.
51938 </para>
51939 </listitem>
51940 <listitem>
51941 <para>
51942 <indexterm role="concept">
51943 <primary><option>require</option> ACL verb</primary>
51944 </indexterm>
51945 <option>require</option>: If all the conditions are met, control is passed to the next ACL
51946 statement. If any of the conditions are not met, the ACL returns <quote>deny</quote>. For
51947 example, when checking a RCPT command,
51948 </para>
51949 <literallayout class="monospaced">
51950 require message = Sender did not verify
51951         verify  = sender
51952 </literallayout>
51953 <para>
51954 passes control to subsequent statements only if the message&#x2019;s sender can be
51955 verified. Otherwise, it rejects the command. Note the positioning of the
51956 <option>message</option> modifier, before the <option>verify</option> condition. The reason for this is
51957 discussed in section <xref linkend="SECTcondmodproc"/>.
51958 </para>
51959 </listitem>
51960 <listitem>
51961 <para>
51962 <indexterm role="concept">
51963 <primary><option>warn</option> ACL verb</primary>
51964 </indexterm>
51965 <option>warn</option>: If all the conditions are true, a line specified by the
51966 <option>log_message</option> modifier is written to Exim&#x2019;s main log. Control always passes
51967 to the next ACL statement. If any condition is false, the log line is not
51968 written. If an identical log line is requested several times in the same
51969 message, only one copy is actually written to the log. If you want to force
51970 duplicates to be written, use the <option>logwrite</option> modifier instead.
51971 </para>
51972 <para>
51973 If <option>log_message</option> is not present, a <option>warn</option> verb just checks its conditions
51974 and obeys any <quote>immediate</quote> modifiers (such as <option>control</option>, <option>set</option>,
51975 <option>logwrite</option>, <option>add_header</option>, and <option>remove_header</option>) that appear before the
51976 first failing condition. There is more about adding header lines in section
51977 <xref linkend="SECTaddheadacl"/>.
51978 </para>
51979 <para>
51980 If any condition on a <option>warn</option> statement cannot be completed (that is, there is
51981 some sort of defer), the log line specified by <option>log_message</option> is not written.
51982 This does not include the case of a forced failure from a lookup, which
51983 is considered to be a successful completion. After a defer, no further
51984 conditions or modifiers in the <option>warn</option> statement are processed. The incident
51985 is logged, and the ACL continues to be processed, from the next statement
51986 onwards.
51987 </para>
51988 <para>
51989 <indexterm role="variable">
51990 <primary><varname>$acl_verify_message</varname></primary>
51991 </indexterm>
51992 When one of the <option>warn</option> conditions is an address verification that fails, the
51993 text of the verification failure message is in <varname>$acl_verify_message</varname>. If you
51994 want this logged, you must set it up explicitly. For example:
51995 </para>
51996 <literallayout class="monospaced">
51997 warn   !verify = sender
51998        log_message = sender verify failed: $acl_verify_message
51999 </literallayout>
52000 </listitem>
52001 </itemizedlist>
52002 <para>
52003 At the end of each ACL there is an implicit unconditional <option>deny</option>.
52004 </para>
52005 <para>
52006 As you can see from the examples above, the conditions and modifiers are
52007 written one to a line, with the first one on the same line as the verb, and
52008 subsequent ones on following lines. If you have a very long condition, you can
52009 continue it onto several physical lines by the usual backslash continuation
52010 mechanism. It is conventional to align the conditions vertically.
52011 </para>
52012 </section>
52013 <section id="SECTaclvariables">
52014 <title>ACL variables</title>
52015 <para>
52016 <indexterm role="concept">
52017 <primary>access control lists (ACLs)</primary>
52018 <secondary>variables</secondary>
52019 </indexterm>
52020 There are some special variables that can be set during ACL processing. They
52021 can be used to pass information between different ACLs, different invocations
52022 of the same ACL in the same SMTP connection, and between ACLs and the routers,
52023 transports, and filters that are used to deliver a message. The names of these
52024 variables must begin with <varname>$acl_c</varname> or <varname>$acl_m</varname>, followed either by a digit or
52025 an underscore, but the remainder of the name can be any sequence of
52026 alphanumeric characters and underscores that you choose. There is no limit on
52027 the number of ACL variables. The two sets act as follows:
52028 </para>
52029 <itemizedlist>
52030 <listitem>
52031 <para>
52032 The values of those variables whose names begin with <varname>$acl_c</varname> persist
52033 throughout an SMTP connection. They are never reset. Thus, a value that is set
52034 while receiving one message is still available when receiving the next message
52035 on the same SMTP connection.
52036 </para>
52037 </listitem>
52038 <listitem>
52039 <para>
52040 The values of those variables whose names begin with <varname>$acl_m</varname> persist only
52041 while a message is being received. They are reset afterwards. They are also
52042 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
52043 </para>
52044 </listitem>
52045 </itemizedlist>
52046 <para>
52047 When a message is accepted, the current values of all the ACL variables are
52048 preserved with the message and are subsequently made available at delivery
52049 time. The ACL variables are set by a modifier called <option>set</option>. For example:
52050 </para>
52051 <literallayout class="monospaced">
52052 accept hosts = whatever
52053        set acl_m4 = some value
52054 accept authenticated = *
52055        set acl_c_auth = yes
52056 </literallayout>
52057 <para>
52058 <emphasis role="bold">Note</emphasis>: A leading dollar sign is not used when naming a variable that is to
52059 be set. If you want to set a variable without taking any action, you can use a
52060 <option>warn</option> verb without any other modifiers or conditions.
52061 </para>
52062 <para>
52063 <indexterm role="option">
52064 <primary><option>strict_acl_vars</option></primary>
52065 </indexterm>
52066 What happens if a syntactically valid but undefined ACL variable is
52067 referenced depends on the setting of the <option>strict_acl_vars</option> option. If it is
52068 false (the default), an empty string is substituted; if it is true, an
52069 error is generated.
52070 </para>
52071 <para>
52072 Versions of Exim before 4.64 have a limited set of numbered variables, but
52073 their names are compatible, so there is no problem with upgrading.
52074 </para>
52075 </section>
52076 <section id="SECTcondmodproc">
52077 <title>Condition and modifier processing</title>
52078 <para>
52079 <indexterm role="concept">
52080 <primary>access control lists (ACLs)</primary>
52081 <secondary>conditions; processing</secondary>
52082 </indexterm>
52083 <indexterm role="concept">
52084 <primary>access control lists (ACLs)</primary>
52085 <secondary>modifiers; processing</secondary>
52086 </indexterm>
52087 An exclamation mark preceding a condition negates its result. For example:
52088 </para>
52089 <literallayout class="monospaced">
52090 deny   domains = *.dom.example
52091       !verify  = recipient
52092 </literallayout>
52093 <para>
52094 causes the ACL to return <quote>deny</quote> if the recipient domain ends in
52095 <emphasis>dom.example</emphasis> and the recipient address cannot be verified. Sometimes
52096 negation can be used on the right-hand side of a condition. For example, these
52097 two statements are equivalent:
52098 </para>
52099 <literallayout class="monospaced">
52100 deny  hosts = !192.168.3.4
52101 deny !hosts =  192.168.3.4
52102 </literallayout>
52103 <para>
52104 However, for many conditions (<option>verify</option> being a good example), only left-hand
52105 side negation of the whole condition is possible.
52106 </para>
52107 <para>
52108 The arguments of conditions and modifiers are expanded. A forced failure
52109 of an expansion causes a condition to be ignored, that is, it behaves as if the
52110 condition is true. Consider these two statements:
52111 </para>
52112 <literallayout class="monospaced">
52113 accept  senders = ${lookup{$host_name}lsearch\
52114                   {/some/file}{$value}fail}
52115 accept  senders = ${lookup{$host_name}lsearch\
52116                   {/some/file}{$value}{}}
52117 </literallayout>
52118 <para>
52119 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
52120 the returned list is searched, but if the lookup fails the behaviour is
52121 different in the two cases. The <option>fail</option> in the first statement causes the
52122 condition to be ignored, leaving no further conditions. The <option>accept</option> verb
52123 therefore succeeds. The second statement, however, generates an empty list when
52124 the lookup fails. No sender can match an empty list, so the condition fails,
52125 and therefore the <option>accept</option> also fails.
52126 </para>
52127 <para>
52128 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
52129 specify actions that are taken as the conditions for a statement are checked;
52130 others specify text for messages that are used when access is denied or a
52131 warning is generated. The <option>control</option> modifier affects the way an incoming
52132 message is handled.
52133 </para>
52134 <para>
52135 The positioning of the modifiers in an ACL statement is important, because the
52136 processing of a verb ceases as soon as its outcome is known. Only those
52137 modifiers that have already been encountered will take effect. For example,
52138 consider this use of the <option>message</option> modifier:
52139 </para>
52140 <literallayout class="monospaced">
52141 require message = Can't verify sender
52142         verify  = sender
52143         message = Can't verify recipient
52144         verify  = recipient
52145         message = This message cannot be used
52146 </literallayout>
52147 <para>
52148 If sender verification fails, Exim knows that the result of the statement is
52149 <quote>deny</quote>, so it goes no further. The first <option>message</option> modifier has been seen,
52150 so its text is used as the error message. If sender verification succeeds, but
52151 recipient verification fails, the second message is used. If recipient
52152 verification succeeds, the third message becomes <quote>current</quote>, but is never used
52153 because there are no more conditions to cause failure.
52154 </para>
52155 <para>
52156 For the <option>deny</option> verb, on the other hand, it is always the last <option>message</option>
52157 modifier that is used, because all the conditions must be true for rejection to
52158 happen. Specifying more than one <option>message</option> modifier does not make sense, and
52159 the message can even be specified after all the conditions. For example:
52160 </para>
52161 <literallayout class="monospaced">
52162 deny   hosts = ...
52163       !senders = *@my.domain.example
52164        message = Invalid sender from client host
52165 </literallayout>
52166 <para>
52167 The <quote>deny</quote> result does not happen until the end of the statement is reached,
52168 by which time Exim has set up the message.
52169 </para>
52170 </section>
52171 <section id="SECTACLmodi">
52172 <title>ACL modifiers</title>
52173 <para>
52174 <indexterm role="concept">
52175 <primary>access control lists (ACLs)</primary>
52176 <secondary>modifiers; list of</secondary>
52177 </indexterm>
52178 The ACL modifiers are as follows:
52179 </para>
52180 <variablelist>
52181 <varlistentry>
52182 <term><emphasis role="bold">add_header</emphasis>&nbsp;=&nbsp;&lt;<emphasis>text</emphasis>&gt;</term>
52183 <listitem>
52184 <para>
52185 This modifier specifies one or more header lines that are to be added to an
52186 incoming message, assuming, of course, that the message is ultimately
52187 accepted. For details, see section <xref linkend="SECTaddheadacl"/>.
52188 </para>
52189 </listitem></varlistentry>
52190 <varlistentry>
52191 <term><emphasis role="bold">continue</emphasis>&nbsp;=&nbsp;&lt;<emphasis>text</emphasis>&gt;</term>
52192 <listitem>
52193 <para>
52194 <indexterm role="concept">
52195 <primary><option>continue</option> ACL modifier</primary>
52196 </indexterm>
52197 <indexterm role="concept">
52198 <primary>database</primary>
52199 <secondary>updating in ACL</secondary>
52200 </indexterm>
52201 This modifier does nothing of itself, and processing of the ACL always
52202 continues with the next condition or modifier. The value of <option>continue</option> is in
52203 the side effects of expanding its argument. Typically this could be used to
52204 update a database. It is really just a syntactic tidiness, to avoid having to
52205 write rather ugly lines like this:
52206 </para>
52207 <literallayout>
52208 <literal>condition = ${if eq{0}{</literal>&lt;<emphasis>some expansion</emphasis>&gt;<literal>}{true}{true}}</literal>
52209 </literallayout>
52210 <para>
52211 Instead, all you need is
52212 </para>
52213 <literallayout>
52214 <literal>continue = </literal>&lt;<emphasis>some expansion</emphasis>&gt;
52215 </literallayout>
52216 </listitem></varlistentry>
52217 <varlistentry>
52218 <term><emphasis role="bold">control</emphasis>&nbsp;=&nbsp;&lt;<emphasis>text</emphasis>&gt;</term>
52219 <listitem>
52220 <para>
52221 <indexterm role="concept">
52222 <primary><option>control</option> ACL modifier</primary>
52223 </indexterm>
52224 This modifier affects the subsequent processing of the SMTP connection or of an
52225 incoming message that is accepted. The effect of the first type of control
52226 lasts for the duration of the connection, whereas the effect of the second type
52227 lasts only until the current message has been received. The message-specific
52228 controls always apply to the whole message, not to individual recipients,
52229 even if the <option>control</option> modifier appears in a RCPT ACL.
52230 </para>
52231 <para>
52232 As there are now quite a few controls that can be applied, they are described
52233 separately in section <xref linkend="SECTcontrols"/>. The <option>control</option> modifier can be used
52234 in several different ways. For example:
52235 </para>
52236 <itemizedlist>
52237 <listitem>
52238 <para>
52239 It can be at the end of an <option>accept</option> statement:
52240 </para>
52241 <literallayout class="monospaced">
52242     accept  ...some conditions
52243             control = queue_only
52244 </literallayout>
52245 <para>
52246 In this case, the control is applied when this statement yields <quote>accept</quote>, in
52247 other words, when the conditions are all true.
52248 </para>
52249 </listitem>
52250 <listitem>
52251 <para>
52252 It can be in the middle of an <option>accept</option> statement:
52253 </para>
52254 <literallayout class="monospaced">
52255     accept  ...some conditions...
52256             control = queue_only
52257             ...some more conditions...
52258 </literallayout>
52259 <para>
52260 If the first set of conditions are true, the control is applied, even if the
52261 statement does not accept because one of the second set of conditions is false.
52262 In this case, some subsequent statement must yield <quote>accept</quote> for the control
52263 to be relevant.
52264 </para>
52265 </listitem>
52266 <listitem>
52267 <para>
52268 It can be used with <option>warn</option> to apply the control, leaving the
52269 decision about accepting or denying to a subsequent verb. For
52270 example:
52271 </para>
52272 <literallayout class="monospaced">
52273     warn    ...some conditions...
52274             control = freeze
52275     accept  ...
52276 </literallayout>
52277 <para>
52278 This example of <option>warn</option> does not contain <option>message</option>, <option>log_message</option>, or
52279 <option>logwrite</option>, so it does not add anything to the message and does not write a
52280 log entry.
52281 </para>
52282 </listitem>
52283 <listitem>
52284 <para>
52285 If you want to apply a control unconditionally, you can use it with a
52286 <option>require</option> verb. For example:
52287 </para>
52288 <literallayout class="monospaced">
52289     require  control = no_multiline_responses
52290 </literallayout>
52291 </listitem>
52292 </itemizedlist>
52293 </listitem></varlistentry>
52294 <varlistentry>
52295 <term><emphasis role="bold">delay</emphasis>&nbsp;=&nbsp;&lt;<emphasis>time</emphasis>&gt;</term>
52296 <listitem>
52297 <para>
52298 <indexterm role="concept">
52299 <primary><option>delay</option> ACL modifier</primary>
52300 </indexterm>
52301 <indexterm role="option">
52302 <primary><option>-bh</option></primary>
52303 </indexterm>
52304 This modifier may appear in any ACL except notquit. It causes Exim to wait for
52305 the time interval before proceeding. However, when testing Exim using the
52306 <option>-bh</option> option, the delay is not actually imposed (an appropriate message is
52307 output instead). The time is given in the usual Exim notation, and the delay
52308 happens as soon as the modifier is processed. In an SMTP session, pending
52309 output is flushed before the delay is imposed.
52310 </para>
52311 <para>
52312 Like <option>control</option>, <option>delay</option> can be used with <option>accept</option> or <option>deny</option>, for
52313 example:
52314 </para>
52315 <literallayout class="monospaced">
52316 deny    ...some conditions...
52317         delay = 30s
52318 </literallayout>
52319 <para>
52320 The delay happens if all the conditions are true, before the statement returns
52321 <quote>deny</quote>. Compare this with:
52322 </para>
52323 <literallayout class="monospaced">
52324 deny    delay = 30s
52325         ...some conditions...
52326 </literallayout>
52327 <para>
52328 which waits for 30s before processing the conditions. The <option>delay</option> modifier
52329 can also be used with <option>warn</option> and together with <option>control</option>:
52330 </para>
52331 <literallayout class="monospaced">
52332 warn    ...some conditions...
52333         delay = 2m
52334         control = freeze
52335 accept  ...
52336 </literallayout>
52337 <para>
52338 If <option>delay</option> is encountered when the SMTP PIPELINING extension is in use,
52339 responses to several commands are no longer buffered and sent in one packet (as
52340 they would normally be) because all output is flushed before imposing the
52341 delay. This optimization is disabled so that a number of small delays do not
52342 appear to the client as one large aggregated delay that might provoke an
52343 unwanted timeout. You can, however, disable output flushing for <option>delay</option> by
52344 using a <option>control</option> modifier to set <option>no_delay_flush</option>.
52345 </para>
52346 </listitem></varlistentry>
52347 <varlistentry>
52348 <term><emphasis role="bold">endpass</emphasis></term>
52349 <listitem>
52350 <para>
52351 <indexterm role="concept">
52352 <primary><option>endpass</option> ACL modifier</primary>
52353 </indexterm>
52354 This modifier, which has no argument, is recognized only in <option>accept</option> and
52355 <option>discard</option> statements. It marks the boundary between the conditions whose
52356 failure causes control to pass to the next statement, and the conditions whose
52357 failure causes the ACL to return <quote>deny</quote>. This concept has proved to be
52358 confusing to some people, so the use of <option>endpass</option> is no longer recommended as
52359 <quote>best practice</quote>. See the description of <option>accept</option> above for more details.
52360 </para>
52361 </listitem></varlistentry>
52362 <varlistentry>
52363 <term><emphasis role="bold">log_message</emphasis>&nbsp;=&nbsp;&lt;<emphasis>text</emphasis>&gt;</term>
52364 <listitem>
52365 <para>
52366 <indexterm role="concept">
52367 <primary><option>log_message</option> ACL modifier</primary>
52368 </indexterm>
52369 This modifier sets up a message that is used as part of the log message if the
52370 ACL denies access or a <option>warn</option> statement&#x2019;s conditions are true. For example:
52371 </para>
52372 <literallayout class="monospaced">
52373 require log_message = wrong cipher suite $tls_in_cipher
52374         encrypted   = DES-CBC3-SHA
52375 </literallayout>
52376 <para>
52377 <option>log_message</option> is also used when recipients are discarded by <option>discard</option>. For
52378 example:
52379 </para>
52380 <literallayout>
52381 <literal>discard </literal>&lt;<emphasis>some conditions</emphasis>&gt;
52382 <literal>        log_message = Discarded $local_part@$domain because...</literal>
52383 </literallayout>
52384 <para>
52385 When access is denied, <option>log_message</option> adds to any underlying error message
52386 that may exist because of a condition failure. For example, while verifying a
52387 recipient address, a <emphasis>:fail:</emphasis> redirection might have already set up a
52388 message.
52389 </para>
52390 <para>
52391 The message may be defined before the conditions to which it applies, because
52392 the string expansion does not happen until Exim decides that access is to be
52393 denied. This means that any variables that are set by the condition are
52394 available for inclusion in the message. For example, the <varname>$dnslist_</varname>&lt;<emphasis>xxx</emphasis>&gt;
52395 variables are set after a DNS black list lookup succeeds. If the expansion of
52396 <option>log_message</option> fails, or if the result is an empty string, the modifier is
52397 ignored.
52398 </para>
52399 <para>
52400 <indexterm role="variable">
52401 <primary><varname>$acl_verify_message</varname></primary>
52402 </indexterm>
52403 If you want to use a <option>warn</option> statement to log the result of an address
52404 verification, you can use <varname>$acl_verify_message</varname> to include the verification
52405 error message.
52406 </para>
52407 <para>
52408 If <option>log_message</option> is used with a <option>warn</option> statement, <quote>Warning:</quote> is added to
52409 the start of the logged message. If the same warning log message is requested
52410 more than once while receiving  a single email message, only one copy is
52411 actually logged. If you want to log multiple copies, use <option>logwrite</option> instead
52412 of <option>log_message</option>. In the absence of <option>log_message</option> and <option>logwrite</option>, nothing
52413 is logged for a successful <option>warn</option> statement.
52414 </para>
52415 <para>
52416 If <option>log_message</option> is not present and there is no underlying error message (for
52417 example, from the failure of address verification), but <option>message</option> is present,
52418 the <option>message</option> text is used for logging rejections. However, if any text for
52419 logging contains newlines, only the first line is logged. In the absence of
52420 both <option>log_message</option> and <option>message</option>, a default built-in message is used for
52421 logging rejections.
52422 </para>
52423 </listitem></varlistentry>
52424 <varlistentry>
52425 <term><emphasis role="bold">log_reject_target</emphasis>&nbsp;=&nbsp;&lt;<emphasis>log name list</emphasis>&gt;</term>
52426 <listitem>
52427 <para>
52428 <indexterm role="concept">
52429 <primary><option>log_reject_target</option> ACL modifier</primary>
52430 </indexterm>
52431 <indexterm role="concept">
52432 <primary>logging in ACL</primary>
52433 <secondary>specifying which log</secondary>
52434 </indexterm>
52435 This modifier makes it possible to specify which logs are used for messages
52436 about ACL rejections. Its argument is a colon-separated list of words that can
52437 be <quote>main</quote>, <quote>reject</quote>, or <quote>panic</quote>. The default is <literal>main:reject</literal>. The list
52438 may be empty, in which case a rejection is not logged at all. For example, this
52439 ACL fragment writes no logging information when access is denied:
52440 </para>
52441 <literallayout>
52442 <literal>deny </literal>&lt;<emphasis>some conditions</emphasis>&gt;
52443 <literal>     log_reject_target =</literal>
52444 </literallayout>
52445 <para>
52446 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
52447 permanent and temporary rejections. Its effect lasts for the rest of the
52448 current ACL.
52449 </para>
52450 </listitem></varlistentry>
52451 <varlistentry>
52452 <term><emphasis role="bold">logwrite</emphasis>&nbsp;=&nbsp;&lt;<emphasis>text</emphasis>&gt;</term>
52453 <listitem>
52454 <para>
52455 <indexterm role="concept">
52456 <primary><option>logwrite</option> ACL modifier</primary>
52457 </indexterm>
52458 <indexterm role="concept">
52459 <primary>logging in ACL</primary>
52460 <secondary>immediate</secondary>
52461 </indexterm>
52462 This modifier writes a message to a log file as soon as it is encountered when
52463 processing an ACL. (Compare <option>log_message</option>, which, except in the case of
52464 <option>warn</option> and <option>discard</option>, is used only if the ACL statement denies
52465 access.) The <option>logwrite</option> modifier can be used to log special incidents in
52466 ACLs. For example:
52467 </para>
52468 <literallayout>
52469 <literal>accept </literal>&lt;<emphasis>some special conditions</emphasis>&gt;
52470 <literal>       control  = freeze</literal>
52471 <literal>       logwrite = froze message because ...</literal>
52472 </literallayout>
52473 <para>
52474 By default, the message is written to the main log. However, it may begin
52475 with a colon, followed by a comma-separated list of log names, and then
52476 another colon, to specify exactly which logs are to be written. For
52477 example:
52478 </para>
52479 <literallayout class="monospaced">
52480 logwrite = :main,reject: text for main and reject logs
52481 logwrite = :panic: text for panic log only
52482 </literallayout>
52483 </listitem></varlistentry>
52484 <varlistentry>
52485 <term><emphasis role="bold">message</emphasis>&nbsp;=&nbsp;&lt;<emphasis>text</emphasis>&gt;</term>
52486 <listitem>
52487 <para>
52488 <indexterm role="concept">
52489 <primary><option>message</option> ACL modifier</primary>
52490 </indexterm>
52491 This modifier sets up a text string that is expanded and used as a response
52492 message when an ACL statement terminates the ACL with an <quote>accept</quote>, <quote>deny</quote>,
52493 or <quote>defer</quote> response. (In the case of the <option>accept</option> and <option>discard</option> verbs,
52494 there is some complication if <option>endpass</option> is involved; see the description of
52495 <option>accept</option> for details.)
52496 </para>
52497 <para>
52498 The expansion of the message happens at the time Exim decides that the ACL is
52499 to end, not at the time it processes <option>message</option>. If the expansion fails, or
52500 generates an empty string, the modifier is ignored. Here is an example where
52501 <option>message</option> must be specified first, because the ACL ends with a rejection if
52502 the <option>hosts</option> condition fails:
52503 </para>
52504 <literallayout class="monospaced">
52505 require  message = Host not recognized
52506          hosts = 10.0.0.0/8
52507 </literallayout>
52508 <para>
52509 (Once a condition has failed, no further conditions or modifiers are
52510 processed.)
52511 </para>
52512 <para>
52513 <indexterm role="concept">
52514 <primary>SMTP</primary>
52515 <secondary>error codes</secondary>
52516 </indexterm>
52517 <indexterm role="option">
52518 <primary><option>smtp_banner</option></primary>
52519 </indexterm>
52520 For ACLs that are triggered by SMTP commands, the message is returned as part
52521 of the SMTP response. The use of <option>message</option> with <option>accept</option> (or <option>discard</option>)
52522 is meaningful only for SMTP, as no message is returned when a non-SMTP message
52523 is accepted. In the case of the connect ACL, accepting with a message modifier
52524 overrides the value of <option>smtp_banner</option>. For the EHLO/HELO ACL, a customized
52525 accept message may not contain more than one line (otherwise it will be
52526 truncated at the first newline and a panic logged), and it cannot affect the
52527 EHLO options.
52528 </para>
52529 <para>
52530 When SMTP is involved, the message may begin with an overriding response code,
52531 consisting of three digits optionally followed by an <quote>extended response code</quote>
52532 of the form <emphasis>n.n.n</emphasis>, each code being followed by a space. For example:
52533 </para>
52534 <literallayout class="monospaced">
52535 deny  message = 599 1.2.3 Host not welcome
52536       hosts = 192.168.34.0/24
52537 </literallayout>
52538 <para>
52539 The first digit of the supplied response code must be the same as would be sent
52540 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
52541 access, but for the predata ACL, note that the default success code is 354, not
52542 2<emphasis>xx</emphasis>.
52543 </para>
52544 <para>
52545 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
52546 the message modifier cannot override the 221 response code.
52547 </para>
52548 <para>
52549 The text in a <option>message</option> modifier is literal; any quotes are taken as
52550 literals, but because the string is expanded, backslash escapes are processed
52551 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
52552 response.
52553 </para>
52554 <para>
52555 <indexterm role="variable">
52556 <primary><varname>$acl_verify_message</varname></primary>
52557 </indexterm>
52558 If <option>message</option> is used on a statement that verifies an address, the message
52559 specified overrides any message that is generated by the verification process.
52560 However, the original message is available in the variable
52561 <varname>$acl_verify_message</varname>, so you can incorporate it into your message if you
52562 wish. In particular, if you want the text from <option>:fail:</option> items in <command>redirect</command>
52563 routers to be passed back as part of the SMTP response, you should either not
52564 use a <option>message</option> modifier, or make use of <varname>$acl_verify_message</varname>.
52565 </para>
52566 <para>
52567 For compatibility with previous releases of Exim, a <option>message</option> modifier that
52568 is used with a <option>warn</option> verb behaves in a similar way to the <option>add_header</option>
52569 modifier, but this usage is now deprecated. However, <option>message</option> acts only when
52570 all the conditions are true, wherever it appears in an ACL command, whereas
52571 <option>add_header</option> acts as soon as it is encountered. If <option>message</option> is used with
52572 <option>warn</option> in an ACL that is not concerned with receiving a message, it has no
52573 effect.
52574 </para>
52575 </listitem></varlistentry>
52576 <varlistentry>
52577 <term><emphasis role="bold">remove_header</emphasis>&nbsp;=&nbsp;&lt;<emphasis>text</emphasis>&gt;</term>
52578 <listitem>
52579 <para>
52580 This modifier specifies one or more header names in a colon-separated list
52581  that are to be removed from an incoming message, assuming, of course, that
52582 the message is ultimately accepted. For details, see section <xref linkend="SECTremoveheadacl"/>.
52583 </para>
52584 </listitem></varlistentry>
52585 <varlistentry>
52586 <term><emphasis role="bold">set</emphasis>&nbsp;&lt;<emphasis>acl_name</emphasis>&gt;&nbsp;=&nbsp;&lt;<emphasis>value</emphasis>&gt;</term>
52587 <listitem>
52588 <para>
52589 <indexterm role="concept">
52590 <primary><option>set</option> ACL modifier</primary>
52591 </indexterm>
52592 This modifier puts a value into one of the ACL variables (see section
52593 <xref linkend="SECTaclvariables"/>).
52594 </para>
52595 </listitem></varlistentry>
52596 <varlistentry>
52597 <term><emphasis role="bold">udpsend</emphasis>&nbsp;=&nbsp;&lt;<emphasis>parameters</emphasis>&gt;</term>
52598 <listitem>
52599 <para>
52600 This modifier sends a UDP packet, for purposes such as statistics
52601 collection or behaviour monitoring. The parameters are expanded, and
52602 the result of the expansion must be a colon-separated list consisting
52603 of a destination server, port number, and the packet contents. The
52604 server can be specified as a host name or IPv4 or IPv6 address. The
52605 separator can be changed with the usual angle bracket syntax. For
52606 example, you might want to collect information on which hosts connect
52607 when:
52608 </para>
52609 <literallayout class="monospaced">
52610 udpsend = &lt;; 2001:dB8::dead:beef ; 1234 ;\
52611              $tod_zulu $sender_host_address
52612 </literallayout>
52613 </listitem></varlistentry>
52614 </variablelist>
52615 </section>
52616 <section id="SECTcontrols">
52617 <title>Use of the control modifier</title>
52618 <para>
52619 <indexterm role="concept">
52620 <primary><option>control</option> ACL modifier</primary>
52621 </indexterm>
52622 The <option>control</option> modifier supports the following settings:
52623 </para>
52624 <variablelist>
52625 <varlistentry>
52626 <term><emphasis role="bold">control&nbsp;=&nbsp;allow_auth_unadvertised</emphasis></term>
52627 <listitem>
52628 <para>
52629 This modifier allows a client host to use the SMTP AUTH command even when it
52630 has not been advertised in response to EHLO. Furthermore, because there are
52631 apparently some really broken clients that do this, Exim will accept AUTH after
52632 HELO (rather than EHLO) when this control is set. It should be used only if you
52633 really need it, and you should limit its use to those broken clients that do
52634 not work without it. For example:
52635 </para>
52636 <literallayout class="monospaced">
52637 warn hosts   = 192.168.34.25
52638      control = allow_auth_unadvertised
52639 </literallayout>
52640 <para>
52641 Normally, when an Exim server receives an AUTH command, it checks the name of
52642 the authentication mechanism that is given in the command to ensure that it
52643 matches an advertised mechanism. When this control is set, the check that a
52644 mechanism has been advertised is bypassed. Any configured mechanism can be used
52645 by the client. This control is permitted only in the connection and HELO ACLs.
52646 </para>
52647 </listitem></varlistentry>
52648 <varlistentry>
52649 <term><emphasis role="bold">control&nbsp;=&nbsp;caseful_local_part</emphasis></term>
52650 <term><emphasis role="bold">control&nbsp;=&nbsp;caselower_local_part</emphasis></term>
52651 <listitem>
52652 <para>
52653 <indexterm role="concept">
52654 <primary>access control lists (ACLs)</primary>
52655 <secondary>case of local part in</secondary>
52656 </indexterm>
52657 <indexterm role="concept">
52658 <primary>case of local parts</primary>
52659 </indexterm>
52660 <indexterm role="variable">
52661 <primary><varname>$local_part</varname></primary>
52662 </indexterm>
52663 These two controls are permitted only in the ACL specified by <option>acl_smtp_rcpt</option>
52664 (that is, during RCPT processing). By default, the contents of <varname>$local_part</varname>
52665 are lower cased before ACL processing. If <quote>caseful_local_part</quote> is specified,
52666 any uppercase letters in the original local part are restored in <varname>$local_part</varname>
52667 for the rest of the ACL, or until a control that sets <quote>caselower_local_part</quote>
52668 is encountered.
52669 </para>
52670 <para>
52671 These controls affect only the current recipient. Moreover, they apply only to
52672 local part handling that takes place directly in the ACL (for example, as a key
52673 in lookups). If a test to verify the recipient is obeyed, the case-related
52674 handling of the local part during the verification is controlled by the router
52675 configuration (see the <option>caseful_local_part</option> generic router option).
52676 </para>
52677 <para>
52678 This facility could be used, for example, to add a spam score to local parts
52679 containing upper case letters. For example, using <varname>$acl_m4</varname> to accumulate the
52680 spam score:
52681 </para>
52682 <literallayout class="monospaced">
52683 warn  control = caseful_local_part
52684       set acl_m4 = ${eval:\
52685                      $acl_m4 + \
52686                      ${if match{$local_part}{[A-Z]}{1}{0}}\
52687                     }
52688       control = caselower_local_part
52689 </literallayout>
52690 <para>
52691 Notice that we put back the lower cased version afterwards, assuming that
52692 is what is wanted for subsequent tests.
52693 </para>
52694 </listitem></varlistentry>
52695 <varlistentry>
52696 <term><emphasis role="bold">control&nbsp;=&nbsp;cutthrough_delivery</emphasis></term>
52697 <listitem>
52698 <para>
52699 <indexterm role="concept">
52700 <primary>access control lists (ACLs)</primary>
52701 <secondary>cutthrough routing</secondary>
52702 </indexterm>
52703 <indexterm role="concept">
52704 <primary>cutthrough</primary>
52705 <secondary>requesting</secondary>
52706 </indexterm>
52707 This option requests delivery be attempted while the item is being received.
52708 It is usable in the RCPT ACL and valid only for single-recipient mails forwarded
52709 from one SMTP connection to another.  If a recipient-verify callout connection is
52710 requested in the same ACL it is held open and used for the data, otherwise one is made
52711 after the ACL completes.
52712 </para>
52713 <para>
52714 Note that routers are used in verify mode,
52715 and cannot depend on content of received headers.
52716 Note also that headers cannot be
52717 modified by any of the post-data ACLs (DATA, MIME and DKIM).
52718 Headers may be modified by routers (subject to the above) and transports.
52719 </para>
52720 <para>
52721 Cutthrough delivery is not supported via transport-filters or when DKIM signing
52722 of outgoing messages is done, because it sends data to the ultimate destination
52723 before the entire message has been received from the source.
52724 </para>
52725 <para>
52726 Should the ultimate destination system positively accept or reject the mail,
52727 a corresponding indication is given to the source system and nothing is queued.
52728 If there is a temporary error the item is queued for later delivery in the
52729 usual fashion. If the item is successfully delivered in cutthrough mode the log line
52730 is tagged with "&gt;&gt;" rather than "=&gt;" and appears before the acceptance "&lt;="
52731 line.
52732 </para>
52733 <para>
52734 Delivery in this mode avoids the generation of a bounce mail to a (possibly faked)
52735 sender when the destination system is doing content-scan based rejection.
52736 </para>
52737 </listitem></varlistentry>
52738 <varlistentry>
52739 <term><emphasis role="bold">control&nbsp;=&nbsp;debug/</emphasis>&lt;<emphasis>options</emphasis>&gt;</term>
52740 <listitem>
52741 <para>
52742 <indexterm role="concept">
52743 <primary>access control lists (ACLs)</primary>
52744 <secondary>enabling debug logging</secondary>
52745 </indexterm>
52746 <indexterm role="concept">
52747 <primary>debugging</primary>
52748 <secondary>enabling from an ACL</secondary>
52749 </indexterm>
52750 This control turns on debug logging, almost as though Exim had been invoked
52751 with <literal>-d</literal>, with the output going to a new logfile, by default called
52752 <emphasis>debuglog</emphasis>.  The filename can be adjusted with the <emphasis>tag</emphasis> option, which
52753 may access any variables already defined.  The logging may be adjusted with
52754 the <emphasis>opts</emphasis> option, which takes the same values as the <literal>-d</literal> command-line
52755 option.  Some examples (which depend on variables that don&#x2019;t exist in all
52756 contexts):
52757 </para>
52758 <literallayout class="monospaced">
52759       control = debug
52760       control = debug/tag=.$sender_host_address
52761       control = debug/opts=+expand+acl
52762       control = debug/tag=.$message_exim_id/opts=+expand
52763 </literallayout>
52764 </listitem></varlistentry>
52765 <varlistentry>
52766 <term><emphasis role="bold">control&nbsp;=&nbsp;dkim_disable_verify</emphasis></term>
52767 <listitem>
52768 <para>
52769 <indexterm role="concept">
52770 <primary>disable DKIM verify</primary>
52771 </indexterm>
52772 <indexterm role="concept">
52773 <primary>DKIM</primary>
52774 <secondary>disable verify</secondary>
52775 </indexterm>
52776 This control turns off DKIM verification processing entirely.  For details on
52777 the operation and configuration of DKIM, see chapter <xref linkend="CHAPdkim"/>.
52778 </para>
52779 </listitem></varlistentry>
52780 <varlistentry>
52781 <term><emphasis role="bold">control&nbsp;=&nbsp;dscp/</emphasis>&lt;<emphasis>value</emphasis>&gt;</term>
52782 <listitem>
52783 <para>
52784 <indexterm role="concept">
52785 <primary>access control lists (ACLs)</primary>
52786 <secondary>setting DSCP value</secondary>
52787 </indexterm>
52788 <indexterm role="concept">
52789 <primary>DSCP</primary>
52790 <secondary>inbound</secondary>
52791 </indexterm>
52792 This option causes the DSCP value associated with the socket for the inbound
52793 connection to be adjusted to a given value, given as one of a number of fixed
52794 strings or to numeric value.
52795 The <option>-bI:dscp</option> option may be used to ask Exim which names it knows of.
52796 Common values include <literal>throughput</literal>, <literal>mincost</literal>, and on newer systems
52797 <literal>ef</literal>, <literal>af41</literal>, etc.  Numeric values may be in the range 0 to 0x3F.
52798 </para>
52799 <para>
52800 The outbound packets from Exim will be marked with this value in the header
52801 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
52802 that these values will have any effect, not be stripped by networking
52803 equipment, or do much of anything without cooperation with your Network
52804 Engineer and those of all network operators between the source and destination.
52805 </para>
52806 </listitem></varlistentry>
52807 <varlistentry>
52808 <term><emphasis role="bold">control&nbsp;=&nbsp;enforce_sync</emphasis></term>
52809 <term><emphasis role="bold">control&nbsp;=&nbsp;no_enforce_sync</emphasis></term>
52810 <listitem>
52811 <para>
52812 <indexterm role="concept">
52813 <primary>SMTP</primary>
52814 <secondary>synchronization checking</secondary>
52815 </indexterm>
52816 <indexterm role="concept">
52817 <primary>synchronization checking in SMTP</primary>
52818 </indexterm>
52819 These controls make it possible to be selective about when SMTP synchronization
52820 is enforced. The global option <option>smtp_enforce_sync</option> specifies the initial
52821 state of the switch (it is true by default). See the description of this option
52822 in chapter <xref linkend="CHAPmainconfig"/> for details of SMTP synchronization checking.
52823 </para>
52824 <para>
52825 The effect of these two controls lasts for the remainder of the SMTP
52826 connection. They can appear in any ACL except the one for the non-SMTP
52827 messages. The most straightforward place to put them is in the ACL defined by
52828 <option>acl_smtp_connect</option>, which is run at the start of an incoming SMTP connection,
52829 before the first synchronization check. The expected use is to turn off the
52830 synchronization checks for badly-behaved hosts that you nevertheless need to
52831 work with.
52832 </para>
52833 </listitem></varlistentry>
52834 <varlistentry>
52835 <term><emphasis role="bold">control&nbsp;=&nbsp;fakedefer/</emphasis>&lt;<emphasis>message</emphasis>&gt;</term>
52836 <listitem>
52837 <para>
52838 <indexterm role="concept">
52839 <primary>fake defer</primary>
52840 </indexterm>
52841 <indexterm role="concept">
52842 <primary>defer, fake</primary>
52843 </indexterm>
52844 This control works in exactly the same way as <option>fakereject</option> (described below)
52845 except that it causes an SMTP 450 response after the message data instead of a
52846 550 response. You must take care when using <option>fakedefer</option> because it causes the
52847 messages to be duplicated when the sender retries. Therefore, you should not
52848 use <option>fakedefer</option> if the message is to be delivered normally.
52849 </para>
52850 </listitem></varlistentry>
52851 <varlistentry>
52852 <term><emphasis role="bold">control&nbsp;=&nbsp;fakereject/</emphasis>&lt;<emphasis>message</emphasis>&gt;</term>
52853 <listitem>
52854 <para>
52855 <indexterm role="concept">
52856 <primary>fake rejection</primary>
52857 </indexterm>
52858 <indexterm role="concept">
52859 <primary>rejection, fake</primary>
52860 </indexterm>
52861 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
52862 words, only when an SMTP message is being received. If Exim accepts the
52863 message, instead the final 250 response, a 550 rejection message is sent.
52864 However, Exim proceeds to deliver the message as normal. The control applies
52865 only to the current message, not to any subsequent ones that may be received in
52866 the same SMTP connection.
52867 </para>
52868 <para>
52869 The text for the 550 response is taken from the <option>control</option> modifier. If no
52870 message is supplied, the following is used:
52871 </para>
52872 <literallayout class="monospaced">
52873 550-Your message has been rejected but is being
52874 550-kept for evaluation.
52875 550-If it was a legitimate message, it may still be
52876 550 delivered to the target recipient(s).
52877 </literallayout>
52878 <para>
52879 This facility should be used with extreme caution.
52880 </para>
52881 </listitem></varlistentry>
52882 <varlistentry>
52883 <term><emphasis role="bold">control&nbsp;=&nbsp;freeze</emphasis></term>
52884 <listitem>
52885 <para>
52886 <indexterm role="concept">
52887 <primary>frozen messages</primary>
52888 <secondary>forcing in ACL</secondary>
52889 </indexterm>
52890 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
52891 other words, only when a message is being received. If the message is accepted,
52892 it is placed on Exim&#x2019;s queue and frozen. The control applies only to the
52893 current message, not to any subsequent ones that may be received in the same
52894 SMTP connection.
52895 </para>
52896 <para>
52897 This modifier can optionally be followed by <literal>/no_tell</literal>. If the global option
52898 <option>freeze_tell</option> is set, it is ignored for the current message (that is, nobody
52899 is told about the freezing), provided all the <emphasis role="bold">control=freeze</emphasis> modifiers that
52900 are obeyed for the current message have the <literal>/no_tell</literal> option.
52901 </para>
52902 </listitem></varlistentry>
52903 <varlistentry>
52904 <term><emphasis role="bold">control&nbsp;=&nbsp;no_delay_flush</emphasis></term>
52905 <listitem>
52906 <para>
52907 <indexterm role="concept">
52908 <primary>SMTP</primary>
52909 <secondary>output flushing, disabling for delay</secondary>
52910 </indexterm>
52911 Exim normally flushes SMTP output before implementing a delay in an ACL, to
52912 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
52913 use. This control, as long as it is encountered before the <option>delay</option> modifier,
52914 disables such output flushing.
52915 </para>
52916 </listitem></varlistentry>
52917 <varlistentry>
52918 <term><emphasis role="bold">control&nbsp;=&nbsp;no_callout_flush</emphasis></term>
52919 <listitem>
52920 <para>
52921 <indexterm role="concept">
52922 <primary>SMTP</primary>
52923 <secondary>output flushing, disabling for callout</secondary>
52924 </indexterm>
52925 Exim normally flushes SMTP output before performing a callout in an ACL, to
52926 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
52927 use. This control, as long as it is encountered before the <option>verify</option> condition
52928 that causes the callout, disables such output flushing.
52929 </para>
52930 </listitem></varlistentry>
52931 <varlistentry>
52932 <term><emphasis role="bold">control&nbsp;=&nbsp;no_mbox_unspool</emphasis></term>
52933 <listitem>
52934 <para>
52935 This control is available when Exim is compiled with the content scanning
52936 extension. Content scanning may require a copy of the current message, or parts
52937 of it, to be written in <quote>mbox format</quote> to a spool file, for passing to a virus
52938 or spam scanner. Normally, such copies are deleted when they are no longer
52939 needed. If this control is set, the copies are not deleted. The control applies
52940 only to the current message, not to any subsequent ones that may be received in
52941 the same SMTP connection. It is provided for debugging purposes and is unlikely
52942 to be useful in production.
52943 </para>
52944 </listitem></varlistentry>
52945 <varlistentry>
52946 <term><emphasis role="bold">control&nbsp;=&nbsp;no_multiline_responses</emphasis></term>
52947 <listitem>
52948 <para>
52949 <indexterm role="concept">
52950 <primary>multiline responses, suppressing</primary>
52951 </indexterm>
52952 This control is permitted for any ACL except the one for non-SMTP messages.
52953 It seems that there are broken clients in use that cannot handle multiline
52954 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
52955 </para>
52956 <para>
52957 If this control is set, multiline SMTP responses from ACL rejections are
52958 suppressed. One way of doing this would have been to put out these responses as
52959 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
52960 (<quote>use multiline responses for more</quote> it says &ndash; ha!), and some of the
52961 responses might get close to that. So this facility, which is after all only a
52962 sop to broken clients, is implemented by doing two very easy things:
52963 </para>
52964 <itemizedlist>
52965 <listitem>
52966 <para>
52967 Extra information that is normally output as part of a rejection caused by
52968 sender verification failure is omitted. Only the final line (typically <quote>sender
52969 verification failed</quote>) is sent.
52970 </para>
52971 </listitem>
52972 <listitem>
52973 <para>
52974 If a <option>message</option> modifier supplies a multiline response, only the first
52975 line is output.
52976 </para>
52977 </listitem>
52978 </itemizedlist>
52979 <para>
52980 The setting of the switch can, of course, be made conditional on the
52981 calling host. Its effect lasts until the end of the SMTP connection.
52982 </para>
52983 </listitem></varlistentry>
52984 <varlistentry>
52985 <term><emphasis role="bold">control&nbsp;=&nbsp;no_pipelining</emphasis></term>
52986 <listitem>
52987 <para>
52988 <indexterm role="concept">
52989 <primary>PIPELINING</primary>
52990 <secondary>suppressing advertising</secondary>
52991 </indexterm>
52992 This control turns off the advertising of the PIPELINING extension to SMTP in
52993 the current session. To be useful, it must be obeyed before Exim sends its
52994 response to an EHLO command. Therefore, it should normally appear in an ACL
52995 controlled by <option>acl_smtp_connect</option> or <option>acl_smtp_helo</option>. See also
52996 <option>pipelining_advertise_hosts</option>.
52997 </para>
52998 </listitem></varlistentry>
52999 <varlistentry>
53000 <term><emphasis role="bold">control&nbsp;=&nbsp;queue_only</emphasis></term>
53001 <listitem>
53002 <para>
53003 <indexterm role="option">
53004 <primary><option>queue_only</option></primary>
53005 </indexterm>
53006 <indexterm role="concept">
53007 <primary>queueing incoming messages</primary>
53008 </indexterm>
53009 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
53010 other words, only when a message is being received. If the message is accepted,
53011 it is placed on Exim&#x2019;s queue and left there for delivery by a subsequent queue
53012 runner. No immediate delivery process is started. In other words, it has the
53013 effect as the <option>queue_only</option> global option. However, the control applies only
53014 to the current message, not to any subsequent ones that may be received in the
53015 same SMTP connection.
53016 </para>
53017 </listitem></varlistentry>
53018 <varlistentry>
53019 <term><emphasis role="bold">control&nbsp;=&nbsp;submission/</emphasis>&lt;<emphasis>options</emphasis>&gt;</term>
53020 <listitem>
53021 <para>
53022 <indexterm role="concept">
53023 <primary>message</primary>
53024 <secondary>submission</secondary>
53025 </indexterm>
53026 <indexterm role="concept">
53027 <primary>submission mode</primary>
53028 </indexterm>
53029 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
53030 latter is the one defined by <option>acl_smtp_predata</option>). Setting it tells Exim that
53031 the current message is a submission from a local MUA. In this case, Exim
53032 operates in <quote>submission mode</quote>, and applies certain fixups to the message if
53033 necessary. For example, it adds a <emphasis>Date:</emphasis> header line if one is not present.
53034 This control is not permitted in the <option>acl_smtp_data</option> ACL, because that is too
53035 late (the message has already been created).
53036 </para>
53037 <para>
53038 Chapter <xref linkend="CHAPmsgproc"/> describes the processing that Exim applies to
53039 messages. Section <xref linkend="SECTsubmodnon"/> covers the processing that happens in
53040 submission mode; the available options for this control are described there.
53041 The control applies only to the current message, not to any subsequent ones
53042 that may be received in the same SMTP connection.
53043 </para>
53044 </listitem></varlistentry>
53045 <varlistentry>
53046 <term><emphasis role="bold">control&nbsp;=&nbsp;suppress_local_fixups</emphasis></term>
53047 <listitem>
53048 <para>
53049 <indexterm role="concept">
53050 <primary>submission fixups, suppressing</primary>
53051 </indexterm>
53052 This control applies to locally submitted (non TCP/IP) messages, and is the
53053 complement of <literal>control = submission</literal>. It disables the fixups that are
53054 normally applied to locally-submitted messages. Specifically:
53055 </para>
53056 <itemizedlist>
53057 <listitem>
53058 <para>
53059 Any <emphasis>Sender:</emphasis> header line is left alone (in this respect, it is a
53060 dynamic version of <option>local_sender_retain</option>).
53061 </para>
53062 </listitem>
53063 <listitem>
53064 <para>
53065 No <emphasis>Message-ID:</emphasis>, <emphasis>From:</emphasis>, or <emphasis>Date:</emphasis> header lines are added.
53066 </para>
53067 </listitem>
53068 <listitem>
53069 <para>
53070 There is no check that <emphasis>From:</emphasis> corresponds to the actual sender.
53071 </para>
53072 </listitem>
53073 </itemizedlist>
53074 <para>
53075 This control may be useful when a remotely-originated message is accepted,
53076 passed to some scanning program, and then re-submitted for delivery. It can be
53077 used only in the <option>acl_smtp_mail</option>, <option>acl_smtp_rcpt</option>, <option>acl_smtp_predata</option>,
53078 and <option>acl_not_smtp_start</option> ACLs, because it has to be set before the message&#x2019;s
53079 data is read.
53080 </para>
53081 <para>
53082 <emphasis role="bold">Note:</emphasis> This control applies only to the current message, not to any others
53083 that are being submitted at the same time using <option>-bs</option> or <option>-bS</option>.
53084 </para>
53085 </listitem></varlistentry>
53086 </variablelist>
53087 </section>
53088 <section id="SECTsummesfix">
53089 <title>Summary of message fixup control</title>
53090 <para>
53091 All four possibilities for message fixups can be specified:
53092 </para>
53093 <itemizedlist>
53094 <listitem>
53095 <para>
53096 Locally submitted, fixups applied: the default.
53097 </para>
53098 </listitem>
53099 <listitem>
53100 <para>
53101 Locally submitted, no fixups applied: use
53102 <literal>control = suppress_local_fixups</literal>.
53103 </para>
53104 </listitem>
53105 <listitem>
53106 <para>
53107 Remotely submitted, no fixups applied: the default.
53108 </para>
53109 </listitem>
53110 <listitem>
53111 <para>
53112 Remotely submitted, fixups applied: use <literal>control = submission</literal>.
53113 </para>
53114 </listitem>
53115 </itemizedlist>
53116 </section>
53117 <section id="SECTaddheadacl">
53118 <title>Adding header lines in ACLs</title>
53119 <para>
53120 <indexterm role="concept">
53121 <primary>header lines</primary>
53122 <secondary>adding in an ACL</secondary>
53123 </indexterm>
53124 <indexterm role="concept">
53125 <primary>header lines</primary>
53126 <secondary>position of added lines</secondary>
53127 </indexterm>
53128 <indexterm role="concept">
53129 <primary><option>add_header</option> ACL modifier</primary>
53130 </indexterm>
53131 The <option>add_header</option> modifier can be used to add one or more extra header lines
53132 to an incoming message, as in this example:
53133 </para>
53134 <literallayout class="monospaced">
53135 warn dnslists = sbl.spamhaus.org : \
53136                 dialup.mail-abuse.org
53137      add_header = X-blacklisted-at: $dnslist_domain
53138 </literallayout>
53139 <para>
53140 The <option>add_header</option> modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
53141 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
53142 receiving a message). The message must ultimately be accepted for
53143 <option>add_header</option> to have any significant effect. You can use <option>add_header</option> with
53144 any ACL verb, including <option>deny</option> (though this is potentially useful only in a
53145 RCPT ACL).
53146 </para>
53147 <para>
53148 Headers will not be added to the message if the modifier is used in
53149 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
53150 </para>
53151 <para>
53152 Leading and trailing newlines are removed from
53153 the data for the <option>add_header</option> modifier; if it then
53154 contains one or more newlines that
53155 are not followed by a space or a tab, it is assumed to contain multiple header
53156 lines. Each one is checked for valid syntax; <literal>X-ACL-Warn:</literal> is added to the
53157 front of any line that is not a valid header line.
53158 </para>
53159 <para>
53160 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
53161 They are added to the message before processing the DATA and MIME ACLs.
53162 However, if an identical header line is requested more than once, only one copy
53163 is actually added to the message. Further header lines may be accumulated
53164 during the DATA and MIME ACLs, after which they are added to the message, again
53165 with duplicates suppressed. Thus, it is possible to add two identical header
53166 lines to an SMTP message, but only if one is added before DATA and one after.
53167 In the case of non-SMTP messages, new headers are accumulated during the
53168 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
53169 message is rejected after DATA or by the non-SMTP ACL, all added header lines
53170 are included in the entry that is written to the reject log.
53171 </para>
53172 <para>
53173 <indexterm role="concept">
53174 <primary>header lines</primary>
53175 <secondary>added; visibility of</secondary>
53176 </indexterm>
53177 Header lines are not visible in string expansions
53178 of message headers
53179 until they are added to the
53180 message. It follows that header lines defined in the MAIL, RCPT, and predata
53181 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
53182 header lines that are added by the DATA or MIME ACLs are not visible in those
53183 ACLs. Because of this restriction, you cannot use header lines as a way of
53184 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
53185 this, you can use ACL variables, as described in section
53186 <xref linkend="SECTaclvariables"/>.
53187 </para>
53188 <para>
53189 The list of headers yet to be added is given by the <option>$headers_added</option> variable.
53190 </para>
53191 <para>
53192 The <option>add_header</option> modifier acts immediately as it is encountered during the
53193 processing of an ACL. Notice the difference between these two cases:
53194 </para>
53195 <literallayout>
53196 <literal>accept add_header = ADDED: some text</literal>
53197 <literal>       </literal>&lt;<emphasis>some condition</emphasis>&gt;
53198
53199 <literal>accept </literal>&lt;<emphasis>some condition</emphasis>&gt;
53200 <literal>       add_header = ADDED: some text</literal>
53201 </literallayout>
53202 <para>
53203 In the first case, the header line is always added, whether or not the
53204 condition is true. In the second case, the header line is added only if the
53205 condition is true. Multiple occurrences of <option>add_header</option> may occur in the same
53206 ACL statement. All those that are encountered before a condition fails are
53207 honoured.
53208 </para>
53209 <para>
53210 <indexterm role="concept">
53211 <primary><option>warn</option> ACL verb</primary>
53212 </indexterm>
53213 For compatibility with previous versions of Exim, a <option>message</option> modifier for a
53214 <option>warn</option> verb acts in the same way as <option>add_header</option>, except that it takes
53215 effect only if all the conditions are true, even if it appears before some of
53216 them. Furthermore, only the last occurrence of <option>message</option> is honoured. This
53217 usage of <option>message</option> is now deprecated. If both <option>add_header</option> and <option>message</option>
53218 are present on a <option>warn</option> verb, both are processed according to their
53219 specifications.
53220 </para>
53221 <para>
53222 By default, new header lines are added to a message at the end of the existing
53223 header lines. However, you can specify that any particular header line should
53224 be added right at the start (before all the <emphasis>Received:</emphasis> lines), immediately
53225 after the first block of <emphasis>Received:</emphasis> lines, or immediately before any line
53226 that is not a <emphasis>Received:</emphasis> or <emphasis>Resent-something:</emphasis> header.
53227 </para>
53228 <para>
53229 This is done by specifying <quote>:at_start:</quote>, <quote>:after_received:</quote>, or
53230 <quote>:at_start_rfc:</quote> (or, for completeness, <quote>:at_end:</quote>) before the text of the
53231 header line, respectively. (Header text cannot start with a colon, as there has
53232 to be a header name first.) For example:
53233 </para>
53234 <literallayout class="monospaced">
53235 warn add_header = \
53236        :after_received:X-My-Header: something or other...
53237 </literallayout>
53238 <para>
53239 If more than one header line is supplied in a single <option>add_header</option> modifier,
53240 each one is treated independently and can therefore be placed differently. If
53241 you add more than one line at the start, or after the Received: block, they end
53242 up in reverse order.
53243 </para>
53244 <para>
53245 <emphasis role="bold">Warning</emphasis>: This facility currently applies only to header lines that are
53246 added in an ACL. It does NOT work for header lines that are added in a
53247 system filter or in a router or transport.
53248 </para>
53249 </section>
53250 <section id="SECTremoveheadacl">
53251 <title>Removing header lines in ACLs</title>
53252 <para>
53253 <indexterm role="concept">
53254 <primary>header lines</primary>
53255 <secondary>removing in an ACL</secondary>
53256 </indexterm>
53257 <indexterm role="concept">
53258 <primary>header lines</primary>
53259 <secondary>position of removed lines</secondary>
53260 </indexterm>
53261 <indexterm role="concept">
53262 <primary><option>remove_header</option> ACL modifier</primary>
53263 </indexterm>
53264 The <option>remove_header</option> modifier can be used to remove one or more header lines
53265 from an incoming message, as in this example:
53266 </para>
53267 <literallayout class="monospaced">
53268 warn   message        = Remove internal headers
53269        remove_header  = x-route-mail1 : x-route-mail2
53270 </literallayout>
53271 <para>
53272 The <option>remove_header</option> modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
53273 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
53274 receiving a message). The message must ultimately be accepted for
53275 <option>remove_header</option> to have any significant effect. You can use <option>remove_header</option>
53276 with any ACL verb, including <option>deny</option>, though this is really not useful for
53277 any verb that doesn&#x2019;t result in a delivered message.
53278 </para>
53279 <para>
53280 Headers will not be removed to the message if the modifier is used in
53281 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
53282 </para>
53283 <para>
53284 More than one header can be removed at the same time by using a colon separated
53285 list of header names. The header matching is case insensitive. Wildcards are
53286 not permitted, nor is list expansion performed, so you cannot use hostlists to
53287 create a list of headers, however both connection and message variable expansion
53288 are performed (<option>$acl_c_*</option> and <option>$acl_m_*</option>), illustrated in this example:
53289 </para>
53290 <literallayout class="monospaced">
53291 warn   hosts           = +internal_hosts
53292        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
53293 warn   message         = Remove internal headers
53294        remove_header   = $acl_c_ihdrs
53295 </literallayout>
53296 <para>
53297 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
53298 They are removed from the message before processing the DATA and MIME ACLs.
53299 There is no harm in attempting to remove the same header twice nor is removing
53300 a non-existent header. Further header lines to be removed may be accumulated
53301 during the DATA and MIME ACLs, after which they are removed from the message,
53302 if present. In the case of non-SMTP messages, headers to be removed are
53303 accumulated during the non-SMTP ACLs, and are removed from the message after
53304 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
53305 ACL, there really is no effect because there is no logging of what headers
53306 would have been removed.
53307 </para>
53308 <para>
53309 <indexterm role="concept">
53310 <primary>header lines</primary>
53311 <secondary>removed; visibility of</secondary>
53312 </indexterm>
53313 Header lines are not visible in string expansions until the DATA phase when it
53314 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
53315 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
53316 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
53317 this restriction, you cannot use header lines as a way of controlling data
53318 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
53319 you should instead use ACL variables, as described in section
53320 <xref linkend="SECTaclvariables"/>.
53321 </para>
53322 <para>
53323 The <option>remove_header</option> modifier acts immediately as it is encountered during the
53324 processing of an ACL. Notice the difference between these two cases:
53325 </para>
53326 <literallayout>
53327 <literal>accept remove_header = X-Internal</literal>
53328 <literal>       </literal>&lt;<emphasis>some condition</emphasis>&gt;
53329
53330 <literal>accept </literal>&lt;<emphasis>some condition</emphasis>&gt;
53331 <literal>       remove_header = X-Internal</literal>
53332 </literallayout>
53333 <para>
53334 In the first case, the header line is always removed, whether or not the
53335 condition is true. In the second case, the header line is removed only if the
53336 condition is true. Multiple occurrences of <option>remove_header</option> may occur in the
53337 same ACL statement. All those that are encountered before a condition fails
53338 are honoured.
53339 </para>
53340 <para>
53341 <emphasis role="bold">Warning</emphasis>: This facility currently applies only to header lines that are
53342 present during ACL processing. It does NOT remove header lines that are added
53343 in a system filter or in a router or transport.
53344 </para>
53345 </section>
53346 <section id="SECTaclconditions">
53347 <title>ACL conditions</title>
53348 <para>
53349 <indexterm role="concept">
53350 <primary>access control lists (ACLs)</primary>
53351 <secondary>conditions; list of</secondary>
53352 </indexterm>
53353 Some of the conditions listed in this section are available only when Exim is
53354 compiled with the content-scanning extension. They are included here briefly
53355 for completeness. More detailed descriptions can be found in the discussion on
53356 content scanning in chapter <xref linkend="CHAPexiscan"/>.
53357 </para>
53358 <para>
53359 Not all conditions are relevant in all circumstances. For example, testing
53360 senders and recipients does not make sense in an ACL that is being run as the
53361 result of the arrival of an ETRN command, and checks on message headers can be
53362 done only in the ACLs specified by <option>acl_smtp_data</option> and <option>acl_not_smtp</option>. You
53363 can use the same condition (with different parameters) more than once in the
53364 same ACL statement. This provides a way of specifying an <quote>and</quote> conjunction.
53365 The conditions are as follows:
53366 </para>
53367 <variablelist>
53368 <varlistentry>
53369 <term><emphasis role="bold">acl&nbsp;=&nbsp;</emphasis>&lt;<emphasis>name&nbsp;of&nbsp;acl&nbsp;or&nbsp;ACL&nbsp;string&nbsp;or&nbsp;file&nbsp;name&nbsp;</emphasis>&gt;</term>
53370 <listitem>
53371 <para>
53372 <indexterm role="concept">
53373 <primary>access control lists (ACLs)</primary>
53374 <secondary>nested</secondary>
53375 </indexterm>
53376 <indexterm role="concept">
53377 <primary>access control lists (ACLs)</primary>
53378 <secondary>indirect</secondary>
53379 </indexterm>
53380 <indexterm role="concept">
53381 <primary>access control lists (ACLs)</primary>
53382 <secondary>arguments</secondary>
53383 </indexterm>
53384 <indexterm role="concept">
53385 <primary><option>acl</option> ACL condition</primary>
53386 </indexterm>
53387 The possible values of the argument are the same as for the
53388 <option>acl_smtp_</option><emphasis>xxx</emphasis> options. The named or inline ACL is run. If it returns
53389 <quote>accept</quote> the condition is true; if it returns <quote>deny</quote> the condition is
53390 false. If it returns <quote>defer</quote>, the current ACL returns <quote>defer</quote> unless the
53391 condition is on a <option>warn</option> verb. In that case, a <quote>defer</quote> return makes the
53392 condition false. This means that further processing of the <option>warn</option> verb
53393 ceases, but processing of the ACL continues.
53394 </para>
53395 <para>
53396 If the argument is a named ACL, up to nine space-separated optional values
53397 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
53398 and $acl_narg is set to the count of values.
53399 Previous values of these variables are restored after the call returns.
53400 The name and values are expanded separately.
53401 </para>
53402 <para>
53403 If the nested <option>acl</option> returns <quote>drop</quote> and the outer condition denies access,
53404 the connection is dropped. If it returns <quote>discard</quote>, the verb must be
53405 <option>accept</option> or <option>discard</option>, and the action is taken immediately &ndash; no further
53406 conditions are tested.
53407 </para>
53408 <para>
53409 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
53410 loops. This condition allows you to use different ACLs in different
53411 circumstances. For example, different ACLs can be used to handle RCPT commands
53412 for different local users or different local domains.
53413 </para>
53414 </listitem></varlistentry>
53415 <varlistentry>
53416 <term><emphasis role="bold">authenticated&nbsp;=&nbsp;</emphasis>&lt;<emphasis>string&nbsp;list</emphasis>&gt;</term>
53417 <listitem>
53418 <para>
53419 <indexterm role="concept">
53420 <primary><option>authenticated</option> ACL condition</primary>
53421 </indexterm>
53422 <indexterm role="concept">
53423 <primary>authentication</primary>
53424 <secondary>ACL checking</secondary>
53425 </indexterm>
53426 <indexterm role="concept">
53427 <primary>access control lists (ACLs)</primary>
53428 <secondary>testing for authentication</secondary>
53429 </indexterm>
53430 If the SMTP connection is not authenticated, the condition is false. Otherwise,
53431 the name of the authenticator is tested against the list. To test for
53432 authentication by any authenticator, you can set
53433 </para>
53434 <literallayout class="monospaced">
53435 authenticated = *
53436 </literallayout>
53437 </listitem></varlistentry>
53438 <varlistentry>
53439 <term><emphasis role="bold">condition&nbsp;=&nbsp;</emphasis>&lt;<emphasis>string</emphasis>&gt;</term>
53440 <listitem>
53441 <para>
53442 <indexterm role="concept">
53443 <primary><option>condition</option> ACL condition</primary>
53444 </indexterm>
53445 <indexterm role="concept">
53446 <primary>customizing</primary>
53447 <secondary>ACL condition</secondary>
53448 </indexterm>
53449 <indexterm role="concept">
53450 <primary>access control lists (ACLs)</primary>
53451 <secondary>customized test</secondary>
53452 </indexterm>
53453 <indexterm role="concept">
53454 <primary>access control lists (ACLs)</primary>
53455 <secondary>testing, customized</secondary>
53456 </indexterm>
53457 This feature allows you to make up custom conditions. If the result of
53458 expanding the string is an empty string, the number zero, or one of the strings
53459 <quote>no</quote> or <quote>false</quote>, the condition is false. If the result is any non-zero
53460 number, or one of the strings <quote>yes</quote> or <quote>true</quote>, the condition is true. For
53461 any other value, some error is assumed to have occurred, and the ACL returns
53462 <quote>defer</quote>. However, if the expansion is forced to fail, the condition is
53463 ignored. The effect is to treat it as true, whether it is positive or
53464 negative.
53465 </para>
53466 </listitem></varlistentry>
53467 <varlistentry>
53468 <term><emphasis role="bold">decode&nbsp;=&nbsp;</emphasis>&lt;<emphasis>location</emphasis>&gt;</term>
53469 <listitem>
53470 <para>
53471 <indexterm role="concept">
53472 <primary><option>decode</option> ACL condition</primary>
53473 </indexterm>
53474 This condition is available only when Exim is compiled with the
53475 content-scanning extension, and it is allowed only in the ACL defined by
53476 <option>acl_smtp_mime</option>. It causes the current MIME part to be decoded into a file.
53477 If all goes well, the condition is true. It is false only if there are
53478 problems such as a syntax error or a memory shortage. For more details, see
53479 chapter <xref linkend="CHAPexiscan"/>.
53480 </para>
53481 </listitem></varlistentry>
53482 <varlistentry>
53483 <term><emphasis role="bold">demime&nbsp;=&nbsp;</emphasis>&lt;<emphasis>extension&nbsp;list</emphasis>&gt;</term>
53484 <listitem>
53485 <para>
53486 <indexterm role="concept">
53487 <primary><option>demime</option> ACL condition</primary>
53488 </indexterm>
53489 This condition is available only when Exim is compiled with the
53490 content-scanning extension. Its use is described in section
53491 <xref linkend="SECTdemimecond"/>.
53492 </para>
53493 </listitem></varlistentry>
53494 <varlistentry>
53495 <term><emphasis role="bold">dnslists&nbsp;=&nbsp;</emphasis>&lt;<emphasis>list&nbsp;of&nbsp;domain&nbsp;names&nbsp;and&nbsp;other&nbsp;data</emphasis>&gt;</term>
53496 <listitem>
53497 <para>
53498 <indexterm role="concept">
53499 <primary><option>dnslists</option> ACL condition</primary>
53500 </indexterm>
53501 <indexterm role="concept">
53502 <primary>DNS list</primary>
53503 <secondary>in ACL</secondary>
53504 </indexterm>
53505 <indexterm role="concept">
53506 <primary>black list (DNS)</primary>
53507 </indexterm>
53508 <indexterm role="concept">
53509 <primary>access control lists (ACLs)</primary>
53510 <secondary>testing a DNS list</secondary>
53511 </indexterm>
53512 This condition checks for entries in DNS black lists. These are also known as
53513 <quote>RBL lists</quote>, after the original Realtime Blackhole List, but note that the
53514 use of the lists at <emphasis>mail-abuse.org</emphasis> now carries a charge. There are too many
53515 different variants of this condition to describe briefly here. See sections
53516 <xref linkend="SECTmorednslists"/>&ndash;<xref linkend="SECTmorednslistslast"/> for details.
53517 </para>
53518 </listitem></varlistentry>
53519 <varlistentry>
53520 <term><emphasis role="bold">domains&nbsp;=&nbsp;</emphasis>&lt;<emphasis>domain&nbsp;list</emphasis>&gt;</term>
53521 <listitem>
53522 <para>
53523 <indexterm role="concept">
53524 <primary><option>domains</option> ACL condition</primary>
53525 </indexterm>
53526 <indexterm role="concept">
53527 <primary>domain</primary>
53528 <secondary>ACL checking</secondary>
53529 </indexterm>
53530 <indexterm role="concept">
53531 <primary>access control lists (ACLs)</primary>
53532 <secondary>testing a recipient domain</secondary>
53533 </indexterm>
53534 <indexterm role="variable">
53535 <primary><varname>$domain_data</varname></primary>
53536 </indexterm>
53537 This condition is relevant only after a RCPT command. It checks that the domain
53538 of the recipient address is in the domain list. If percent-hack processing is
53539 enabled, it is done before this test is done. If the check succeeds with a
53540 lookup, the result of the lookup is placed in <varname>$domain_data</varname> until the next
53541 <option>domains</option> test.
53542 </para>
53543 <para>
53544 <emphasis role="bold">Note carefully</emphasis> (because many people seem to fall foul of this): you cannot
53545 use <option>domains</option> in a DATA ACL.
53546 </para>
53547 </listitem></varlistentry>
53548 <varlistentry>
53549 <term><emphasis role="bold">encrypted&nbsp;=&nbsp;</emphasis>&lt;<emphasis>string&nbsp;list</emphasis>&gt;</term>
53550 <listitem>
53551 <para>
53552 <indexterm role="concept">
53553 <primary><option>encrypted</option> ACL condition</primary>
53554 </indexterm>
53555 <indexterm role="concept">
53556 <primary>encryption</primary>
53557 <secondary>checking in an ACL</secondary>
53558 </indexterm>
53559 <indexterm role="concept">
53560 <primary>access control lists (ACLs)</primary>
53561 <secondary>testing for encryption</secondary>
53562 </indexterm>
53563 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
53564 name of the cipher suite in use is tested against the list. To test for
53565 encryption without testing for any specific cipher suite(s), set
53566 </para>
53567 <literallayout class="monospaced">
53568 encrypted = *
53569 </literallayout>
53570 </listitem></varlistentry>
53571 <varlistentry>
53572 <term><emphasis role="bold">hosts&nbsp;=&nbsp;</emphasis>&lt;<emphasis>host&nbsp;list</emphasis>&gt;</term>
53573 <listitem>
53574 <para>
53575 <indexterm role="concept">
53576 <primary><option>hosts</option> ACL condition</primary>
53577 </indexterm>
53578 <indexterm role="concept">
53579 <primary>host</primary>
53580 <secondary>ACL checking</secondary>
53581 </indexterm>
53582 <indexterm role="concept">
53583 <primary>access control lists (ACLs)</primary>
53584 <secondary>testing the client host</secondary>
53585 </indexterm>
53586 This condition tests that the calling host matches the host list. If you have
53587 name lookups or wildcarded host names and IP addresses in the same host list,
53588 you should normally put the IP addresses first. For example, you could have:
53589 </para>
53590 <literallayout class="monospaced">
53591 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
53592 </literallayout>
53593 <para>
53594 The lookup in this example uses the host name for its key. This is implied by
53595 the lookup type <quote>dbm</quote>. (For a host address lookup you would use <quote>net-dbm</quote>
53596 and it wouldn&#x2019;t matter which way round you had these two items.)
53597 </para>
53598 <para>
53599 The reason for the problem with host names lies in the left-to-right way that
53600 Exim processes lists. It can test IP addresses without doing any DNS lookups,
53601 but when it reaches an item that requires a host name, it fails if it cannot
53602 find a host name to compare with the pattern. If the above list is given in the
53603 opposite order, the <option>accept</option> statement fails for a host whose name cannot be
53604 found, even if its IP address is 10.9.8.7.
53605 </para>
53606 <para>
53607 If you really do want to do the name check first, and still recognize the IP
53608 address even if the name lookup fails, you can rewrite the ACL like this:
53609 </para>
53610 <literallayout class="monospaced">
53611 accept hosts = dbm;/etc/friendly/hosts
53612 accept hosts = 10.9.8.7
53613 </literallayout>
53614 <para>
53615 The default action on failing to find the host name is to assume that the host
53616 is not in the list, so the first <option>accept</option> statement fails. The second
53617 statement can then check the IP address.
53618 </para>
53619 <para>
53620 <indexterm role="variable">
53621 <primary><varname>$host_data</varname></primary>
53622 </indexterm>
53623 If a <option>hosts</option> condition is satisfied by means of a lookup, the result
53624 of the lookup is made available in the <varname>$host_data</varname> variable. This
53625 allows you, for example, to set up a statement like this:
53626 </para>
53627 <literallayout class="monospaced">
53628 deny  hosts = net-lsearch;/some/file
53629 message = $host_data
53630 </literallayout>
53631 <para>
53632 which gives a custom error message for each denied host.
53633 </para>
53634 </listitem></varlistentry>
53635 <varlistentry>
53636 <term><emphasis role="bold">local_parts&nbsp;=&nbsp;</emphasis>&lt;<emphasis>local&nbsp;part&nbsp;list</emphasis>&gt;</term>
53637 <listitem>
53638 <para>
53639 <indexterm role="concept">
53640 <primary><option>local_parts</option> ACL condition</primary>
53641 </indexterm>
53642 <indexterm role="concept">
53643 <primary>local part</primary>
53644 <secondary>ACL checking</secondary>
53645 </indexterm>
53646 <indexterm role="concept">
53647 <primary>access control lists (ACLs)</primary>
53648 <secondary>testing a local part</secondary>
53649 </indexterm>
53650 <indexterm role="variable">
53651 <primary><varname>$local_part_data</varname></primary>
53652 </indexterm>
53653 This condition is relevant only after a RCPT command. It checks that the local
53654 part of the recipient address is in the list. If percent-hack processing is
53655 enabled, it is done before this test. If the check succeeds with a lookup, the
53656 result of the lookup is placed in <varname>$local_part_data</varname>, which remains set until
53657 the next <option>local_parts</option> test.
53658 </para>
53659 </listitem></varlistentry>
53660 <varlistentry>
53661 <term><emphasis role="bold">malware&nbsp;=&nbsp;</emphasis>&lt;<emphasis>option</emphasis>&gt;</term>
53662 <listitem>
53663 <para>
53664 <indexterm role="concept">
53665 <primary><option>malware</option> ACL condition</primary>
53666 </indexterm>
53667 <indexterm role="concept">
53668 <primary>access control lists (ACLs)</primary>
53669 <secondary>virus scanning</secondary>
53670 </indexterm>
53671 <indexterm role="concept">
53672 <primary>access control lists (ACLs)</primary>
53673 <secondary>scanning for viruses</secondary>
53674 </indexterm>
53675 This condition is available only when Exim is compiled with the
53676 content-scanning extension. It causes the incoming message to be scanned for
53677 viruses. For details, see chapter <xref linkend="CHAPexiscan"/>.
53678 </para>
53679 </listitem></varlistentry>
53680 <varlistentry>
53681 <term><emphasis role="bold">mime_regex&nbsp;=&nbsp;</emphasis>&lt;<emphasis>list&nbsp;of&nbsp;regular&nbsp;expressions</emphasis>&gt;</term>
53682 <listitem>
53683 <para>
53684 <indexterm role="concept">
53685 <primary><option>mime_regex</option> ACL condition</primary>
53686 </indexterm>
53687 <indexterm role="concept">
53688 <primary>access control lists (ACLs)</primary>
53689 <secondary>testing by regex matching</secondary>
53690 </indexterm>
53691 This condition is available only when Exim is compiled with the
53692 content-scanning extension, and it is allowed only in the ACL defined by
53693 <option>acl_smtp_mime</option>. It causes the current MIME part to be scanned for a match
53694 with any of the regular expressions. For details, see chapter
53695 <xref linkend="CHAPexiscan"/>.
53696 </para>
53697 </listitem></varlistentry>
53698 <varlistentry>
53699 <term><emphasis role="bold">ratelimit&nbsp;=&nbsp;</emphasis>&lt;<emphasis>parameters</emphasis>&gt;</term>
53700 <listitem>
53701 <para>
53702 <indexterm role="concept">
53703 <primary>rate limiting</primary>
53704 </indexterm>
53705 This condition can be used to limit the rate at which a user or host submits
53706 messages. Details are given in section <xref linkend="SECTratelimiting"/>.
53707 </para>
53708 </listitem></varlistentry>
53709 <varlistentry>
53710 <term><emphasis role="bold">recipients&nbsp;=&nbsp;</emphasis>&lt;<emphasis>address&nbsp;list</emphasis>&gt;</term>
53711 <listitem>
53712 <para>
53713 <indexterm role="concept">
53714 <primary><option>recipients</option> ACL condition</primary>
53715 </indexterm>
53716 <indexterm role="concept">
53717 <primary>recipient</primary>
53718 <secondary>ACL checking</secondary>
53719 </indexterm>
53720 <indexterm role="concept">
53721 <primary>access control lists (ACLs)</primary>
53722 <secondary>testing a recipient</secondary>
53723 </indexterm>
53724 This condition is relevant only after a RCPT command. It checks the entire
53725 recipient address against a list of recipients.
53726 </para>
53727 </listitem></varlistentry>
53728 <varlistentry>
53729 <term><emphasis role="bold">regex&nbsp;=&nbsp;</emphasis>&lt;<emphasis>list&nbsp;of&nbsp;regular&nbsp;expressions</emphasis>&gt;</term>
53730 <listitem>
53731 <para>
53732 <indexterm role="concept">
53733 <primary><option>regex</option> ACL condition</primary>
53734 </indexterm>
53735 <indexterm role="concept">
53736 <primary>access control lists (ACLs)</primary>
53737 <secondary>testing by regex matching</secondary>
53738 </indexterm>
53739 This condition is available only when Exim is compiled with the
53740 content-scanning extension, and is available only in the DATA, MIME, and
53741 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
53742 any of the regular expressions. For details, see chapter <xref linkend="CHAPexiscan"/>.
53743 </para>
53744 </listitem></varlistentry>
53745 <varlistentry>
53746 <term><emphasis role="bold">sender_domains&nbsp;=&nbsp;</emphasis>&lt;<emphasis>domain&nbsp;list</emphasis>&gt;</term>
53747 <listitem>
53748 <para>
53749 <indexterm role="concept">
53750 <primary><option>sender_domains</option> ACL condition</primary>
53751 </indexterm>
53752 <indexterm role="concept">
53753 <primary>sender</primary>
53754 <secondary>ACL checking</secondary>
53755 </indexterm>
53756 <indexterm role="concept">
53757 <primary>access control lists (ACLs)</primary>
53758 <secondary>testing a sender domain</secondary>
53759 </indexterm>
53760 <indexterm role="variable">
53761 <primary><varname>$domain</varname></primary>
53762 </indexterm>
53763 <indexterm role="variable">
53764 <primary><varname>$sender_address_domain</varname></primary>
53765 </indexterm>
53766 This condition tests the domain of the sender of the message against the given
53767 domain list. <emphasis role="bold">Note</emphasis>: The domain of the sender address is in
53768 <varname>$sender_address_domain</varname>. It is <emphasis>not</emphasis> put in <varname>$domain</varname> during the testing
53769 of this condition. This is an exception to the general rule for testing domain
53770 lists. It is done this way so that, if this condition is used in an ACL for a
53771 RCPT command, the recipient&#x2019;s domain (which is in <varname>$domain</varname>) can be used to
53772 influence the sender checking.
53773 </para>
53774 <para>
53775 <emphasis role="bold">Warning</emphasis>: It is a bad idea to use this condition on its own as a control on
53776 relaying, because sender addresses are easily, and commonly, forged.
53777 </para>
53778 </listitem></varlistentry>
53779 <varlistentry>
53780 <term><emphasis role="bold">senders&nbsp;=&nbsp;</emphasis>&lt;<emphasis>address&nbsp;list</emphasis>&gt;</term>
53781 <listitem>
53782 <para>
53783 <indexterm role="concept">
53784 <primary><option>senders</option> ACL condition</primary>
53785 </indexterm>
53786 <indexterm role="concept">
53787 <primary>sender</primary>
53788 <secondary>ACL checking</secondary>
53789 </indexterm>
53790 <indexterm role="concept">
53791 <primary>access control lists (ACLs)</primary>
53792 <secondary>testing a sender</secondary>
53793 </indexterm>
53794 This condition tests the sender of the message against the given list. To test
53795 for a bounce message, which has an empty sender, set
53796 </para>
53797 <literallayout class="monospaced">
53798 senders = :
53799 </literallayout>
53800 <para>
53801 <emphasis role="bold">Warning</emphasis>: It is a bad idea to use this condition on its own as a control on
53802 relaying, because sender addresses are easily, and commonly, forged.
53803 </para>
53804 </listitem></varlistentry>
53805 <varlistentry>
53806 <term><emphasis role="bold">spam&nbsp;=&nbsp;</emphasis>&lt;<emphasis>username</emphasis>&gt;</term>
53807 <listitem>
53808 <para>
53809 <indexterm role="concept">
53810 <primary><option>spam</option> ACL condition</primary>
53811 </indexterm>
53812 <indexterm role="concept">
53813 <primary>access control lists (ACLs)</primary>
53814 <secondary>scanning for spam</secondary>
53815 </indexterm>
53816 This condition is available only when Exim is compiled with the
53817 content-scanning extension. It causes the incoming message to be scanned by
53818 SpamAssassin. For details, see chapter <xref linkend="CHAPexiscan"/>.
53819 </para>
53820 </listitem></varlistentry>
53821 <varlistentry>
53822 <term><emphasis role="bold">verify&nbsp;=&nbsp;certificate</emphasis></term>
53823 <listitem>
53824 <para>
53825 <indexterm role="concept">
53826 <primary><option>verify</option> ACL condition</primary>
53827 </indexterm>
53828 <indexterm role="concept">
53829 <primary>TLS</primary>
53830 <secondary>client certificate verification</secondary>
53831 </indexterm>
53832 <indexterm role="concept">
53833 <primary>certificate</primary>
53834 <secondary>verification of client</secondary>
53835 </indexterm>
53836 <indexterm role="concept">
53837 <primary>access control lists (ACLs)</primary>
53838 <secondary>certificate verification</secondary>
53839 </indexterm>
53840 <indexterm role="concept">
53841 <primary>access control lists (ACLs)</primary>
53842 <secondary>testing a TLS certificate</secondary>
53843 </indexterm>
53844 This condition is true in an SMTP session if the session is encrypted, and a
53845 certificate was received from the client, and the certificate was verified. The
53846 server requests a certificate only if the client matches <option>tls_verify_hosts</option>
53847 or <option>tls_try_verify_hosts</option> (see chapter <xref linkend="CHAPTLS"/>).
53848 </para>
53849 </listitem></varlistentry>
53850 <varlistentry>
53851 <term><emphasis role="bold">verify&nbsp;=&nbsp;csa</emphasis></term>
53852 <listitem>
53853 <para>
53854 <indexterm role="concept">
53855 <primary>CSA verification</primary>
53856 </indexterm>
53857 This condition checks whether the sending host (the client) is authorized to
53858 send email. Details of how this works are given in section
53859 <xref linkend="SECTverifyCSA"/>.
53860 </para>
53861 </listitem></varlistentry>
53862 <varlistentry revisionflag="changed">
53863 <term><emphasis role="bold">verify&nbsp;=&nbsp;header_names_ascii</emphasis></term>
53864 <listitem>
53865 <para revisionflag="changed">
53866 <indexterm role="concept">
53867 <primary><option>verify</option> ACL condition</primary>
53868 </indexterm>
53869 <indexterm role="concept">
53870 <primary>access control lists (ACLs)</primary>
53871 <secondary>verifying header names only ASCII</secondary>
53872 </indexterm>
53873 <indexterm role="concept">
53874 <primary>header lines</primary>
53875 <secondary>verifying header names only ASCII</secondary>
53876 </indexterm>
53877 <indexterm role="concept">
53878 <primary>verifying</primary>
53879 <secondary>header names only ASCII</secondary>
53880 </indexterm>
53881 This condition is relevant only in an ACL that is run after a message has been
53882 received, that is, in an ACL specified by <option>acl_smtp_data</option> or
53883 <option>acl_not_smtp</option>.  It checks all header names (not the content) to make sure
53884 there are no non-ASCII characters, also excluding control characters.  The
53885 allowable characters are decimal ASCII values 33 through 126.
53886 </para>
53887 <para revisionflag="changed">
53888 Exim itself will handle headers with non-ASCII characters, but it can cause
53889 problems for downstream applications, so this option will allow their
53890 detection and rejection in the DATA ACL&#x2019;s.
53891 </para>
53892 </listitem></varlistentry>
53893 <varlistentry>
53894 <term><emphasis role="bold">verify&nbsp;=&nbsp;header_sender/</emphasis>&lt;<emphasis>options</emphasis>&gt;</term>
53895 <listitem>
53896 <para>
53897 <indexterm role="concept">
53898 <primary><option>verify</option> ACL condition</primary>
53899 </indexterm>
53900 <indexterm role="concept">
53901 <primary>access control lists (ACLs)</primary>
53902 <secondary>verifying sender in the header</secondary>
53903 </indexterm>
53904 <indexterm role="concept">
53905 <primary>header lines</primary>
53906 <secondary>verifying the sender in</secondary>
53907 </indexterm>
53908 <indexterm role="concept">
53909 <primary>sender</primary>
53910 <secondary>verifying in header</secondary>
53911 </indexterm>
53912 <indexterm role="concept">
53913 <primary>verifying</primary>
53914 <secondary>sender in header</secondary>
53915 </indexterm>
53916 This condition is relevant only in an ACL that is run after a message has been
53917 received, that is, in an ACL specified by <option>acl_smtp_data</option> or
53918 <option>acl_not_smtp</option>. It checks that there is a verifiable address in at least one
53919 of the <emphasis>Sender:</emphasis>, <emphasis>Reply-To:</emphasis>, or <emphasis>From:</emphasis> header lines. Such an address
53920 is loosely thought of as a <quote>sender</quote> address (hence the name of the test).
53921 However, an address that appears in one of these headers need not be an address
53922 that accepts bounce messages; only sender addresses in envelopes are required
53923 to accept bounces. Therefore, if you use the callout option on this check, you
53924 might want to arrange for a non-empty address in the MAIL command.
53925 </para>
53926 <para>
53927 Details of address verification and the options are given later, starting at
53928 section <xref linkend="SECTaddressverification"/> (callouts are described in section
53929 <xref linkend="SECTcallver"/>). You can combine this condition with the <option>senders</option>
53930 condition to restrict it to bounce messages only:
53931 </para>
53932 <literallayout class="monospaced">
53933 deny    senders = :
53934         message = A valid sender header is required for bounces
53935        !verify  = header_sender
53936 </literallayout>
53937 </listitem></varlistentry>
53938 <varlistentry>
53939 <term><emphasis role="bold">verify&nbsp;=&nbsp;header_syntax</emphasis></term>
53940 <listitem>
53941 <para>
53942 <indexterm role="concept">
53943 <primary><option>verify</option> ACL condition</primary>
53944 </indexterm>
53945 <indexterm role="concept">
53946 <primary>access control lists (ACLs)</primary>
53947 <secondary>verifying header syntax</secondary>
53948 </indexterm>
53949 <indexterm role="concept">
53950 <primary>header lines</primary>
53951 <secondary>verifying syntax</secondary>
53952 </indexterm>
53953 <indexterm role="concept">
53954 <primary>verifying</primary>
53955 <secondary>header syntax</secondary>
53956 </indexterm>
53957 This condition is relevant only in an ACL that is run after a message has been
53958 received, that is, in an ACL specified by <option>acl_smtp_data</option> or
53959 <option>acl_not_smtp</option>. It checks the syntax of all header lines that can contain
53960 lists of addresses (<emphasis>Sender:</emphasis>, <emphasis>From:</emphasis>, <emphasis>Reply-To:</emphasis>, <emphasis>To:</emphasis>, <emphasis>Cc:</emphasis>,
53961 and <emphasis>Bcc:</emphasis>). Unqualified addresses (local parts without domains) are
53962 permitted only in locally generated messages and from hosts that match
53963 <option>sender_unqualified_hosts</option> or <option>recipient_unqualified_hosts</option>, as
53964 appropriate.
53965 </para>
53966 <para>
53967 Note that this condition is a syntax check only. However, a common spamming
53968 ploy used to be to send syntactically invalid headers such as
53969 </para>
53970 <literallayout class="monospaced">
53971 To: @
53972 </literallayout>
53973 <para>
53974 and this condition can be used to reject such messages, though they are not as
53975 common as they used to be.
53976 </para>
53977 </listitem></varlistentry>
53978 <varlistentry>
53979 <term><emphasis role="bold">verify&nbsp;=&nbsp;helo</emphasis></term>
53980 <listitem>
53981 <para>
53982 <indexterm role="concept">
53983 <primary><option>verify</option> ACL condition</primary>
53984 </indexterm>
53985 <indexterm role="concept">
53986 <primary>access control lists (ACLs)</primary>
53987 <secondary>verifying HELO/EHLO</secondary>
53988 </indexterm>
53989 <indexterm role="concept">
53990 <primary>HELO</primary>
53991 <secondary>verifying</secondary>
53992 </indexterm>
53993 <indexterm role="concept">
53994 <primary>EHLO</primary>
53995 <secondary>verifying</secondary>
53996 </indexterm>
53997 <indexterm role="concept">
53998 <primary>verifying</primary>
53999 <secondary>EHLO</secondary>
54000 </indexterm>
54001 <indexterm role="concept">
54002 <primary>verifying</primary>
54003 <secondary>HELO</secondary>
54004 </indexterm>
54005 This condition is true if a HELO or EHLO command has been received from the
54006 client host, and its contents have been verified. If there has been no previous
54007 attempt to verify the HELO/EHLO contents, it is carried out when this
54008 condition is encountered. See the description of the <option>helo_verify_hosts</option> and
54009 <option>helo_try_verify_hosts</option> options for details of how to request verification
54010 independently of this condition.
54011 </para>
54012 <para>
54013 For SMTP input that does not come over TCP/IP (the <option>-bs</option> command line
54014 option), this condition is always true.
54015 </para>
54016 </listitem></varlistentry>
54017 <varlistentry>
54018 <term><emphasis role="bold">verify&nbsp;=&nbsp;not_blind</emphasis></term>
54019 <listitem>
54020 <para>
54021 <indexterm role="concept">
54022 <primary>verifying</primary>
54023 <secondary>not blind</secondary>
54024 </indexterm>
54025 <indexterm role="concept">
54026 <primary>bcc recipients, verifying none</primary>
54027 </indexterm>
54028 This condition checks that there are no blind (bcc) recipients in the message.
54029 Every envelope recipient must appear either in a <emphasis>To:</emphasis> header line or in a
54030 <emphasis>Cc:</emphasis> header line for this condition to be true. Local parts are checked
54031 case-sensitively; domains are checked case-insensitively. If <emphasis>Resent-To:</emphasis> or
54032 <emphasis>Resent-Cc:</emphasis> header lines exist, they are also checked. This condition can be
54033 used only in a DATA or non-SMTP ACL.
54034 </para>
54035 <para>
54036 There are, of course, many legitimate messages that make use of blind (bcc)
54037 recipients. This check should not be used on its own for blocking messages.
54038 </para>
54039 </listitem></varlistentry>
54040 <varlistentry>
54041 <term><emphasis role="bold">verify&nbsp;=&nbsp;recipient/</emphasis>&lt;<emphasis>options</emphasis>&gt;</term>
54042 <listitem>
54043 <para>
54044 <indexterm role="concept">
54045 <primary><option>verify</option> ACL condition</primary>
54046 </indexterm>
54047 <indexterm role="concept">
54048 <primary>access control lists (ACLs)</primary>
54049 <secondary>verifying recipient</secondary>
54050 </indexterm>
54051 <indexterm role="concept">
54052 <primary>recipient</primary>
54053 <secondary>verifying</secondary>
54054 </indexterm>
54055 <indexterm role="concept">
54056 <primary>verifying</primary>
54057 <secondary>recipient</secondary>
54058 </indexterm>
54059 <indexterm role="variable">
54060 <primary><varname>$address_data</varname></primary>
54061 </indexterm>
54062 This condition is relevant only after a RCPT command. It verifies the current
54063 recipient. Details of address verification are given later, starting at section
54064 <xref linkend="SECTaddressverification"/>. After a recipient has been verified, the value
54065 of <varname>$address_data</varname> is the last value that was set while routing the address.
54066 This applies even if the verification fails. When an address that is being
54067 verified is redirected to a single address, verification continues with the new
54068 address, and in that case, the subsequent value of <varname>$address_data</varname> is the
54069 value for the child address.
54070 </para>
54071 </listitem></varlistentry>
54072 <varlistentry>
54073 <term><emphasis role="bold">verify&nbsp;=&nbsp;reverse_host_lookup</emphasis></term>
54074 <listitem>
54075 <para>
54076 <indexterm role="concept">
54077 <primary><option>verify</option> ACL condition</primary>
54078 </indexterm>
54079 <indexterm role="concept">
54080 <primary>access control lists (ACLs)</primary>
54081 <secondary>verifying host reverse lookup</secondary>
54082 </indexterm>
54083 <indexterm role="concept">
54084 <primary>host</primary>
54085 <secondary>verifying reverse lookup</secondary>
54086 </indexterm>
54087 This condition ensures that a verified host name has been looked up from the IP
54088 address of the client host. (This may have happened already if the host name
54089 was needed for checking a host list, or if the host matched <option>host_lookup</option>.)
54090 Verification ensures that the host name obtained from a reverse DNS lookup, or
54091 one of its aliases, does, when it is itself looked up in the DNS, yield the
54092 original IP address.
54093 </para>
54094 <para>
54095 If this condition is used for a locally generated message (that is, when there
54096 is no client host involved), it always succeeds.
54097 </para>
54098 </listitem></varlistentry>
54099 <varlistentry>
54100 <term><emphasis role="bold">verify&nbsp;=&nbsp;sender/</emphasis>&lt;<emphasis>options</emphasis>&gt;</term>
54101 <listitem>
54102 <para>
54103 <indexterm role="concept">
54104 <primary><option>verify</option> ACL condition</primary>
54105 </indexterm>
54106 <indexterm role="concept">
54107 <primary>access control lists (ACLs)</primary>
54108 <secondary>verifying sender</secondary>
54109 </indexterm>
54110 <indexterm role="concept">
54111 <primary>sender</primary>
54112 <secondary>verifying</secondary>
54113 </indexterm>
54114 <indexterm role="concept">
54115 <primary>verifying</primary>
54116 <secondary>sender</secondary>
54117 </indexterm>
54118 This condition is relevant only after a MAIL or RCPT command, or after a
54119 message has been received (the <option>acl_smtp_data</option> or <option>acl_not_smtp</option> ACLs). If
54120 the message&#x2019;s sender is empty (that is, this is a bounce message), the
54121 condition is true. Otherwise, the sender address is verified.
54122 </para>
54123 <para>
54124 <indexterm role="variable">
54125 <primary><varname>$address_data</varname></primary>
54126 </indexterm>
54127 <indexterm role="variable">
54128 <primary><varname>$sender_address_data</varname></primary>
54129 </indexterm>
54130 If there is data in the <varname>$address_data</varname> variable at the end of routing, its
54131 value is placed in <varname>$sender_address_data</varname> at the end of verification. This
54132 value can be used in subsequent conditions and modifiers in the same ACL
54133 statement. It does not persist after the end of the current statement. If you
54134 want to preserve the value for longer, you can save it in an ACL variable.
54135 </para>
54136 <para>
54137 Details of verification are given later, starting at section
54138 <xref linkend="SECTaddressverification"/>. Exim caches the result of sender verification,
54139 to avoid doing it more than once per message.
54140 </para>
54141 </listitem></varlistentry>
54142 <varlistentry>
54143 <term><emphasis role="bold">verify&nbsp;=&nbsp;sender=</emphasis>&lt;<emphasis>address</emphasis>&gt;<emphasis role="bold">/</emphasis>&lt;<emphasis>options</emphasis>&gt;</term>
54144 <listitem>
54145 <para>
54146 <indexterm role="concept">
54147 <primary><option>verify</option> ACL condition</primary>
54148 </indexterm>
54149 This is a variation of the previous option, in which a modified address is
54150 verified as a sender.
54151 </para>
54152 </listitem></varlistentry>
54153 </variablelist>
54154 </section>
54155 <section id="SECTmorednslists">
54156 <title>Using DNS lists</title>
54157 <para>
54158 <indexterm role="concept">
54159 <primary>DNS list</primary>
54160 <secondary>in ACL</secondary>
54161 </indexterm>
54162 <indexterm role="concept">
54163 <primary>black list (DNS)</primary>
54164 </indexterm>
54165 <indexterm role="concept">
54166 <primary>access control lists (ACLs)</primary>
54167 <secondary>testing a DNS list</secondary>
54168 </indexterm>
54169 In its simplest form, the <option>dnslists</option> condition tests whether the calling host
54170 is on at least one of a number of DNS lists by looking up the inverted IP
54171 address in one or more DNS domains. (Note that DNS list domains are not mail
54172 domains, so the <literal>+</literal> syntax for named lists doesn&#x2019;t work - it is used for
54173 special options instead.) For example, if the calling host&#x2019;s IP
54174 address is 192.168.62.43, and the ACL statement is
54175 </para>
54176 <literallayout class="monospaced">
54177 deny dnslists = blackholes.mail-abuse.org : \
54178                 dialups.mail-abuse.org
54179 </literallayout>
54180 <para>
54181 the following records are looked up:
54182 </para>
54183 <literallayout class="monospaced">
54184 43.62.168.192.blackholes.mail-abuse.org
54185 43.62.168.192.dialups.mail-abuse.org
54186 </literallayout>
54187 <para>
54188 As soon as Exim finds an existing DNS record, processing of the list stops.
54189 Thus, multiple entries on the list provide an <quote>or</quote> conjunction. If you want
54190 to test that a host is on more than one list (an <quote>and</quote> conjunction), you can
54191 use two separate conditions:
54192 </para>
54193 <literallayout class="monospaced">
54194 deny dnslists = blackholes.mail-abuse.org
54195      dnslists = dialups.mail-abuse.org
54196 </literallayout>
54197 <para>
54198 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
54199 behaves as if the host does not match the list item, that is, as if the DNS
54200 record does not exist. If there are further items in the DNS list, they are
54201 processed.
54202 </para>
54203 <para>
54204 This is usually the required action when <option>dnslists</option> is used with <option>deny</option>
54205 (which is the most common usage), because it prevents a DNS failure from
54206 blocking mail. However, you can change this behaviour by putting one of the
54207 following special items in the list:
54208 </para>
54209 <literallayout>
54210 <literal>+include_unknown </literal>   behave as if the item is on the list
54211 <literal>+exclude_unknown </literal>   behave as if the item is not on the list (default)
54212 <literal>+defer_unknown   </literal>   give a temporary error
54213 </literallayout>
54214 <para>
54215 <indexterm role="concept">
54216 <primary><literal>+include_unknown</literal></primary>
54217 </indexterm>
54218 <indexterm role="concept">
54219 <primary><literal>+exclude_unknown</literal></primary>
54220 </indexterm>
54221 <indexterm role="concept">
54222 <primary><literal>+defer_unknown</literal></primary>
54223 </indexterm>
54224 Each of these applies to any subsequent items on the list. For example:
54225 </para>
54226 <literallayout class="monospaced">
54227 deny dnslists = +defer_unknown : foo.bar.example
54228 </literallayout>
54229 <para>
54230 Testing the list of domains stops as soon as a match is found. If you want to
54231 warn for one list and block for another, you can use two different statements:
54232 </para>
54233 <literallayout class="monospaced">
54234 deny  dnslists = blackholes.mail-abuse.org
54235 warn  message  = X-Warn: sending host is on dialups list
54236       dnslists = dialups.mail-abuse.org
54237 </literallayout>
54238 <para>
54239 DNS list lookups are cached by Exim for the duration of the SMTP session,
54240 so a lookup based on the IP address is done at most once for any incoming
54241 connection. Exim does not share information between multiple incoming
54242 connections (but your local name server cache should be active).
54243 </para>
54244 </section>
54245 <section id="SECID201">
54246 <title>Specifying the IP address for a DNS list lookup</title>
54247 <para>
54248 <indexterm role="concept">
54249 <primary>DNS list</primary>
54250 <secondary>keyed by explicit IP address</secondary>
54251 </indexterm>
54252 By default, the IP address that is used in a DNS list lookup is the IP address
54253 of the calling host. However, you can specify another IP address by listing it
54254 after the domain name, introduced by a slash. For example:
54255 </para>
54256 <literallayout class="monospaced">
54257 deny dnslists = black.list.tld/192.168.1.2
54258 </literallayout>
54259 <para>
54260 This feature is not very helpful with explicit IP addresses; it is intended for
54261 use with IP addresses that are looked up, for example, the IP addresses of the
54262 MX hosts or nameservers of an email sender address. For an example, see section
54263 <xref linkend="SECTmulkeyfor"/> below.
54264 </para>
54265 </section>
54266 <section id="SECID202">
54267 <title>DNS lists keyed on domain names</title>
54268 <para>
54269 <indexterm role="concept">
54270 <primary>DNS list</primary>
54271 <secondary>keyed by domain name</secondary>
54272 </indexterm>
54273 There are some lists that are keyed on domain names rather than inverted IP
54274 addresses (see for example the <emphasis>domain based zones</emphasis> link at
54275 <emphasis role="bold"><ulink url="http://www.rfc-ignorant.org/">http://www.rfc-ignorant.org/</ulink></emphasis>). No reversing of components is used
54276 with these lists. You can change the name that is looked up in a DNS list by
54277 listing it after the domain name, introduced by a slash. For example,
54278 </para>
54279 <literallayout class="monospaced">
54280 deny  message  = Sender's domain is listed at $dnslist_domain
54281       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
54282 </literallayout>
54283 <para>
54284 This particular example is useful only in ACLs that are obeyed after the
54285 RCPT or DATA commands, when a sender address is available. If (for
54286 example) the message&#x2019;s sender is <emphasis>user@tld.example</emphasis> the name that is looked
54287 up by this example is
54288 </para>
54289 <literallayout class="monospaced">
54290 tld.example.dsn.rfc-ignorant.org
54291 </literallayout>
54292 <para>
54293 A single <option>dnslists</option> condition can contain entries for both names and IP
54294 addresses. For example:
54295 </para>
54296 <literallayout class="monospaced">
54297 deny dnslists = sbl.spamhaus.org : \
54298                 dsn.rfc-ignorant.org/$sender_address_domain
54299 </literallayout>
54300 <para>
54301 The first item checks the sending host&#x2019;s IP address; the second checks a domain
54302 name. The whole condition is true if either of the DNS lookups succeeds.
54303 </para>
54304 </section>
54305 <section id="SECTmulkeyfor">
54306 <title>Multiple explicit keys for a DNS list</title>
54307 <para>
54308 <indexterm role="concept">
54309 <primary>DNS list</primary>
54310 <secondary>multiple keys for</secondary>
54311 </indexterm>
54312 The syntax described above for looking up explicitly-defined values (either
54313 names or IP addresses) in a DNS blacklist is a simplification. After the domain
54314 name for the DNS list, what follows the slash can in fact be a list of items.
54315 As with all lists in Exim, the default separator is a colon. However, because
54316 this is a sublist within the list of DNS blacklist domains, it is necessary
54317 either to double the separators like this:
54318 </para>
54319 <literallayout class="monospaced">
54320 dnslists = black.list.tld/name.1::name.2
54321 </literallayout>
54322 <para>
54323 or to change the separator character, like this:
54324 </para>
54325 <literallayout class="monospaced">
54326 dnslists = black.list.tld/&lt;;name.1;name.2
54327 </literallayout>
54328 <para>
54329 If an item in the list is an IP address, it is inverted before the DNS
54330 blacklist domain is appended. If it is not an IP address, no inversion
54331 occurs. Consider this condition:
54332 </para>
54333 <literallayout class="monospaced">
54334 dnslists = black.list.tld/&lt;;192.168.1.2;a.domain
54335 </literallayout>
54336 <para>
54337 The DNS lookups that occur are:
54338 </para>
54339 <literallayout class="monospaced">
54340 2.1.168.192.black.list.tld
54341 a.domain.black.list.tld
54342 </literallayout>
54343 <para>
54344 Once a DNS record has been found (that matches a specific IP return
54345 address, if specified &ndash; see section <xref linkend="SECTaddmatcon"/>), no further lookups
54346 are done. If there is a temporary DNS error, the rest of the sublist of domains
54347 or IP addresses is tried. A temporary error for the whole dnslists item occurs
54348 only if no other DNS lookup in this sublist succeeds. In other words, a
54349 successful lookup for any of the items in the sublist overrides a temporary
54350 error for a previous item.
54351 </para>
54352 <para>
54353 The ability to supply a list of items after the slash is in some sense just a
54354 syntactic convenience. These two examples have the same effect:
54355 </para>
54356 <literallayout class="monospaced">
54357 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
54358 dnslists = black.list.tld/a.domain::b.domain
54359 </literallayout>
54360 <para>
54361 However, when the data for the list is obtained from a lookup, the second form
54362 is usually much more convenient. Consider this example:
54363 </para>
54364 <literallayout class="monospaced">
54365 deny message  = The mail servers for the domain \
54366                 $sender_address_domain \
54367                 are listed at $dnslist_domain ($dnslist_value); \
54368                 see $dnslist_text.
54369      dnslists = sbl.spamhaus.org/&lt;|${lookup dnsdb {&gt;|a=&lt;|\
54370                                    ${lookup dnsdb {&gt;|mxh=\
54371                                    $sender_address_domain} }} }
54372 </literallayout>
54373 <para>
54374 Note the use of <literal>&gt;|</literal> in the dnsdb lookup to specify the separator for
54375 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
54376 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
54377 of expanding the condition might be something like this:
54378 </para>
54379 <literallayout class="monospaced">
54380 dnslists = sbl.spahmaus.org/&lt;|192.168.2.3|192.168.5.6|...
54381 </literallayout>
54382 <para>
54383 Thus, this example checks whether or not the IP addresses of the sender
54384 domain&#x2019;s mail servers are on the Spamhaus black list.
54385 </para>
54386 <para>
54387 The key that was used for a successful DNS list lookup is put into the variable
54388 <varname>$dnslist_matched</varname> (see section <xref linkend="SECID204"/>).
54389 </para>
54390 </section>
54391 <section id="SECID203">
54392 <title>Data returned by DNS lists</title>
54393 <para>
54394 <indexterm role="concept">
54395 <primary>DNS list</primary>
54396 <secondary>data returned from</secondary>
54397 </indexterm>
54398 DNS lists are constructed using address records in the DNS. The original RBL
54399 just used the address 127.0.0.1 on the right hand side of each record, but the
54400 RBL+ list and some other lists use a number of values with different meanings.
54401 The values used on the RBL+ list are:
54402 </para>
54403 <literallayout>
54404 127.1.0.1  RBL
54405 127.1.0.2  DUL
54406 127.1.0.3  DUL and RBL
54407 127.1.0.4  RSS
54408 127.1.0.5  RSS and RBL
54409 127.1.0.6  RSS and DUL
54410 127.1.0.7  RSS and DUL and RBL
54411 </literallayout>
54412 <para>
54413 Section <xref linkend="SECTaddmatcon"/> below describes how you can distinguish between
54414 different values. Some DNS lists may return more than one address record;
54415 see section <xref linkend="SECThanmuldnsrec"/> for details of how they are checked.
54416 </para>
54417 </section>
54418 <section id="SECID204">
54419 <title>Variables set from DNS lists</title>
54420 <para>
54421 <indexterm role="concept">
54422 <primary>expansion</primary>
54423 <secondary>variables, set from DNS list</secondary>
54424 </indexterm>
54425 <indexterm role="concept">
54426 <primary>DNS list</primary>
54427 <secondary>variables set from</secondary>
54428 </indexterm>
54429 <indexterm role="variable">
54430 <primary><varname>$dnslist_domain</varname></primary>
54431 </indexterm>
54432 <indexterm role="variable">
54433 <primary><varname>$dnslist_matched</varname></primary>
54434 </indexterm>
54435 <indexterm role="variable">
54436 <primary><varname>$dnslist_text</varname></primary>
54437 </indexterm>
54438 <indexterm role="variable">
54439 <primary><varname>$dnslist_value</varname></primary>
54440 </indexterm>
54441 When an entry is found in a DNS list, the variable <varname>$dnslist_domain</varname> contains
54442 the name of the overall domain that matched (for example,
54443 <literal>spamhaus.example</literal>), <varname>$dnslist_matched</varname> contains the key within that domain
54444 (for example, <literal>192.168.5.3</literal>), and <varname>$dnslist_value</varname> contains the data from
54445 the DNS record. When the key is an IP address, it is not reversed in
54446 <varname>$dnslist_matched</varname> (though it is, of course, in the actual lookup). In simple
54447 cases, for example:
54448 </para>
54449 <literallayout class="monospaced">
54450 deny dnslists = spamhaus.example
54451 </literallayout>
54452 <para>
54453 the key is also available in another variable (in this case,
54454 <varname>$sender_host_address</varname>). In more complicated cases, however, this is not true.
54455 For example, using a data lookup (as described in section <xref linkend="SECTmulkeyfor"/>)
54456 might generate a dnslists lookup like this:
54457 </para>
54458 <literallayout class="monospaced">
54459 deny dnslists = spamhaus.example/&lt;|192.168.1.2|192.168.6.7|...
54460 </literallayout>
54461 <para>
54462 If this condition succeeds, the value in <varname>$dnslist_matched</varname> might be
54463 <literal>192.168.6.7</literal> (for example).
54464 </para>
54465 <para>
54466 If more than one address record is returned by the DNS lookup, all the IP
54467 addresses are included in <varname>$dnslist_value</varname>, separated by commas and spaces.
54468 The variable <varname>$dnslist_text</varname> contains the contents of any associated TXT
54469 record. For lists such as RBL+ the TXT record for a merged entry is often not
54470 very meaningful. See section <xref linkend="SECTmordetinf"/> for a way of obtaining more
54471 information.
54472 </para>
54473 <para>
54474 You can use the DNS list variables in <option>message</option> or <option>log_message</option> modifiers
54475 &ndash; although these appear before the condition in the ACL, they are not
54476 expanded until after it has failed. For example:
54477 </para>
54478 <literallayout class="monospaced">
54479 deny    hosts = !+local_networks
54480         message = $sender_host_address is listed \
54481                   at $dnslist_domain
54482         dnslists = rbl-plus.mail-abuse.example
54483 </literallayout>
54484 </section>
54485 <section id="SECTaddmatcon">
54486 <title>Additional matching conditions for DNS lists</title>
54487 <para>
54488 <indexterm role="concept">
54489 <primary>DNS list</primary>
54490 <secondary>matching specific returned data</secondary>
54491 </indexterm>
54492 You can add an equals sign and an IP address after a <option>dnslists</option> domain name
54493 in order to restrict its action to DNS records with a matching right hand side.
54494 For example,
54495 </para>
54496 <literallayout class="monospaced">
54497 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
54498 </literallayout>
54499 <para>
54500 rejects only those hosts that yield 127.0.0.2. Without this additional data,
54501 any address record is considered to be a match. For the moment, we assume
54502 that the DNS lookup returns just one record. Section <xref linkend="SECThanmuldnsrec"/>
54503 describes how multiple records are handled.
54504 </para>
54505 <para>
54506 More than one IP address may be given for checking, using a comma as a
54507 separator. These are alternatives &ndash; if any one of them matches, the
54508 <option>dnslists</option> condition is true. For example:
54509 </para>
54510 <literallayout class="monospaced">
54511 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
54512 </literallayout>
54513 <para>
54514 If you want to specify a constraining address list and also specify names or IP
54515 addresses to be looked up, the constraining address list must be specified
54516 first. For example:
54517 </para>
54518 <literallayout class="monospaced">
54519 deny dnslists = dsn.rfc-ignorant.org\
54520                 =127.0.0.2/$sender_address_domain
54521 </literallayout>
54522 <para>
54523 If the character <literal>&amp;</literal> is used instead of <literal>=</literal>, the comparison for each
54524 listed IP address is done by a bitwise <quote>and</quote> instead of by an equality test.
54525 In other words, the listed addresses are used as bit masks. The comparison is
54526 true if all the bits in the mask are present in the address that is being
54527 tested. For example:
54528 </para>
54529 <literallayout class="monospaced">
54530 dnslists = a.b.c&amp;0.0.0.3
54531 </literallayout>
54532 <para>
54533 matches if the address is <emphasis>x.x.x.</emphasis>3, <emphasis>x.x.x.</emphasis>7, <emphasis>x.x.x.</emphasis>11, etc. If you
54534 want to test whether one bit or another bit is present (as opposed to both
54535 being present), you must use multiple values. For example:
54536 </para>
54537 <literallayout class="monospaced">
54538 dnslists = a.b.c&amp;0.0.0.1,0.0.0.2
54539 </literallayout>
54540 <para>
54541 matches if the final component of the address is an odd number or two times
54542 an odd number.
54543 </para>
54544 </section>
54545 <section id="SECID205">
54546 <title>Negated DNS matching conditions</title>
54547 <para>
54548 You can supply a negative list of IP addresses as part of a <option>dnslists</option>
54549 condition. Whereas
54550 </para>
54551 <literallayout class="monospaced">
54552 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
54553 </literallayout>
54554 <para>
54555 means <quote>deny if the host is in the black list at the domain <emphasis>a.b.c</emphasis> and the
54556 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3</quote>,
54557 </para>
54558 <literallayout class="monospaced">
54559 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
54560 </literallayout>
54561 <para>
54562 means <quote>deny if the host is in the black list at the domain <emphasis>a.b.c</emphasis> and the
54563 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3</quote>. In other
54564 words, the result of the test is inverted if an exclamation mark appears before
54565 the <literal>=</literal> (or the <literal>&amp;</literal>) sign.
54566 </para>
54567 <para>
54568 <emphasis role="bold">Note</emphasis>: This kind of negation is not the same as negation in a domain,
54569 host, or address list (which is why the syntax is different).
54570 </para>
54571 <para>
54572 If you are using just one list, the negation syntax does not gain you much. The
54573 previous example is precisely equivalent to
54574 </para>
54575 <literallayout class="monospaced">
54576 deny  dnslists = a.b.c
54577      !dnslists = a.b.c=127.0.0.2,127.0.0.3
54578 </literallayout>
54579 <para>
54580 However, if you are using multiple lists, the negation syntax is clearer.
54581 Consider this example:
54582 </para>
54583 <literallayout class="monospaced">
54584 deny  dnslists = sbl.spamhaus.org : \
54585                  list.dsbl.org : \
54586                  dnsbl.njabl.org!=127.0.0.3 : \
54587                  relays.ordb.org
54588 </literallayout>
54589 <para>
54590 Using only positive lists, this would have to be:
54591 </para>
54592 <literallayout class="monospaced">
54593 deny  dnslists = sbl.spamhaus.org : \
54594                  list.dsbl.org
54595 deny  dnslists = dnsbl.njabl.org
54596      !dnslists = dnsbl.njabl.org=127.0.0.3
54597 deny  dnslists = relays.ordb.org
54598 </literallayout>
54599 <para>
54600 which is less clear, and harder to maintain.
54601 </para>
54602 </section>
54603 <section id="SECThanmuldnsrec">
54604 <title>Handling multiple DNS records from a DNS list</title>
54605 <para>
54606 A DNS lookup for a <option>dnslists</option> condition may return more than one DNS record,
54607 thereby providing more than one IP address. When an item in a <option>dnslists</option> list
54608 is followed by <literal>=</literal> or <literal>&amp;</literal> and a list of IP addresses, in order to restrict
54609 the match to specific results from the DNS lookup, there are two ways in which
54610 the checking can be handled. For example, consider the condition:
54611 </para>
54612 <literallayout class="monospaced">
54613 dnslists = a.b.c=127.0.0.1
54614 </literallayout>
54615 <para>
54616 What happens if the DNS lookup for the incoming IP address yields both
54617 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
54618 condition true because at least one given value was found, or is it false
54619 because at least one of the found values was not listed? And how does this
54620 affect negated conditions? Both possibilities are provided for with the help of
54621 additional separators <literal>==</literal> and <literal>=&amp;</literal>.
54622 </para>
54623 <itemizedlist>
54624 <listitem>
54625 <para>
54626 If <literal>=</literal> or <literal>&amp;</literal> is used, the condition is true if any one of the looked up
54627 IP addresses matches one of the listed addresses. For the example above, the
54628 condition is true because 127.0.0.1 matches.
54629 </para>
54630 </listitem>
54631 <listitem>
54632 <para>
54633 If <literal>==</literal> or <literal>=&amp;</literal> is used, the condition is true only if every one of the
54634 looked up IP addresses matches one of the listed addresses. If the condition is
54635 changed to:
54636 </para>
54637 <literallayout class="monospaced">
54638 dnslists = a.b.c==127.0.0.1
54639 </literallayout>
54640 <para>
54641 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
54642 false because 127.0.0.2 is not listed. You would need to have:
54643 </para>
54644 <literallayout class="monospaced">
54645 dnslists = a.b.c==127.0.0.1,127.0.0.2
54646 </literallayout>
54647 <para>
54648 for the condition to be true.
54649 </para>
54650 </listitem>
54651 </itemizedlist>
54652 <para>
54653 When <literal>!</literal> is used to negate IP address matching, it inverts the result, giving
54654 the precise opposite of the behaviour above. Thus:
54655 </para>
54656 <itemizedlist>
54657 <listitem>
54658 <para>
54659 If <literal>!=</literal> or <literal>!&amp;</literal> is used, the condition is true if none of the looked up IP
54660 addresses matches one of the listed addresses. Consider:
54661 </para>
54662 <literallayout class="monospaced">
54663 dnslists = a.b.c!&amp;0.0.0.1
54664 </literallayout>
54665 <para>
54666 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
54667 false because 127.0.0.1 matches.
54668 </para>
54669 </listitem>
54670 <listitem>
54671 <para>
54672 If <literal>!==</literal> or <literal>!=&amp;</literal> is used, the condition is true if there is at least one
54673 looked up IP address that does not match. Consider:
54674 </para>
54675 <literallayout class="monospaced">
54676 dnslists = a.b.c!=&amp;0.0.0.1
54677 </literallayout>
54678 <para>
54679 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
54680 true, because 127.0.0.2 does not match. You would need to have:
54681 </para>
54682 <literallayout class="monospaced">
54683 dnslists = a.b.c!=&amp;0.0.0.1,0.0.0.2
54684 </literallayout>
54685 <para>
54686 for the condition to be false.
54687 </para>
54688 </listitem>
54689 </itemizedlist>
54690 <para>
54691 When the DNS lookup yields only a single IP address, there is no difference
54692 between <literal>=</literal> and <literal>==</literal> and between <literal>&amp;</literal> and <literal>=&amp;</literal>.
54693 </para>
54694 </section>
54695 <section id="SECTmordetinf">
54696 <title>Detailed information from merged DNS lists</title>
54697 <para>
54698 <indexterm role="concept">
54699 <primary>DNS list</primary>
54700 <secondary>information from merged</secondary>
54701 </indexterm>
54702 When the facility for restricting the matching IP values in a DNS list is used,
54703 the text from the TXT record that is set in <varname>$dnslist_text</varname> may not reflect
54704 the true reason for rejection. This happens when lists are merged and the IP
54705 address in the A record is used to distinguish them; unfortunately there is
54706 only one TXT record. One way round this is not to use merged lists, but that
54707 can be inefficient because it requires multiple DNS lookups where one would do
54708 in the vast majority of cases when the host of interest is not on any of the
54709 lists.
54710 </para>
54711 <para>
54712 A less inefficient way of solving this problem is available. If
54713 two domain names, comma-separated, are given, the second is used first to
54714 do an initial check, making use of any IP value restrictions that are set.
54715 If there is a match, the first domain is used, without any IP value
54716 restrictions, to get the TXT record. As a byproduct of this, there is also
54717 a check that the IP being tested is indeed on the first list. The first
54718 domain is the one that is put in <varname>$dnslist_domain</varname>. For example:
54719 </para>
54720 <literallayout class="monospaced">
54721 reject message  = \
54722          rejected because $sender_host_address is blacklisted \
54723          at $dnslist_domain\n$dnslist_text
54724        dnslists = \
54725          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
54726          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
54727 </literallayout>
54728 <para>
54729 For the first blacklist item, this starts by doing a lookup in
54730 <emphasis>sbl-xbl.spamhaus.org</emphasis> and testing for a 127.0.0.2 return. If there is a
54731 match, it then looks in <emphasis>sbl.spamhaus.org</emphasis>, without checking the return
54732 value, and as long as something is found, it looks for the corresponding TXT
54733 record. If there is no match in <emphasis>sbl-xbl.spamhaus.org</emphasis>, nothing more is done.
54734 The second blacklist item is processed similarly.
54735 </para>
54736 <para>
54737 If you are interested in more than one merged list, the same list must be
54738 given several times, but because the results of the DNS lookups are cached,
54739 the DNS calls themselves are not repeated. For example:
54740 </para>
54741 <literallayout class="monospaced">
54742 reject dnslists = \
54743          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
54744          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
54745          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
54746          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
54747 </literallayout>
54748 <para>
54749 In this case there is one lookup in <emphasis>dnsbl.sorbs.net</emphasis>, and if none of the IP
54750 values matches (or if no record is found), this is the only lookup that is
54751 done. Only if there is a match is one of the more specific lists consulted.
54752 </para>
54753 </section>
54754 <section id="SECTmorednslistslast">
54755 <title>DNS lists and IPv6</title>
54756 <para>
54757 <indexterm role="concept">
54758 <primary>IPv6</primary>
54759 <secondary>DNS black lists</secondary>
54760 </indexterm>
54761 <indexterm role="concept">
54762 <primary>DNS list</primary>
54763 <secondary>IPv6 usage</secondary>
54764 </indexterm>
54765 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
54766 nibble by nibble. For example, if the calling host&#x2019;s IP address is
54767 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
54768 </para>
54769 <literallayout class="monospaced">
54770 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
54771   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
54772 </literallayout>
54773 <para>
54774 (split over two lines here to fit on the page). Unfortunately, some of the DNS
54775 lists contain wildcard records, intended for IPv4, that interact badly with
54776 IPv6. For example, the DNS entry
54777 </para>
54778 <literallayout class="monospaced">
54779 *.3.some.list.example.    A    127.0.0.1
54780 </literallayout>
54781 <para>
54782 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
54783 Unfortunately, it also matches the entire 3::/4 IPv6 network.
54784 </para>
54785 <para>
54786 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
54787 <option>condition</option> condition, as in this example:
54788 </para>
54789 <literallayout class="monospaced">
54790 deny   condition = ${if isip4{$sender_host_address}}
54791        dnslists  = some.list.example
54792 </literallayout>
54793 <para>
54794 If an explicit key is being used for a DNS lookup and it may be an IPv6
54795 address you should specify alternate list separators for both the outer
54796 (DNS list name) list and inner (lookup keys) list:
54797 </para>
54798 <literallayout class="monospaced">
54799        dnslists = &lt;; dnsbl.example.com/&lt;|$acl_m_addrslist
54800 </literallayout>
54801 </section>
54802 <section id="SECTratelimiting">
54803 <title>Rate limiting incoming messages</title>
54804 <para>
54805 <indexterm role="concept">
54806 <primary>rate limiting</primary>
54807 <secondary>client sending</secondary>
54808 </indexterm>
54809 <indexterm role="concept">
54810 <primary>limiting client sending rates</primary>
54811 </indexterm>
54812 <indexterm role="option">
54813 <primary><option>smtp_ratelimit_*</option></primary>
54814 </indexterm>
54815 The <option>ratelimit</option> ACL condition can be used to measure and control the rate at
54816 which clients can send email. This is more powerful than the
54817 <option>smtp_ratelimit_*</option> options, because those options control the rate of
54818 commands in a single SMTP session only, whereas the <option>ratelimit</option> condition
54819 works across all connections (concurrent and sequential) from the same client
54820 host. The syntax of the <option>ratelimit</option> condition is:
54821 </para>
54822 <literallayout>
54823 <literal>ratelimit =</literal> &lt;<emphasis>m</emphasis>&gt; <literal>/</literal> &lt;<emphasis>p</emphasis>&gt; <literal>/</literal> &lt;<emphasis>options</emphasis>&gt; <literal>/</literal> &lt;<emphasis>key</emphasis>&gt;
54824 </literallayout>
54825 <para>
54826 If the average client sending rate is less than <emphasis>m</emphasis> messages per time
54827 period <emphasis>p</emphasis> then the condition is false; otherwise it is true.
54828 </para>
54829 <para>
54830 As a side-effect, the <option>ratelimit</option> condition sets the expansion variable
54831 <varname>$sender_rate</varname> to the client&#x2019;s computed rate, <varname>$sender_rate_limit</varname> to the
54832 configured value of <emphasis>m</emphasis>, and <varname>$sender_rate_period</varname> to the configured value
54833 of <emphasis>p</emphasis>.
54834 </para>
54835 <para>
54836 The parameter <emphasis>p</emphasis> is the smoothing time constant, in the form of an Exim
54837 time interval, for example, <literal>8h</literal> for eight hours. A larger time constant
54838 means that it takes Exim longer to forget a client&#x2019;s past behaviour. The
54839 parameter <emphasis>m</emphasis> is the maximum number of messages that a client is permitted to
54840 send in each time interval. It also specifies the number of messages permitted
54841 in a fast burst. By increasing both <emphasis>m</emphasis> and <emphasis>p</emphasis> but keeping <emphasis>m/p</emphasis>
54842 constant, you can allow a client to send more messages in a burst without
54843 changing its long-term sending rate limit. Conversely, if <emphasis>m</emphasis> and <emphasis>p</emphasis> are
54844 both small, messages must be sent at an even rate.
54845 </para>
54846 <para>
54847 There is a script in <filename>util/ratelimit.pl</filename> which extracts sending rates from
54848 log files, to assist with choosing appropriate settings for <emphasis>m</emphasis> and <emphasis>p</emphasis>
54849 when deploying the <option>ratelimit</option> ACL condition. The script prints usage
54850 instructions when it is run with no arguments.
54851 </para>
54852 <para>
54853 The key is used to look up the data for calculating the client&#x2019;s average
54854 sending rate. This data is stored in Exim&#x2019;s spool directory, alongside the
54855 retry and other hints databases. The default key is <varname>$sender_host_address</varname>,
54856 which means Exim computes the sending rate of each client host IP address.
54857 By changing the key you can change how Exim identifies clients for the purpose
54858 of ratelimiting. For example, to limit the sending rate of each authenticated
54859 user, independent of the computer they are sending from, set the key to
54860 <varname>$authenticated_id</varname>. You must ensure that the lookup key is meaningful; for
54861 example, <varname>$authenticated_id</varname> is only meaningful if the client has
54862 authenticated (which you can check with the <option>authenticated</option> ACL condition).
54863 </para>
54864 <para>
54865 The lookup key does not have to identify clients: If you want to limit the
54866 rate at which a recipient receives messages, you can use the key
54867 <literal>$local_part@$domain</literal> with the <option>per_rcpt</option> option (see below) in a RCPT
54868 ACL.
54869 </para>
54870 <para>
54871 Each <option>ratelimit</option> condition can have up to four options. A <option>per_*</option> option
54872 specifies what Exim measures the rate of, for example messages or recipients
54873 or bytes. You can adjust the measurement using the <option>unique=</option> and/or
54874 <option>count=</option> options. You can also control when Exim updates the recorded rate
54875 using a <option>strict</option>, <option>leaky</option>, or <option>readonly</option> option. The options are
54876 separated by a slash, like the other parameters. They may appear in any order.
54877 </para>
54878 <para>
54879 Internally, Exim appends the smoothing constant <emphasis>p</emphasis> onto the lookup key with
54880 any options that alter the meaning of the stored data. The limit <emphasis>m</emphasis> is not
54881 stored, so you can alter the configured maximum rate and Exim will still
54882 remember clients&#x2019; past behaviour. If you change the <option>per_*</option> mode or add or
54883 remove the <option>unique=</option> option, the lookup key changes so Exim will forget past
54884 behaviour. The lookup key is not affected by changes to the update mode and
54885 the <option>count=</option> option.
54886 </para>
54887 </section>
54888 <section id="ratoptmea">
54889 <title>Ratelimit options for what is being measured</title>
54890 <para>
54891 <indexterm role="concept">
54892 <primary>rate limiting</primary>
54893 <secondary>per_* options</secondary>
54894 </indexterm>
54895 The <option>per_conn</option> option limits the client&#x2019;s connection rate. It is not
54896 normally used in the <option>acl_not_smtp</option>, <option>acl_not_smtp_mime</option>, or
54897 <option>acl_not_smtp_start</option> ACLs.
54898 </para>
54899 <para>
54900 The <option>per_mail</option> option limits the client&#x2019;s rate of sending messages. This is
54901 the default if none of the <option>per_*</option> options is specified. It can be used in
54902 <option>acl_smtp_mail</option>, <option>acl_smtp_rcpt</option>, <option>acl_smtp_predata</option>, <option>acl_smtp_mime</option>,
54903 <option>acl_smtp_data</option>, or <option>acl_not_smtp</option>.
54904 </para>
54905 <para>
54906 The <option>per_byte</option> option limits the sender&#x2019;s email bandwidth. It can be used in
54907 the same ACLs as the <option>per_mail</option> option, though it is best to use this option
54908 in the <option>acl_smtp_mime</option>, <option>acl_smtp_data</option> or <option>acl_not_smtp</option> ACLs; if it is
54909 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
54910 in its MAIL command, which may be inaccurate or completely missing. You can
54911 follow the limit <emphasis>m</emphasis> in the configuration with K, M, or G to specify limits
54912 in kilobytes, megabytes, or gigabytes, respectively.
54913 </para>
54914 <para>
54915 The <option>per_rcpt</option> option causes Exim to limit the rate at which recipients are
54916 accepted. It can be used in the <option>acl_smtp_rcpt</option>, <option>acl_smtp_predata</option>,
54917 <option>acl_smtp_mime</option>, <option>acl_smtp_data</option>, or <option>acl_smtp_rcpt</option> ACLs. In
54918 <option>acl_smtp_rcpt</option> the rate is updated one recipient at a time; in the other
54919 ACLs the rate is updated with the total recipient count in one go. Note that
54920 in either case the rate limiting engine will see a message with many
54921 recipients as a large high-speed burst.
54922 </para>
54923 <para>
54924 The <option>per_addr</option> option is like the <option>per_rcpt</option> option, except it counts the
54925 number of different recipients that the client has sent messages to in the
54926 last time period. That is, if the client repeatedly sends messages to the same
54927 recipient, its measured rate is not increased. This option can only be used in
54928 <option>acl_smtp_rcpt</option>.
54929 </para>
54930 <para>
54931 The <option>per_cmd</option> option causes Exim to recompute the rate every time the
54932 condition is processed. This can be used to limit the rate of any SMTP
54933 command. If it is used in multiple ACLs it can limit the aggregate rate of
54934 multiple different commands.
54935 </para>
54936 <para>
54937 The <option>count=</option> option can be used to alter how much Exim adds to the client&#x2019;s
54938 measured rate. For example, the <option>per_byte</option> option is equivalent to
54939 <literal>per_mail/count=$message_size</literal>. If there is no <option>count=</option> option, Exim
54940 increases the measured rate by one (except for the <option>per_rcpt</option> option in ACLs
54941 other than <option>acl_smtp_rcpt</option>). The count does not have to be an integer.
54942 </para>
54943 <para>
54944 The <option>unique=</option> option is described in section <xref linkend="ratoptuniq"/> below.
54945 </para>
54946 </section>
54947 <section id="ratoptupd">
54948 <title>Ratelimit update modes</title>
54949 <para>
54950 <indexterm role="concept">
54951 <primary>rate limiting</primary>
54952 <secondary>reading data without updating</secondary>
54953 </indexterm>
54954 You can specify one of three options with the <option>ratelimit</option> condition to
54955 control when its database is updated. This section describes the <option>readonly</option>
54956 mode, and the next section describes the <option>strict</option> and <option>leaky</option> modes.
54957 </para>
54958 <para>
54959 If the <option>ratelimit</option> condition is used in <option>readonly</option> mode, Exim looks up a
54960 previously-computed rate to check against the limit.
54961 </para>
54962 <para>
54963 For example, you can test the client&#x2019;s sending rate and deny it access (when
54964 it is too fast) in the connect ACL. If the client passes this check then it
54965 can go on to send a message, in which case its recorded rate will be updated
54966 in the MAIL ACL. Subsequent connections from the same client will check this
54967 new rate.
54968 </para>
54969 <literallayout class="monospaced">
54970 acl_check_connect:
54971  deny ratelimit = 100 / 5m / readonly
54972     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
54973                   (max $sender_rate_limit)
54974 # ...
54975 acl_check_mail:
54976  warn ratelimit = 100 / 5m / strict
54977     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
54978                   (max $sender_rate_limit)
54979 </literallayout>
54980 <para>
54981 If Exim encounters multiple <option>ratelimit</option> conditions with the same key when
54982 processing a message then it may increase the client&#x2019;s measured rate more than
54983 it should. For example, this will happen if you check the <option>per_rcpt</option> option
54984 in both <option>acl_smtp_rcpt</option> and <option>acl_smtp_data</option>. However it&#x2019;s OK to check the
54985 same <option>ratelimit</option> condition multiple times in the same ACL. You can avoid any
54986 multiple update problems by using the <option>readonly</option> option on later ratelimit
54987 checks.
54988 </para>
54989 <para>
54990 The <option>per_*</option> options described above do not make sense in some ACLs. If you
54991 use a <option>per_*</option> option in an ACL where it is not normally permitted then the
54992 update mode defaults to <option>readonly</option> and you cannot specify the <option>strict</option> or
54993 <option>leaky</option> modes. In other ACLs the default update mode is <option>leaky</option> (see the
54994 next section) so you must specify the <option>readonly</option> option explicitly.
54995 </para>
54996 </section>
54997 <section id="ratoptfast">
54998 <title>Ratelimit options for handling fast clients</title>
54999 <para>
55000 <indexterm role="concept">
55001 <primary>rate limiting</primary>
55002 <secondary>strict and leaky modes</secondary>
55003 </indexterm>
55004 If a client&#x2019;s average rate is greater than the maximum, the rate limiting
55005 engine can react in two possible ways, depending on the presence of the
55006 <option>strict</option> or <option>leaky</option> update modes. This is independent of the other
55007 counter-measures (such as rejecting the message) that may be specified by the
55008 rest of the ACL.
55009 </para>
55010 <para>
55011 The <option>leaky</option> (default) option means that the client&#x2019;s recorded rate is not
55012 updated if it is above the limit. The effect of this is that Exim measures the
55013 client&#x2019;s average rate of successfully sent email, which cannot be greater than
55014 the maximum allowed. If the client is over the limit it may suffer some
55015 counter-measures (as specified in the ACL), but it will still be able to send
55016 email at the configured maximum rate, whatever the rate of its attempts. This
55017 is generally the better choice if you have clients that retry automatically.
55018 For example, it does not prevent a sender with an over-aggressive retry rate
55019 from getting any email through.
55020 </para>
55021 <para>
55022 The <option>strict</option> option means that the client&#x2019;s recorded rate is always
55023 updated. The effect of this is that Exim measures the client&#x2019;s average rate
55024 of attempts to send email, which can be much higher than the maximum it is
55025 actually allowed. If the client is over the limit it may be subjected to
55026 counter-measures by the ACL. It must slow down and allow sufficient time to
55027 pass that its computed rate falls below the maximum before it can send email
55028 again. The time (the number of smoothing periods) it must wait and not
55029 attempt to send mail can be calculated with this formula:
55030 </para>
55031 <literallayout class="monospaced">
55032         ln(peakrate/maxrate)
55033 </literallayout>
55034 </section>
55035 <section id="ratoptuniq">
55036 <title>Limiting the rate of different events</title>
55037 <para>
55038 <indexterm role="concept">
55039 <primary>rate limiting</primary>
55040 <secondary>counting unique events</secondary>
55041 </indexterm>
55042 The <option>ratelimit</option> <option>unique=</option> option controls a mechanism for counting the
55043 rate of different events. For example, the <option>per_addr</option> option uses this
55044 mechanism to count the number of different recipients that the client has
55045 sent messages to in the last time period; it is equivalent to
55046 <literal>per_rcpt/unique=$local_part@$domain</literal>. You could use this feature to
55047 measure the rate that a client uses different sender addresses with the
55048 options <literal>per_mail/unique=$sender_address</literal>.
55049 </para>
55050 <para>
55051 For each <option>ratelimit</option> key Exim stores the set of <option>unique=</option> values that it
55052 has seen for that key. The whole set is thrown away when it is older than the
55053 rate smoothing period <emphasis>p</emphasis>, so each different event is counted at most once
55054 per period. In the <option>leaky</option> update mode, an event that causes the client to
55055 go over the limit is not added to the set, in the same way that the client&#x2019;s
55056 recorded rate is not updated in the same situation.
55057 </para>
55058 <para>
55059 When you combine the <option>unique=</option> and <option>readonly</option> options, the specific
55060 <option>unique=</option> value is ignored, and Exim just retrieves the client&#x2019;s stored
55061 rate.
55062 </para>
55063 <para>
55064 The <option>unique=</option> mechanism needs more space in the ratelimit database than the
55065 other <option>ratelimit</option> options in order to store the event set. The number of
55066 unique values is potentially as large as the rate limit, so the extra space
55067 required increases with larger limits.
55068 </para>
55069 <para>
55070 The uniqueification is not perfect: there is a small probability that Exim
55071 will think a new event has happened before. If the sender&#x2019;s rate is less than
55072 the limit, Exim should be more than 99.9% correct. However in <option>strict</option> mode
55073 the measured rate can go above the limit, in which case Exim may under-count
55074 events by a significant margin. Fortunately, if the rate is high enough (2.7
55075 times the limit) that the false positive rate goes above 9%, then Exim will
55076 throw away the over-full event set before the measured rate falls below the
55077 limit. Therefore the only harm should be that exceptionally high sending rates
55078 are logged incorrectly; any countermeasures you configure will be as effective
55079 as intended.
55080 </para>
55081 </section>
55082 <section id="useratlim">
55083 <title>Using rate limiting</title>
55084 <para>
55085 Exim&#x2019;s other ACL facilities are used to define what counter-measures are taken
55086 when the rate limit is exceeded. This might be anything from logging a warning
55087 (for example, while measuring existing sending rates in order to define
55088 policy), through time delays to slow down fast senders, up to rejecting the
55089 message. For example:
55090 </para>
55091 <literallayout class="monospaced">
55092 # Log all senders' rates
55093 warn ratelimit = 0 / 1h / strict
55094      log_message = Sender rate $sender_rate / $sender_rate_period
55095
55096 # Slow down fast senders; note the need to truncate $sender_rate
55097 # at the decimal point.
55098 warn ratelimit = 100 / 1h / per_rcpt / strict
55099      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
55100                    $sender_rate_limit }s
55101
55102 # Keep authenticated users under control
55103 deny authenticated = *
55104      ratelimit = 100 / 1d / strict / $authenticated_id
55105
55106 # System-wide rate limit
55107 defer message = Sorry, too busy. Try again later.
55108      ratelimit = 10 / 1s / $primary_hostname
55109
55110 # Restrict incoming rate from each host, with a default
55111 # set using a macro and special cases looked up in a table.
55112 defer message = Sender rate exceeds $sender_rate_limit \
55113                messages per $sender_rate_period
55114      ratelimit = ${lookup {$sender_host_address} \
55115                    cdb {DB/ratelimits.cdb} \
55116                    {$value} {RATELIMIT} }
55117 </literallayout>
55118 <para>
55119 <emphasis role="bold">Warning</emphasis>: If you have a busy server with a lot of <option>ratelimit</option> tests,
55120 especially with the <option>per_rcpt</option> option, you may suffer from a performance
55121 bottleneck caused by locking on the ratelimit hints database. Apart from
55122 making your ACLs less complicated, you can reduce the problem by using a
55123 RAM disk for Exim&#x2019;s hints directory (usually <filename>/var/spool/exim/db/</filename>). However
55124 this means that Exim will lose its hints data after a reboot (including retry
55125 hints, the callout cache, and ratelimit data).
55126 </para>
55127 </section>
55128 <section id="SECTaddressverification">
55129 <title>Address verification</title>
55130 <para>
55131 <indexterm role="concept">
55132 <primary>verifying address</primary>
55133 <secondary>options for</secondary>
55134 </indexterm>
55135 <indexterm role="concept">
55136 <primary>policy control</primary>
55137 <secondary>address verification</secondary>
55138 </indexterm>
55139 Several of the <option>verify</option> conditions described in section
55140 <xref linkend="SECTaclconditions"/> cause addresses to be verified. Section
55141 <xref linkend="SECTsenaddver"/> discusses the reporting of sender verification failures.
55142 The verification conditions can be followed by options that modify the
55143 verification process. The options are separated from the keyword and from each
55144 other by slashes, and some of them contain parameters. For example:
55145 </para>
55146 <literallayout class="monospaced">
55147 verify = sender/callout
55148 verify = recipient/defer_ok/callout=10s,defer_ok
55149 </literallayout>
55150 <para>
55151 The first stage of address verification, which always happens, is to run the
55152 address through the routers, in <quote>verify mode</quote>. Routers can detect the
55153 difference between verification and routing for delivery, and their actions can
55154 be varied by a number of generic options such as <option>verify</option> and <option>verify_only</option>
55155 (see chapter <xref linkend="CHAProutergeneric"/>). If routing fails, verification fails.
55156 The available options are as follows:
55157 </para>
55158 <itemizedlist>
55159 <listitem>
55160 <para>
55161 If the <option>callout</option> option is specified, successful routing to one or more
55162 remote hosts is followed by a <quote>callout</quote> to those hosts as an additional
55163 check. Callouts and their sub-options are discussed in the next section.
55164 </para>
55165 </listitem>
55166 <listitem>
55167 <para>
55168 If there is a defer error while doing verification routing, the ACL
55169 normally returns <quote>defer</quote>. However, if you include <option>defer_ok</option> in the
55170 options, the condition is forced to be true instead. Note that this is a main
55171 verification option as well as a suboption for callouts.
55172 </para>
55173 </listitem>
55174 <listitem>
55175 <para>
55176 The <option>no_details</option> option is covered in section <xref linkend="SECTsenaddver"/>, which
55177 discusses the reporting of sender address verification failures.
55178 </para>
55179 </listitem>
55180 <listitem>
55181 <para>
55182 The <option>success_on_redirect</option> option causes verification always to succeed
55183 immediately after a successful redirection. By default, if a redirection
55184 generates just one address, that address is also verified. See further
55185 discussion in section <xref linkend="SECTredirwhilveri"/>.
55186 </para>
55187 </listitem>
55188 </itemizedlist>
55189 <para>
55190 <indexterm role="concept">
55191 <primary>verifying address</primary>
55192 <secondary>differentiating failures</secondary>
55193 </indexterm>
55194 <indexterm role="variable">
55195 <primary><varname>$recipient_verify_failure</varname></primary>
55196 </indexterm>
55197 <indexterm role="variable">
55198 <primary><varname>$sender_verify_failure</varname></primary>
55199 </indexterm>
55200 <indexterm role="variable">
55201 <primary><varname>$acl_verify_message</varname></primary>
55202 </indexterm>
55203 After an address verification failure, <varname>$acl_verify_message</varname> contains the
55204 error message that is associated with the failure. It can be preserved by
55205 coding like this:
55206 </para>
55207 <literallayout class="monospaced">
55208 warn  !verify = sender
55209        set acl_m0 = $acl_verify_message
55210 </literallayout>
55211 <para>
55212 If you are writing your own custom rejection message or log message when
55213 denying access, you can use this variable to include information about the
55214 verification failure.
55215 </para>
55216 <para>
55217 In addition, <varname>$sender_verify_failure</varname> or <varname>$recipient_verify_failure</varname> (as
55218 appropriate) contains one of the following words:
55219 </para>
55220 <itemizedlist>
55221 <listitem>
55222 <para>
55223 <option>qualify</option>: The address was unqualified (no domain), and the message
55224 was neither local nor came from an exempted host.
55225 </para>
55226 </listitem>
55227 <listitem>
55228 <para>
55229 <option>route</option>: Routing failed.
55230 </para>
55231 </listitem>
55232 <listitem>
55233 <para>
55234 <option>mail</option>: Routing succeeded, and a callout was attempted; rejection
55235 occurred at or before the MAIL command (that is, on initial
55236 connection, HELO, or MAIL).
55237 </para>
55238 </listitem>
55239 <listitem>
55240 <para>
55241 <option>recipient</option>: The RCPT command in a callout was rejected.
55242 </para>
55243 </listitem>
55244 <listitem>
55245 <para>
55246 <option>postmaster</option>: The postmaster check in a callout was rejected.
55247 </para>
55248 </listitem>
55249 </itemizedlist>
55250 <para>
55251 The main use of these variables is expected to be to distinguish between
55252 rejections of MAIL and rejections of RCPT in callouts.
55253 </para>
55254 </section>
55255 <section id="SECTcallver">
55256 <title>Callout verification</title>
55257 <para>
55258 <indexterm role="concept">
55259 <primary>verifying address</primary>
55260 <secondary>by callout</secondary>
55261 </indexterm>
55262 <indexterm role="concept">
55263 <primary>callout</primary>
55264 <secondary>verification</secondary>
55265 </indexterm>
55266 <indexterm role="concept">
55267 <primary>SMTP</primary>
55268 <secondary>callout verification</secondary>
55269 </indexterm>
55270 For non-local addresses, routing verifies the domain, but is unable to do any
55271 checking of the local part. There are situations where some means of verifying
55272 the local part is desirable. One way this can be done is to make an SMTP
55273 <emphasis>callback</emphasis> to a delivery host for the sender address or a <emphasis>callforward</emphasis> to
55274 a subsequent host for a recipient address, to see if the host accepts the
55275 address. We use the term <emphasis>callout</emphasis> to cover both cases. Note that for a
55276 sender address, the callback is not to the client host that is trying to
55277 deliver the message, but to one of the hosts that accepts incoming mail for the
55278 sender&#x2019;s domain.
55279 </para>
55280 <para>
55281 Exim does not do callouts by default. If you want them to happen, you must
55282 request them by setting appropriate options on the <option>verify</option> condition, as
55283 described below. This facility should be used with care, because it can add a
55284 lot of resource usage to the cost of verifying an address. However, Exim does
55285 cache the results of callouts, which helps to reduce the cost. Details of
55286 caching are in section <xref linkend="SECTcallvercache"/>.
55287 </para>
55288 <para>
55289 Recipient callouts are usually used only between hosts that are controlled by
55290 the same administration. For example, a corporate gateway host could use
55291 callouts to check for valid recipients on an internal mailserver. A successful
55292 callout does not guarantee that a real delivery to the address would succeed;
55293 on the other hand, a failing callout does guarantee that a delivery would fail.
55294 </para>
55295 <para>
55296 If the <option>callout</option> option is present on a condition that verifies an address, a
55297 second stage of verification occurs if the address is successfully routed to
55298 one or more remote hosts. The usual case is routing by a <command>dnslookup</command> or a
55299 <command>manualroute</command> router, where the router specifies the hosts. However, if a
55300 router that does not set up hosts routes to an <command>smtp</command> transport with a
55301 <option>hosts</option> setting, the transport&#x2019;s hosts are used. If an <command>smtp</command> transport has
55302 <option>hosts_override</option> set, its hosts are always used, whether or not the router
55303 supplies a host list.
55304 Callouts are only supported on <command>smtp</command> transports.
55305 </para>
55306 <para>
55307 The port that is used is taken from the transport, if it is specified and is a
55308 remote transport. (For routers that do verification only, no transport need be
55309 specified.) Otherwise, the default SMTP port is used. If a remote transport
55310 specifies an outgoing interface, this is used; otherwise the interface is not
55311 specified. Likewise, the text that is used for the HELO command is taken from
55312 the transport&#x2019;s <option>helo_data</option> option; if there is no transport, the value of
55313 <varname>$smtp_active_hostname</varname> is used.
55314 </para>
55315 <para>
55316 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
55317 test whether a bounce message could be delivered to the sender address. The
55318 following SMTP commands are sent:
55319 </para>
55320 <literallayout>
55321 <literal>HELO </literal>&lt;<emphasis>local host name</emphasis>&gt;
55322 <literal>MAIL FROM:&lt;&gt;</literal>
55323 <literal>RCPT TO:</literal>&lt;<emphasis>the address to be tested</emphasis>&gt;
55324 <literal>QUIT</literal>
55325 </literallayout>
55326 <para>
55327 LHLO is used instead of HELO if the transport&#x2019;s <option>protocol</option> option is
55328 set to <quote>lmtp</quote>.
55329 </para>
55330 <para>
55331 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
55332 settings.
55333 </para>
55334 <para>
55335 A recipient callout check is similar. By default, it also uses an empty address
55336 for the sender. This default is chosen because most hosts do not make use of
55337 the sender address when verifying a recipient. Using the same address means
55338 that a single cache entry can be used for each recipient. Some sites, however,
55339 do make use of the sender address when verifying. These are catered for by the
55340 <option>use_sender</option> and <option>use_postmaster</option> options, described in the next section.
55341 </para>
55342 <para>
55343 If the response to the RCPT command is a 2<emphasis>xx</emphasis> code, the verification
55344 succeeds. If it is 5<emphasis>xx</emphasis>, the verification fails. For any other condition,
55345 Exim tries the next host, if any. If there is a problem with all the remote
55346 hosts, the ACL yields <quote>defer</quote>, unless the <option>defer_ok</option> parameter of the
55347 <option>callout</option> option is given, in which case the condition is forced to succeed.
55348 </para>
55349 <para>
55350 <indexterm role="concept">
55351 <primary>SMTP</primary>
55352 <secondary>output flushing, disabling for callout</secondary>
55353 </indexterm>
55354 A callout may take a little time. For this reason, Exim normally flushes SMTP
55355 output before performing a callout in an ACL, to avoid unexpected timeouts in
55356 clients when the SMTP PIPELINING extension is in use. The flushing can be
55357 disabled by using a <option>control</option> modifier to set <option>no_callout_flush</option>.
55358 </para>
55359 </section>
55360 <section id="CALLaddparcall">
55361 <title>Additional parameters for callouts</title>
55362 <para>
55363 <indexterm role="concept">
55364 <primary>callout</primary>
55365 <secondary>additional parameters for</secondary>
55366 </indexterm>
55367 The <option>callout</option> option can be followed by an equals sign and a number of
55368 optional parameters, separated by commas. For example:
55369 </para>
55370 <literallayout class="monospaced">
55371 verify = recipient/callout=10s,defer_ok
55372 </literallayout>
55373 <para>
55374 The old syntax, which had <option>callout_defer_ok</option> and <option>check_postmaster</option> as
55375 separate verify options, is retained for backwards compatibility, but is now
55376 deprecated. The additional parameters for <option>callout</option> are as follows:
55377 </para>
55378 <variablelist>
55379 <varlistentry>
55380 <term>&lt;<emphasis>a&nbsp;time&nbsp;interval</emphasis>&gt;</term>
55381 <listitem>
55382 <para>
55383 <indexterm role="concept">
55384 <primary>callout</primary>
55385 <secondary>timeout, specifying</secondary>
55386 </indexterm>
55387 This specifies the timeout that applies for the callout attempt to each host.
55388 For example:
55389 </para>
55390 <literallayout class="monospaced">
55391 verify = sender/callout=5s
55392 </literallayout>
55393 <para>
55394 The default is 30 seconds. The timeout is used for each response from the
55395 remote host. It is also used for the initial connection, unless overridden by
55396 the <option>connect</option> parameter.
55397 </para>
55398 </listitem></varlistentry>
55399 <varlistentry>
55400 <term><emphasis role="bold">connect&nbsp;=&nbsp;</emphasis>&lt;<emphasis>time&nbsp;interval</emphasis>&gt;</term>
55401 <listitem>
55402 <para>
55403 <indexterm role="concept">
55404 <primary>callout</primary>
55405 <secondary>connection timeout, specifying</secondary>
55406 </indexterm>
55407 This parameter makes it possible to set a different (usually smaller) timeout
55408 for making the SMTP connection. For example:
55409 </para>
55410 <literallayout class="monospaced">
55411 verify = sender/callout=5s,connect=1s
55412 </literallayout>
55413 <para>
55414 If not specified, this timeout defaults to the general timeout value.
55415 </para>
55416 </listitem></varlistentry>
55417 <varlistentry>
55418 <term><emphasis role="bold">defer_ok</emphasis></term>
55419 <listitem>
55420 <para>
55421 <indexterm role="concept">
55422 <primary>callout</primary>
55423 <secondary>defer, action on</secondary>
55424 </indexterm>
55425 When this parameter is present, failure to contact any host, or any other kind
55426 of temporary error, is treated as success by the ACL. However, the cache is not
55427 updated in this circumstance.
55428 </para>
55429 </listitem></varlistentry>
55430 <varlistentry>
55431 <term><emphasis role="bold">fullpostmaster</emphasis></term>
55432 <listitem>
55433 <para>
55434 <indexterm role="concept">
55435 <primary>callout</primary>
55436 <secondary>full postmaster check</secondary>
55437 </indexterm>
55438 This operates like the <option>postmaster</option> option (see below), but if the check for
55439 <emphasis>postmaster@domain</emphasis> fails, it tries just <emphasis>postmaster</emphasis>, without a domain, in
55440 accordance with the specification in RFC 2821. The RFC states that the
55441 unqualified address <emphasis>postmaster</emphasis> should be accepted.
55442 </para>
55443 </listitem></varlistentry>
55444 <varlistentry>
55445 <term><emphasis role="bold">mailfrom&nbsp;=&nbsp;</emphasis>&lt;<emphasis>email&nbsp;address</emphasis>&gt;</term>
55446 <listitem>
55447 <para>
55448 <indexterm role="concept">
55449 <primary>callout</primary>
55450 <secondary>sender when verifying header</secondary>
55451 </indexterm>
55452 When verifying addresses in header lines using the <option>header_sender</option>
55453 verification option, Exim behaves by default as if the addresses are envelope
55454 sender addresses from a message. Callout verification therefore tests to see
55455 whether a bounce message could be delivered, by using an empty address in the
55456 MAIL command. However, it is arguable that these addresses might never be used
55457 as envelope senders, and could therefore justifiably reject bounce messages
55458 (empty senders). The <option>mailfrom</option> callout parameter allows you to specify what
55459 address to use in the MAIL command. For example:
55460 </para>
55461 <literallayout class="monospaced">
55462 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
55463 </literallayout>
55464 <para>
55465 This parameter is available only for the <option>header_sender</option> verification option.
55466 </para>
55467 </listitem></varlistentry>
55468 <varlistentry>
55469 <term><emphasis role="bold">maxwait&nbsp;=&nbsp;</emphasis>&lt;<emphasis>time&nbsp;interval</emphasis>&gt;</term>
55470 <listitem>
55471 <para>
55472 <indexterm role="concept">
55473 <primary>callout</primary>
55474 <secondary>overall timeout, specifying</secondary>
55475 </indexterm>
55476 This parameter sets an overall timeout for performing a callout verification.
55477 For example:
55478 </para>
55479 <literallayout class="monospaced">
55480 verify = sender/callout=5s,maxwait=30s
55481 </literallayout>
55482 <para>
55483 This timeout defaults to four times the callout timeout for individual SMTP
55484 commands. The overall timeout applies when there is more than one host that can
55485 be tried. The timeout is checked before trying the next host. This prevents
55486 very long delays if there are a large number of hosts and all are timing out
55487 (for example, when network connections are timing out).
55488 </para>
55489 </listitem></varlistentry>
55490 <varlistentry>
55491 <term><emphasis role="bold">no_cache</emphasis></term>
55492 <listitem>
55493 <para>
55494 <indexterm role="concept">
55495 <primary>callout</primary>
55496 <secondary>cache, suppressing</secondary>
55497 </indexterm>
55498 <indexterm role="concept">
55499 <primary>caching callout, suppressing</primary>
55500 </indexterm>
55501 When this parameter is given, the callout cache is neither read nor updated.
55502 </para>
55503 </listitem></varlistentry>
55504 <varlistentry>
55505 <term><emphasis role="bold">postmaster</emphasis></term>
55506 <listitem>
55507 <para>
55508 <indexterm role="concept">
55509 <primary>callout</primary>
55510 <secondary>postmaster; checking</secondary>
55511 </indexterm>
55512 When this parameter is set, a successful callout check is followed by a similar
55513 check for the local part <emphasis>postmaster</emphasis> at the same domain. If this address is
55514 rejected, the callout fails (but see <option>fullpostmaster</option> above). The result of
55515 the postmaster check is recorded in a cache record; if it is a failure, this is
55516 used to fail subsequent callouts for the domain without a connection being
55517 made, until the cache record expires.
55518 </para>
55519 </listitem></varlistentry>
55520 <varlistentry>
55521 <term><emphasis role="bold">postmaster_mailfrom&nbsp;=&nbsp;</emphasis>&lt;<emphasis>email&nbsp;address</emphasis>&gt;</term>
55522 <listitem>
55523 <para>
55524 The postmaster check uses an empty sender in the MAIL command by default.
55525 You can use this parameter to do a postmaster check using a different address.
55526 For example:
55527 </para>
55528 <literallayout class="monospaced">
55529 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
55530 </literallayout>
55531 <para>
55532 If both <option>postmaster</option> and <option>postmaster_mailfrom</option> are present, the rightmost
55533 one overrides. The <option>postmaster</option> parameter is equivalent to this example:
55534 </para>
55535 <literallayout class="monospaced">
55536 require  verify = sender/callout=postmaster_mailfrom=
55537 </literallayout>
55538 <para>
55539 <emphasis role="bold">Warning</emphasis>: The caching arrangements for postmaster checking do not take
55540 account of the sender address. It is assumed that either the empty address or
55541 a fixed non-empty address will be used. All that Exim remembers is that the
55542 postmaster check for the domain succeeded or failed.
55543 </para>
55544 </listitem></varlistentry>
55545 <varlistentry>
55546 <term><emphasis role="bold">random</emphasis></term>
55547 <listitem>
55548 <para>
55549 <indexterm role="concept">
55550 <primary>callout</primary>
55551 <secondary><quote>random</quote> check</secondary>
55552 </indexterm>
55553 When this parameter is set, before doing the normal callout check, Exim does a
55554 check for a <quote>random</quote> local part at the same domain. The local part is not
55555 really random &ndash; it is defined by the expansion of the option
55556 <option>callout_random_local_part</option>, which defaults to
55557 </para>
55558 <literallayout class="monospaced">
55559 $primary_hostname-$tod_epoch-testing
55560 </literallayout>
55561 <para>
55562 The idea here is to try to determine whether the remote host accepts all local
55563 parts without checking. If it does, there is no point in doing callouts for
55564 specific local parts. If the <quote>random</quote> check succeeds, the result is saved in
55565 a cache record, and used to force the current and subsequent callout checks to
55566 succeed without a connection being made, until the cache record expires.
55567 </para>
55568 </listitem></varlistentry>
55569 <varlistentry>
55570 <term><emphasis role="bold">use_postmaster</emphasis></term>
55571 <listitem>
55572 <para>
55573 <indexterm role="concept">
55574 <primary>callout</primary>
55575 <secondary>sender for recipient check</secondary>
55576 </indexterm>
55577 This parameter applies to recipient callouts only. For example:
55578 </para>
55579 <literallayout class="monospaced">
55580 deny  !verify = recipient/callout=use_postmaster
55581 </literallayout>
55582 <para>
55583 <indexterm role="variable">
55584 <primary><varname>$qualify_domain</varname></primary>
55585 </indexterm>
55586 It causes a non-empty postmaster address to be used in the MAIL command when
55587 performing the callout for the recipient, and also for a <quote>random</quote> check if
55588 that is configured. The local part of the address is <literal>postmaster</literal> and the
55589 domain is the contents of <varname>$qualify_domain</varname>.
55590 </para>
55591 </listitem></varlistentry>
55592 <varlistentry>
55593 <term><emphasis role="bold">use_sender</emphasis></term>
55594 <listitem>
55595 <para>
55596 This option applies to recipient callouts only. For example:
55597 </para>
55598 <literallayout class="monospaced">
55599 require  verify = recipient/callout=use_sender
55600 </literallayout>
55601 <para>
55602 It causes the message&#x2019;s actual sender address to be used in the MAIL
55603 command when performing the callout, instead of an empty address. There is no
55604 need to use this option unless you know that the called hosts make use of the
55605 sender when checking recipients. If used indiscriminately, it reduces the
55606 usefulness of callout caching.
55607 </para>
55608 </listitem></varlistentry>
55609 </variablelist>
55610 <para>
55611 If you use any of the parameters that set a non-empty sender for the MAIL
55612 command (<option>mailfrom</option>, <option>postmaster_mailfrom</option>, <option>use_postmaster</option>, or
55613 <option>use_sender</option>), you should think about possible loops. Recipient checking is
55614 usually done between two hosts that are under the same management, and the host
55615 that receives the callouts is not normally configured to do callouts itself.
55616 Therefore, it is normally safe to use <option>use_postmaster</option> or <option>use_sender</option> in
55617 these circumstances.
55618 </para>
55619 <para>
55620 However, if you use a non-empty sender address for a callout to an arbitrary
55621 host, there is the likelihood that the remote host will itself initiate a
55622 callout check back to your host. As it is checking what appears to be a message
55623 sender, it is likely to use an empty address in MAIL, thus avoiding a
55624 callout loop. However, to be on the safe side it would be best to set up your
55625 own ACLs so that they do not do sender verification checks when the recipient
55626 is the address you use for header sender or postmaster callout checking.
55627 </para>
55628 <para>
55629 Another issue to think about when using non-empty senders for callouts is
55630 caching. When you set <option>mailfrom</option> or <option>use_sender</option>, the cache record is keyed
55631 by the sender/recipient combination; thus, for any given recipient, many more
55632 actual callouts are performed than when an empty sender or postmaster is used.
55633 </para>
55634 </section>
55635 <section id="SECTcallvercache">
55636 <title>Callout caching</title>
55637 <para>
55638 <indexterm role="concept">
55639 <primary>hints database</primary>
55640 <secondary>callout cache</secondary>
55641 </indexterm>
55642 <indexterm role="concept">
55643 <primary>callout</primary>
55644 <secondary>cache, description of</secondary>
55645 </indexterm>
55646 <indexterm role="concept">
55647 <primary>caching</primary>
55648 <secondary>callout</secondary>
55649 </indexterm>
55650 Exim caches the results of callouts in order to reduce the amount of resources
55651 used, unless you specify the <option>no_cache</option> parameter with the <option>callout</option>
55652 option. A hints database called <quote>callout</quote> is used for the cache. Two
55653 different record types are used: one records the result of a callout check for
55654 a specific address, and the other records information that applies to the
55655 entire domain (for example, that it accepts the local part <emphasis>postmaster</emphasis>).
55656 </para>
55657 <para>
55658 When an original callout fails, a detailed SMTP error message is given about
55659 the failure. However, for subsequent failures use the cache data, this message
55660 is not available.
55661 </para>
55662 <para>
55663 The expiry times for negative and positive address cache records are
55664 independent, and can be set by the global options <option>callout_negative_expire</option>
55665 (default 2h) and <option>callout_positive_expire</option> (default 24h), respectively.
55666 </para>
55667 <para>
55668 If a host gives a negative response to an SMTP connection, or rejects any
55669 commands up to and including
55670 </para>
55671 <literallayout class="monospaced">
55672 MAIL FROM:&lt;&gt;
55673 </literallayout>
55674 <para>
55675 (but not including the MAIL command with a non-empty address),
55676 any callout attempt is bound to fail. Exim remembers such failures in a
55677 domain cache record, which it uses to fail callouts for the domain without
55678 making new connections, until the domain record times out. There are two
55679 separate expiry times for domain cache records:
55680 <option>callout_domain_negative_expire</option> (default 3h) and
55681 <option>callout_domain_positive_expire</option> (default 7d).
55682 </para>
55683 <para>
55684 Domain records expire when the negative expiry time is reached if callouts
55685 cannot be made for the domain, or if the postmaster check failed.
55686 Otherwise, they expire when the positive expiry time is reached. This
55687 ensures that, for example, a host that stops accepting <quote>random</quote> local parts
55688 will eventually be noticed.
55689 </para>
55690 <para>
55691 The callout caching mechanism is based on the domain of the address that is
55692 being tested. If the domain routes to several hosts, it is assumed that their
55693 behaviour will be the same.
55694 </para>
55695 </section>
55696 <section id="SECTsenaddver">
55697 <title>Sender address verification reporting</title>
55698 <para>
55699 <indexterm role="concept">
55700 <primary>verifying</primary>
55701 <secondary>suppressing error details</secondary>
55702 </indexterm>
55703 See section <xref linkend="SECTaddressverification"/> for a general discussion of
55704 verification. When sender verification fails in an ACL, the details of the
55705 failure are given as additional output lines before the 550 response to the
55706 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
55707 you might see:
55708 </para>
55709 <literallayout class="monospaced">
55710 MAIL FROM:&lt;xyz@abc.example&gt;
55711 250 OK
55712 RCPT TO:&lt;pqr@def.example&gt;
55713 550-Verification failed for &lt;xyz@abc.example&gt;
55714 550-Called:   192.168.34.43
55715 550-Sent:     RCPT TO:&lt;xyz@abc.example&gt;
55716 550-Response: 550 Unknown local part xyz in &lt;xyz@abc.example&gt;
55717 550 Sender verification failed
55718 </literallayout>
55719 <para>
55720 If more than one RCPT command fails in the same way, the details are given
55721 only for the first of them. However, some administrators do not want to send
55722 out this much information. You can suppress the details by adding
55723 <literal>/no_details</literal> to the ACL statement that requests sender verification. For
55724 example:
55725 </para>
55726 <literallayout class="monospaced">
55727 verify = sender/no_details
55728 </literallayout>
55729 </section>
55730 <section id="SECTredirwhilveri">
55731 <title>Redirection while verifying</title>
55732 <para>
55733 <indexterm role="concept">
55734 <primary>verifying</primary>
55735 <secondary>redirection while</secondary>
55736 </indexterm>
55737 <indexterm role="concept">
55738 <primary>address redirection</primary>
55739 <secondary>while verifying</secondary>
55740 </indexterm>
55741 A dilemma arises when a local address is redirected by aliasing or forwarding
55742 during verification: should the generated addresses themselves be verified,
55743 or should the successful expansion of the original address be enough to verify
55744 it? By default, Exim takes the following pragmatic approach:
55745 </para>
55746 <itemizedlist>
55747 <listitem>
55748 <para>
55749 When an incoming address is redirected to just one child address, verification
55750 continues with the child address, and if that fails to verify, the original
55751 verification also fails.
55752 </para>
55753 </listitem>
55754 <listitem>
55755 <para>
55756 When an incoming address is redirected to more than one child address,
55757 verification does not continue. A success result is returned.
55758 </para>
55759 </listitem>
55760 </itemizedlist>
55761 <para>
55762 This seems the most reasonable behaviour for the common use of aliasing as a
55763 way of redirecting different local parts to the same mailbox. It means, for
55764 example, that a pair of alias entries of the form
55765 </para>
55766 <literallayout class="monospaced">
55767 A.Wol:   aw123
55768 aw123:   :fail: Gone away, no forwarding address
55769 </literallayout>
55770 <para>
55771 work as expected, with both local parts causing verification failure. When a
55772 redirection generates more than one address, the behaviour is more like a
55773 mailing list, where the existence of the alias itself is sufficient for
55774 verification to succeed.
55775 </para>
55776 <para>
55777 It is possible, however, to change the default behaviour so that all successful
55778 redirections count as successful verifications, however many new addresses are
55779 generated. This is specified by the <option>success_on_redirect</option> verification
55780 option. For example:
55781 </para>
55782 <literallayout class="monospaced">
55783 require verify = recipient/success_on_redirect/callout=10s
55784 </literallayout>
55785 <para>
55786 In this example, verification succeeds if a router generates a new address, and
55787 the callout does not occur, because no address was routed to a remote host.
55788 </para>
55789 <para>
55790 When verification is being tested via the <option>-bv</option> option, the treatment of
55791 redirections is as just described, unless the <option>-v</option> or any debugging option is
55792 also specified. In that case, full verification is done for every generated
55793 address and a report is output for each of them.
55794 </para>
55795 </section>
55796 <section id="SECTverifyCSA">
55797 <title>Client SMTP authorization (CSA)</title>
55798 <para>
55799 <indexterm role="concept">
55800 <primary>CSA</primary>
55801 <secondary>verifying</secondary>
55802 </indexterm>
55803 Client SMTP Authorization is a system that allows a site to advertise
55804 which machines are and are not permitted to send email. This is done by placing
55805 special SRV records in the DNS; these are looked up using the client&#x2019;s HELO
55806 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
55807 Authorization checks in Exim are performed by the ACL condition:
55808 </para>
55809 <literallayout class="monospaced">
55810 verify = csa
55811 </literallayout>
55812 <para>
55813 This fails if the client is not authorized. If there is a DNS problem, or if no
55814 valid CSA SRV record is found, or if the client is authorized, the condition
55815 succeeds. These three cases can be distinguished using the expansion variable
55816 <varname>$csa_status</varname>, which can take one of the values <quote>fail</quote>, <quote>defer</quote>,
55817 <quote>unknown</quote>, or <quote>ok</quote>. The condition does not itself defer because that would
55818 be likely to cause problems for legitimate email.
55819 </para>
55820 <para>
55821 The error messages produced by the CSA code include slightly more
55822 detail. If <varname>$csa_status</varname> is <quote>defer</quote>, this may be because of problems
55823 looking up the CSA SRV record, or problems looking up the CSA target
55824 address record. There are four reasons for <varname>$csa_status</varname> being <quote>fail</quote>:
55825 </para>
55826 <itemizedlist>
55827 <listitem>
55828 <para>
55829 The client&#x2019;s host name is explicitly not authorized.
55830 </para>
55831 </listitem>
55832 <listitem>
55833 <para>
55834 The client&#x2019;s IP address does not match any of the CSA target IP addresses.
55835 </para>
55836 </listitem>
55837 <listitem>
55838 <para>
55839 The client&#x2019;s host name is authorized but it has no valid target IP addresses
55840 (for example, the target&#x2019;s addresses are IPv6 and the client is using IPv4).
55841 </para>
55842 </listitem>
55843 <listitem>
55844 <para>
55845 The client&#x2019;s host name has no CSA SRV record but a parent domain has asserted
55846 that all subdomains must be explicitly authorized.
55847 </para>
55848 </listitem>
55849 </itemizedlist>
55850 <para>
55851 The <option>csa</option> verification condition can take an argument which is the domain to
55852 use for the DNS query. The default is:
55853 </para>
55854 <literallayout class="monospaced">
55855 verify = csa/$sender_helo_name
55856 </literallayout>
55857 <para>
55858 This implementation includes an extension to CSA. If the query domain
55859 is an address literal such as [192.0.2.95], or if it is a bare IP
55860 address, Exim searches for CSA SRV records in the reverse DNS as if
55861 the HELO domain was (for example) <emphasis>95.2.0.192.in-addr.arpa</emphasis>. Therefore it is
55862 meaningful to say:
55863 </para>
55864 <literallayout class="monospaced">
55865 verify = csa/$sender_host_address
55866 </literallayout>
55867 <para>
55868 In fact, this is the check that Exim performs if the client does not say HELO.
55869 This extension can be turned off by setting the main configuration option
55870 <option>dns_csa_use_reverse</option> to be false.
55871 </para>
55872 <para>
55873 If a CSA SRV record is not found for the domain itself, a search
55874 is performed through its parent domains for a record which might be
55875 making assertions about subdomains. The maximum depth of this search is limited
55876 using the main configuration option <option>dns_csa_search_limit</option>, which is 5 by
55877 default. Exim does not look for CSA SRV records in a top level domain, so the
55878 default settings handle HELO domains as long as seven
55879 (<emphasis>hostname.five.four.three.two.one.com</emphasis>). This encompasses the vast majority
55880 of legitimate HELO domains.
55881 </para>
55882 <para>
55883 The <emphasis>dnsdb</emphasis> lookup also has support for CSA. Although <emphasis>dnsdb</emphasis> also supports
55884 direct SRV lookups, this is not sufficient because of the extra parent domain
55885 search behaviour of CSA, and (as with PTR lookups) <emphasis>dnsdb</emphasis> also turns IP
55886 addresses into lookups in the reverse DNS space. The result of a successful
55887 lookup such as:
55888 </para>
55889 <literallayout class="monospaced">
55890 ${lookup dnsdb {csa=$sender_helo_name}}
55891 </literallayout>
55892 <para>
55893 has two space-separated fields: an authorization code and a target host name.
55894 The authorization code can be <quote>Y</quote> for yes, <quote>N</quote> for no, <quote>X</quote> for explicit
55895 authorization required but absent, or <quote>?</quote> for unknown.
55896 </para>
55897 </section>
55898 <section id="SECTverifyPRVS">
55899 <title>Bounce address tag validation</title>
55900 <para>
55901 <indexterm role="concept">
55902 <primary>BATV, verifying</primary>
55903 </indexterm>
55904 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
55905 of outgoing messages have a cryptographic, timestamped <quote>tag</quote> added to them.
55906 Genuine incoming bounce messages should therefore always be addressed to
55907 recipients that have a valid tag. This scheme is a way of detecting unwanted
55908 bounce messages caused by sender address forgeries (often called <quote>collateral
55909 spam</quote>), because the recipients of such messages do not include valid tags.
55910 </para>
55911 <para>
55912 There are two expansion items to help with the implementation of the BATV
55913 <quote>prvs</quote> (private signature) scheme in an Exim configuration. This scheme signs
55914 the original envelope sender address by using a simple key to add a hash of the
55915 address and some time-based randomizing information. The <option>prvs</option> expansion
55916 item creates a signed address, and the <option>prvscheck</option> expansion item checks one.
55917 The syntax of these expansion items is described in section
55918 <xref linkend="SECTexpansionitems"/>.
55919 </para>
55920 <para>
55921 As an example, suppose the secret per-address keys are stored in an MySQL
55922 database. A query to look up the key for an address could be defined as a macro
55923 like this:
55924 </para>
55925 <literallayout class="monospaced">
55926 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
55927                 WHERE sender='${quote_mysql:$prvscheck_address}'\
55928                 }{$value}}
55929 </literallayout>
55930 <para>
55931 Suppose also that the senders who make use of BATV are defined by an address
55932 list called <option>batv_senders</option>. Then, in the ACL for RCPT commands, you could
55933 use this:
55934 </para>
55935 <literallayout class="monospaced">
55936 # Bounces: drop unsigned addresses for BATV senders
55937 deny message = This address does not send an unsigned reverse path
55938      senders = :
55939      recipients = +batv_senders
55940
55941 # Bounces: In case of prvs-signed address, check signature.
55942 deny message = Invalid reverse path signature.
55943      senders = :
55944      condition  = ${prvscheck {$local_part@$domain}\
55945                   {PRVSCHECK_SQL}{1}}
55946      !condition = $prvscheck_result
55947 </literallayout>
55948 <para>
55949 The first statement rejects recipients for bounce messages that are addressed
55950 to plain BATV sender addresses, because it is known that BATV senders do not
55951 send out messages with plain sender addresses. The second statement rejects
55952 recipients that are prvs-signed, but with invalid signatures (either because
55953 the key is wrong, or the signature has timed out).
55954 </para>
55955 <para>
55956 A non-prvs-signed address is not rejected by the second statement, because the
55957 <option>prvscheck</option> expansion yields an empty string if its first argument is not a
55958 prvs-signed address, thus causing the <option>condition</option> condition to be false. If
55959 the first argument is a syntactically valid prvs-signed address, the yield is
55960 the third string (in this case <quote>1</quote>), whether or not the cryptographic and
55961 timeout checks succeed. The <varname>$prvscheck_result</varname> variable contains the result
55962 of the checks (empty for failure, <quote>1</quote> for success).
55963 </para>
55964 <para>
55965 There is one more issue you must consider when implementing prvs-signing:
55966 you have to ensure that the routers accept prvs-signed addresses and
55967 deliver them correctly. The easiest way to handle this is to use a <command>redirect</command>
55968 router to remove the signature with a configuration along these lines:
55969 </para>
55970 <literallayout class="monospaced">
55971 batv_redirect:
55972   driver = redirect
55973   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
55974 </literallayout>
55975 <para>
55976 This works because, if the third argument of <option>prvscheck</option> is empty, the result
55977 of the expansion of a prvs-signed address is the decoded value of the original
55978 address. This router should probably be the first of your routers that handles
55979 local addresses.
55980 </para>
55981 <para>
55982 To create BATV-signed addresses in the first place, a transport of this form
55983 can be used:
55984 </para>
55985 <literallayout class="monospaced">
55986 external_smtp_batv:
55987   driver = smtp
55988   return_path = ${prvs {$return_path} \
55989                        {${lookup mysql{SELECT \
55990                        secret FROM batv_prvs WHERE \
55991                        sender='${quote_mysql:$sender_address}'} \
55992                        {$value}fail}}}
55993 </literallayout>
55994 <para>
55995 If no key can be found for the existing return path, no signing takes place.
55996 </para>
55997 </section>
55998 <section id="SECTrelaycontrol">
55999 <title>Using an ACL to control relaying</title>
56000 <para>
56001 <indexterm role="concept">
56002 <primary>access control lists (ACLs)</primary>
56003 <secondary>relay control</secondary>
56004 </indexterm>
56005 <indexterm role="concept">
56006 <primary>relaying</primary>
56007 <secondary>control by ACL</secondary>
56008 </indexterm>
56009 <indexterm role="concept">
56010 <primary>policy control</primary>
56011 <secondary>relay control</secondary>
56012 </indexterm>
56013 An MTA is said to <emphasis>relay</emphasis> a message if it receives it from some host and
56014 delivers it directly to another host as a result of a remote address contained
56015 within it. Redirecting a local address via an alias or forward file and then
56016 passing the message on to another host is not relaying,
56017 <indexterm role="concept">
56018 <primary><quote>percent hack</quote></primary>
56019 </indexterm>
56020 but a redirection as a result of the <quote>percent hack</quote> is.
56021 </para>
56022 <para>
56023 Two kinds of relaying exist, which are termed <quote>incoming</quote> and <quote>outgoing</quote>.
56024 A host which is acting as a gateway or an MX backup is concerned with incoming
56025 relaying from arbitrary hosts to a specific set of domains. On the other hand,
56026 a host which is acting as a smart host for a number of clients is concerned
56027 with outgoing relaying from those clients to the Internet at large. Often the
56028 same host is fulfilling both functions,
56029 but in principle these two kinds of relaying are entirely independent. What is
56030 not wanted is the transmission of mail from arbitrary remote hosts through your
56031 system to arbitrary domains.
56032 </para>
56033 <para>
56034 You can implement relay control by means of suitable statements in the ACL that
56035 runs for each RCPT command. For convenience, it is often easiest to use
56036 Exim&#x2019;s named list facility to define the domains and hosts involved. For
56037 example, suppose you want to do the following:
56038 </para>
56039 <itemizedlist>
56040 <listitem>
56041 <para>
56042 Deliver a number of domains to mailboxes on the local host (or process them
56043 locally in some other way). Let&#x2019;s say these are <emphasis>my.dom1.example</emphasis> and
56044 <emphasis>my.dom2.example</emphasis>.
56045 </para>
56046 </listitem>
56047 <listitem>
56048 <para>
56049 Relay mail for a number of other domains for which you are the secondary MX.
56050 These might be <emphasis>friend1.example</emphasis> and <emphasis>friend2.example</emphasis>.
56051 </para>
56052 </listitem>
56053 <listitem>
56054 <para>
56055 Relay mail from the hosts on your local LAN, to whatever domains are involved.
56056 Suppose your LAN is 192.168.45.0/24.
56057 </para>
56058 </listitem>
56059 </itemizedlist>
56060 <para>
56061 In the main part of the configuration, you put the following definitions:
56062 </para>
56063 <literallayout class="monospaced">
56064 domainlist local_domains    = my.dom1.example : my.dom2.example
56065 domainlist relay_to_domains = friend1.example : friend2.example
56066 hostlist   relay_from_hosts = 192.168.45.0/24
56067 </literallayout>
56068 <para>
56069 Now you can use these definitions in the ACL that is run for every RCPT
56070 command:
56071 </para>
56072 <literallayout class="monospaced">
56073 acl_check_rcpt:
56074   accept domains = +local_domains : +relay_to_domains
56075   accept hosts   = +relay_from_hosts
56076 </literallayout>
56077 <para>
56078 The first statement accepts any RCPT command that contains an address in
56079 the local or relay domains. For any other domain, control passes to the second
56080 statement, which accepts the command only if it comes from one of the relay
56081 hosts. In practice, you will probably want to make your ACL more sophisticated
56082 than this, for example, by including sender and recipient verification. The
56083 default configuration includes a more comprehensive example, which is described
56084 in chapter <xref linkend="CHAPdefconfil"/>.
56085 </para>
56086 </section>
56087 <section id="SECTcheralcon">
56088 <title>Checking a relay configuration</title>
56089 <para>
56090 <indexterm role="concept">
56091 <primary>relaying</primary>
56092 <secondary>checking control of</secondary>
56093 </indexterm>
56094 You can check the relay characteristics of your configuration in the same way
56095 that you can test any ACL behaviour for an incoming SMTP connection, by using
56096 the <option>-bh</option> option to run a fake SMTP session with which you interact.
56097 </para>
56098 <para>
56099 For specifically testing for unwanted relaying, the host
56100 <emphasis>relay-test.mail-abuse.org</emphasis> provides a useful service. If you telnet to this
56101 host from the host on which Exim is running, using the normal telnet port, you
56102 will see a normal telnet connection message and then quite a long delay. Be
56103 patient. The remote host is making an SMTP connection back to your host, and
56104 trying a number of common probes to test for open relay vulnerability. The
56105 results of the tests will eventually appear on your terminal.
56106 <indexterm role="concept" startref="IIDacl" class="endofrange"/>
56107 </para>
56108 </section>
56109 </chapter>
56110
56111 <chapter id="CHAPexiscan">
56112 <title>Content scanning at ACL time</title>
56113 <para>
56114 <indexterm role="concept" id="IIDcosca" class="startofrange">
56115 <primary>content scanning</primary>
56116 <secondary>at ACL time</secondary>
56117 </indexterm>
56118 The extension of Exim to include content scanning at ACL time, formerly known
56119 as <quote>exiscan</quote>, was originally implemented as a patch by Tom Kistner. The code
56120 was integrated into the main source for Exim release 4.50, and Tom continues to
56121 maintain it. Most of the wording of this chapter is taken from Tom&#x2019;s
56122 specification.
56123 </para>
56124 <para>
56125 It is also possible to scan the content of messages at other times. The
56126 <function>local_scan()</function> function (see chapter <xref linkend="CHAPlocalscan"/>) allows for content
56127 scanning after all the ACLs have run. A transport filter can be used to scan
56128 messages at delivery time (see the <option>transport_filter</option> option, described in
56129 chapter <xref linkend="CHAPtransportgeneric"/>).
56130 </para>
56131 <para>
56132 If you want to include the ACL-time content-scanning features when you compile
56133 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
56134 <filename>Local/Makefile</filename>. When you do that, the Exim binary is built with:
56135 </para>
56136 <itemizedlist>
56137 <listitem>
56138 <para>
56139 Two additional ACLs (<option>acl_smtp_mime</option> and <option>acl_not_smtp_mime</option>) that are run
56140 for all MIME parts for SMTP and non-SMTP messages, respectively.
56141 </para>
56142 </listitem>
56143 <listitem>
56144 <para>
56145 Additional ACL conditions and modifiers: <option>decode</option>, <option>malware</option>,
56146 <option>mime_regex</option>, <option>regex</option>, and <option>spam</option>. These can be used in the ACL that is
56147 run at the end of message reception (the <option>acl_smtp_data</option> ACL).
56148 </para>
56149 </listitem>
56150 <listitem>
56151 <para>
56152 An additional control feature (<quote>no_mbox_unspool</quote>) that saves spooled copies
56153 of messages, or parts of messages, for debugging purposes.
56154 </para>
56155 </listitem>
56156 <listitem>
56157 <para>
56158 Additional expansion variables that are set in the new ACL and by the new
56159 conditions.
56160 </para>
56161 </listitem>
56162 <listitem>
56163 <para>
56164 Two new main configuration options: <option>av_scanner</option> and <option>spamd_address</option>.
56165 </para>
56166 </listitem>
56167 </itemizedlist>
56168 <para>
56169 There is another content-scanning configuration option for <filename>Local/Makefile</filename>,
56170 called WITH_OLD_DEMIME. If this is set, the old, deprecated <option>demime</option> ACL
56171 condition is compiled, in addition to all the other content-scanning features.
56172 </para>
56173 <para>
56174 Content-scanning is continually evolving, and new features are still being
56175 added. While such features are still unstable and liable to incompatible
56176 changes, they are made available in Exim by setting options whose names begin
56177 EXPERIMENTAL_ in <filename>Local/Makefile</filename>. Such features are not documented in
56178 this manual. You can find out about them by reading the file called
56179 <filename>doc/experimental.txt</filename>.
56180 </para>
56181 <para>
56182 All the content-scanning facilities work on a MBOX copy of the message that is
56183 temporarily created in a file called:
56184 </para>
56185 <literallayout>
56186 &lt;<emphasis>spool_directory</emphasis>&gt;<literal>/scan/</literal>&lt;<emphasis>message_id</emphasis>&gt;/&lt;<emphasis>message_id</emphasis>&gt;<literal>.eml</literal>
56187 </literallayout>
56188 <para>
56189 The <filename>.eml</filename> extension is a friendly hint to virus scanners that they can
56190 expect an MBOX-like structure inside that file. The file is created when the
56191 first content scanning facility is called. Subsequent calls to content
56192 scanning conditions open the same file again. The directory is recursively
56193 removed when the <option>acl_smtp_data</option> ACL has finished running, unless
56194 </para>
56195 <literallayout class="monospaced">
56196 control = no_mbox_unspool
56197 </literallayout>
56198 <para>
56199 has been encountered. When the MIME ACL decodes files, they are put into the
56200 same directory by default.
56201 </para>
56202 <section id="SECTscanvirus">
56203 <title>Scanning for viruses</title>
56204 <para>
56205 <indexterm role="concept">
56206 <primary>virus scanning</primary>
56207 </indexterm>
56208 <indexterm role="concept">
56209 <primary>content scanning</primary>
56210 <secondary>for viruses</secondary>
56211 </indexterm>
56212 <indexterm role="concept">
56213 <primary>content scanning</primary>
56214 <secondary>the <option>malware</option> condition</secondary>
56215 </indexterm>
56216 The <option>malware</option> ACL condition lets you connect virus scanner software to Exim.
56217 It supports a <quote>generic</quote> interface to scanners called via the shell, and
56218 specialized interfaces for <quote>daemon</quote> type virus scanners, which are resident
56219 in memory and thus are much faster.
56220 </para>
56221 <para>
56222 <indexterm role="option">
56223 <primary><option>av_scanner</option></primary>
56224 </indexterm>
56225 You can set the <option>av_scanner</option> option in first part of the Exim configuration
56226 file to specify which scanner to use, together with any additional options that
56227 are needed. The basic syntax is as follows:
56228 </para>
56229 <literallayout>
56230 <literal>av_scanner = &lt;</literal><emphasis>scanner-type</emphasis><literal>&gt;:&lt;</literal><emphasis>option1</emphasis><literal>&gt;:&lt;</literal><emphasis>option2</emphasis><literal>&gt;:[...]</literal>
56231 </literallayout>
56232 <para>
56233 If you do not set <option>av_scanner</option>, it defaults to
56234 </para>
56235 <literallayout class="monospaced">
56236 av_scanner = sophie:/var/run/sophie
56237 </literallayout>
56238 <para>
56239 If the value of <option>av_scanner</option> starts with a dollar character, it is expanded
56240 before use.
56241 The usual list-parsing of the content (see <xref linkend="SECTlistconstruct"/>) applies.
56242 The following scanner types are supported in this release:
56243 </para>
56244 <variablelist>
56245 <varlistentry>
56246 <term><option>aveserver</option></term>
56247 <listitem>
56248 <para>
56249 <indexterm role="concept">
56250 <primary>virus scanners</primary>
56251 <secondary>Kaspersky</secondary>
56252 </indexterm>
56253 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
56254 at <emphasis role="bold"><ulink url="http://www.kaspersky.com">http://www.kaspersky.com</ulink></emphasis>. This scanner type takes one option,
56255 which is the path to the daemon&#x2019;s UNIX socket. The default is shown in this
56256 example:
56257 </para>
56258 <literallayout class="monospaced">
56259 av_scanner = aveserver:/var/run/aveserver
56260 </literallayout>
56261 </listitem></varlistentry>
56262 <varlistentry>
56263 <term><option>clamd</option></term>
56264 <listitem>
56265 <para>
56266 <indexterm role="concept">
56267 <primary>virus scanners</primary>
56268 <secondary>clamd</secondary>
56269 </indexterm>
56270 This daemon-type scanner is GPL and free. You can get it at
56271 <emphasis role="bold"><ulink url="http://www.clamav.net/">http://www.clamav.net/</ulink></emphasis>. Some older versions of clamd do not seem to
56272 unpack MIME containers, so it used to be recommended to unpack MIME attachments
56273 in the MIME ACL. This no longer believed to be necessary. One option is
56274 required: either the path and name of a UNIX socket file, or a hostname or IP
56275 number, and a port, separated by space, as in the second of these examples:
56276 </para>
56277 <literallayout class="monospaced">
56278 av_scanner = clamd:/opt/clamd/socket
56279 av_scanner = clamd:192.0.2.3 1234
56280 av_scanner = clamd:192.0.2.3 1234:local
56281 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
56282 </literallayout>
56283 <para>
56284 If the value of av_scanner points to a UNIX socket file or contains the local
56285 keyword, then the ClamAV interface will pass a filename containing the data
56286 to be scanned, which will should normally result in less I/O happening and be
56287 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
56288 Exim does not assume that there is a common filesystem with the remote host.
56289 There is an option WITH_OLD_CLAMAV_STREAM in <filename>src/EDITME</filename> available, should
56290 you be running a version of ClamAV prior to 0.95.
56291 </para>
56292 <para>
56293 The final example shows that multiple TCP targets can be specified.  Exim will
56294 randomly use one for each incoming email (i.e. it load balances them).  Note
56295 that only TCP targets may be used if specifying a list of scanners; a UNIX
56296 socket cannot be mixed in with TCP targets.  If one of the servers becomes
56297 unavailable, Exim will try the remaining one(s) until it finds one that works.
56298 When a clamd server becomes unreachable, Exim will log a message.  Exim does
56299 not keep track of scanner state between multiple messages, and the scanner
56300 selection is random, so the message will get logged in the mainlog for each
56301 email that the down scanner gets chosen first (message wrapped to be readable):
56302 </para>
56303 <literallayout class="monospaced">
56304 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
56305    clamd: connection to localhost, port 3310 failed
56306    (Connection refused)
56307 </literallayout>
56308 <para>
56309 If the option is unset, the default is <filename>/tmp/clamd</filename>. Thanks to David Saez for
56310 contributing the code for this scanner.
56311 </para>
56312 </listitem></varlistentry>
56313 <varlistentry>
56314 <term><option>cmdline</option></term>
56315 <listitem>
56316 <para>
56317 <indexterm role="concept">
56318 <primary>virus scanners</primary>
56319 <secondary>command line interface</secondary>
56320 </indexterm>
56321 This is the keyword for the generic command line scanner interface. It can be
56322 used to attach virus scanners that are invoked from the shell. This scanner
56323 type takes 3 mandatory options:
56324 </para>
56325 <orderedlist numeration="arabic">
56326 <listitem>
56327 <para>
56328 The full path and name of the scanner binary, with all command line options,
56329 and a placeholder (<literal>%s</literal>) for the directory to scan.
56330 </para>
56331 </listitem>
56332 <listitem>
56333 <para>
56334 A regular expression to match against the STDOUT and STDERR output of the
56335 virus scanner. If the expression matches, a virus was found. You must make
56336 absolutely sure that this expression matches on <quote>virus found</quote>. This is called
56337 the <quote>trigger</quote> expression.
56338 </para>
56339 </listitem>
56340 <listitem>
56341 <para>
56342 Another regular expression, containing exactly one pair of parentheses, to
56343 match the name of the virus found in the scanners output. This is called the
56344 <quote>name</quote> expression.
56345 </para>
56346 </listitem>
56347 </orderedlist>
56348 <para>
56349 For example, Sophos Sweep reports a virus on a line like this:
56350 </para>
56351 <literallayout class="monospaced">
56352 Virus 'W32/Magistr-B' found in file ./those.bat
56353 </literallayout>
56354 <para>
56355 For the trigger expression, we can match the phrase <quote>found in file</quote>. For the
56356 name expression, we want to extract the W32/Magistr-B string, so we can match
56357 for the single quotes left and right of it. Altogether, this makes the
56358 configuration setting:
56359 </para>
56360 <literallayout class="monospaced">
56361 av_scanner = cmdline:\
56362              /path/to/sweep -ss -all -rec -archive %s:\
56363              found in file:'(.+)'
56364 </literallayout>
56365 </listitem></varlistentry>
56366 <varlistentry>
56367 <term><option>drweb</option></term>
56368 <listitem>
56369 <para>
56370 <indexterm role="concept">
56371 <primary>virus scanners</primary>
56372 <secondary>DrWeb</secondary>
56373 </indexterm>
56374 The DrWeb daemon scanner (<emphasis role="bold"><ulink url="http://www.sald.com/">http://www.sald.com/</ulink></emphasis>) interface takes one
56375 argument, either a full path to a UNIX socket, or an IP address and port
56376 separated by white space, as in these examples:
56377 </para>
56378 <literallayout class="monospaced">
56379 av_scanner = drweb:/var/run/drwebd.sock
56380 av_scanner = drweb:192.168.2.20 31337
56381 </literallayout>
56382 <para>
56383 If you omit the argument, the default path <filename>/usr/local/drweb/run/drwebd.sock</filename>
56384 is used. Thanks to Alex Miller for contributing the code for this scanner.
56385 </para>
56386 </listitem></varlistentry>
56387 <varlistentry>
56388 <term><option>fsecure</option></term>
56389 <listitem>
56390 <para>
56391 <indexterm role="concept">
56392 <primary>virus scanners</primary>
56393 <secondary>F-Secure</secondary>
56394 </indexterm>
56395 The F-Secure daemon scanner (<emphasis role="bold"><ulink url="http://www.f-secure.com">http://www.f-secure.com</ulink></emphasis>) takes one
56396 argument which is the path to a UNIX socket. For example:
56397 </para>
56398 <literallayout class="monospaced">
56399 av_scanner = fsecure:/path/to/.fsav
56400 </literallayout>
56401 <para>
56402 If no argument is given, the default is <filename>/var/run/.fsav</filename>. Thanks to Johan
56403 Thelmen for contributing the code for this scanner.
56404 </para>
56405 </listitem></varlistentry>
56406 <varlistentry>
56407 <term><option>kavdaemon</option></term>
56408 <listitem>
56409 <para>
56410 <indexterm role="concept">
56411 <primary>virus scanners</primary>
56412 <secondary>Kaspersky</secondary>
56413 </indexterm>
56414 This is the scanner daemon of Kaspersky Version 4. This version of the
56415 Kaspersky scanner is outdated. Please upgrade (see <option>aveserver</option> above). This
56416 scanner type takes one option, which is the path to the daemon&#x2019;s UNIX socket.
56417 For example:
56418 </para>
56419 <literallayout class="monospaced">
56420 av_scanner = kavdaemon:/opt/AVP/AvpCtl
56421 </literallayout>
56422 <para>
56423 The default path is <filename>/var/run/AvpCtl</filename>.
56424 </para>
56425 </listitem></varlistentry>
56426 <varlistentry>
56427 <term><option>mksd</option></term>
56428 <listitem>
56429 <para>
56430 <indexterm role="concept">
56431 <primary>virus scanners</primary>
56432 <secondary>mksd</secondary>
56433 </indexterm>
56434 This is a daemon type scanner that is aimed mainly at Polish users, though some
56435 parts of documentation are now available in English. You can get it at
56436 <emphasis role="bold"><ulink url="http://linux.mks.com.pl/">http://linux.mks.com.pl/</ulink></emphasis>. The only option for this scanner type is
56437 the maximum number of processes used simultaneously to scan the attachments,
56438 provided that the demime facility is employed and also provided that mksd has
56439 been run with at least the same number of child processes. For example:
56440 </para>
56441 <literallayout class="monospaced">
56442 av_scanner = mksd:2
56443 </literallayout>
56444 <para>
56445 You can safely omit this option (the default value is 1).
56446 </para>
56447 </listitem></varlistentry>
56448 <varlistentry>
56449 <term><option>sock</option></term>
56450 <listitem>
56451 <para>
56452 <indexterm role="concept">
56453 <primary>virus scanners</primary>
56454 <secondary>simple socket-connected</secondary>
56455 </indexterm>
56456 This is a general-purpose way of talking to simple scanner daemons
56457 running on the local machine.
56458 There are four options:
56459 an address (which may be an IP addres and port, or the path of a Unix socket),
56460 a commandline to send (may include a single %s which will be replaced with
56461 the path to the mail file to be scanned),
56462 an RE to trigger on from the returned data,
56463 an RE to extract malware_name from the returned data.
56464 For example:
56465 </para>
56466 <literallayout class="monospaced">
56467 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
56468 </literallayout>
56469 <para>
56470 Default for the socket specifier is <filename>/tmp/malware.sock</filename>.
56471 Default for the commandline is <filename>%s\n</filename>.
56472 Both regular-expressions are required.
56473 </para>
56474 </listitem></varlistentry>
56475 <varlistentry>
56476 <term><option>sophie</option></term>
56477 <listitem>
56478 <para>
56479 <indexterm role="concept">
56480 <primary>virus scanners</primary>
56481 <secondary>Sophos and Sophie</secondary>
56482 </indexterm>
56483 Sophie is a daemon that uses Sophos&#x2019; <option>libsavi</option> library to scan for viruses.
56484 You can get Sophie at <emphasis role="bold"><ulink url="http://www.clanfield.info/sophie/">http://www.clanfield.info/sophie/</ulink></emphasis>. The only option
56485 for this scanner type is the path to the UNIX socket that Sophie uses for
56486 client communication. For example:
56487 </para>
56488 <literallayout class="monospaced">
56489 av_scanner = sophie:/tmp/sophie
56490 </literallayout>
56491 <para>
56492 The default path is <filename>/var/run/sophie</filename>, so if you are using this, you can omit
56493 the option.
56494 </para>
56495 </listitem></varlistentry>
56496 </variablelist>
56497 <para>
56498 When <option>av_scanner</option> is correctly set, you can use the <option>malware</option> condition in
56499 the DATA ACL. <emphasis role="bold">Note</emphasis>: You cannot use the <option>malware</option> condition in the MIME
56500 ACL.
56501 </para>
56502 <para>
56503 The <option>av_scanner</option> option is expanded each time <option>malware</option> is called. This
56504 makes it possible to use different scanners. See further below for an example.
56505 The <option>malware</option> condition caches its results, so when you use it multiple times
56506 for the same message, the actual scanning process is only carried out once.
56507 However, using expandable items in <option>av_scanner</option> disables this caching, in
56508 which case each use of the <option>malware</option> condition causes a new scan of the
56509 message.
56510 </para>
56511 <para>
56512 The <option>malware</option> condition takes a right-hand argument that is expanded before
56513 use. It can then be one of
56514 </para>
56515 <itemizedlist>
56516 <listitem>
56517 <para>
56518 <quote>true</quote>, <quote>*</quote>, or <quote>1</quote>, in which case the message is scanned for viruses.
56519 The condition succeeds if a virus was found, and fail otherwise. This is the
56520 recommended usage.
56521 </para>
56522 </listitem>
56523 <listitem>
56524 <para>
56525 <quote>false</quote> or <quote>0</quote> or an empty string, in which case no scanning is done and
56526 the condition fails immediately.
56527 </para>
56528 </listitem>
56529 <listitem>
56530 <para>
56531 A regular expression, in which case the message is scanned for viruses. The
56532 condition succeeds if a virus is found and its name matches the regular
56533 expression. This allows you to take special actions on certain types of virus.
56534 </para>
56535 </listitem>
56536 </itemizedlist>
56537 <para>
56538 You can append <literal>/defer_ok</literal> to the <option>malware</option> condition to accept messages
56539 even if there is a problem with the virus scanner. Otherwise, such a problem
56540 causes the ACL to defer.
56541 </para>
56542 <para>
56543 <indexterm role="variable">
56544 <primary><varname>$malware_name</varname></primary>
56545 </indexterm>
56546 When a virus is found, the condition sets up an expansion variable called
56547 <varname>$malware_name</varname> that contains the name of the virus. You can use it in a
56548 <option>message</option> modifier that specifies the error returned to the sender, and/or in
56549 logging data.
56550 </para>
56551 <para>
56552 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
56553 use the <option>demime</option> condition (see section <xref linkend="SECTdemimecond"/>) before the
56554 <option>malware</option> condition.
56555 </para>
56556 <para>
56557 Beware the interaction of Exim&#x2019;s <option>message_size_limit</option> with any size limits
56558 imposed by your anti-virus scanner.
56559 </para>
56560 <para>
56561 Here is a very simple scanning example:
56562 </para>
56563 <literallayout class="monospaced">
56564 deny message = This message contains malware ($malware_name)
56565      demime = *
56566      malware = *
56567 </literallayout>
56568 <para>
56569 The next example accepts messages when there is a problem with the scanner:
56570 </para>
56571 <literallayout class="monospaced">
56572 deny message = This message contains malware ($malware_name)
56573      demime = *
56574      malware = */defer_ok
56575 </literallayout>
56576 <para>
56577 The next example shows how to use an ACL variable to scan with both sophie and
56578 aveserver. It assumes you have set:
56579 </para>
56580 <literallayout class="monospaced">
56581 av_scanner = $acl_m0
56582 </literallayout>
56583 <para>
56584 in the main Exim configuration.
56585 </para>
56586 <literallayout class="monospaced">
56587 deny message = This message contains malware ($malware_name)
56588      set acl_m0 = sophie
56589      malware = *
56590
56591 deny message = This message contains malware ($malware_name)
56592      set acl_m0 = aveserver
56593      malware = *
56594 </literallayout>
56595 </section>
56596 <section id="SECTscanspamass">
56597 <title>Scanning with SpamAssassin</title>
56598 <para>
56599 <indexterm role="concept">
56600 <primary>content scanning</primary>
56601 <secondary>for spam</secondary>
56602 </indexterm>
56603 <indexterm role="concept">
56604 <primary>spam scanning</primary>
56605 </indexterm>
56606 <indexterm role="concept">
56607 <primary>SpamAssassin</primary>
56608 </indexterm>
56609 The <option>spam</option> ACL condition calls SpamAssassin&#x2019;s <option>spamd</option> daemon to get a spam
56610 score and a report for the message. You can get SpamAssassin at
56611 <emphasis role="bold"><ulink url="http://www.spamassassin.org">http://www.spamassassin.org</ulink></emphasis>, or, if you have a working Perl
56612 installation, you can use CPAN by running:
56613 </para>
56614 <literallayout class="monospaced">
56615 perl -MCPAN -e 'install Mail::SpamAssassin'
56616 </literallayout>
56617 <para>
56618 SpamAssassin has its own set of configuration files. Please review its
56619 documentation to see how you can tweak it. The default installation should work
56620 nicely, however.
56621 </para>
56622 <para>
56623 <indexterm role="option">
56624 <primary><option>spamd_address</option></primary>
56625 </indexterm>
56626 After having installed and configured SpamAssassin, start the <option>spamd</option> daemon.
56627 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
56628 port for <option>spamd</option>, you must set the <option>spamd_address</option> option in the global
56629 part of the Exim configuration as follows (example):
56630 </para>
56631 <literallayout class="monospaced">
56632 spamd_address = 192.168.99.45 387
56633 </literallayout>
56634 <para>
56635 You do not need to set this option if you use the default. As of version 2.60,
56636 <option>spamd</option> also supports communication over UNIX sockets. If you want to use
56637 these, supply <option>spamd_address</option> with an absolute file name instead of a
56638 address/port pair:
56639 </para>
56640 <literallayout class="monospaced">
56641 spamd_address = /var/run/spamd_socket
56642 </literallayout>
56643 <para>
56644 You can have multiple <option>spamd</option> servers to improve scalability. These can
56645 reside on other hardware reachable over the network. To specify multiple
56646 <option>spamd</option> servers, put multiple address/port pairs in the <option>spamd_address</option>
56647 option, separated with colons:
56648 </para>
56649 <literallayout class="monospaced">
56650 spamd_address = 192.168.2.10 783 : \
56651                 192.168.2.11 783 : \
56652                 192.168.2.12 783
56653 </literallayout>
56654 <para>
56655 Up to 32 <option>spamd</option> servers are supported. The servers are queried in a random
56656 fashion. When a server fails to respond to the connection attempt, all other
56657 servers are tried until one succeeds. If no server responds, the <option>spam</option>
56658 condition defers.
56659 </para>
56660 <para>
56661 <emphasis role="bold">Warning</emphasis>: It is not possible to use the UNIX socket connection method with
56662 multiple <option>spamd</option> servers.
56663 </para>
56664 <para>
56665 The <option>spamd_address</option> variable is expanded before use if it starts with
56666 a dollar sign. In this case, the expansion may return a string that is
56667 used as the list so that multiple spamd servers can be the result of an
56668 expansion.
56669 </para>
56670 </section>
56671 <section id="SECID206">
56672 <title>Calling SpamAssassin from an Exim ACL</title>
56673 <para>
56674 Here is a simple example of the use of the <option>spam</option> condition in a DATA ACL:
56675 </para>
56676 <literallayout class="monospaced">
56677 deny message = This message was classified as SPAM
56678      spam = joe
56679 </literallayout>
56680 <para>
56681 The right-hand side of the <option>spam</option> condition specifies a name. This is
56682 relevant if you have set up multiple SpamAssassin profiles. If you do not want
56683 to scan using a specific profile, but rather use the SpamAssassin system-wide
56684 default profile, you can scan for an unknown name, or simply use <quote>nobody</quote>.
56685 However, you must put something on the right-hand side.
56686 </para>
56687 <para>
56688 The name allows you to use per-domain or per-user antispam profiles in
56689 principle, but this is not straightforward in practice, because a message may
56690 have multiple recipients, not necessarily all in the same domain. Because the
56691 <option>spam</option> condition has to be called from a DATA ACL in order to be able to
56692 read the contents of the message, the variables <varname>$local_part</varname> and <varname>$domain</varname>
56693 are not set.
56694 </para>
56695 <para>
56696 The right-hand side of the <option>spam</option> condition is expanded before being used, so
56697 you can put lookups or conditions there. When the right-hand side evaluates to
56698 <quote>0</quote> or <quote>false</quote>, no scanning is done and the condition fails immediately.
56699 </para>
56700 <para>
56701 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
56702 large ones may cause significant performance degradation. As most spam messages
56703 are quite small, it is recommended that you do not scan the big ones. For
56704 example:
56705 </para>
56706 <literallayout class="monospaced">
56707 deny message = This message was classified as SPAM
56708      condition = ${if &lt; {$message_size}{10K}}
56709      spam = nobody
56710 </literallayout>
56711 <para>
56712 The <option>spam</option> condition returns true if the threshold specified in the user&#x2019;s
56713 SpamAssassin profile has been matched or exceeded. If you want to use the
56714 <option>spam</option> condition for its side effects (see the variables below), you can make
56715 it always return <quote>true</quote> by appending <literal>:true</literal> to the username.
56716 </para>
56717 <para>
56718 <indexterm role="concept">
56719 <primary>spam scanning</primary>
56720 <secondary>returned variables</secondary>
56721 </indexterm>
56722 When the <option>spam</option> condition is run, it sets up a number of expansion
56723 variables. These variables are saved with the received message, thus they are
56724 available for use at delivery time.
56725 </para>
56726 <variablelist>
56727 <varlistentry>
56728 <term><varname>$spam_score</varname></term>
56729 <listitem>
56730 <para>
56731 The spam score of the message, for example <quote>3.4</quote> or <quote>30.5</quote>. This is useful
56732 for inclusion in log or reject messages.
56733 </para>
56734 </listitem></varlistentry>
56735 <varlistentry>
56736 <term><varname>$spam_score_int</varname></term>
56737 <listitem>
56738 <para>
56739 The spam score of the message, multiplied by ten, as an integer value. For
56740 example <quote>34</quote> or <quote>305</quote>. It may appear to disagree with <varname>$spam_score</varname>
56741 because <varname>$spam_score</varname> is rounded and <varname>$spam_score_int</varname> is truncated.
56742 The integer value is useful for numeric comparisons in conditions.
56743 </para>
56744 </listitem></varlistentry>
56745 <varlistentry>
56746 <term><varname>$spam_bar</varname></term>
56747 <listitem>
56748 <para>
56749 A string consisting of a number of <quote>+</quote> or <quote>-</quote> characters, representing the
56750 integer part of the spam score value. A spam score of 4.4 would have a
56751 <varname>$spam_bar</varname> value of <quote>++++</quote>. This is useful for inclusion in warning
56752 headers, since MUAs can match on such strings.
56753 </para>
56754 </listitem></varlistentry>
56755 <varlistentry>
56756 <term><varname>$spam_report</varname></term>
56757 <listitem>
56758 <para>
56759 A multiline text table, containing the full SpamAssassin report for the
56760 message. Useful for inclusion in headers or reject messages.
56761 </para>
56762 </listitem></varlistentry>
56763 </variablelist>
56764 <para>
56765 The <option>spam</option> condition caches its results unless expansion in
56766 spamd_address was used. If you call it again with the same user name, it
56767 does not scan again, but rather returns the same values as before.
56768 </para>
56769 <para>
56770 The <option>spam</option> condition returns DEFER if there is any error while running
56771 the message through SpamAssassin or if the expansion of spamd_address
56772 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
56773 statement block), append <literal>/defer_ok</literal> to the right-hand side of the
56774 spam condition, like this:
56775 </para>
56776 <literallayout class="monospaced">
56777 deny message = This message was classified as SPAM
56778      spam    = joe/defer_ok
56779 </literallayout>
56780 <para>
56781 This causes messages to be accepted even if there is a problem with <option>spamd</option>.
56782 </para>
56783 <para>
56784 Here is a longer, commented example of the use of the <option>spam</option>
56785 condition:
56786 </para>
56787 <literallayout class="monospaced">
56788 # put headers in all messages (no matter if spam or not)
56789 warn  spam = nobody:true
56790       add_header = X-Spam-Score: $spam_score ($spam_bar)
56791       add_header = X-Spam-Report: $spam_report
56792
56793 # add second subject line with *SPAM* marker when message
56794 # is over threshold
56795 warn  spam = nobody
56796       add_header = Subject: *SPAM* $h_Subject:
56797
56798 # reject spam at high scores (&gt; 12)
56799 deny  message = This message scored $spam_score spam points.
56800       spam = nobody:true
56801       condition = ${if &gt;{$spam_score_int}{120}{1}{0}}
56802 </literallayout>
56803 </section>
56804 <section id="SECTscanmimepart">
56805 <title>Scanning MIME parts</title>
56806 <para>
56807 <indexterm role="concept">
56808 <primary>content scanning</primary>
56809 <secondary>MIME parts</secondary>
56810 </indexterm>
56811 <indexterm role="concept">
56812 <primary>MIME content scanning</primary>
56813 </indexterm>
56814 <indexterm role="option">
56815 <primary><option>acl_smtp_mime</option></primary>
56816 </indexterm>
56817 <indexterm role="option">
56818 <primary><option>acl_not_smtp_mime</option></primary>
56819 </indexterm>
56820 The <option>acl_smtp_mime</option> global option specifies an ACL that is called once for
56821 each MIME part of an SMTP message, including multipart types, in the sequence
56822 of their position in the message. Similarly, the <option>acl_not_smtp_mime</option> option
56823 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
56824 options may both refer to the same ACL if you want the same processing in both
56825 cases.
56826 </para>
56827 <para>
56828 These ACLs are called (possibly many times) just before the <option>acl_smtp_data</option>
56829 ACL in the case of an SMTP message, or just before the <option>acl_not_smtp</option> ACL in
56830 the case of a non-SMTP message. However, a MIME ACL is called only if the
56831 message contains a <emphasis>Content-Type:</emphasis> header line. When a call to a MIME
56832 ACL does not yield <quote>accept</quote>, ACL processing is aborted and the appropriate
56833 result code is sent to the client. In the case of an SMTP message, the
56834 <option>acl_smtp_data</option> ACL is not called when this happens.
56835 </para>
56836 <para>
56837 You cannot use the <option>malware</option> or <option>spam</option> conditions in a MIME ACL; these can
56838 only be used in the DATA or non-SMTP ACLs. However, you can use the <option>regex</option>
56839 condition to match against the raw MIME part. You can also use the
56840 <option>mime_regex</option> condition to match against the decoded MIME part (see section
56841 <xref linkend="SECTscanregex"/>).
56842 </para>
56843 <para>
56844 At the start of a MIME ACL, a number of variables are set from the header
56845 information for the relevant MIME part. These are described below. The contents
56846 of the MIME part are not by default decoded into a disk file except for MIME
56847 parts whose content-type is <quote>message/rfc822</quote>. If you want to decode a MIME
56848 part into a disk file, you can use the <option>decode</option> condition. The general
56849 syntax is:
56850 </para>
56851 <literallayout>
56852 <literal>decode = [/</literal>&lt;<emphasis>path</emphasis>&gt;<literal>/]</literal>&lt;<emphasis>filename</emphasis>&gt;
56853 </literallayout>
56854 <para>
56855 The right hand side is expanded before use. After expansion,
56856 the value can be:
56857 </para>
56858 <orderedlist numeration="arabic">
56859 <listitem>
56860 <para>
56861 <quote>0</quote> or <quote>false</quote>, in which case no decoding is done.
56862 </para>
56863 </listitem>
56864 <listitem>
56865 <para>
56866 The string <quote>default</quote>. In that case, the file is put in the temporary
56867 <quote>default</quote> directory &lt;<emphasis>spool_directory</emphasis>&gt;<filename>/scan/</filename>&lt;<emphasis>message_id</emphasis>&gt;<filename>/</filename> with
56868 a sequential file name consisting of the message id and a sequence number. The
56869 full path and name is available in <varname>$mime_decoded_filename</varname> after decoding.
56870 </para>
56871 </listitem>
56872 <listitem>
56873 <para>
56874 A full path name starting with a slash. If the full name is an existing
56875 directory, it is used as a replacement for the default directory. The filename
56876 is then sequentially assigned. If the path does not exist, it is used as
56877 the full path and file name.
56878 </para>
56879 </listitem>
56880 <listitem>
56881 <para>
56882 If the string does not start with a slash, it is used as the
56883 filename, and the default path is then used.
56884 </para>
56885 </listitem>
56886 </orderedlist>
56887 <para>
56888 The <option>decode</option> condition normally succeeds. It is only false for syntax
56889 errors or unusual circumstances such as memory shortages. You can easily decode
56890 a file with its original, proposed filename using
56891 </para>
56892 <literallayout class="monospaced">
56893 decode = $mime_filename
56894 </literallayout>
56895 <para>
56896 However, you should keep in mind that <varname>$mime_filename</varname> might contain
56897 anything. If you place files outside of the default path, they are not
56898 automatically unlinked.
56899 </para>
56900 <para>
56901 For RFC822 attachments (these are messages attached to messages, with a
56902 content-type of <quote>message/rfc822</quote>), the ACL is called again in the same manner
56903 as for the primary message, only that the <varname>$mime_is_rfc822</varname> expansion
56904 variable is set (see below). Attached messages are always decoded to disk
56905 before being checked, and the files are unlinked once the check is done.
56906 </para>
56907 <para>
56908 The MIME ACL supports the <option>regex</option> and <option>mime_regex</option> conditions. These can be
56909 used to match regular expressions against raw and decoded MIME parts,
56910 respectively. They are described in section <xref linkend="SECTscanregex"/>.
56911 </para>
56912 <para>
56913 <indexterm role="concept">
56914 <primary>MIME content scanning</primary>
56915 <secondary>returned variables</secondary>
56916 </indexterm>
56917 The following list describes all expansion variables that are
56918 available in the MIME ACL:
56919 </para>
56920 <variablelist>
56921 <varlistentry>
56922 <term><varname>$mime_boundary</varname></term>
56923 <listitem>
56924 <para>
56925 If the current part is a multipart (see <varname>$mime_is_multipart</varname>) below, it should
56926 have a boundary string, which is stored in this variable. If the current part
56927 has no boundary parameter in the <emphasis>Content-Type:</emphasis> header, this variable
56928 contains the empty string.
56929 </para>
56930 </listitem></varlistentry>
56931 <varlistentry>
56932 <term><varname>$mime_charset</varname></term>
56933 <listitem>
56934 <para>
56935 This variable contains the character set identifier, if one was found in the
56936 <emphasis>Content-Type:</emphasis> header. Examples for charset identifiers are:
56937 </para>
56938 <literallayout class="monospaced">
56939 us-ascii
56940 gb2312 (Chinese)
56941 iso-8859-1
56942 </literallayout>
56943 <para>
56944 Please note that this value is not normalized, so you should do matches
56945 case-insensitively.
56946 </para>
56947 </listitem></varlistentry>
56948 <varlistentry>
56949 <term><varname>$mime_content_description</varname></term>
56950 <listitem>
56951 <para>
56952 This variable contains the normalized content of the <emphasis>Content-Description:</emphasis>
56953 header. It can contain a human-readable description of the parts content. Some
56954 implementations repeat the filename for attachments here, but they are usually
56955 only used for display purposes.
56956 </para>
56957 </listitem></varlistentry>
56958 <varlistentry>
56959 <term><varname>$mime_content_disposition</varname></term>
56960 <listitem>
56961 <para>
56962 This variable contains the normalized content of the <emphasis>Content-Disposition:</emphasis>
56963 header. You can expect strings like <quote>attachment</quote> or <quote>inline</quote> here.
56964 </para>
56965 </listitem></varlistentry>
56966 <varlistentry>
56967 <term><varname>$mime_content_id</varname></term>
56968 <listitem>
56969 <para>
56970 This variable contains the normalized content of the <emphasis>Content-ID:</emphasis> header.
56971 This is a unique ID that can be used to reference a part from another part.
56972 </para>
56973 </listitem></varlistentry>
56974 <varlistentry>
56975 <term><varname>$mime_content_size</varname></term>
56976 <listitem>
56977 <para>
56978 This variable is set only after the <option>decode</option> modifier (see above) has been
56979 successfully run. It contains the size of the decoded part in kilobytes. The
56980 size is always rounded up to full kilobytes, so only a completely empty part
56981 has a <varname>$mime_content_size</varname> of zero.
56982 </para>
56983 </listitem></varlistentry>
56984 <varlistentry>
56985 <term><varname>$mime_content_transfer_encoding</varname></term>
56986 <listitem>
56987 <para>
56988 This variable contains the normalized content of the
56989 <emphasis>Content-transfer-encoding:</emphasis> header. This is a symbolic name for an encoding
56990 type. Typical values are <quote>base64</quote> and <quote>quoted-printable</quote>.
56991 </para>
56992 </listitem></varlistentry>
56993 <varlistentry>
56994 <term><varname>$mime_content_type</varname></term>
56995 <listitem>
56996 <para>
56997 If the MIME part has a <emphasis>Content-Type:</emphasis> header, this variable contains its
56998 value, lowercased, and without any options (like <quote>name</quote> or <quote>charset</quote>). Here
56999 are some examples of popular MIME types, as they may appear in this variable:
57000 </para>
57001 <literallayout class="monospaced">
57002 text/plain
57003 text/html
57004 application/octet-stream
57005 image/jpeg
57006 audio/midi
57007 </literallayout>
57008 <para>
57009 If the MIME part has no <emphasis>Content-Type:</emphasis> header, this variable contains the
57010 empty string.
57011 </para>
57012 </listitem></varlistentry>
57013 <varlistentry>
57014 <term><varname>$mime_decoded_filename</varname></term>
57015 <listitem>
57016 <para>
57017 This variable is set only after the <option>decode</option> modifier (see above) has been
57018 successfully run. It contains the full path and file name of the file
57019 containing the decoded data.
57020 </para>
57021 </listitem></varlistentry>
57022 </variablelist>
57023 <para>
57024 <indexterm role="concept">
57025 <primary>RFC 2047</primary>
57026 </indexterm>
57027 </para>
57028 <variablelist>
57029 <varlistentry>
57030 <term><varname>$mime_filename</varname></term>
57031 <listitem>
57032 <para>
57033 This is perhaps the most important of the MIME variables. It contains a
57034 proposed filename for an attachment, if one was found in either the
57035 <emphasis>Content-Type:</emphasis> or <emphasis>Content-Disposition:</emphasis> headers. The filename will be
57036 RFC2047 decoded, but no additional sanity checks are done. If no filename was
57037 found, this variable contains the empty string.
57038 </para>
57039 </listitem></varlistentry>
57040 <varlistentry>
57041 <term><varname>$mime_is_coverletter</varname></term>
57042 <listitem>
57043 <para>
57044 This variable attempts to differentiate the <quote>cover letter</quote> of an e-mail from
57045 attached data. It can be used to clamp down on flashy or unnecessarily encoded
57046 content in the cover letter, while not restricting attachments at all.
57047 </para>
57048 <para>
57049 The variable contains 1 (true) for a MIME part believed to be part of the
57050 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
57051 follows:
57052 </para>
57053 <orderedlist numeration="arabic">
57054 <listitem>
57055 <para>
57056 The outermost MIME part of a message is always a cover letter.
57057 </para>
57058 </listitem>
57059 <listitem>
57060 <para>
57061 If a multipart/alternative or multipart/related MIME part is a cover letter,
57062 so are all MIME subparts within that multipart.
57063 </para>
57064 </listitem>
57065 <listitem>
57066 <para>
57067 If any other multipart is a cover letter, the first subpart is a cover letter,
57068 and the rest are attachments.
57069 </para>
57070 </listitem>
57071 <listitem>
57072 <para>
57073 All parts contained within an attachment multipart are attachments.
57074 </para>
57075 </listitem>
57076 </orderedlist>
57077 <para>
57078 As an example, the following will ban <quote>HTML mail</quote> (including that sent with
57079 alternative plain text), while allowing HTML files to be attached. HTML
57080 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
57081 </para>
57082 <literallayout class="monospaced">
57083 deny message = HTML mail is not accepted here
57084 !condition = $mime_is_rfc822
57085 condition = $mime_is_coverletter
57086 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
57087 </literallayout>
57088 </listitem></varlistentry>
57089 <varlistentry>
57090 <term><varname>$mime_is_multipart</varname></term>
57091 <listitem>
57092 <para>
57093 This variable has the value 1 (true) when the current part has the main type
57094 <quote>multipart</quote>, for example <quote>multipart/alternative</quote> or <quote>multipart/mixed</quote>.
57095 Since multipart entities only serve as containers for other parts, you may not
57096 want to carry out specific actions on them.
57097 </para>
57098 </listitem></varlistentry>
57099 <varlistentry>
57100 <term><varname>$mime_is_rfc822</varname></term>
57101 <listitem>
57102 <para>
57103 This variable has the value 1 (true) if the current part is not a part of the
57104 checked message itself, but part of an attached message. Attached message
57105 decoding is fully recursive.
57106 </para>
57107 </listitem></varlistentry>
57108 <varlistentry>
57109 <term><varname>$mime_part_count</varname></term>
57110 <listitem>
57111 <para>
57112 This variable is a counter that is raised for each processed MIME part. It
57113 starts at zero for the very first part (which is usually a multipart). The
57114 counter is per-message, so it is reset when processing RFC822 attachments (see
57115 <varname>$mime_is_rfc822</varname>). The counter stays set after <option>acl_smtp_mime</option> is
57116 complete, so you can use it in the DATA ACL to determine the number of MIME
57117 parts of a message. For non-MIME messages, this variable contains the value -1.
57118 </para>
57119 </listitem></varlistentry>
57120 </variablelist>
57121 </section>
57122 <section id="SECTscanregex">
57123 <title>Scanning with regular expressions</title>
57124 <para>
57125 <indexterm role="concept">
57126 <primary>content scanning</primary>
57127 <secondary>with regular expressions</secondary>
57128 </indexterm>
57129 <indexterm role="concept">
57130 <primary>regular expressions</primary>
57131 <secondary>content scanning with</secondary>
57132 </indexterm>
57133 You can specify your own custom regular expression matches on the full body of
57134 the message, or on individual MIME parts.
57135 </para>
57136 <para>
57137 The <option>regex</option> condition takes one or more regular expressions as arguments and
57138 matches them against the full message (when called in the DATA ACL) or a raw
57139 MIME part (when called in the MIME ACL). The <option>regex</option> condition matches
57140 linewise, with a maximum line length of 32K characters. That means you cannot
57141 have multiline matches with the <option>regex</option> condition.
57142 </para>
57143 <para>
57144 The <option>mime_regex</option> condition can be called only in the MIME ACL. It matches up
57145 to 32K of decoded content (the whole content at once, not linewise). If the
57146 part has not been decoded with the <option>decode</option> modifier earlier in the ACL, it
57147 is decoded automatically when <option>mime_regex</option> is executed (using default path
57148 and filename values). If the decoded data is larger than  32K, only the first
57149 32K characters are checked.
57150 </para>
57151 <para>
57152 The regular expressions are passed as a colon-separated list. To include a
57153 literal colon, you must double it. Since the whole right-hand side string is
57154 expanded before being used, you must also escape dollar signs and backslashes
57155 with more backslashes, or use the <literal>\N</literal> facility to disable expansion.
57156 Here is a simple example that contains two regular expressions:
57157 </para>
57158 <literallayout class="monospaced">
57159 deny message = contains blacklisted regex ($regex_match_string)
57160      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
57161 </literallayout>
57162 <para>
57163 The conditions returns true if any one of the regular expressions matches. The
57164 <varname>$regex_match_string</varname> expansion variable is then set up and contains the
57165 matching regular expression.
57166 </para>
57167 <para>
57168 <emphasis role="bold">Warning</emphasis>: With large messages, these conditions can be fairly
57169 CPU-intensive.
57170 </para>
57171 </section>
57172 <section id="SECTdemimecond">
57173 <title>The demime condition</title>
57174 <para>
57175 <indexterm role="concept">
57176 <primary>content scanning</primary>
57177 <secondary>MIME checking</secondary>
57178 </indexterm>
57179 <indexterm role="concept">
57180 <primary>MIME content scanning</primary>
57181 </indexterm>
57182 The <option>demime</option> ACL condition provides MIME unpacking, sanity checking and file
57183 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
57184 <option>demime</option> condition uses a simpler interface to MIME decoding than the MIME
57185 ACL functionality, but provides no additional facilities. Please note that this
57186 condition is deprecated and kept only for backward compatibility. You must set
57187 the WITH_OLD_DEMIME option in <filename>Local/Makefile</filename> at build time to be able to
57188 use the <option>demime</option> condition.
57189 </para>
57190 <para>
57191 The <option>demime</option> condition unpacks MIME containers in the message. It detects
57192 errors in MIME containers and can match file extensions found in the message
57193 against a list. Using this facility produces files containing the unpacked MIME
57194 parts of the message in the temporary scan directory. If you do antivirus
57195 scanning, it is recommended that you use the <option>demime</option> condition before the
57196 antivirus (<option>malware</option>) condition.
57197 </para>
57198 <para>
57199 On the right-hand side of the <option>demime</option> condition you can pass a
57200 colon-separated list of file extensions that it should match against. For
57201 example:
57202 </para>
57203 <literallayout class="monospaced">
57204 deny message = Found blacklisted file attachment
57205      demime  = vbs:com:bat:pif:prf:lnk
57206 </literallayout>
57207 <para>
57208 If one of the file extensions is found, the condition is true, otherwise it is
57209 false. If there is a temporary error while demimeing (for example, <quote>disk
57210 full</quote>), the condition defers, and the message is temporarily rejected (unless
57211 the condition is on a <option>warn</option> verb).
57212 </para>
57213 <para>
57214 The right-hand side is expanded before being treated as a list, so you can have
57215 conditions and lookups there. If it expands to an empty string, <quote>false</quote>, or
57216 zero (<quote>0</quote>), no demimeing is done and the condition is false.
57217 </para>
57218 <para>
57219 The <option>demime</option> condition set the following variables:
57220 </para>
57221 <variablelist>
57222 <varlistentry>
57223 <term><varname>$demime_errorlevel</varname></term>
57224 <listitem>
57225 <para>
57226 <indexterm role="variable">
57227 <primary><varname>$demime_errorlevel</varname></primary>
57228 </indexterm>
57229 When an error is detected in a MIME container, this variable contains the
57230 severity of the error, as an integer number. The higher the value, the more
57231 severe the error (the current maximum value is 3). If this variable is unset or
57232 zero, no error occurred.
57233 </para>
57234 </listitem></varlistentry>
57235 <varlistentry>
57236 <term><varname>$demime_reason</varname></term>
57237 <listitem>
57238 <para>
57239 <indexterm role="variable">
57240 <primary><varname>$demime_reason</varname></primary>
57241 </indexterm>
57242 When <varname>$demime_errorlevel</varname> is greater than zero, this variable contains a
57243 human-readable text string describing the MIME error that occurred.
57244 </para>
57245 </listitem></varlistentry>
57246 </variablelist>
57247 <variablelist>
57248 <varlistentry>
57249 <term><varname>$found_extension</varname></term>
57250 <listitem>
57251 <para>
57252 <indexterm role="variable">
57253 <primary><varname>$found_extension</varname></primary>
57254 </indexterm>
57255 When the <option>demime</option> condition is true, this variable contains the file
57256 extension it found.
57257 </para>
57258 </listitem></varlistentry>
57259 </variablelist>
57260 <para>
57261 Both <varname>$demime_errorlevel</varname> and <varname>$demime_reason</varname> are set by the first call of
57262 the <option>demime</option> condition, and are not changed on subsequent calls.
57263 </para>
57264 <para>
57265 If you do not want to check for file extensions, but rather use the <option>demime</option>
57266 condition for unpacking or error checking purposes, pass <quote>*</quote> as the
57267 right-hand side value. Here is a more elaborate example of how to use this
57268 facility:
57269 </para>
57270 <literallayout class="monospaced">
57271 # Reject messages with serious MIME container errors
57272 deny  message = Found MIME error ($demime_reason).
57273       demime = *
57274       condition = ${if &gt;{$demime_errorlevel}{2}{1}{0}}
57275
57276 # Reject known virus spreading file extensions.
57277 # Accepting these is pretty much braindead.
57278 deny  message = contains $found_extension file (blacklisted).
57279       demime  = com:vbs:bat:pif:scr
57280
57281 # Freeze .exe and .doc files. Postmaster can
57282 # examine them and eventually thaw them.
57283 deny  log_message = Another $found_extension file.
57284       demime = exe:doc
57285       control = freeze
57286 </literallayout>
57287 <para>
57288 <indexterm role="concept" startref="IIDcosca" class="endofrange"/>
57289 </para>
57290 </section>
57291 </chapter>
57292
57293 <chapter id="CHAPlocalscan">
57294 <title>Adding a local scan function to Exim</title>
57295 <titleabbrev>Local scan function</titleabbrev>
57296 <para>
57297 <indexterm role="concept" id="IIDlosca" class="startofrange">
57298 <primary><function>local_scan()</function> function</primary>
57299 <secondary>description of</secondary>
57300 </indexterm>
57301 <indexterm role="concept">
57302 <primary>customizing</primary>
57303 <secondary>input scan using C function</secondary>
57304 </indexterm>
57305 <indexterm role="concept">
57306 <primary>policy control</primary>
57307 <secondary>by local scan function</secondary>
57308 </indexterm>
57309 In these days of email worms, viruses, and ever-increasing spam, some sites
57310 want to apply a lot of checking to messages before accepting them.
57311 </para>
57312 <para>
57313 The content scanning extension (chapter <xref linkend="CHAPexiscan"/>) has facilities for
57314 passing messages to external virus and spam scanning software. You can also do
57315 a certain amount in Exim itself through string expansions and the <option>condition</option>
57316 condition in the ACL that runs after the SMTP DATA command or the ACL for
57317 non-SMTP messages (see chapter <xref linkend="CHAPACL"/>), but this has its limitations.
57318 </para>
57319 <para>
57320 To allow for further customization to a site&#x2019;s own requirements, there is the
57321 possibility of linking Exim with a private message scanning function, written
57322 in C. If you want to run code that is written in something other than C, you
57323 can of course use a little C stub to call it.
57324 </para>
57325 <para>
57326 The local scan function is run once for every incoming message, at the point
57327 when Exim is just about to accept the message.
57328 It can therefore be used to control non-SMTP messages from local processes as
57329 well as messages arriving via SMTP.
57330 </para>
57331 <para>
57332 Exim applies a timeout to calls of the local scan function, and there is an
57333 option called <option>local_scan_timeout</option> for setting it. The default is 5 minutes.
57334 Zero means <quote>no timeout</quote>.
57335 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
57336 before calling the local scan function, so that the most common types of crash
57337 are caught. If the timeout is exceeded or one of those signals is caught, the
57338 incoming message is rejected with a temporary error if it is an SMTP message.
57339 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
57340 code. The incident is logged on the main and reject logs.
57341 </para>
57342 <section id="SECID207">
57343 <title>Building Exim to use a local scan function</title>
57344 <para>
57345 <indexterm role="concept">
57346 <primary><function>local_scan()</function> function</primary>
57347 <secondary>building Exim to use</secondary>
57348 </indexterm>
57349 To make use of the local scan function feature, you must tell Exim where your
57350 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
57351 <filename>Local/Makefile</filename>. A recommended place to put it is in the <filename>Local</filename>
57352 directory, so you might set
57353 </para>
57354 <literallayout class="monospaced">
57355 LOCAL_SCAN_SOURCE=Local/local_scan.c
57356 </literallayout>
57357 <para>
57358 for example. The function must be called <function>local_scan()</function>. It is called by
57359 Exim after it has received a message, when the success return code is about to
57360 be sent. This is after all the ACLs have been run. The return code from your
57361 function controls whether the message is actually accepted or not. There is a
57362 commented template function (that just accepts the message) in the file
57363 _src/local_scan.c_.
57364 </para>
57365 <para>
57366 If you want to make use of Exim&#x2019;s run time configuration file to set options
57367 for your <function>local_scan()</function> function, you must also set
57368 </para>
57369 <literallayout class="monospaced">
57370 LOCAL_SCAN_HAS_OPTIONS=yes
57371 </literallayout>
57372 <para>
57373 in <filename>Local/Makefile</filename> (see section <xref linkend="SECTconoptloc"/> below).
57374 </para>
57375 </section>
57376 <section id="SECTapiforloc">
57377 <title>API for local_scan()</title>
57378 <para>
57379 <indexterm role="concept">
57380 <primary><function>local_scan()</function> function</primary>
57381 <secondary>API description</secondary>
57382 </indexterm>
57383 You must include this line near the start of your code:
57384 </para>
57385 <literallayout class="monospaced">
57386 #include "local_scan.h"
57387 </literallayout>
57388 <para>
57389 This header file defines a number of variables and other values, and the
57390 prototype for the function itself. Exim is coded to use unsigned char values
57391 almost exclusively, and one of the things this header defines is a shorthand
57392 for <literal>unsigned char</literal> called <literal>uschar</literal>.
57393 It also contains the following macro definitions, to simplify casting character
57394 strings and pointers to character strings:
57395 </para>
57396 <literallayout class="monospaced">
57397 #define CS   (char *)
57398 #define CCS  (const char *)
57399 #define CSS  (char **)
57400 #define US   (unsigned char *)
57401 #define CUS  (const unsigned char *)
57402 #define USS  (unsigned char **)
57403 </literallayout>
57404 <para>
57405 The function prototype for <function>local_scan()</function> is:
57406 </para>
57407 <literallayout class="monospaced">
57408 extern int local_scan(int fd, uschar **return_text);
57409 </literallayout>
57410 <para>
57411 The arguments are as follows:
57412 </para>
57413 <itemizedlist>
57414 <listitem>
57415 <para>
57416 <option>fd</option> is a file descriptor for the file that contains the body of the message
57417 (the -D file). The file is open for reading and writing, but updating it is not
57418 recommended. <emphasis role="bold">Warning</emphasis>: You must <emphasis>not</emphasis> close this file descriptor.
57419 </para>
57420 <para>
57421 The descriptor is positioned at character 19 of the file, which is the first
57422 character of the body itself, because the first 19 characters are the message
57423 id followed by <literal>-D</literal> and a newline. If you rewind the file, you should use the
57424 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
57425 case this changes in some future version.
57426 </para>
57427 </listitem>
57428 <listitem>
57429 <para>
57430 <option>return_text</option> is an address which you can use to return a pointer to a text
57431 string at the end of the function. The value it points to on entry is NULL.
57432 </para>
57433 </listitem>
57434 </itemizedlist>
57435 <para>
57436 The function must return an <option>int</option> value which is one of the following macros:
57437 </para>
57438 <variablelist>
57439 <varlistentry>
57440 <term><literal>LOCAL_SCAN_ACCEPT</literal></term>
57441 <listitem>
57442 <para>
57443 <indexterm role="variable">
57444 <primary><varname>$local_scan_data</varname></primary>
57445 </indexterm>
57446 The message is accepted. If you pass back a string of text, it is saved with
57447 the message, and made available in the variable <varname>$local_scan_data</varname>. No
57448 newlines are permitted (if there are any, they are turned into spaces) and the
57449 maximum length of text is 1000 characters.
57450 </para>
57451 </listitem></varlistentry>
57452 <varlistentry>
57453 <term><literal>LOCAL_SCAN_ACCEPT_FREEZE</literal></term>
57454 <listitem>
57455 <para>
57456 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
57457 queued without immediate delivery, and is frozen.
57458 </para>
57459 </listitem></varlistentry>
57460 <varlistentry>
57461 <term><literal>LOCAL_SCAN_ACCEPT_QUEUE</literal></term>
57462 <listitem>
57463 <para>
57464 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
57465 queued without immediate delivery.
57466 </para>
57467 </listitem></varlistentry>
57468 <varlistentry>
57469 <term><literal>LOCAL_SCAN_REJECT</literal></term>
57470 <listitem>
57471 <para>
57472 The message is rejected; the returned text is used as an error message which is
57473 passed back to the sender and which is also logged. Newlines are permitted &ndash;
57474 they cause a multiline response for SMTP rejections, but are converted to
57475 <literal>\n</literal> in log lines. If no message is given, <quote>Administrative prohibition</quote> is
57476 used.
57477 </para>
57478 </listitem></varlistentry>
57479 <varlistentry>
57480 <term><literal>LOCAL_SCAN_TEMPREJECT</literal></term>
57481 <listitem>
57482 <para>
57483 The message is temporarily rejected; the returned text is used as an error
57484 message as for LOCAL_SCAN_REJECT. If no message is given, <quote>Temporary local
57485 problem</quote> is used.
57486 </para>
57487 </listitem></varlistentry>
57488 <varlistentry>
57489 <term><literal>LOCAL_SCAN_REJECT_NOLOGHDR</literal></term>
57490 <listitem>
57491 <para>
57492 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
57493 message is not written to the reject log. It has the effect of unsetting the
57494 <option>rejected_header</option> log selector for just this rejection. If
57495 <option>rejected_header</option> is already unset (see the discussion of the
57496 <option>log_selection</option> option in section <xref linkend="SECTlogselector"/>), this code is the
57497 same as LOCAL_SCAN_REJECT.
57498 </para>
57499 </listitem></varlistentry>
57500 <varlistentry>
57501 <term><literal>LOCAL_SCAN_TEMPREJECT_NOLOGHDR</literal></term>
57502 <listitem>
57503 <para>
57504 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
57505 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
57506 </para>
57507 </listitem></varlistentry>
57508 </variablelist>
57509 <para>
57510 If the message is not being received by interactive SMTP, rejections are
57511 reported by writing to <option>stderr</option> or by sending an email, as configured by the
57512 <option>-oe</option> command line options.
57513 </para>
57514 </section>
57515 <section id="SECTconoptloc">
57516 <title>Configuration options for local_scan()</title>
57517 <para>
57518 <indexterm role="concept">
57519 <primary><function>local_scan()</function> function</primary>
57520 <secondary>configuration options</secondary>
57521 </indexterm>
57522 It is possible to have option settings in the main configuration file
57523 that set values in static variables in the <function>local_scan()</function> module. If you
57524 want to do this, you must have the line
57525 </para>
57526 <literallayout class="monospaced">
57527 LOCAL_SCAN_HAS_OPTIONS=yes
57528 </literallayout>
57529 <para>
57530 in your <filename>Local/Makefile</filename> when you build Exim. (This line is in
57531 <filename>OS/Makefile-Default</filename>, commented out). Then, in the <function>local_scan()</function> source
57532 file, you must define static variables to hold the option values, and a table
57533 to define them.
57534 </para>
57535 <para>
57536 The table must be a vector called <option>local_scan_options</option>, of type
57537 <literal>optionlist</literal>. Each entry is a triplet, consisting of a name, an option type,
57538 and a pointer to the variable that holds the value. The entries must appear in
57539 alphabetical order. Following <option>local_scan_options</option> you must also define a
57540 variable called <option>local_scan_options_count</option> that contains the number of
57541 entries in the table. Here is a short example, showing two kinds of option:
57542 </para>
57543 <literallayout class="monospaced">
57544 static int my_integer_option = 42;
57545 static uschar *my_string_option = US"a default string";
57546
57547 optionlist local_scan_options[] = {
57548   { "my_integer", opt_int,       &amp;my_integer_option },
57549   { "my_string",  opt_stringptr, &amp;my_string_option }
57550 };
57551
57552 int local_scan_options_count =
57553   sizeof(local_scan_options)/sizeof(optionlist);
57554 </literallayout>
57555 <para>
57556 The values of the variables can now be changed from Exim&#x2019;s runtime
57557 configuration file by including a local scan section as in this example:
57558 </para>
57559 <literallayout class="monospaced">
57560 begin local_scan
57561 my_integer = 99
57562 my_string = some string of text...
57563 </literallayout>
57564 <para>
57565 The available types of option data are as follows:
57566 </para>
57567 <variablelist>
57568 <varlistentry>
57569 <term><emphasis role="bold">opt_bool</emphasis></term>
57570 <listitem>
57571 <para>
57572 This specifies a boolean (true/false) option. The address should point to a
57573 variable of type <literal>BOOL</literal>, which will be set to TRUE or FALSE, which are macros
57574 that are defined as <quote>1</quote> and <quote>0</quote>, respectively. If you want to detect
57575 whether such a variable has been set at all, you can initialize it to
57576 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
57577 values.)
57578 </para>
57579 </listitem></varlistentry>
57580 <varlistentry>
57581 <term><emphasis role="bold">opt_fixed</emphasis></term>
57582 <listitem>
57583 <para>
57584 This specifies a fixed point number, such as is used for load averages.
57585 The address should point to a variable of type <literal>int</literal>. The value is stored
57586 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
57587 </para>
57588 </listitem></varlistentry>
57589 <varlistentry>
57590 <term><emphasis role="bold">opt_int</emphasis></term>
57591 <listitem>
57592 <para>
57593 This specifies an integer; the address should point to a variable of type
57594 <literal>int</literal>. The value may be specified in any of the integer formats accepted by
57595 Exim.
57596 </para>
57597 </listitem></varlistentry>
57598 <varlistentry>
57599 <term><emphasis role="bold">opt_mkint</emphasis></term>
57600 <listitem>
57601 <para>
57602 This is the same as <option>opt_int</option>, except that when such a value is output in a
57603 <option>-bP</option> listing, if it is an exact number of kilobytes or megabytes, it is
57604 printed with the suffix K or M.
57605 </para>
57606 </listitem></varlistentry>
57607 <varlistentry>
57608 <term><emphasis role="bold">opt_octint</emphasis></term>
57609 <listitem>
57610 <para>
57611 This also specifies an integer, but the value is always interpreted as an
57612 octal integer, whether or not it starts with the digit zero, and it is
57613 always output in octal.
57614 </para>
57615 </listitem></varlistentry>
57616 <varlistentry>
57617 <term><emphasis role="bold">opt_stringptr</emphasis></term>
57618 <listitem>
57619 <para>
57620 This specifies a string value; the address must be a pointer to a
57621 variable that points to a string (for example, of type <literal>uschar *</literal>).
57622 </para>
57623 </listitem></varlistentry>
57624 <varlistentry>
57625 <term><emphasis role="bold">opt_time</emphasis></term>
57626 <listitem>
57627 <para>
57628 This specifies a time interval value. The address must point to a variable of
57629 type <literal>int</literal>. The value that is placed there is a number of seconds.
57630 </para>
57631 </listitem></varlistentry>
57632 </variablelist>
57633 <para>
57634 If the <option>-bP</option> command line option is followed by <literal>local_scan</literal>, Exim prints
57635 out the values of all the <function>local_scan()</function> options.
57636 </para>
57637 </section>
57638 <section id="SECID208">
57639 <title>Available Exim variables</title>
57640 <para>
57641 <indexterm role="concept">
57642 <primary><function>local_scan()</function> function</primary>
57643 <secondary>available Exim variables</secondary>
57644 </indexterm>
57645 The header <filename>local_scan.h</filename> gives you access to a number of C variables. These
57646 are the only ones that are guaranteed to be maintained from release to release.
57647 Note, however, that you can obtain the value of any Exim expansion variable,
57648 including <varname>$recipients</varname>, by calling <emphasis>expand_string()</emphasis>. The exported
57649 C variables are as follows:
57650 </para>
57651 <variablelist>
57652 <varlistentry>
57653 <term><emphasis role="bold">int&nbsp;body_linecount</emphasis></term>
57654 <listitem>
57655 <para>
57656 This variable contains the number of lines in the message&#x2019;s body.
57657 </para>
57658 </listitem></varlistentry>
57659 <varlistentry>
57660 <term><emphasis role="bold">int&nbsp;body_zerocount</emphasis></term>
57661 <listitem>
57662 <para>
57663 This variable contains the number of binary zero bytes in the message&#x2019;s body.
57664 </para>
57665 </listitem></varlistentry>
57666 <varlistentry>
57667 <term><emphasis role="bold">unsigned&nbsp;int&nbsp;debug_selector</emphasis></term>
57668 <listitem>
57669 <para>
57670 This variable is set to zero when no debugging is taking place. Otherwise, it
57671 is a bitmap of debugging selectors. Two bits are identified for use in
57672 <function>local_scan()</function>; they are defined as macros:
57673 </para>
57674 <itemizedlist>
57675 <listitem>
57676 <para>
57677 The <literal>D_v</literal> bit is set when <option>-v</option> was present on the command line. This is a
57678 testing option that is not privileged &ndash; any caller may set it. All the
57679 other selector bits can be set only by admin users.
57680 </para>
57681 </listitem>
57682 <listitem>
57683 <para>
57684 The <literal>D_local_scan</literal> bit is provided for use by <function>local_scan()</function>; it is set
57685 by the <literal>+local_scan</literal> debug selector. It is not included in the default set
57686 of debugging bits.
57687 </para>
57688 </listitem>
57689 </itemizedlist>
57690 <para>
57691 Thus, to write to the debugging output only when <literal>+local_scan</literal> has been
57692 selected, you should use code like this:
57693 </para>
57694 <literallayout class="monospaced">
57695 if ((debug_selector &amp; D_local_scan) != 0)
57696   debug_printf("xxx", ...);
57697 </literallayout>
57698 </listitem></varlistentry>
57699 <varlistentry>
57700 <term><emphasis role="bold">uschar&nbsp;*expand_string_message</emphasis></term>
57701 <listitem>
57702 <para>
57703 After a failing call to <emphasis>expand_string()</emphasis> (returned value NULL), the
57704 variable <option>expand_string_message</option> contains the error message, zero-terminated.
57705 </para>
57706 </listitem></varlistentry>
57707 <varlistentry>
57708 <term><emphasis role="bold">header_line&nbsp;*header_list</emphasis></term>
57709 <listitem>
57710 <para>
57711 A pointer to a chain of header lines. The <option>header_line</option> structure is
57712 discussed below.
57713 </para>
57714 </listitem></varlistentry>
57715 <varlistentry>
57716 <term><emphasis role="bold">header_line&nbsp;*header_last</emphasis></term>
57717 <listitem>
57718 <para>
57719 A pointer to the last of the header lines.
57720 </para>
57721 </listitem></varlistentry>
57722 <varlistentry>
57723 <term><emphasis role="bold">uschar&nbsp;*headers_charset</emphasis></term>
57724 <listitem>
57725 <para>
57726 The value of the <option>headers_charset</option> configuration option.
57727 </para>
57728 </listitem></varlistentry>
57729 <varlistentry>
57730 <term><emphasis role="bold">BOOL&nbsp;host_checking</emphasis></term>
57731 <listitem>
57732 <para>
57733 This variable is TRUE during a host checking session that is initiated by the
57734 <option>-bh</option> command line option.
57735 </para>
57736 </listitem></varlistentry>
57737 <varlistentry>
57738 <term><emphasis role="bold">uschar&nbsp;*interface_address</emphasis></term>
57739 <listitem>
57740 <para>
57741 The IP address of the interface that received the message, as a string. This
57742 is NULL for locally submitted messages.
57743 </para>
57744 </listitem></varlistentry>
57745 <varlistentry>
57746 <term><emphasis role="bold">int&nbsp;interface_port</emphasis></term>
57747 <listitem>
57748 <para>
57749 The port on which this message was received. When testing with the <option>-bh</option>
57750 command line option, the value of this variable is -1 unless a port has been
57751 specified via the <option>-oMi</option> option.
57752 </para>
57753 </listitem></varlistentry>
57754 <varlistentry>
57755 <term><emphasis role="bold">uschar&nbsp;*message_id</emphasis></term>
57756 <listitem>
57757 <para>
57758 This variable contains Exim&#x2019;s message id for the incoming message (the value of
57759 <varname>$message_exim_id</varname>) as a zero-terminated string.
57760 </para>
57761 </listitem></varlistentry>
57762 <varlistentry>
57763 <term><emphasis role="bold">uschar&nbsp;*received_protocol</emphasis></term>
57764 <listitem>
57765 <para>
57766 The name of the protocol by which the message was received.
57767 </para>
57768 </listitem></varlistentry>
57769 <varlistentry>
57770 <term><emphasis role="bold">int&nbsp;recipients_count</emphasis></term>
57771 <listitem>
57772 <para>
57773 The number of accepted recipients.
57774 </para>
57775 </listitem></varlistentry>
57776 <varlistentry>
57777 <term><emphasis role="bold">recipient_item&nbsp;*recipients_list</emphasis></term>
57778 <listitem>
57779 <para>
57780 <indexterm role="concept">
57781 <primary>recipient</primary>
57782 <secondary>adding in local scan</secondary>
57783 </indexterm>
57784 <indexterm role="concept">
57785 <primary>recipient</primary>
57786 <secondary>removing in local scan</secondary>
57787 </indexterm>
57788 The list of accepted recipients, held in a vector of length
57789 <option>recipients_count</option>. The <option>recipient_item</option> structure is discussed below. You
57790 can add additional recipients by calling <emphasis>receive_add_recipient()</emphasis> (see
57791 below). You can delete recipients by removing them from the vector and
57792 adjusting the value in <option>recipients_count</option>. In particular, by setting
57793 <option>recipients_count</option> to zero you remove all recipients. If you then return the
57794 value <literal>LOCAL_SCAN_ACCEPT</literal>, the message is accepted, but immediately
57795 blackholed. To replace the recipients, you can set <option>recipients_count</option> to zero
57796 and then call <emphasis>receive_add_recipient()</emphasis> as often as needed.
57797 </para>
57798 </listitem></varlistentry>
57799 <varlistentry>
57800 <term><emphasis role="bold">uschar&nbsp;*sender_address</emphasis></term>
57801 <listitem>
57802 <para>
57803 The envelope sender address. For bounce messages this is the empty string.
57804 </para>
57805 </listitem></varlistentry>
57806 <varlistentry>
57807 <term><emphasis role="bold">uschar&nbsp;*sender_host_address</emphasis></term>
57808 <listitem>
57809 <para>
57810 The IP address of the sending host, as a string. This is NULL for
57811 locally-submitted messages.
57812 </para>
57813 </listitem></varlistentry>
57814 <varlistentry>
57815 <term><emphasis role="bold">uschar&nbsp;*sender_host_authenticated</emphasis></term>
57816 <listitem>
57817 <para>
57818 The name of the authentication mechanism that was used, or NULL if the message
57819 was not received over an authenticated SMTP connection.
57820 </para>
57821 </listitem></varlistentry>
57822 <varlistentry>
57823 <term><emphasis role="bold">uschar&nbsp;*sender_host_name</emphasis></term>
57824 <listitem>
57825 <para>
57826 The name of the sending host, if known.
57827 </para>
57828 </listitem></varlistentry>
57829 <varlistentry>
57830 <term><emphasis role="bold">int&nbsp;sender_host_port</emphasis></term>
57831 <listitem>
57832 <para>
57833 The port on the sending host.
57834 </para>
57835 </listitem></varlistentry>
57836 <varlistentry>
57837 <term><emphasis role="bold">BOOL&nbsp;smtp_input</emphasis></term>
57838 <listitem>
57839 <para>
57840 This variable is TRUE for all SMTP input, including BSMTP.
57841 </para>
57842 </listitem></varlistentry>
57843 <varlistentry>
57844 <term><emphasis role="bold">BOOL&nbsp;smtp_batched_input</emphasis></term>
57845 <listitem>
57846 <para>
57847 This variable is TRUE for BSMTP input.
57848 </para>
57849 </listitem></varlistentry>
57850 <varlistentry>
57851 <term><emphasis role="bold">int&nbsp;store_pool</emphasis></term>
57852 <listitem>
57853 <para>
57854 The contents of this variable control which pool of memory is used for new
57855 requests. See section <xref linkend="SECTmemhanloc"/> for details.
57856 </para>
57857 </listitem></varlistentry>
57858 </variablelist>
57859 </section>
57860 <section id="SECID209">
57861 <title>Structure of header lines</title>
57862 <para>
57863 The <option>header_line</option> structure contains the members listed below.
57864 You can add additional header lines by calling the <emphasis>header_add()</emphasis> function
57865 (see below). You can cause header lines to be ignored (deleted) by setting
57866 their type to *.
57867 </para>
57868 <variablelist>
57869 <varlistentry>
57870 <term><emphasis role="bold">struct&nbsp;header_line&nbsp;*next</emphasis></term>
57871 <listitem>
57872 <para>
57873 A pointer to the next header line, or NULL for the last line.
57874 </para>
57875 </listitem></varlistentry>
57876 <varlistentry>
57877 <term><emphasis role="bold">int&nbsp;type</emphasis></term>
57878 <listitem>
57879 <para>
57880 A code identifying certain headers that Exim recognizes. The codes are printing
57881 characters, and are documented in chapter <xref linkend="CHAPspool"/> of this manual.
57882 Notice in particular that any header line whose type is * is not transmitted
57883 with the message. This flagging is used for header lines that have been
57884 rewritten, or are to be removed (for example, <emphasis>Envelope-sender:</emphasis> header
57885 lines.) Effectively, * means <quote>deleted</quote>.
57886 </para>
57887 </listitem></varlistentry>
57888 <varlistentry>
57889 <term><emphasis role="bold">int&nbsp;slen</emphasis></term>
57890 <listitem>
57891 <para>
57892 The number of characters in the header line, including the terminating and any
57893 internal newlines.
57894 </para>
57895 </listitem></varlistentry>
57896 <varlistentry>
57897 <term><emphasis role="bold">uschar&nbsp;*text</emphasis></term>
57898 <listitem>
57899 <para>
57900 A pointer to the text of the header. It always ends with a newline, followed by
57901 a zero byte. Internal newlines are preserved.
57902 </para>
57903 </listitem></varlistentry>
57904 </variablelist>
57905 </section>
57906 <section id="SECID210">
57907 <title>Structure of recipient items</title>
57908 <para>
57909 The <option>recipient_item</option> structure contains these members:
57910 </para>
57911 <variablelist>
57912 <varlistentry>
57913 <term><emphasis role="bold">uschar&nbsp;*address</emphasis></term>
57914 <listitem>
57915 <para>
57916 This is a pointer to the recipient address as it was received.
57917 </para>
57918 </listitem></varlistentry>
57919 <varlistentry>
57920 <term><emphasis role="bold">int&nbsp;pno</emphasis></term>
57921 <listitem>
57922 <para>
57923 This is used in later Exim processing when top level addresses are created by
57924 the <option>one_time</option> option. It is not relevant at the time <function>local_scan()</function> is run
57925 and must always contain -1 at this stage.
57926 </para>
57927 </listitem></varlistentry>
57928 <varlistentry>
57929 <term><emphasis role="bold">uschar&nbsp;*errors_to</emphasis></term>
57930 <listitem>
57931 <para>
57932 If this value is not NULL, bounce messages caused by failing to deliver to the
57933 recipient are sent to the address it contains. In other words, it overrides the
57934 envelope sender for this one recipient. (Compare the <option>errors_to</option> generic
57935 router option.) If a <function>local_scan()</function> function sets an <option>errors_to</option> field to
57936 an unqualified address, Exim qualifies it using the domain from
57937 <option>qualify_recipient</option>. When <function>local_scan()</function> is called, the <option>errors_to</option> field
57938 is NULL for all recipients.
57939 </para>
57940 </listitem></varlistentry>
57941 </variablelist>
57942 </section>
57943 <section id="SECID211">
57944 <title>Available Exim functions</title>
57945 <para>
57946 <indexterm role="concept">
57947 <primary><function>local_scan()</function> function</primary>
57948 <secondary>available Exim functions</secondary>
57949 </indexterm>
57950 The header <filename>local_scan.h</filename> gives you access to a number of Exim functions.
57951 These are the only ones that are guaranteed to be maintained from release to
57952 release:
57953 </para>
57954 <variablelist>
57955 <varlistentry>
57956 <term><emphasis role="bold">pid_t&nbsp;child_open(uschar&nbsp;**argv,&nbsp;uschar&nbsp;**envp,&nbsp;int&nbsp;newumask,&nbsp;int&nbsp;*infdptr,&nbsp;int&nbsp;*outfdptr, &nbsp;&nbsp;BOOL&nbsp;make_leader)</emphasis></term>
57957 <listitem>
57958 <para>
57959 This function creates a child process that runs the command specified by
57960 <option>argv</option>. The environment for the process is specified by <option>envp</option>, which can
57961 be NULL if no environment variables are to be passed. A new umask is supplied
57962 for the process in <option>newumask</option>.
57963 </para>
57964 <para>
57965 Pipes to the standard input and output of the new process are set up
57966 and returned to the caller via the <option>infdptr</option> and <option>outfdptr</option> arguments. The
57967 standard error is cloned to the standard output. If there are any file
57968 descriptors <quote>in the way</quote> in the new process, they are closed. If the final
57969 argument is TRUE, the new process is made into a process group leader.
57970 </para>
57971 <para>
57972 The function returns the pid of the new process, or -1 if things go wrong.
57973 </para>
57974 </listitem></varlistentry>
57975 <varlistentry>
57976 <term><emphasis role="bold">int&nbsp;child_close(pid_t&nbsp;pid,&nbsp;int&nbsp;timeout)</emphasis></term>
57977 <listitem>
57978 <para>
57979 This function waits for a child process to terminate, or for a timeout (in
57980 seconds) to expire. A timeout value of zero means wait as long as it takes. The
57981 return value is as follows:
57982 </para>
57983 <itemizedlist>
57984 <listitem>
57985 <para>
57986 &gt;= 0
57987 </para>
57988 <para>
57989 The process terminated by a normal exit and the value is the process
57990 ending status.
57991 </para>
57992 </listitem>
57993 <listitem>
57994 <para>
57995 &lt; 0 and &gt; &ndash;256
57996 </para>
57997 <para>
57998 The process was terminated by a signal and the value is the negation of the
57999 signal number.
58000 </para>
58001 </listitem>
58002 <listitem>
58003 <para>
58004 &ndash;256
58005 </para>
58006 <para>
58007 The process timed out.
58008 </para>
58009 </listitem>
58010 <listitem>
58011 <para>
58012 &ndash;257
58013 </para>
58014 <para>
58015 The was some other error in wait(); <option>errno</option> is still set.
58016 </para>
58017 </listitem>
58018 </itemizedlist>
58019 </listitem></varlistentry>
58020 <varlistentry>
58021 <term><emphasis role="bold">pid_t&nbsp;child_open_exim(int&nbsp;*fd)</emphasis></term>
58022 <listitem>
58023 <para>
58024 This function provide you with a means of submitting a new message to
58025 Exim. (Of course, you can also call <filename>/usr/sbin/sendmail</filename> yourself if you
58026 want, but this packages it all up for you.) The function creates a pipe,
58027 forks a subprocess that is running
58028 </para>
58029 <literallayout class="monospaced">
58030 exim -t -oem -oi -f &lt;&gt;
58031 </literallayout>
58032 <para>
58033 and returns to you (via the <literal>int *</literal> argument) a file descriptor for the pipe
58034 that is connected to the standard input. The yield of the function is the PID
58035 of the subprocess. You can then write a message to the file descriptor, with
58036 recipients in <emphasis>To:</emphasis>, <emphasis>Cc:</emphasis>, and/or <emphasis>Bcc:</emphasis> header lines.
58037 </para>
58038 <para>
58039 When you have finished, call <emphasis>child_close()</emphasis> to wait for the process to
58040 finish and to collect its ending status. A timeout value of zero is usually
58041 fine in this circumstance. Unless you have made a mistake with the recipient
58042 addresses, you should get a return code of zero.
58043 </para>
58044 </listitem></varlistentry>
58045 <varlistentry>
58046 <term><emphasis role="bold">pid_t&nbsp;child_open_exim2(int&nbsp;*fd,&nbsp;uschar&nbsp;*sender,&nbsp;uschar&nbsp;*sender_authentication)</emphasis></term>
58047 <listitem>
58048 <para>
58049 This function is a more sophisticated version of <emphasis>child_open()</emphasis>. The command
58050 that it runs is:
58051 </para>
58052 <literallayout>
58053 <literal>exim -t -oem -oi -f </literal><emphasis>sender</emphasis><literal> -oMas </literal><emphasis>sender_authentication</emphasis>
58054 </literallayout>
58055 <para>
58056 The third argument may be NULL, in which case the <option>-oMas</option> option is omitted.
58057 </para>
58058 </listitem></varlistentry>
58059 <varlistentry>
58060 <term><emphasis role="bold">void&nbsp;debug_printf(char&nbsp;*,&nbsp;...)</emphasis></term>
58061 <listitem>
58062 <para>
58063 This is Exim&#x2019;s debugging function, with arguments as for <emphasis>(printf()</emphasis>. The
58064 output is written to the standard error stream. If no debugging is selected,
58065 calls to <emphasis>debug_printf()</emphasis> have no effect. Normally, you should make calls
58066 conditional on the <literal>local_scan</literal> debug selector by coding like this:
58067 </para>
58068 <literallayout class="monospaced">
58069 if ((debug_selector &amp; D_local_scan) != 0)
58070   debug_printf("xxx", ...);
58071 </literallayout>
58072 </listitem></varlistentry>
58073 <varlistentry>
58074 <term><emphasis role="bold">uschar&nbsp;*expand_string(uschar&nbsp;*string)</emphasis></term>
58075 <listitem>
58076 <para>
58077 This is an interface to Exim&#x2019;s string expansion code. The return value is the
58078 expanded string, or NULL if there was an expansion failure.
58079 The C variable <option>expand_string_message</option> contains an error message after an
58080 expansion failure. If expansion does not change the string, the return value is
58081 the pointer to the input string. Otherwise, the return value points to a new
58082 block of memory that was obtained by a call to <emphasis>store_get()</emphasis>. See section
58083 <xref linkend="SECTmemhanloc"/> below for a discussion of memory handling.
58084 </para>
58085 </listitem></varlistentry>
58086 <varlistentry>
58087 <term><emphasis role="bold">void&nbsp;header_add(int&nbsp;type,&nbsp;char&nbsp;*format,&nbsp;...)</emphasis></term>
58088 <listitem>
58089 <para>
58090 This function allows you to an add additional header line at the end of the
58091 existing ones. The first argument is the type, and should normally be a space
58092 character. The second argument is a format string and any number of
58093 substitution arguments as for <function>sprintf()</function>. You may include internal newlines
58094 if you want, and you must ensure that the string ends with a newline.
58095 </para>
58096 </listitem></varlistentry>
58097 <varlistentry>
58098 <term><emphasis role="bold">void&nbsp;header_add_at_position(BOOL&nbsp;after,&nbsp;uschar&nbsp;*name,&nbsp;BOOL&nbsp;topnot,&nbsp;int&nbsp;type,&nbsp;char&nbsp;*format, &nbsp;&nbsp;...)</emphasis></term>
58099 <listitem>
58100 <para>
58101 This function adds a new header line at a specified point in the header
58102 chain. The header itself is specified as for <emphasis>header_add()</emphasis>.
58103 </para>
58104 <para>
58105 If <option>name</option> is NULL, the new header is added at the end of the chain if
58106 <option>after</option> is true, or at the start if <option>after</option> is false. If <option>name</option> is not
58107 NULL, the header lines are searched for the first non-deleted header that
58108 matches the name. If one is found, the new header is added before it if
58109 <option>after</option> is false. If <option>after</option> is true, the new header is added after the
58110 found header and any adjacent subsequent ones with the same name (even if
58111 marked <quote>deleted</quote>). If no matching non-deleted header is found, the <option>topnot</option>
58112 option controls where the header is added. If it is true, addition is at the
58113 top; otherwise at the bottom. Thus, to add a header after all the <emphasis>Received:</emphasis>
58114 headers, or at the top if there are no <emphasis>Received:</emphasis> headers, you could use
58115 </para>
58116 <literallayout class="monospaced">
58117 header_add_at_position(TRUE, US"Received", TRUE,
58118   ' ', "X-xxx: ...");
58119 </literallayout>
58120 <para>
58121 Normally, there is always at least one non-deleted <emphasis>Received:</emphasis> header, but
58122 there may not be if <option>received_header_text</option> expands to an empty string.
58123 </para>
58124 </listitem></varlistentry>
58125 <varlistentry>
58126 <term><emphasis role="bold">void&nbsp;header_remove(int&nbsp;occurrence,&nbsp;uschar&nbsp;*name)</emphasis></term>
58127 <listitem>
58128 <para>
58129 This function removes header lines. If <option>occurrence</option> is zero or negative, all
58130 occurrences of the header are removed. If occurrence is greater than zero, that
58131 particular instance of the header is removed. If no header(s) can be found that
58132 match the specification, the function does nothing.
58133 </para>
58134 </listitem></varlistentry>
58135 <varlistentry>
58136 <term><emphasis role="bold">BOOL&nbsp;header_testname(header_line&nbsp;*hdr,&nbsp;uschar&nbsp;*name,&nbsp;int&nbsp;length,&nbsp;BOOL&nbsp;notdel)</emphasis></term>
58137 <listitem>
58138 <para>
58139 This function tests whether the given header has the given name. It is not just
58140 a string comparison, because white space is permitted between the name and the
58141 colon. If the <option>notdel</option> argument is true, a false return is forced for all
58142 <quote>deleted</quote> headers; otherwise they are not treated specially. For example:
58143 </para>
58144 <literallayout class="monospaced">
58145 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
58146 </literallayout>
58147 </listitem></varlistentry>
58148 <varlistentry>
58149 <term><emphasis role="bold">uschar&nbsp;*lss_b64encode(uschar&nbsp;*cleartext,&nbsp;int&nbsp;length)</emphasis></term>
58150 <listitem>
58151 <para>
58152 <indexterm role="concept">
58153 <primary>base64 encoding</primary>
58154 <secondary>functions for <function>local_scan()</function> use</secondary>
58155 </indexterm>
58156 This function base64-encodes a string, which is passed by address and length.
58157 The text may contain bytes of any value, including zero. The result is passed
58158 back in dynamic memory that is obtained by calling <emphasis>store_get()</emphasis>. It is
58159 zero-terminated.
58160 </para>
58161 </listitem></varlistentry>
58162 <varlistentry>
58163 <term><emphasis role="bold">int&nbsp;lss_b64decode(uschar&nbsp;*codetext,&nbsp;uschar&nbsp;**cleartext)</emphasis></term>
58164 <listitem>
58165 <para>
58166 This function decodes a base64-encoded string. Its arguments are a
58167 zero-terminated base64-encoded string and the address of a variable that is set
58168 to point to the result, which is in dynamic memory. The length of the decoded
58169 string is the yield of the function. If the input is invalid base64 data, the
58170 yield is -1. A zero byte is added to the end of the output string to make it
58171 easy to interpret as a C string (assuming it contains no zeros of its own). The
58172 added zero byte is not included in the returned count.
58173 </para>
58174 </listitem></varlistentry>
58175 <varlistentry>
58176 <term><emphasis role="bold">int&nbsp;lss_match_domain(uschar&nbsp;*domain,&nbsp;uschar&nbsp;*list)</emphasis></term>
58177 <listitem>
58178 <para>
58179 This function checks for a match in a domain list. Domains are always
58180 matched caselessly. The return value is one of the following:
58181 </para>
58182 <literallayout>
58183 <literal>OK     </literal> match succeeded
58184 <literal>FAIL   </literal> match failed
58185 <literal>DEFER  </literal> match deferred
58186 </literallayout>
58187 <para>
58188 DEFER is usually caused by some kind of lookup defer, such as the
58189 inability to contact a database.
58190 </para>
58191 </listitem></varlistentry>
58192 <varlistentry>
58193 <term><emphasis role="bold">int&nbsp;lss_match_local_part(uschar&nbsp;*localpart,&nbsp;uschar&nbsp;*list,&nbsp;BOOL&nbsp;caseless)</emphasis></term>
58194 <listitem>
58195 <para>
58196 This function checks for a match in a local part list. The third argument
58197 controls case-sensitivity. The return values are as for
58198 <emphasis>lss_match_domain()</emphasis>.
58199 </para>
58200 </listitem></varlistentry>
58201 <varlistentry>
58202 <term><emphasis role="bold">int&nbsp;lss_match_address(uschar&nbsp;*address,&nbsp;uschar&nbsp;*list,&nbsp;BOOL&nbsp;caseless)</emphasis></term>
58203 <listitem>
58204 <para>
58205 This function checks for a match in an address list. The third argument
58206 controls the case-sensitivity of the local part match. The domain is always
58207 matched caselessly. The return values are as for <emphasis>lss_match_domain()</emphasis>.
58208 </para>
58209 </listitem></varlistentry>
58210 <varlistentry>
58211 <term><emphasis role="bold">int&nbsp;lss_match_host(uschar&nbsp;*host_name,&nbsp;uschar&nbsp;*host_address,&nbsp;uschar&nbsp;*list)</emphasis></term>
58212 <listitem>
58213 <para>
58214 This function checks for a match in a host list. The most common usage is
58215 expected to be
58216 </para>
58217 <literallayout class="monospaced">
58218 lss_match_host(sender_host_name, sender_host_address, ...)
58219 </literallayout>
58220 <para>
58221 <indexterm role="variable">
58222 <primary><varname>$sender_host_address</varname></primary>
58223 </indexterm>
58224 An empty address field matches an empty item in the host list. If the host name
58225 is NULL, the name corresponding to <varname>$sender_host_address</varname> is automatically
58226 looked up if a host name is required to match an item in the list. The return
58227 values are as for <emphasis>lss_match_domain()</emphasis>, but in addition, <emphasis>lss_match_host()</emphasis>
58228 returns ERROR in the case when it had to look up a host name, but the lookup
58229 failed.
58230 </para>
58231 </listitem></varlistentry>
58232 <varlistentry>
58233 <term><emphasis role="bold">void&nbsp;log_write(unsigned&nbsp;int&nbsp;selector,&nbsp;int&nbsp;which,&nbsp;char&nbsp;*format,&nbsp;...)</emphasis></term>
58234 <listitem>
58235 <para>
58236 This function writes to Exim&#x2019;s log files. The first argument should be zero (it
58237 is concerned with <option>log_selector</option>). The second argument can be <literal>LOG_MAIN</literal> or
58238 <literal>LOG_REJECT</literal> or <literal>LOG_PANIC</literal> or the inclusive <quote>or</quote> of any combination of
58239 them. It specifies to which log or logs the message is written. The remaining
58240 arguments are a format and relevant insertion arguments. The string should not
58241 contain any newlines, not even at the end.
58242 </para>
58243 </listitem></varlistentry>
58244 <varlistentry>
58245 <term><emphasis role="bold">void&nbsp;receive_add_recipient(uschar&nbsp;*address,&nbsp;int&nbsp;pno)</emphasis></term>
58246 <listitem>
58247 <para>
58248 This function adds an additional recipient to the message. The first argument
58249 is the recipient address. If it is unqualified (has no domain), it is qualified
58250 with the <option>qualify_recipient</option> domain. The second argument must always be -1.
58251 </para>
58252 <para>
58253 This function does not allow you to specify a private <option>errors_to</option> address (as
58254 described with the structure of <option>recipient_item</option> above), because it pre-dates
58255 the addition of that field to the structure. However, it is easy to add such a
58256 value afterwards. For example:
58257 </para>
58258 <literallayout class="monospaced">
58259  receive_add_recipient(US"monitor@mydom.example", -1);
58260  recipients_list[recipients_count-1].errors_to =
58261    US"postmaster@mydom.example";
58262 </literallayout>
58263 </listitem></varlistentry>
58264 <varlistentry>
58265 <term><emphasis role="bold">BOOL&nbsp;receive_remove_recipient(uschar&nbsp;*recipient)</emphasis></term>
58266 <listitem>
58267 <para>
58268 This is a convenience function to remove a named recipient from the list of
58269 recipients. It returns true if a recipient was removed, and false if no
58270 matching recipient could be found. The argument must be a complete email
58271 address.
58272 </para>
58273 </listitem></varlistentry>
58274 </variablelist>
58275 <para>
58276 <indexterm role="concept">
58277 <primary>RFC 2047</primary>
58278 </indexterm>
58279 </para>
58280 <variablelist>
58281 <varlistentry>
58282 <term><emphasis role="bold">uschar&nbsp;rfc2047_decode(uschar&nbsp;*string,&nbsp;BOOL&nbsp;lencheck,&nbsp;uschar&nbsp;*target,&nbsp;int&nbsp;zeroval,&nbsp;int&nbsp;*lenptr, &nbsp;&nbsp;uschar&nbsp;**error)</emphasis></term>
58283 <listitem>
58284 <para>
58285 This function decodes strings that are encoded according to RFC 2047. Typically
58286 these are the contents of header lines. First, each <quote>encoded word</quote> is decoded
58287 from the Q or B encoding into a byte-string. Then, if provided with the name of
58288 a charset encoding, and if the <function>iconv()</function> function is available, an attempt is
58289 made  to translate the result to the named character set. If this fails, the
58290 binary string is returned with an error message.
58291 </para>
58292 <para>
58293 The first argument is the string to be decoded. If <option>lencheck</option> is TRUE, the
58294 maximum MIME word length is enforced. The third argument is the target
58295 encoding, or NULL if no translation is wanted.
58296 </para>
58297 <para>
58298 <indexterm role="concept">
58299 <primary>binary zero</primary>
58300 <secondary>in RFC 2047 decoding</secondary>
58301 </indexterm>
58302 <indexterm role="concept">
58303 <primary>RFC 2047</primary>
58304 <secondary>binary zero in</secondary>
58305 </indexterm>
58306 If a binary zero is encountered in the decoded string, it is replaced by the
58307 contents of the <option>zeroval</option> argument. For use with Exim headers, the value must
58308 not be 0 because header lines are handled as zero-terminated strings.
58309 </para>
58310 <para>
58311 The function returns the result of processing the string, zero-terminated; if
58312 <option>lenptr</option> is not NULL, the length of the result is set in the variable to
58313 which it points. When <option>zeroval</option> is 0, <option>lenptr</option> should not be NULL.
58314 </para>
58315 <para>
58316 If an error is encountered, the function returns NULL and uses the <option>error</option>
58317 argument to return an error message. The variable pointed to by <option>error</option> is
58318 set to NULL if there is no error; it may be set non-NULL even when the function
58319 returns a non-NULL value if decoding was successful, but there was a problem
58320 with translation.
58321 </para>
58322 </listitem></varlistentry>
58323 <varlistentry>
58324 <term><emphasis role="bold">int&nbsp;smtp_fflush(void)</emphasis></term>
58325 <listitem>
58326 <para>
58327 This function is used in conjunction with <emphasis>smtp_printf()</emphasis>, as described
58328 below.
58329 </para>
58330 </listitem></varlistentry>
58331 <varlistentry>
58332 <term><emphasis role="bold">void&nbsp;smtp_printf(char&nbsp;*,&nbsp;...)</emphasis></term>
58333 <listitem>
58334 <para>
58335 The arguments of this function are like <function>printf()</function>; it writes to the SMTP
58336 output stream. You should use this function only when there is an SMTP output
58337 stream, that is, when the incoming message is being received via interactive
58338 SMTP. This is the case when <option>smtp_input</option> is TRUE and <option>smtp_batched_input</option>
58339 is FALSE. If you want to test for an incoming message from another host (as
58340 opposed to a local process that used the <option>-bs</option> command line option), you can
58341 test the value of <option>sender_host_address</option>, which is non-NULL when a remote host
58342 is involved.
58343 </para>
58344 <para>
58345 If an SMTP TLS connection is established, <emphasis>smtp_printf()</emphasis> uses the TLS
58346 output function, so it can be used for all forms of SMTP connection.
58347 </para>
58348 <para>
58349 Strings that are written by <emphasis>smtp_printf()</emphasis> from within <function>local_scan()</function>
58350 must start with an appropriate response code: 550 if you are going to return
58351 LOCAL_SCAN_REJECT, 451 if you are going to return
58352 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
58353 initial lines of a multi-line response, the code must be followed by a hyphen
58354 to indicate that the line is not the final response line. You must also ensure
58355 that the lines you write terminate with CRLF. For example:
58356 </para>
58357 <literallayout class="monospaced">
58358 smtp_printf("550-this is some extra info\r\n");
58359 return LOCAL_SCAN_REJECT;
58360 </literallayout>
58361 <para>
58362 Note that you can also create multi-line responses by including newlines in
58363 the data returned via the <option>return_text</option> argument. The added value of using
58364 <emphasis>smtp_printf()</emphasis> is that, for instance, you could introduce delays between
58365 multiple output lines.
58366 </para>
58367 <para>
58368 The <emphasis>smtp_printf()</emphasis> function does not return any error indication, because it
58369 does not automatically flush pending output, and therefore does not test
58370 the state of the stream. (In the main code of Exim, flushing and error
58371 detection is done when Exim is ready for the next SMTP input command.) If
58372 you want to flush the output and check for an error (for example, the
58373 dropping of a TCP/IP connection), you can call <emphasis>smtp_fflush()</emphasis>, which has no
58374 arguments. It flushes the output stream, and returns a non-zero value if there
58375 is an error.
58376 </para>
58377 </listitem></varlistentry>
58378 <varlistentry>
58379 <term><emphasis role="bold">void&nbsp;*store_get(int)</emphasis></term>
58380 <listitem>
58381 <para>
58382 This function accesses Exim&#x2019;s internal store (memory) manager. It gets a new
58383 chunk of memory whose size is given by the argument. Exim bombs out if it ever
58384 runs out of memory. See the next section for a discussion of memory handling.
58385 </para>
58386 </listitem></varlistentry>
58387 <varlistentry>
58388 <term><emphasis role="bold">void&nbsp;*store_get_perm(int)</emphasis></term>
58389 <listitem>
58390 <para>
58391 This function is like <emphasis>store_get()</emphasis>, but it always gets memory from the
58392 permanent pool. See the next section for a discussion of memory handling.
58393 </para>
58394 </listitem></varlistentry>
58395 <varlistentry>
58396 <term><emphasis role="bold">uschar&nbsp;*string_copy(uschar&nbsp;*string)</emphasis></term>
58397 <listitem>
58398 <para>
58399 See below.
58400 </para>
58401 </listitem></varlistentry>
58402 <varlistentry>
58403 <term><emphasis role="bold">uschar&nbsp;*string_copyn(uschar&nbsp;*string,&nbsp;int&nbsp;length)</emphasis></term>
58404 <listitem>
58405 <para>
58406 See below.
58407 </para>
58408 </listitem></varlistentry>
58409 <varlistentry>
58410 <term><emphasis role="bold">uschar&nbsp;*string_sprintf(char&nbsp;*format,&nbsp;...)</emphasis></term>
58411 <listitem>
58412 <para>
58413 These three functions create strings using Exim&#x2019;s dynamic memory facilities.
58414 The first makes a copy of an entire string. The second copies up to a maximum
58415 number of characters, indicated by the second argument. The third uses a format
58416 and insertion arguments to create a new string. In each case, the result is a
58417 pointer to a new string in the current memory pool. See the next section for
58418 more discussion.
58419 </para>
58420 </listitem></varlistentry>
58421 </variablelist>
58422 </section>
58423 <section id="SECTmemhanloc">
58424 <title>More about Exim&#x2019;s memory handling</title>
58425 <para>
58426 <indexterm role="concept">
58427 <primary><function>local_scan()</function> function</primary>
58428 <secondary>memory handling</secondary>
58429 </indexterm>
58430 No function is provided for freeing memory, because that is never needed.
58431 The dynamic memory that Exim uses when receiving a message is automatically
58432 recycled if another message is received by the same process (this applies only
58433 to incoming SMTP connections &ndash; other input methods can supply only one
58434 message at a time). After receiving the last message, a reception process
58435 terminates.
58436 </para>
58437 <para>
58438 Because it is recycled, the normal dynamic memory cannot be used for holding
58439 data that must be preserved over a number of incoming messages on the same SMTP
58440 connection. However, Exim in fact uses two pools of dynamic memory; the second
58441 one is not recycled, and can be used for this purpose.
58442 </para>
58443 <para>
58444 If you want to allocate memory that remains available for subsequent messages
58445 in the same SMTP connection, you should set
58446 </para>
58447 <literallayout class="monospaced">
58448 store_pool = POOL_PERM
58449 </literallayout>
58450 <para>
58451 before calling the function that does the allocation. There is no need to
58452 restore the value if you do not need to; however, if you do want to revert to
58453 the normal pool, you can either restore the previous value of <option>store_pool</option> or
58454 set it explicitly to POOL_MAIN.
58455 </para>
58456 <para>
58457 The pool setting applies to all functions that get dynamic memory, including
58458 <emphasis>expand_string()</emphasis>, <emphasis>store_get()</emphasis>, and the <emphasis>string_xxx()</emphasis> functions.
58459 There is also a convenience function called <emphasis>store_get_perm()</emphasis> that gets a
58460 block of memory from the permanent pool while preserving the value of
58461 <option>store_pool</option>.
58462 <indexterm role="concept" startref="IIDlosca" class="endofrange"/>
58463 </para>
58464 </section>
58465 </chapter>
58466
58467 <chapter id="CHAPsystemfilter">
58468 <title>System-wide message filtering</title>
58469 <para>
58470 <indexterm role="concept" id="IIDsysfil1" class="startofrange">
58471 <primary>filter</primary>
58472 <secondary>system filter</secondary>
58473 </indexterm>
58474 <indexterm role="concept" id="IIDsysfil2" class="startofrange">
58475 <primary>filtering all mail</primary>
58476 </indexterm>
58477 <indexterm role="concept" id="IIDsysfil3" class="startofrange">
58478 <primary>system filter</primary>
58479 </indexterm>
58480 The previous chapters (on ACLs and the local scan function) describe checks
58481 that can be applied to messages before they are accepted by a host. There is
58482 also a mechanism for checking messages once they have been received, but before
58483 they are delivered. This is called the <emphasis>system filter</emphasis>.
58484 </para>
58485 <para>
58486 The system filter operates in a similar manner to users&#x2019; filter files, but it
58487 is run just once per message (however many recipients the message has).
58488 It should not normally be used as a substitute for routing, because <option>deliver</option>
58489 commands in a system router provide new envelope recipient addresses.
58490 The system filter must be an Exim filter. It cannot be a Sieve filter.
58491 </para>
58492 <para>
58493 The system filter is run at the start of a delivery attempt, before any routing
58494 is done. If a message fails to be completely delivered at the first attempt,
58495 the system filter is run again at the start of every retry.
58496 If you want your filter to do something only once per message, you can make use
58497 of the <option>first_delivery</option> condition in an <option>if</option> command in the filter to
58498 prevent it happening on retries.
58499 </para>
58500 <para>
58501 <indexterm role="variable">
58502 <primary><varname>$domain</varname></primary>
58503 </indexterm>
58504 <indexterm role="variable">
58505 <primary><varname>$local_part</varname></primary>
58506 </indexterm>
58507 <emphasis role="bold">Warning</emphasis>: Because the system filter runs just once, variables that are
58508 specific to individual recipient addresses, such as <varname>$local_part</varname> and
58509 <varname>$domain</varname>, are not set, and the <quote>personal</quote> condition is not meaningful. If
58510 you want to run a centrally-specified filter for each recipient address
58511 independently, you can do so by setting up a suitable <command>redirect</command> router, as
58512 described in section <xref linkend="SECTperaddfil"/> below.
58513 </para>
58514 <section id="SECID212">
58515 <title>Specifying a system filter</title>
58516 <para>
58517 <indexterm role="concept">
58518 <primary>uid (user id)</primary>
58519 <secondary>system filter</secondary>
58520 </indexterm>
58521 <indexterm role="concept">
58522 <primary>gid (group id)</primary>
58523 <secondary>system filter</secondary>
58524 </indexterm>
58525 The name of the file that contains the system filter must be specified by
58526 setting <option>system_filter</option>. If you want the filter to run under a uid and gid
58527 other than root, you must also set <option>system_filter_user</option> and
58528 <option>system_filter_group</option> as appropriate. For example:
58529 </para>
58530 <literallayout class="monospaced">
58531 system_filter = /etc/mail/exim.filter
58532 system_filter_user = exim
58533 </literallayout>
58534 <para>
58535 If a system filter generates any deliveries directly to files or pipes (via the
58536 <option>save</option> or <option>pipe</option> commands), transports to handle these deliveries must be
58537 specified by setting <option>system_filter_file_transport</option> and
58538 <option>system_filter_pipe_transport</option>, respectively. Similarly,
58539 <option>system_filter_reply_transport</option> must be set to handle any messages generated
58540 by the <option>reply</option> command.
58541 </para>
58542 </section>
58543 <section id="SECID213">
58544 <title>Testing a system filter</title>
58545 <para>
58546 You can run simple tests of a system filter in the same way as for a user
58547 filter, but you should use <option>-bF</option> rather than <option>-bf</option>, so that features that
58548 are permitted only in system filters are recognized.
58549 </para>
58550 <para>
58551 If you want to test the combined effect of a system filter and a user filter,
58552 you can use both <option>-bF</option> and <option>-bf</option> on the same command line.
58553 </para>
58554 </section>
58555 <section id="SECID214">
58556 <title>Contents of a system filter</title>
58557 <para>
58558 The language used to specify system filters is the same as for users&#x2019; filter
58559 files. It is described in the separate end-user document <emphasis>Exim&#x2019;s interface to
58560 mail filtering</emphasis>. However, there are some additional features that are
58561 available only in system filters; these are described in subsequent sections.
58562 If they are encountered in a user&#x2019;s filter file or when testing with <option>-bf</option>,
58563 they cause errors.
58564 </para>
58565 <para>
58566 <indexterm role="concept">
58567 <primary>frozen messages</primary>
58568 <secondary>manual thaw; testing in filter</secondary>
58569 </indexterm>
58570 There are two special conditions which, though available in users&#x2019; filter
58571 files, are designed for use in system filters. The condition <option>first_delivery</option>
58572 is true only for the first attempt at delivering a message, and
58573 <option>manually_thawed</option> is true only if the message has been frozen, and
58574 subsequently thawed by an admin user. An explicit forced delivery counts as a
58575 manual thaw, but thawing as a result of the <option>auto_thaw</option> setting does not.
58576 </para>
58577 <para>
58578 <emphasis role="bold">Warning</emphasis>: If a system filter uses the <option>first_delivery</option> condition to
58579 specify an <quote>unseen</quote> (non-significant) delivery, and that delivery does not
58580 succeed, it will not be tried again.
58581 If you want Exim to retry an unseen delivery until it succeeds, you should
58582 arrange to set it up every time the filter runs.
58583 </para>
58584 <para>
58585 When a system filter finishes running, the values of the variables <varname>$n0</varname> &ndash;
58586 <varname>$n9</varname> are copied into <varname>$sn0</varname> &ndash; <varname>$sn9</varname> and are thereby made available to
58587 users&#x2019; filter files. Thus a system filter can, for example, set up <quote>scores</quote>
58588 to which users&#x2019; filter files can refer.
58589 </para>
58590 </section>
58591 <section id="SECID215">
58592 <title>Additional variable for system filters</title>
58593 <para>
58594 <indexterm role="variable">
58595 <primary><varname>$recipients</varname></primary>
58596 </indexterm>
58597 The expansion variable <varname>$recipients</varname>, containing a list of all the recipients
58598 of the message (separated by commas and white space), is available in system
58599 filters. It is not available in users&#x2019; filters for privacy reasons.
58600 </para>
58601 </section>
58602 <section id="SECID216">
58603 <title>Defer, freeze, and fail commands for system filters</title>
58604 <para>
58605 <indexterm role="concept">
58606 <primary>freezing messages</primary>
58607 </indexterm>
58608 <indexterm role="concept">
58609 <primary>message</primary>
58610 <secondary>freezing</secondary>
58611 </indexterm>
58612 <indexterm role="concept">
58613 <primary>message</primary>
58614 <secondary>forced failure</secondary>
58615 </indexterm>
58616 <indexterm role="concept">
58617 <primary><option>fail</option></primary>
58618 <secondary>in system filter</secondary>
58619 </indexterm>
58620 <indexterm role="concept">
58621 <primary><option>freeze</option> in system filter</primary>
58622 </indexterm>
58623 <indexterm role="concept">
58624 <primary><option>defer</option> in system filter</primary>
58625 </indexterm>
58626 There are three extra commands (<option>defer</option>, <option>freeze</option> and <option>fail</option>) which are
58627 always available in system filters, but are not normally enabled in users&#x2019;
58628 filters. (See the <option>allow_defer</option>, <option>allow_freeze</option> and <option>allow_fail</option> options
58629 for the <command>redirect</command> router.) These commands can optionally be followed by the
58630 word <option>text</option> and a string containing an error message, for example:
58631 </para>
58632 <literallayout class="monospaced">
58633 fail text "this message looks like spam to me"
58634 </literallayout>
58635 <para>
58636 The keyword <option>text</option> is optional if the next character is a double quote.
58637 </para>
58638 <para>
58639 The <option>defer</option> command defers delivery of the original recipients of the
58640 message. The <option>fail</option> command causes all the original recipients to be failed,
58641 and a bounce message to be created. The <option>freeze</option> command suspends all
58642 delivery attempts for the original recipients. In all cases, any new deliveries
58643 that are specified by the filter are attempted as normal after the filter has
58644 run.
58645 </para>
58646 <para>
58647 The <option>freeze</option> command is ignored if the message has been manually unfrozen and
58648 not manually frozen since. This means that automatic freezing by a system
58649 filter can be used as a way of checking out suspicious messages. If a message
58650 is found to be all right, manually unfreezing it allows it to be delivered.
58651 </para>
58652 <para>
58653 <indexterm role="concept">
58654 <primary>log</primary>
58655 <secondary><option>fail</option> command log line</secondary>
58656 </indexterm>
58657 <indexterm role="concept">
58658 <primary><option>fail</option></primary>
58659 <secondary>log line; reducing</secondary>
58660 </indexterm>
58661 The text given with a fail command is used as part of the bounce message as
58662 well as being written to the log. If the message is quite long, this can fill
58663 up a lot of log space when such failures are common. To reduce the size of the
58664 log message, Exim interprets the text in a special way if it starts with the
58665 two characters <literal>&lt;&lt;</literal> and contains <literal>&gt;&gt;</literal> later. The text between these two
58666 strings is written to the log, and the rest of the text is used in the bounce
58667 message. For example:
58668 </para>
58669 <literallayout class="monospaced">
58670 fail "&lt;&lt;filter test 1&gt;&gt;Your message is rejected \
58671      because it contains attachments that we are \
58672      not prepared to receive."
58673 </literallayout>
58674 <para>
58675 <indexterm role="concept">
58676 <primary>loop</primary>
58677 <secondary>caused by <option>fail</option></secondary>
58678 </indexterm>
58679 Take great care with the <option>fail</option> command when basing the decision to fail on
58680 the contents of the message, because the bounce message will of course include
58681 the contents of the original message and will therefore trigger the <option>fail</option>
58682 command again (causing a mail loop) unless steps are taken to prevent this.
58683 Testing the <option>error_message</option> condition is one way to prevent this. You could
58684 use, for example
58685 </para>
58686 <literallayout class="monospaced">
58687 if $message_body contains "this is spam" and not error_message
58688 then fail text "spam is not wanted here" endif
58689 </literallayout>
58690 <para>
58691 though of course that might let through unwanted bounce messages. The
58692 alternative is clever checking of the body and/or headers to detect bounces
58693 generated by the filter.
58694 </para>
58695 <para>
58696 The interpretation of a system filter file ceases after a
58697 <option>defer</option>,
58698 <option>freeze</option>, or <option>fail</option> command is obeyed. However, any deliveries that were
58699 set up earlier in the filter file are honoured, so you can use a sequence such
58700 as
58701 </para>
58702 <literallayout class="monospaced">
58703 mail ...
58704 freeze
58705 </literallayout>
58706 <para>
58707 to send a specified message when the system filter is freezing (or deferring or
58708 failing) a message. The normal deliveries for the message do not, of course,
58709 take place.
58710 </para>
58711 </section>
58712 <section id="SECTaddremheasys">
58713 <title>Adding and removing headers in a system filter</title>
58714 <para>
58715 <indexterm role="concept">
58716 <primary>header lines</primary>
58717 <secondary>adding; in system filter</secondary>
58718 </indexterm>
58719 <indexterm role="concept">
58720 <primary>header lines</primary>
58721 <secondary>removing; in system filter</secondary>
58722 </indexterm>
58723 <indexterm role="concept">
58724 <primary>filter</primary>
58725 <secondary>header lines; adding/removing</secondary>
58726 </indexterm>
58727 Two filter commands that are available only in system filters are:
58728 </para>
58729 <literallayout class="monospaced">
58730 headers add &lt;string&gt;
58731 headers remove &lt;string&gt;
58732 </literallayout>
58733 <para>
58734 The argument for the <option>headers add</option> is a string that is expanded and then
58735 added to the end of the message&#x2019;s headers. It is the responsibility of the
58736 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
58737 space is ignored, and if the string is otherwise empty, or if the expansion is
58738 forced to fail, the command has no effect.
58739 </para>
58740 <para>
58741 You can use <quote>\n</quote> within the string, followed by white space, to specify
58742 continued header lines. More than one header may be added in one command by
58743 including <quote>\n</quote> within the string without any following white space. For
58744 example:
58745 </para>
58746 <literallayout class="monospaced">
58747 headers add "X-header-1: ....\n  \
58748              continuation of X-header-1 ...\n\
58749              X-header-2: ...."
58750 </literallayout>
58751 <para>
58752 Note that the header line continuation white space after the first newline must
58753 be placed before the backslash that continues the input string, because white
58754 space after input continuations is ignored.
58755 </para>
58756 <para>
58757 The argument for <option>headers remove</option> is a colon-separated list of header names.
58758 This command applies only to those headers that are stored with the message;
58759 those that are added at delivery time (such as <emphasis>Envelope-To:</emphasis> and
58760 <emphasis>Return-Path:</emphasis>) cannot be removed by this means. If there is more than one
58761 header with the same name, they are all removed.
58762 </para>
58763 <para>
58764 The <option>headers</option> command in a system filter makes an immediate change to the set
58765 of header lines that was received with the message (with possible additions
58766 from ACL processing). Subsequent commands in the system filter operate on the
58767 modified set, which also forms the basis for subsequent message delivery.
58768 Unless further modified during routing or transporting, this set of headers is
58769 used for all recipients of the message.
58770 </para>
58771 <para>
58772 During routing and transporting, the variables that refer to the contents of
58773 header lines refer only to those lines that are in this set. Thus, header lines
58774 that are added by a system filter are visible to users&#x2019; filter files and to all
58775 routers and transports. This contrasts with the manipulation of header lines by
58776 routers and transports, which is not immediate, but which instead is saved up
58777 until the message is actually being written (see section
58778 <xref linkend="SECTheadersaddrem"/>).
58779 </para>
58780 <para>
58781 If the message is not delivered at the first attempt, header lines that were
58782 added by the system filter are stored with the message, and so are still
58783 present at the next delivery attempt. Header lines that were removed are still
58784 present, but marked <quote>deleted</quote> so that they are not transported with the
58785 message. For this reason, it is usual to make the <option>headers</option> command
58786 conditional on <option>first_delivery</option> so that the set of header lines is not
58787 modified more than once.
58788 </para>
58789 <para>
58790 Because header modification in a system filter acts immediately, you have to
58791 use an indirect approach if you want to modify the contents of a header line.
58792 For example:
58793 </para>
58794 <literallayout class="monospaced">
58795 headers add "Old-Subject: $h_subject:"
58796 headers remove "Subject"
58797 headers add "Subject: new subject (was: $h_old-subject:)"
58798 headers remove "Old-Subject"
58799 </literallayout>
58800 </section>
58801 <section id="SECID217">
58802 <title>Setting an errors address in a system filter</title>
58803 <para>
58804 <indexterm role="concept">
58805 <primary>envelope sender</primary>
58806 </indexterm>
58807 In a system filter, if a <option>deliver</option> command is followed by
58808 </para>
58809 <literallayout class="monospaced">
58810 errors_to &lt;some address&gt;
58811 </literallayout>
58812 <para>
58813 in order to change the envelope sender (and hence the error reporting) for that
58814 delivery, any address may be specified. (In a user filter, only the current
58815 user&#x2019;s address can be set.) For example, if some mail is being monitored, you
58816 might use
58817 </para>
58818 <literallayout class="monospaced">
58819 unseen deliver monitor@spying.example errors_to root@local.example
58820 </literallayout>
58821 <para>
58822 to take a copy which would not be sent back to the normal error reporting
58823 address if its delivery failed.
58824 </para>
58825 </section>
58826 <section id="SECTperaddfil">
58827 <title>Per-address filtering</title>
58828 <para>
58829 <indexterm role="variable">
58830 <primary><varname>$domain</varname></primary>
58831 </indexterm>
58832 <indexterm role="variable">
58833 <primary><varname>$local_part</varname></primary>
58834 </indexterm>
58835 In contrast to the system filter, which is run just once per message for each
58836 delivery attempt, it is also possible to set up a system-wide filtering
58837 operation that runs once for each recipient address. In this case, variables
58838 such as <varname>$local_part</varname> and <varname>$domain</varname> can be used, and indeed, the choice of
58839 filter file could be made dependent on them. This is an example of a router
58840 which implements such a filter:
58841 </para>
58842 <literallayout class="monospaced">
58843 central_filter:
58844   check_local_user
58845   driver = redirect
58846   domains = +local_domains
58847   file = /central/filters/$local_part
58848   no_verify
58849   allow_filter
58850   allow_freeze
58851 </literallayout>
58852 <para>
58853 The filter is run in a separate process under its own uid. Therefore, either
58854 <option>check_local_user</option> must be set (as above), in which case the filter is run as
58855 the local user, or the <option>user</option> option must be used to specify which user to
58856 use. If both are set, <option>user</option> overrides.
58857 </para>
58858 <para>
58859 Care should be taken to ensure that none of the commands in the filter file
58860 specify a significant delivery if the message is to go on to be delivered to
58861 its intended recipient. The router will not then claim to have dealt with the
58862 address, so it will be passed on to subsequent routers to be delivered in the
58863 normal way.
58864 <indexterm role="concept" startref="IIDsysfil1" class="endofrange"/>
58865 <indexterm role="concept" startref="IIDsysfil2" class="endofrange"/>
58866 <indexterm role="concept" startref="IIDsysfil3" class="endofrange"/>
58867 </para>
58868 </section>
58869 </chapter>
58870
58871 <chapter id="CHAPmsgproc">
58872 <title>Message processing</title>
58873 <para>
58874 <indexterm role="concept" id="IIDmesproc" class="startofrange">
58875 <primary>message</primary>
58876 <secondary>general processing</secondary>
58877 </indexterm>
58878 Exim performs various transformations on the sender and recipient addresses of
58879 all messages that it handles, and also on the messages&#x2019; header lines. Some of
58880 these are optional and configurable, while others always take place. All of
58881 this processing, except rewriting as a result of routing, and the addition or
58882 removal of header lines while delivering, happens when a message is received,
58883 before it is placed on Exim&#x2019;s queue.
58884 </para>
58885 <para>
58886 Some of the automatic processing takes place by default only for
58887 <quote>locally-originated</quote> messages. This adjective is used to describe messages
58888 that are not received over TCP/IP, but instead are passed to an Exim process on
58889 its standard input. This includes the interactive <quote>local SMTP</quote> case that is
58890 set up by the <option>-bs</option> command line option.
58891 </para>
58892 <para>
58893 <emphasis role="bold">Note</emphasis>: Messages received over TCP/IP on the loopback interface (127.0.0.1
58894 or ::1) are not considered to be locally-originated. Exim does not treat the
58895 loopback interface specially in any way.
58896 </para>
58897 <para>
58898 If you want the loopback interface to be treated specially, you must ensure
58899 that there are appropriate entries in your ACLs.
58900 </para>
58901 <section id="SECTsubmodnon">
58902 <title>Submission mode for non-local messages</title>
58903 <para>
58904 <indexterm role="concept">
58905 <primary>message</primary>
58906 <secondary>submission</secondary>
58907 </indexterm>
58908 <indexterm role="concept">
58909 <primary>submission mode</primary>
58910 </indexterm>
58911 Processing that happens automatically for locally-originated messages (unless
58912 <option>suppress_local_fixups</option> is set) can also be requested for messages that are
58913 received over TCP/IP. The term <quote>submission mode</quote> is used to describe this
58914 state. Submission mode is set by the modifier
58915 </para>
58916 <literallayout class="monospaced">
58917 control = submission
58918 </literallayout>
58919 <para>
58920 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
58921 <xref linkend="SECTACLmodi"/> and <xref linkend="SECTcontrols"/>). This makes Exim treat the message as
58922 a local submission, and is normally used when the source of the message is
58923 known to be an MUA running on a client host (as opposed to an MTA). For
58924 example, to set submission mode for messages originating on the IPv4 loopback
58925 interface, you could include the following in the MAIL ACL:
58926 </para>
58927 <literallayout class="monospaced">
58928 warn  hosts = 127.0.0.1
58929       control = submission
58930 </literallayout>
58931 <para>
58932 <indexterm role="concept">
58933 <primary><option>sender_retain</option> submission option</primary>
58934 </indexterm>
58935 There are some options that can be used when setting submission mode. A slash
58936 is used to separate options. For example:
58937 </para>
58938 <literallayout class="monospaced">
58939 control = submission/sender_retain
58940 </literallayout>
58941 <para>
58942 Specifying <option>sender_retain</option> has the effect of setting <option>local_sender_retain</option>
58943 true and <option>local_from_check</option> false for the current incoming message. The first
58944 of these allows an existing <emphasis>Sender:</emphasis> header in the message to remain, and
58945 the second suppresses the check to ensure that <emphasis>From:</emphasis> matches the
58946 authenticated sender. With this setting, Exim still fixes up messages by adding
58947 <emphasis>Date:</emphasis> and <emphasis>Message-ID:</emphasis> header lines if they are missing, but makes no
58948 attempt to check sender authenticity in header lines.
58949 </para>
58950 <para>
58951 When <option>sender_retain</option> is not set, a submission mode setting may specify a
58952 domain to be used when generating a <emphasis>From:</emphasis> or <emphasis>Sender:</emphasis> header line. For
58953 example:
58954 </para>
58955 <literallayout class="monospaced">
58956 control = submission/domain=some.domain
58957 </literallayout>
58958 <para>
58959 The domain may be empty. How this value is used is described in sections
58960 <xref linkend="SECTthefrohea"/> and <xref linkend="SECTthesenhea"/>. There is also a <option>name</option> option
58961 that allows you to specify the user&#x2019;s full name for inclusion in a created
58962 <emphasis>Sender:</emphasis> or <emphasis>From:</emphasis> header line. For example:
58963 </para>
58964 <literallayout class="monospaced">
58965 accept authenticated = *
58966        control = submission/domain=wonderland.example/\
58967                             name=${lookup {$authenticated_id} \
58968                                    lsearch {/etc/exim/namelist}}
58969 </literallayout>
58970 <para>
58971 Because the name may contain any characters, including slashes, the <option>name</option>
58972 option must be given last. The remainder of the string is used as the name. For
58973 the example above, if <filename>/etc/exim/namelist</filename> contains:
58974 </para>
58975 <literallayout class="monospaced">
58976 bigegg:  Humpty Dumpty
58977 </literallayout>
58978 <para>
58979 then when the sender has authenticated as <emphasis>bigegg</emphasis>, the generated <emphasis>Sender:</emphasis>
58980 line would be:
58981 </para>
58982 <literallayout class="monospaced">
58983 Sender: Humpty Dumpty &lt;bigegg@wonderland.example&gt;
58984 </literallayout>
58985 <para>
58986 <indexterm role="concept">
58987 <primary>return path</primary>
58988 <secondary>in submission mode</secondary>
58989 </indexterm>
58990 By default, submission mode forces the return path to the same address as is
58991 used to create the <emphasis>Sender:</emphasis> header. However, if <option>sender_retain</option> is
58992 specified, the return path is also left unchanged.
58993 </para>
58994 <para>
58995 <emphasis role="bold">Note</emphasis>: The changes caused by submission mode take effect after the predata
58996 ACL. This means that any sender checks performed before the fix-ups use the
58997 untrusted sender address specified by the user, not the trusted sender address
58998 specified by submission mode. Although this might be slightly unexpected, it
58999 does mean that you can configure ACL checks to spot that a user is trying to
59000 spoof another&#x2019;s address.
59001 </para>
59002 </section>
59003 <section id="SECTlineendings">
59004 <title>Line endings</title>
59005 <para>
59006 <indexterm role="concept">
59007 <primary>line endings</primary>
59008 </indexterm>
59009 <indexterm role="concept">
59010 <primary>carriage return</primary>
59011 </indexterm>
59012 <indexterm role="concept">
59013 <primary>linefeed</primary>
59014 </indexterm>
59015 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
59016 linefeed) is the line ending for messages transmitted over the Internet using
59017 SMTP over TCP/IP. However, within individual operating systems, different
59018 conventions are used. For example, Unix-like systems use just LF, but others
59019 use CRLF or just CR.
59020 </para>
59021 <para>
59022 Exim was designed for Unix-like systems, and internally, it stores messages
59023 using the system&#x2019;s convention of a single LF as a line terminator. When
59024 receiving a message, all line endings are translated to this standard format.
59025 Originally, it was thought that programs that passed messages directly to an
59026 MTA within an operating system would use that system&#x2019;s convention. Experience
59027 has shown that this is not the case; for example, there are Unix applications
59028 that use CRLF in this circumstance. For this reason, and for compatibility with
59029 other MTAs, the way Exim handles line endings for all messages is now as
59030 follows:
59031 </para>
59032 <itemizedlist>
59033 <listitem>
59034 <para>
59035 LF not preceded by CR is treated as a line ending.
59036 </para>
59037 </listitem>
59038 <listitem>
59039 <para>
59040 CR is treated as a line ending; if it is immediately followed by LF, the LF
59041 is ignored.
59042 </para>
59043 </listitem>
59044 <listitem>
59045 <para>
59046 The sequence <quote>CR, dot, CR</quote> does not terminate an incoming SMTP message,
59047 nor a local message in the state where a line containing only a dot is a
59048 terminator.
59049 </para>
59050 </listitem>
59051 <listitem>
59052 <para>
59053 If a bare CR is encountered within a header line, an extra space is added after
59054 the line terminator so as not to end the header line. The reasoning behind this
59055 is that bare CRs in header lines are most likely either to be mistakes, or
59056 people trying to play silly games.
59057 </para>
59058 </listitem>
59059 <listitem>
59060 <para>
59061 If the first header line received in a message ends with CRLF, a subsequent
59062 bare LF in a header line is treated in the same way as a bare CR in a header
59063 line.
59064 </para>
59065 </listitem>
59066 </itemizedlist>
59067 </section>
59068 <section id="SECID218">
59069 <title>Unqualified addresses</title>
59070 <para>
59071 <indexterm role="concept">
59072 <primary>unqualified addresses</primary>
59073 </indexterm>
59074 <indexterm role="concept">
59075 <primary>address</primary>
59076 <secondary>qualification</secondary>
59077 </indexterm>
59078 By default, Exim expects every envelope address it receives from an external
59079 host to be fully qualified. Unqualified addresses cause negative responses to
59080 SMTP commands. However, because SMTP is used as a means of transporting
59081 messages from MUAs running on personal workstations, there is sometimes a
59082 requirement to accept unqualified addresses from specific hosts or IP networks.
59083 </para>
59084 <para>
59085 Exim has two options that separately control which hosts may send unqualified
59086 sender or recipient addresses in SMTP commands, namely
59087 <option>sender_unqualified_hosts</option> and <option>recipient_unqualified_hosts</option>. In both
59088 cases, if an unqualified address is accepted, it is qualified by adding the
59089 value of <option>qualify_domain</option> or <option>qualify_recipient</option>, as appropriate.
59090 </para>
59091 <para>
59092 <indexterm role="option">
59093 <primary><option>qualify_domain</option></primary>
59094 </indexterm>
59095 <indexterm role="option">
59096 <primary><option>qualify_recipient</option></primary>
59097 </indexterm>
59098 Unqualified addresses in header lines are automatically qualified for messages
59099 that are locally originated, unless the <option>-bnq</option> option is given on the command
59100 line. For messages received over SMTP, unqualified addresses in header lines
59101 are qualified only if unqualified addresses are permitted in SMTP commands. In
59102 other words, such qualification is also controlled by
59103 <option>sender_unqualified_hosts</option> and <option>recipient_unqualified_hosts</option>,
59104 </para>
59105 </section>
59106 <section id="SECID219">
59107 <title>The UUCP From line</title>
59108 <para>
59109 <indexterm role="concept">
59110 <primary><quote>From</quote> line</primary>
59111 </indexterm>
59112 <indexterm role="concept">
59113 <primary>UUCP</primary>
59114 <secondary><quote>From</quote> line</secondary>
59115 </indexterm>
59116 <indexterm role="concept">
59117 <primary>sender</primary>
59118 <secondary>address</secondary>
59119 </indexterm>
59120 <indexterm role="option">
59121 <primary><option>uucp_from_pattern</option></primary>
59122 </indexterm>
59123 <indexterm role="option">
59124 <primary><option>uucp_from_sender</option></primary>
59125 </indexterm>
59126 <indexterm role="concept">
59127 <primary>envelope sender</primary>
59128 </indexterm>
59129 <indexterm role="concept">
59130 <primary>Sendmail compatibility</primary>
59131 <secondary><quote>From</quote> line</secondary>
59132 </indexterm>
59133 Messages that have come from UUCP (and some other applications) often begin
59134 with a line containing the envelope sender and a timestamp, following the word
59135 <quote>From</quote>. Examples of two common formats are:
59136 </para>
59137 <literallayout class="monospaced">
59138 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
59139 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
59140 </literallayout>
59141 <para>
59142 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
59143 Exim recognizes such lines at the start of messages that are submitted to it
59144 via the command line (that is, on the standard input). It does not recognize
59145 such lines in incoming SMTP messages, unless the sending host matches
59146 <option>ignore_fromline_hosts</option> or the <option>-bs</option> option was used for a local message
59147 and <option>ignore_fromline_local</option> is set. The recognition is controlled by a
59148 regular expression that is defined by the <option>uucp_from_pattern</option> option, whose
59149 default value matches the two common cases shown above and puts the address
59150 that follows <quote>From</quote> into <varname>$1</varname>.
59151 </para>
59152 <para>
59153 <indexterm role="concept">
59154 <primary>numerical variables (<varname>$1</varname> <varname>$2</varname> etc)</primary>
59155 <secondary>in <quote>From </quote> line handling</secondary>
59156 </indexterm>
59157 When the caller of Exim for a non-SMTP message that contains a <quote>From</quote> line is
59158 a trusted user, the message&#x2019;s sender address is constructed by expanding the
59159 contents of <option>uucp_sender_address</option>, whose default value is <quote>$1</quote>. This is
59160 then parsed as an RFC 2822 address. If there is no domain, the local part is
59161 qualified with <option>qualify_domain</option> unless it is the empty string. However, if
59162 the command line <option>-f</option> option is used, it overrides the <quote>From</quote> line.
59163 </para>
59164 <para>
59165 If the caller of Exim is not trusted, the <quote>From</quote> line is recognized, but the
59166 sender address is not changed. This is also the case for incoming SMTP messages
59167 that are permitted to contain <quote>From</quote> lines.
59168 </para>
59169 <para>
59170 Only one <quote>From</quote> line is recognized. If there is more than one, the second is
59171 treated as a data line that starts the body of the message, as it is not valid
59172 as a header line. This also happens if a <quote>From</quote> line is present in an
59173 incoming SMTP message from a source that is not permitted to send them.
59174 </para>
59175 </section>
59176 <section id="SECID220">
59177 <title>Resent- header lines</title>
59178 <para>
59179 <indexterm role="concept">
59180 <primary><option>Resent-</option> header lines</primary>
59181 </indexterm>
59182 RFC 2822 makes provision for sets of header lines starting with the string
59183 <literal>Resent-</literal> to be added to a message when it is resent by the original
59184 recipient to somebody else. These headers are <emphasis>Resent-Date:</emphasis>,
59185 <emphasis>Resent-From:</emphasis>, <emphasis>Resent-Sender:</emphasis>, <emphasis>Resent-To:</emphasis>, <emphasis>Resent-Cc:</emphasis>,
59186 <emphasis>Resent-Bcc:</emphasis> and <emphasis>Resent-Message-ID:</emphasis>. The RFC says:
59187 </para>
59188 <blockquote>
59189 <para>
59190 <emphasis>Resent fields are strictly informational. They MUST NOT be used in the normal
59191 processing of replies or other such automatic actions on messages.</emphasis>
59192 </para>
59193 </blockquote>
59194 <para>
59195 This leaves things a bit vague as far as other processing actions such as
59196 address rewriting are concerned. Exim treats <option>Resent-</option> header lines as
59197 follows:
59198 </para>
59199 <itemizedlist>
59200 <listitem>
59201 <para>
59202 A <emphasis>Resent-From:</emphasis> line that just contains the login id of the submitting user
59203 is automatically rewritten in the same way as <emphasis>From:</emphasis> (see below).
59204 </para>
59205 </listitem>
59206 <listitem>
59207 <para>
59208 If there&#x2019;s a rewriting rule for a particular header line, it is also applied to
59209 <option>Resent-</option> header lines of the same type. For example, a rule that rewrites
59210 <emphasis>From:</emphasis> also rewrites <emphasis>Resent-From:</emphasis>.
59211 </para>
59212 </listitem>
59213 <listitem>
59214 <para>
59215 For local messages, if <emphasis>Sender:</emphasis> is removed on input, <emphasis>Resent-Sender:</emphasis> is
59216 also removed.
59217 </para>
59218 </listitem>
59219 <listitem>
59220 <para>
59221 For a locally-submitted message,
59222 if there are any <option>Resent-</option> header lines but no <emphasis>Resent-Date:</emphasis>,
59223 <emphasis>Resent-From:</emphasis>, or <emphasis>Resent-Message-Id:</emphasis>, they are added as necessary. It is
59224 the contents of <emphasis>Resent-Message-Id:</emphasis> (rather than <emphasis>Message-Id:</emphasis>) which are
59225 included in log lines in this case.
59226 </para>
59227 </listitem>
59228 <listitem>
59229 <para>
59230 The logic for adding <emphasis>Sender:</emphasis> is duplicated for <emphasis>Resent-Sender:</emphasis> when any
59231 <option>Resent-</option> header lines are present.
59232 </para>
59233 </listitem>
59234 </itemizedlist>
59235 </section>
59236 <section id="SECID221">
59237 <title>The Auto-Submitted: header line</title>
59238 <para>
59239 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
59240 includes the header line:
59241 </para>
59242 <literallayout class="monospaced">
59243 Auto-Submitted: auto-replied
59244 </literallayout>
59245 </section>
59246 <section id="SECID222">
59247 <title>The Bcc: header line</title>
59248 <para>
59249 <indexterm role="concept">
59250 <primary><emphasis>Bcc:</emphasis> header line</primary>
59251 </indexterm>
59252 If Exim is called with the <option>-t</option> option, to take recipient addresses from a
59253 message&#x2019;s header, it removes any <emphasis>Bcc:</emphasis> header line that may exist (after
59254 extracting its addresses). If <option>-t</option> is not present on the command line, any
59255 existing <emphasis>Bcc:</emphasis> is not removed.
59256 </para>
59257 </section>
59258 <section id="SECID223">
59259 <title>The Date: header line</title>
59260 <para>
59261 <indexterm role="concept">
59262 <primary><emphasis>Date:</emphasis> header line</primary>
59263 </indexterm>
59264 If a locally-generated or submission-mode message has no <emphasis>Date:</emphasis> header line,
59265 Exim adds one, using the current date and time, unless the
59266 <option>suppress_local_fixups</option> control has been specified.
59267 </para>
59268 </section>
59269 <section id="SECID224">
59270 <title>The Delivery-date: header line</title>
59271 <para>
59272 <indexterm role="concept">
59273 <primary><emphasis>Delivery-date:</emphasis> header line</primary>
59274 </indexterm>
59275 <indexterm role="option">
59276 <primary><option>delivery_date_remove</option></primary>
59277 </indexterm>
59278 <emphasis>Delivery-date:</emphasis> header lines are not part of the standard RFC 2822 header
59279 set. Exim can be configured to add them to the final delivery of messages. (See
59280 the generic <option>delivery_date_add</option> transport option.) They should not be present
59281 in messages in transit. If the <option>delivery_date_remove</option> configuration option is
59282 set (the default), Exim removes <emphasis>Delivery-date:</emphasis> header lines from incoming
59283 messages.
59284 </para>
59285 </section>
59286 <section id="SECID225">
59287 <title>The Envelope-to: header line</title>
59288 <para>
59289 <indexterm role="concept">
59290 <primary><emphasis>Envelope-to:</emphasis> header line</primary>
59291 </indexterm>
59292 <indexterm role="option">
59293 <primary><option>envelope_to_remove</option></primary>
59294 </indexterm>
59295 <emphasis>Envelope-to:</emphasis> header lines are not part of the standard RFC 2822 header set.
59296 Exim can be configured to add them to the final delivery of messages. (See the
59297 generic <option>envelope_to_add</option> transport option.) They should not be present in
59298 messages in transit. If the <option>envelope_to_remove</option> configuration option is set
59299 (the default), Exim removes <emphasis>Envelope-to:</emphasis> header lines from incoming
59300 messages.
59301 </para>
59302 </section>
59303 <section id="SECTthefrohea">
59304 <title>The From: header line</title>
59305 <para>
59306 <indexterm role="concept">
59307 <primary><emphasis>From:</emphasis> header line</primary>
59308 </indexterm>
59309 <indexterm role="concept">
59310 <primary>Sendmail compatibility</primary>
59311 <secondary><quote>From</quote> line</secondary>
59312 </indexterm>
59313 <indexterm role="concept">
59314 <primary>message</primary>
59315 <secondary>submission</secondary>
59316 </indexterm>
59317 <indexterm role="concept">
59318 <primary>submission mode</primary>
59319 </indexterm>
59320 If a submission-mode message does not contain a <emphasis>From:</emphasis> header line, Exim
59321 adds one if either of the following conditions is true:
59322 </para>
59323 <itemizedlist>
59324 <listitem>
59325 <para>
59326 The envelope sender address is not empty (that is, this is not a bounce
59327 message). The added header line copies the envelope sender address.
59328 </para>
59329 </listitem>
59330 <listitem>
59331 <para>
59332 <indexterm role="variable">
59333 <primary><varname>$authenticated_id</varname></primary>
59334 </indexterm>
59335 The SMTP session is authenticated and <varname>$authenticated_id</varname> is not empty.
59336 </para>
59337 <orderedlist numeration="arabic">
59338 <listitem>
59339 <para>
59340 <indexterm role="variable">
59341 <primary><varname>$qualify_domain</varname></primary>
59342 </indexterm>
59343 If no domain is specified by the submission control, the local part is
59344 <varname>$authenticated_id</varname> and the domain is <varname>$qualify_domain</varname>.
59345 </para>
59346 </listitem>
59347 <listitem>
59348 <para>
59349 If a non-empty domain is specified by the submission control, the local
59350 part is <varname>$authenticated_id</varname>, and the domain is the specified domain.
59351 </para>
59352 </listitem>
59353 <listitem>
59354 <para>
59355 If an empty domain is specified by the submission control,
59356 <varname>$authenticated_id</varname> is assumed to be the complete address.
59357 </para>
59358 </listitem>
59359 </orderedlist>
59360 </listitem>
59361 </itemizedlist>
59362 <para>
59363 A non-empty envelope sender takes precedence.
59364 </para>
59365 <para>
59366 If a locally-generated incoming message does not contain a <emphasis>From:</emphasis> header
59367 line, and the <option>suppress_local_fixups</option> control is not set, Exim adds one
59368 containing the sender&#x2019;s address. The calling user&#x2019;s login name and full name
59369 are used to construct the address, as described in section <xref linkend="SECTconstr"/>.
59370 They are obtained from the password data by calling <function>getpwuid()</function> (but see the
59371 <option>unknown_login</option> configuration option). The address is qualified with
59372 <option>qualify_domain</option>.
59373 </para>
59374 <para>
59375 For compatibility with Sendmail, if an incoming, non-SMTP message has a
59376 <emphasis>From:</emphasis> header line containing just the unqualified login name of the calling
59377 user, this is replaced by an address containing the user&#x2019;s login name and full
59378 name as described in section <xref linkend="SECTconstr"/>.
59379 </para>
59380 </section>
59381 <section id="SECID226">
59382 <title>The Message-ID: header line</title>
59383 <para>
59384 <indexterm role="concept">
59385 <primary><emphasis>Message-ID:</emphasis> header line</primary>
59386 </indexterm>
59387 <indexterm role="concept">
59388 <primary>message</primary>
59389 <secondary>submission</secondary>
59390 </indexterm>
59391 <indexterm role="option">
59392 <primary><option>message_id_header_text</option></primary>
59393 </indexterm>
59394 If a locally-generated or submission-mode incoming message does not contain a
59395 <emphasis>Message-ID:</emphasis> or <emphasis>Resent-Message-ID:</emphasis> header line, and the
59396 <option>suppress_local_fixups</option> control is not set, Exim adds a suitable header line
59397 to the message. If there are any <emphasis>Resent-:</emphasis> headers in the message, it
59398 creates <emphasis>Resent-Message-ID:</emphasis>. The id is constructed from Exim&#x2019;s internal
59399 message id, preceded by the letter E to ensure it starts with a letter, and
59400 followed by @ and the primary host name. Additional information can be included
59401 in this header line by setting the <option>message_id_header_text</option> and/or
59402 <option>message_id_header_domain</option> options.
59403 </para>
59404 </section>
59405 <section id="SECID227">
59406 <title>The Received: header line</title>
59407 <para>
59408 <indexterm role="concept">
59409 <primary><emphasis>Received:</emphasis> header line</primary>
59410 </indexterm>
59411 A <emphasis>Received:</emphasis> header line is added at the start of every message. The
59412 contents are defined by the <option>received_header_text</option> configuration option, and
59413 Exim automatically adds a semicolon and a timestamp to the configured string.
59414 </para>
59415 <para>
59416 The <emphasis>Received:</emphasis> header is generated as soon as the message&#x2019;s header lines
59417 have been received. At this stage, the timestamp in the <emphasis>Received:</emphasis> header
59418 line is the time that the message started to be received. This is the value
59419 that is seen by the DATA ACL and by the <function>local_scan()</function> function.
59420 </para>
59421 <para>
59422 Once a message is accepted, the timestamp in the <emphasis>Received:</emphasis> header line is
59423 changed to the time of acceptance, which is (apart from a small delay while the
59424 -H spool file is written) the earliest time at which delivery could start.
59425 </para>
59426 </section>
59427 <section id="SECID228">
59428 <title>The References: header line</title>
59429 <para>
59430 <indexterm role="concept">
59431 <primary><emphasis>References:</emphasis> header line</primary>
59432 </indexterm>
59433 Messages created by the <command>autoreply</command> transport include a <emphasis>References:</emphasis>
59434 header line. This is constructed according to the rules that are described in
59435 section 3.64 of RFC 2822 (which states that replies should contain such a
59436 header line), and section 3.14 of RFC 3834 (which states that automatic
59437 responses are not different in this respect). However, because some mail
59438 processing software does not cope well with very long header lines, no more
59439 than 12 message IDs are copied from the <emphasis>References:</emphasis> header line in the
59440 incoming message. If there are more than 12, the first one and then the final
59441 11 are copied, before adding the message ID of the incoming message.
59442 </para>
59443 </section>
59444 <section id="SECID229">
59445 <title>The Return-path: header line</title>
59446 <para>
59447 <indexterm role="concept">
59448 <primary><emphasis>Return-path:</emphasis> header line</primary>
59449 </indexterm>
59450 <indexterm role="option">
59451 <primary><option>return_path_remove</option></primary>
59452 </indexterm>
59453 <emphasis>Return-path:</emphasis> header lines are defined as something an MTA may insert when
59454 it does the final delivery of messages. (See the generic <option>return_path_add</option>
59455 transport option.) Therefore, they should not be present in messages in
59456 transit. If the <option>return_path_remove</option> configuration option is set (the
59457 default), Exim removes <emphasis>Return-path:</emphasis> header lines from incoming messages.
59458 </para>
59459 </section>
59460 <section id="SECTthesenhea">
59461 <title>The Sender: header line</title>
59462 <para>
59463 <indexterm role="concept">
59464 <primary><emphasis>Sender:</emphasis> header line</primary>
59465 </indexterm>
59466 <indexterm role="concept">
59467 <primary>message</primary>
59468 <secondary>submission</secondary>
59469 </indexterm>
59470 For a locally-originated message from an untrusted user, Exim may remove an
59471 existing <emphasis>Sender:</emphasis> header line, and it may add a new one. You can modify
59472 these actions by setting the <option>local_sender_retain</option> option true, the
59473 <option>local_from_check</option> option false, or by using the <option>suppress_local_fixups</option>
59474 control setting.
59475 </para>
59476 <para>
59477 When a local message is received from an untrusted user and
59478 <option>local_from_check</option> is true (the default), and the <option>suppress_local_fixups</option>
59479 control has not been set, a check is made to see if the address given in the
59480 <emphasis>From:</emphasis> header line is the correct (local) sender of the message. The address
59481 that is expected has the login name as the local part and the value of
59482 <option>qualify_domain</option> as the domain. Prefixes and suffixes for the local part can
59483 be permitted by setting <option>local_from_prefix</option> and <option>local_from_suffix</option>
59484 appropriately. If <emphasis>From:</emphasis> does not contain the correct sender, a <emphasis>Sender:</emphasis>
59485 line is added to the message.
59486 </para>
59487 <para>
59488 If you set <option>local_from_check</option> false, this checking does not occur. However,
59489 the removal of an existing <emphasis>Sender:</emphasis> line still happens, unless you also set
59490 <option>local_sender_retain</option> to be true. It is not possible to set both of these
59491 options true at the same time.
59492 </para>
59493 <para>
59494 <indexterm role="concept">
59495 <primary>submission mode</primary>
59496 </indexterm>
59497 By default, no processing of <emphasis>Sender:</emphasis> header lines is done for messages
59498 received over TCP/IP or for messages submitted by trusted users. However, when
59499 a message is received over TCP/IP in submission mode, and <option>sender_retain</option> is
59500 not specified on the submission control, the following processing takes place:
59501 </para>
59502 <para>
59503 <indexterm role="variable">
59504 <primary><varname>$authenticated_id</varname></primary>
59505 </indexterm>
59506 First, any existing <emphasis>Sender:</emphasis> lines are removed. Then, if the SMTP session is
59507 authenticated, and <varname>$authenticated_id</varname> is not empty, a sender address is
59508 created as follows:
59509 </para>
59510 <itemizedlist>
59511 <listitem>
59512 <para>
59513 <indexterm role="variable">
59514 <primary><varname>$qualify_domain</varname></primary>
59515 </indexterm>
59516 If no domain is specified by the submission control, the local part is
59517 <varname>$authenticated_id</varname> and the domain is <varname>$qualify_domain</varname>.
59518 </para>
59519 </listitem>
59520 <listitem>
59521 <para>
59522 If a non-empty domain is specified by the submission control, the local part
59523 is <varname>$authenticated_id</varname>, and the domain is the specified domain.
59524 </para>
59525 </listitem>
59526 <listitem>
59527 <para>
59528 If an empty domain is specified by the submission control,
59529 <varname>$authenticated_id</varname> is assumed to be the complete address.
59530 </para>
59531 </listitem>
59532 </itemizedlist>
59533 <para>
59534 This address is compared with the address in the <emphasis>From:</emphasis> header line. If they
59535 are different, a <emphasis>Sender:</emphasis> header line containing the created address is
59536 added. Prefixes and suffixes for the local part in <emphasis>From:</emphasis> can be permitted
59537 by setting <option>local_from_prefix</option> and <option>local_from_suffix</option> appropriately.
59538 </para>
59539 <para>
59540 <indexterm role="concept">
59541 <primary>return path</primary>
59542 <secondary>created from <emphasis>Sender:</emphasis></secondary>
59543 </indexterm>
59544 <emphasis role="bold">Note</emphasis>: Whenever a <emphasis>Sender:</emphasis> header line is created, the return path for
59545 the message (the envelope sender address) is changed to be the same address,
59546 except in the case of submission mode when <option>sender_retain</option> is specified.
59547 </para>
59548 </section>
59549 <section id="SECTheadersaddrem">
59550 <title>Adding and removing header lines in routers and transports</title>
59551 <para>
59552 <indexterm role="concept">
59553 <primary>header lines</primary>
59554 <secondary>adding; in router or transport</secondary>
59555 </indexterm>
59556 <indexterm role="concept">
59557 <primary>header lines</primary>
59558 <secondary>removing; in router or transport</secondary>
59559 </indexterm>
59560 When a message is delivered, the addition and removal of header lines can be
59561 specified in a system filter, or on any of the routers and transports that
59562 process the message. Section <xref linkend="SECTaddremheasys"/> contains details about
59563 modifying headers in a system filter. Header lines can also be added in an ACL
59564 as a message is received (see section <xref linkend="SECTaddheadacl"/>).
59565 </para>
59566 <para>
59567 In contrast to what happens in a system filter, header modifications that are
59568 specified on routers and transports apply only to the particular recipient
59569 addresses that are being processed by those routers and transports. These
59570 changes do not actually take place until a copy of the message is being
59571 transported. Therefore, they do not affect the basic set of header lines, and
59572 they do not affect the values of the variables that refer to header lines.
59573 </para>
59574 <para>
59575 <emphasis role="bold">Note</emphasis>: In particular, this means that any expansions in the configuration of
59576 the transport cannot refer to the modified header lines, because such
59577 expansions all occur before the message is actually transported.
59578 </para>
59579 <para>
59580 For both routers and transports, the argument of a <option>headers_add</option>
59581 option must be in the form of one or more RFC 2822 header lines, separated by
59582 newlines (coded as <quote>\n</quote>). For example:
59583 </para>
59584 <literallayout class="monospaced">
59585 headers_add = X-added-header: added by $primary_hostname\n\
59586               X-added-second: another added header line
59587 </literallayout>
59588 <para>
59589 Exim does not check the syntax of these added header lines.
59590 </para>
59591 <para>
59592 Multiple <option>headers_add</option> options for a single router or transport can be
59593 specified; the values will append to a single list of header lines.
59594 Each header-line is separately expanded.
59595 </para>
59596 <para>
59597 The argument of a <option>headers_remove</option> option must consist of a colon-separated
59598 list of header names. This is confusing, because header names themselves are
59599 often terminated by colons. In this case, the colons are the list separators,
59600 not part of the names. For example:
59601 </para>
59602 <literallayout class="monospaced">
59603 headers_remove = return-receipt-to:acknowledge-to
59604 </literallayout>
59605 <para>
59606 Multiple <option>headers_remove</option> options for a single router or transport can be
59607 specified; the arguments will append to a single header-names list.
59608 Each item is separately expanded.
59609 </para>
59610 <para>
59611 When <option>headers_add</option> or <option>headers_remove</option> is specified on a router,
59612 items are expanded at routing time,
59613 and then associated with all addresses that are
59614 accepted by that router, and also with any new addresses that it generates. If
59615 an address passes through several routers as a result of aliasing or
59616 forwarding, the changes are cumulative.
59617 </para>
59618 <para>
59619 <indexterm role="option">
59620 <primary><option>unseen</option></primary>
59621 </indexterm>
59622 However, this does not apply to multiple routers that result from the use of
59623 the <option>unseen</option> option. Any header modifications that were specified by the
59624 <quote>unseen</quote> router or its predecessors apply only to the <quote>unseen</quote> delivery.
59625 </para>
59626 <para>
59627 Addresses that end up with different <option>headers_add</option> or <option>headers_remove</option>
59628 settings cannot be delivered together in a batch, so a transport is always
59629 dealing with a set of addresses that have the same header-processing
59630 requirements.
59631 </para>
59632 <para>
59633 The transport starts by writing the original set of header lines that arrived
59634 with the message, possibly modified by the system filter. As it writes out
59635 these lines, it consults the list of header names that were attached to the
59636 recipient address(es) by <option>headers_remove</option> options in routers, and it also
59637 consults the transport&#x2019;s own <option>headers_remove</option> option. Header lines whose
59638 names are on either of these lists are not written out. If there are multiple
59639 instances of any listed header, they are all skipped.
59640 </para>
59641 <para>
59642 After the remaining original header lines have been written, new header
59643 lines that were specified by routers&#x2019; <option>headers_add</option> options are written, in
59644 the order in which they were attached to the address. These are followed by any
59645 header lines specified by the transport&#x2019;s <option>headers_add</option> option.
59646 </para>
59647 <para>
59648 This way of handling header line modifications in routers and transports has
59649 the following consequences:
59650 </para>
59651 <itemizedlist>
59652 <listitem>
59653 <para>
59654 The original set of header lines, possibly modified by the system filter,
59655 remains <quote>visible</quote>, in the sense that the <varname>$header_</varname><emphasis>xxx</emphasis> variables refer
59656 to it, at all times.
59657 </para>
59658 </listitem>
59659 <listitem>
59660 <para>
59661 Header lines that are added by a router&#x2019;s
59662 <option>headers_add</option> option are not accessible by means of the <varname>$header_</varname><emphasis>xxx</emphasis>
59663 expansion syntax in subsequent routers or the transport.
59664 </para>
59665 </listitem>
59666 <listitem>
59667 <para>
59668 Conversely, header lines that are specified for removal by <option>headers_remove</option>
59669 in a router remain visible to subsequent routers and the transport.
59670 </para>
59671 </listitem>
59672 <listitem>
59673 <para>
59674 Headers added to an address by <option>headers_add</option> in a router cannot be removed by
59675 a later router or by a transport.
59676 </para>
59677 </listitem>
59678 <listitem>
59679 <para>
59680 An added header can refer to the contents of an original header that is to be
59681 removed, even it has the same name as the added header. For example:
59682 </para>
59683 <literallayout class="monospaced">
59684 headers_remove = subject
59685 headers_add = Subject: new subject (was: $h_subject:)
59686 </literallayout>
59687 </listitem>
59688 </itemizedlist>
59689 <para>
59690 <emphasis role="bold">Warning</emphasis>: The <option>headers_add</option> and <option>headers_remove</option> options cannot be used
59691 for a <command>redirect</command> router that has the <option>one_time</option> option set.
59692 </para>
59693 </section>
59694 <section id="SECTconstr">
59695 <title>Constructed addresses</title>
59696 <para>
59697 <indexterm role="concept">
59698 <primary>address</primary>
59699 <secondary>constructed</secondary>
59700 </indexterm>
59701 <indexterm role="concept">
59702 <primary>constructed address</primary>
59703 </indexterm>
59704 When Exim constructs a sender address for a locally-generated message, it uses
59705 the form
59706 </para>
59707 <literallayout>
59708 &lt;<emphasis>user name</emphasis>&gt;&nbsp;&nbsp;&lt;<emphasis>login</emphasis><literal>@</literal><emphasis>qualify_domain</emphasis>&gt;
59709 </literallayout>
59710 <para>
59711 For example:
59712 </para>
59713 <literallayout class="monospaced">
59714 Zaphod Beeblebrox &lt;zaphod@end.univ.example&gt;
59715 </literallayout>
59716 <para>
59717 The user name is obtained from the <option>-F</option> command line option if set, or
59718 otherwise by looking up the calling user by <function>getpwuid()</function> and extracting the
59719 <quote>gecos</quote> field from the password entry. If the <quote>gecos</quote> field contains an
59720 ampersand character, this is replaced by the login name with the first letter
59721 upper cased, as is conventional in a number of operating systems. See the
59722 <option>gecos_name</option> option for a way to tailor the handling of the <quote>gecos</quote> field.
59723 The <option>unknown_username</option> option can be used to specify user names in cases when
59724 there is no password file entry.
59725 </para>
59726 <para>
59727 <indexterm role="concept">
59728 <primary>RFC 2047</primary>
59729 </indexterm>
59730 In all cases, the user name is made to conform to RFC 2822 by quoting all or
59731 parts of it if necessary. In addition, if it contains any non-printing
59732 characters, it is encoded as described in RFC 2047, which defines a way of
59733 including non-ASCII characters in header lines. The value of the
59734 <option>headers_charset</option> option specifies the name of the encoding that is used (the
59735 characters are assumed to be in this encoding). The setting of
59736 <option>print_topbitchars</option> controls whether characters with the top bit set (that
59737 is, with codes greater than 127) count as printing characters or not.
59738 </para>
59739 </section>
59740 <section id="SECID230">
59741 <title>Case of local parts</title>
59742 <para>
59743 <indexterm role="concept">
59744 <primary>case of local parts</primary>
59745 </indexterm>
59746 <indexterm role="concept">
59747 <primary>local part</primary>
59748 <secondary>case of</secondary>
59749 </indexterm>
59750 RFC 2822 states that the case of letters in the local parts of addresses cannot
59751 be assumed to be non-significant. Exim preserves the case of local parts of
59752 addresses, but by default it uses a lower-cased form when it is routing,
59753 because on most Unix systems, usernames are in lower case and case-insensitive
59754 routing is required. However, any particular router can be made to use the
59755 original case for local parts by setting the <option>caseful_local_part</option> generic
59756 router option.
59757 </para>
59758 <para>
59759 <indexterm role="concept">
59760 <primary>mixed-case login names</primary>
59761 </indexterm>
59762 If you must have mixed-case user names on your system, the best way to proceed,
59763 assuming you want case-independent handling of incoming email, is to set up
59764 your first router to convert incoming local parts in your domains to the
59765 correct case by means of a file lookup. For example:
59766 </para>
59767 <literallayout class="monospaced">
59768 correct_case:
59769   driver = redirect
59770   domains = +local_domains
59771   data = ${lookup{$local_part}cdb\
59772               {/etc/usercased.cdb}{$value}fail}\
59773               @$domain
59774 </literallayout>
59775 <para>
59776 For this router, the local part is forced to lower case by the default action
59777 (<option>caseful_local_part</option> is not set). The lower-cased local part is used to look
59778 up a new local part in the correct case. If you then set <option>caseful_local_part</option>
59779 on any subsequent routers which process your domains, they will operate on
59780 local parts with the correct case in a case-sensitive manner.
59781 </para>
59782 </section>
59783 <section id="SECID231">
59784 <title>Dots in local parts</title>
59785 <para>
59786 <indexterm role="concept">
59787 <primary>dot</primary>
59788 <secondary>in local part</secondary>
59789 </indexterm>
59790 <indexterm role="concept">
59791 <primary>local part</primary>
59792 <secondary>dots in</secondary>
59793 </indexterm>
59794 RFC 2822 forbids empty components in local parts. That is, an unquoted local
59795 part may not begin or end with a dot, nor have two consecutive dots in the
59796 middle. However, it seems that many MTAs do not enforce this, so Exim permits
59797 empty components for compatibility.
59798 </para>
59799 </section>
59800 <section id="SECID232">
59801 <title>Rewriting addresses</title>
59802 <para>
59803 <indexterm role="concept">
59804 <primary>rewriting</primary>
59805 <secondary>addresses</secondary>
59806 </indexterm>
59807 Rewriting of sender and recipient addresses, and addresses in headers, can
59808 happen automatically, or as the result of configuration options, as described
59809 in chapter <xref linkend="CHAPrewrite"/>. The headers that may be affected by this are
59810 <emphasis>Bcc:</emphasis>, <emphasis>Cc:</emphasis>, <emphasis>From:</emphasis>, <emphasis>Reply-To:</emphasis>, <emphasis>Sender:</emphasis>, and <emphasis>To:</emphasis>.
59811 </para>
59812 <para>
59813 Automatic rewriting includes qualification, as mentioned above. The other case
59814 in which it can happen is when an incomplete non-local domain is given. The
59815 routing process may cause this to be expanded into the full domain name. For
59816 example, a header such as
59817 </para>
59818 <literallayout class="monospaced">
59819 To: hare@teaparty
59820 </literallayout>
59821 <para>
59822 might get rewritten as
59823 </para>
59824 <literallayout class="monospaced">
59825 To: hare@teaparty.wonderland.fict.example
59826 </literallayout>
59827 <para>
59828 Rewriting as a result of routing is the one kind of message processing that
59829 does not happen at input time, as it cannot be done until the address has
59830 been routed.
59831 </para>
59832 <para>
59833 Strictly, one should not do <emphasis>any</emphasis> deliveries of a message until all its
59834 addresses have been routed, in case any of the headers get changed as a
59835 result of routing. However, doing this in practice would hold up many
59836 deliveries for unreasonable amounts of time, just because one address could not
59837 immediately be routed. Exim therefore does not delay other deliveries when
59838 routing of one or more addresses is deferred.
59839 <indexterm role="concept" startref="IIDmesproc" class="endofrange"/>
59840 </para>
59841 </section>
59842 </chapter>
59843
59844 <chapter id="CHAPSMTP">
59845 <title>SMTP processing</title>
59846 <para>
59847 <indexterm role="concept" id="IIDsmtpproc1" class="startofrange">
59848 <primary>SMTP</primary>
59849 <secondary>processing details</secondary>
59850 </indexterm>
59851 <indexterm role="concept" id="IIDsmtpproc2" class="startofrange">
59852 <primary>LMTP</primary>
59853 <secondary>processing details</secondary>
59854 </indexterm>
59855 Exim supports a number of different ways of using the SMTP protocol, and its
59856 LMTP variant, which is an interactive protocol for transferring messages into a
59857 closed mail store application. This chapter contains details of how SMTP is
59858 processed. For incoming mail, the following are available:
59859 </para>
59860 <itemizedlist>
59861 <listitem>
59862 <para>
59863 SMTP over TCP/IP (Exim daemon or <emphasis>inetd</emphasis>);
59864 </para>
59865 </listitem>
59866 <listitem>
59867 <para>
59868 SMTP over the standard input and output (the <option>-bs</option> option);
59869 </para>
59870 </listitem>
59871 <listitem>
59872 <para>
59873 Batched SMTP on the standard input (the <option>-bS</option> option).
59874 </para>
59875 </listitem>
59876 </itemizedlist>
59877 <para>
59878 For mail delivery, the following are available:
59879 </para>
59880 <itemizedlist>
59881 <listitem>
59882 <para>
59883 SMTP over TCP/IP (the <command>smtp</command> transport);
59884 </para>
59885 </listitem>
59886 <listitem>
59887 <para>
59888 LMTP over TCP/IP (the <command>smtp</command> transport with the <option>protocol</option> option set to
59889 <quote>lmtp</quote>);
59890 </para>
59891 </listitem>
59892 <listitem>
59893 <para>
59894 LMTP over a pipe to a process running in the local host (the <command>lmtp</command>
59895 transport);
59896 </para>
59897 </listitem>
59898 <listitem>
59899 <para>
59900 Batched SMTP to a file or pipe (the <command>appendfile</command> and <command>pipe</command> transports with
59901 the <option>use_bsmtp</option> option set).
59902 </para>
59903 </listitem>
59904 </itemizedlist>
59905 <para>
59906 <emphasis>Batched SMTP</emphasis> is the name for a process in which batches of messages are
59907 stored in or read from files (or pipes), in a format in which SMTP commands are
59908 used to contain the envelope information.
59909 </para>
59910 <section id="SECToutSMTPTCP">
59911 <title>Outgoing SMTP and LMTP over TCP/IP</title>
59912 <para>
59913 <indexterm role="concept">
59914 <primary>SMTP</primary>
59915 <secondary>outgoing over TCP/IP</secondary>
59916 </indexterm>
59917 <indexterm role="concept">
59918 <primary>outgoing SMTP over TCP/IP</primary>
59919 </indexterm>
59920 <indexterm role="concept">
59921 <primary>LMTP</primary>
59922 <secondary>over TCP/IP</secondary>
59923 </indexterm>
59924 <indexterm role="concept">
59925 <primary>outgoing LMTP over TCP/IP</primary>
59926 </indexterm>
59927 <indexterm role="concept">
59928 <primary>EHLO</primary>
59929 </indexterm>
59930 <indexterm role="concept">
59931 <primary>HELO</primary>
59932 </indexterm>
59933 <indexterm role="concept">
59934 <primary>SIZE option on MAIL command</primary>
59935 </indexterm>
59936 Outgoing SMTP and LMTP over TCP/IP is implemented by the <command>smtp</command> transport.
59937 The <option>protocol</option> option selects which protocol is to be used, but the actual
59938 processing is the same in both cases.
59939 </para>
59940 <para>
59941 If, in response to its EHLO command, Exim is told that the SIZE
59942 parameter is supported, it adds SIZE=&lt;<emphasis>n</emphasis>&gt; to each subsequent MAIL
59943 command. The value of &lt;<emphasis>n</emphasis>&gt; is the message size plus the value of the
59944 <option>size_addition</option> option (default 1024) to allow for additions to the message
59945 such as per-transport header lines, or changes made in a
59946 <indexterm role="concept">
59947 <primary>transport</primary>
59948 <secondary>filter</secondary>
59949 </indexterm>
59950 <indexterm role="concept">
59951 <primary>filter</primary>
59952 <secondary>transport filter</secondary>
59953 </indexterm>
59954 transport filter. If <option>size_addition</option> is set negative, the use of SIZE is
59955 suppressed.
59956 </para>
59957 <para>
59958 If the remote server advertises support for PIPELINING, Exim uses the
59959 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
59960 required for the transaction.
59961 </para>
59962 <para>
59963 If the remote server advertises support for the STARTTLS command, and Exim
59964 was built to support TLS encryption, it tries to start a TLS session unless the
59965 server matches <option>hosts_avoid_tls</option>. See chapter <xref linkend="CHAPTLS"/> for more details.
59966 Either a match in that or <option>hosts_verify_avoid_tls</option> apply when the transport
59967 is called for verification.
59968 </para>
59969 <para>
59970 If the remote server advertises support for the AUTH command, Exim scans
59971 the authenticators configuration for any suitable client settings, as described
59972 in chapter <xref linkend="CHAPSMTPAUTH"/>.
59973 </para>
59974 <para>
59975 <indexterm role="concept">
59976 <primary>carriage return</primary>
59977 </indexterm>
59978 <indexterm role="concept">
59979 <primary>linefeed</primary>
59980 </indexterm>
59981 Responses from the remote host are supposed to be terminated by CR followed by
59982 LF. However, there are known to be hosts that do not send CR characters, so in
59983 order to be able to interwork with such hosts, Exim treats LF on its own as a
59984 line terminator.
59985 </para>
59986 <para>
59987 If a message contains a number of different addresses, all those with the same
59988 characteristics (for example, the same envelope sender) that resolve to the
59989 same set of hosts, in the same order, are sent in a single SMTP transaction,
59990 even if they are for different domains, unless there are more than the setting
59991 of the <option>max_rcpt</option>s option in the <command>smtp</command> transport allows, in which case
59992 they are split into groups containing no more than <option>max_rcpt</option>s addresses
59993 each. If <option>remote_max_parallel</option> is greater than one, such groups may be sent
59994 in parallel sessions. The order of hosts with identical MX values is not
59995 significant when checking whether addresses can be batched in this way.
59996 </para>
59997 <para>
59998 When the <command>smtp</command> transport suffers a temporary failure that is not
59999 message-related, Exim updates its transport-specific database, which contains
60000 records indexed by host name that remember which messages are waiting for each
60001 particular host. It also updates the retry database with new retry times.
60002 </para>
60003 <para>
60004 <indexterm role="concept">
60005 <primary>hints database</primary>
60006 <secondary>retry keys</secondary>
60007 </indexterm>
60008 Exim&#x2019;s retry hints are based on host name plus IP address, so if one address of
60009 a multi-homed host is broken, it will soon be skipped most of the time.
60010 See the next section for more detail about error handling.
60011 </para>
60012 <para>
60013 <indexterm role="concept">
60014 <primary>SMTP</primary>
60015 <secondary>passed connection</secondary>
60016 </indexterm>
60017 <indexterm role="concept">
60018 <primary>SMTP</primary>
60019 <secondary>batching over TCP/IP</secondary>
60020 </indexterm>
60021 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
60022 looks in the hints database for the transport to see if there are any queued
60023 messages waiting for the host to which it is connected. If it finds one, it
60024 creates a new Exim process using the <option>-MC</option> option (which can only be used by
60025 a process running as root or the Exim user) and passes the TCP/IP socket to it
60026 so that it can deliver another message using the same socket. The new process
60027 does only those deliveries that are routed to the connected host, and may in
60028 turn pass the socket on to a third process, and so on.
60029 </para>
60030 <para>
60031 The <option>connection_max_messages</option> option of the <command>smtp</command> transport can be used to
60032 limit the number of messages sent down a single TCP/IP connection.
60033 </para>
60034 <para>
60035 <indexterm role="concept">
60036 <primary>asterisk</primary>
60037 <secondary>after IP address</secondary>
60038 </indexterm>
60039 The second and subsequent messages delivered down an existing connection are
60040 identified in the main log by the addition of an asterisk after the closing
60041 square bracket of the IP address.
60042 </para>
60043 </section>
60044 <section id="SECToutSMTPerr">
60045 <title>Errors in outgoing SMTP</title>
60046 <para>
60047 <indexterm role="concept">
60048 <primary>error</primary>
60049 <secondary>in outgoing SMTP</secondary>
60050 </indexterm>
60051 <indexterm role="concept">
60052 <primary>SMTP</primary>
60053 <secondary>errors in outgoing</secondary>
60054 </indexterm>
60055 <indexterm role="concept">
60056 <primary>host</primary>
60057 <secondary>error</secondary>
60058 </indexterm>
60059 Three different kinds of error are recognized for outgoing SMTP: host errors,
60060 message errors, and recipient errors.
60061 </para>
60062 <variablelist>
60063 <varlistentry>
60064 <term><emphasis role="bold">Host errors</emphasis></term>
60065 <listitem>
60066 <para>
60067 A host error is not associated with a particular message or with a
60068 particular recipient of a message. The host errors are:
60069 </para>
60070 <itemizedlist>
60071 <listitem>
60072 <para>
60073 Connection refused or timed out,
60074 </para>
60075 </listitem>
60076 <listitem>
60077 <para>
60078 Any error response code on connection,
60079 </para>
60080 </listitem>
60081 <listitem>
60082 <para>
60083 Any error response code to EHLO or HELO,
60084 </para>
60085 </listitem>
60086 <listitem>
60087 <para>
60088 Loss of connection at any time, except after <quote>.</quote>,
60089 </para>
60090 </listitem>
60091 <listitem>
60092 <para>
60093 I/O errors at any time,
60094 </para>
60095 </listitem>
60096 <listitem>
60097 <para>
60098 Timeouts during the session, other than in response to MAIL, RCPT or
60099 the <quote>.</quote> at the end of the data.
60100 </para>
60101 </listitem>
60102 </itemizedlist>
60103 <para>
60104 For a host error, a permanent error response on connection, or in response to
60105 EHLO, causes all addresses routed to the host to be failed. Any other host
60106 error causes all addresses to be deferred, and retry data to be created for the
60107 host. It is not tried again, for any message, until its retry time arrives. If
60108 the current set of addresses are not all delivered in this run (to some
60109 alternative host), the message is added to the list of those waiting for this
60110 host, so if it is still undelivered when a subsequent successful delivery is
60111 made to the host, it will be sent down the same SMTP connection.
60112 </para>
60113 </listitem></varlistentry>
60114 <varlistentry>
60115 <term><emphasis role="bold">Message errors</emphasis></term>
60116 <listitem>
60117 <para>
60118 <indexterm role="concept">
60119 <primary>message</primary>
60120 <secondary>error</secondary>
60121 </indexterm>
60122 A message error is associated with a particular message when sent to a
60123 particular host, but not with a particular recipient of the message. The
60124 message errors are:
60125 </para>
60126 <itemizedlist>
60127 <listitem>
60128 <para>
60129 Any error response code to MAIL, DATA, or the <quote>.</quote> that terminates
60130 the data,
60131 </para>
60132 </listitem>
60133 <listitem>
60134 <para>
60135 Timeout after MAIL,
60136 </para>
60137 </listitem>
60138 <listitem>
60139 <para>
60140 Timeout or loss of connection after the <quote>.</quote> that terminates the data. A
60141 timeout after the DATA command itself is treated as a host error, as is loss of
60142 connection at any other time.
60143 </para>
60144 </listitem>
60145 </itemizedlist>
60146 <para>
60147 For a message error, a permanent error response (5<emphasis>xx</emphasis>) causes all addresses
60148 to be failed, and a delivery error report to be returned to the sender. A
60149 temporary error response (4<emphasis>xx</emphasis>), or one of the timeouts, causes all
60150 addresses to be deferred. Retry data is not created for the host, but instead,
60151 a retry record for the combination of host plus message id is created. The
60152 message is not added to the list of those waiting for this host. This ensures
60153 that the failing message will not be sent to this host again until the retry
60154 time arrives. However, other messages that are routed to the host are not
60155 affected, so if it is some property of the message that is causing the error,
60156 it will not stop the delivery of other mail.
60157 </para>
60158 <para>
60159 If the remote host specified support for the SIZE parameter in its response
60160 to EHLO, Exim adds SIZE=<emphasis>nnn</emphasis> to the MAIL command, so an
60161 over-large message will cause a message error because the error arrives as a
60162 response to MAIL.
60163 </para>
60164 </listitem></varlistentry>
60165 <varlistentry>
60166 <term><emphasis role="bold">Recipient errors</emphasis></term>
60167 <listitem>
60168 <para>
60169 <indexterm role="concept">
60170 <primary>recipient</primary>
60171 <secondary>error</secondary>
60172 </indexterm>
60173 A recipient error is associated with a particular recipient of a message. The
60174 recipient errors are:
60175 </para>
60176 <itemizedlist>
60177 <listitem>
60178 <para>
60179 Any error response to RCPT,
60180 </para>
60181 </listitem>
60182 <listitem>
60183 <para>
60184 Timeout after RCPT.
60185 </para>
60186 </listitem>
60187 </itemizedlist>
60188 <para>
60189 For a recipient error, a permanent error response (5<emphasis>xx</emphasis>) causes the
60190 recipient address to be failed, and a bounce message to be returned to the
60191 sender. A temporary error response (4<emphasis>xx</emphasis>) or a timeout causes the failing
60192 address to be deferred, and routing retry data to be created for it. This is
60193 used to delay processing of the address in subsequent queue runs, until its
60194 routing retry time arrives. This applies to all messages, but because it
60195 operates only in queue runs, one attempt will be made to deliver a new message
60196 to the failing address before the delay starts to operate. This ensures that,
60197 if the failure is really related to the message rather than the recipient
60198 (<quote>message too big for this recipient</quote> is a possible example), other messages
60199 have a chance of getting delivered. If a delivery to the address does succeed,
60200 the retry information gets cleared, so all stuck messages get tried again, and
60201 the retry clock is reset.
60202 </para>
60203 <para>
60204 The message is not added to the list of those waiting for this host. Use of the
60205 host for other messages is unaffected, and except in the case of a timeout,
60206 other recipients are processed independently, and may be successfully delivered
60207 in the current SMTP session. After a timeout it is of course impossible to
60208 proceed with the session, so all addresses get deferred. However, those other
60209 than the one that failed do not suffer any subsequent retry delays. Therefore,
60210 if one recipient is causing trouble, the others have a chance of getting
60211 through when a subsequent delivery attempt occurs before the failing
60212 recipient&#x2019;s retry time.
60213 </para>
60214 </listitem></varlistentry>
60215 </variablelist>
60216 <para>
60217 In all cases, if there are other hosts (or IP addresses) available for the
60218 current set of addresses (for example, from multiple MX records), they are
60219 tried in this run for any undelivered addresses, subject of course to their
60220 own retry data. In other words, recipient error retry data does not take effect
60221 until the next delivery attempt.
60222 </para>
60223 <para>
60224 Some hosts have been observed to give temporary error responses to every
60225 MAIL command at certain times (<quote>insufficient space</quote> has been seen). It
60226 would be nice if such circumstances could be recognized, and defer data for the
60227 host itself created, but this is not possible within the current Exim design.
60228 What actually happens is that retry data for every (host, message) combination
60229 is created.
60230 </para>
60231 <para>
60232 The reason that timeouts after MAIL and RCPT are treated specially is that
60233 these can sometimes arise as a result of the remote host&#x2019;s verification
60234 procedures. Exim makes this assumption, and treats them as if a temporary error
60235 response had been received. A timeout after <quote>.</quote> is treated specially because
60236 it is known that some broken implementations fail to recognize the end of the
60237 message if the last character of the last line is a binary zero. Thus, it is
60238 helpful to treat this case as a message error.
60239 </para>
60240 <para>
60241 Timeouts at other times are treated as host errors, assuming a problem with the
60242 host, or the connection to it. If a timeout after MAIL, RCPT,
60243 or <quote>.</quote> is really a connection problem, the assumption is that at the next try
60244 the timeout is likely to occur at some other point in the dialogue, causing it
60245 then to be treated as a host error.
60246 </para>
60247 <para>
60248 There is experimental evidence that some MTAs drop the connection after the
60249 terminating <quote>.</quote> if they do not like the contents of the message for some
60250 reason, in contravention of the RFC, which indicates that a 5<emphasis>xx</emphasis> response
60251 should be given. That is why Exim treats this case as a message rather than a
60252 host error, in order not to delay other messages to the same host.
60253 </para>
60254 </section>
60255 <section id="SECID233">
60256 <title>Incoming SMTP messages over TCP/IP</title>
60257 <para>
60258 <indexterm role="concept">
60259 <primary>SMTP</primary>
60260 <secondary>incoming over TCP/IP</secondary>
60261 </indexterm>
60262 <indexterm role="concept">
60263 <primary>incoming SMTP over TCP/IP</primary>
60264 </indexterm>
60265 <indexterm role="concept">
60266 <primary>inetd</primary>
60267 </indexterm>
60268 <indexterm role="concept">
60269 <primary>daemon</primary>
60270 </indexterm>
60271 Incoming SMTP messages can be accepted in one of two ways: by running a
60272 listening daemon, or by using <emphasis>inetd</emphasis>. In the latter case, the entry in
60273 <filename>/etc/inetd.conf</filename> should be like this:
60274 </para>
60275 <literallayout class="monospaced">
60276 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
60277 </literallayout>
60278 <para>
60279 Exim distinguishes between this case and the case of a locally running user
60280 agent using the <option>-bs</option> option by checking whether or not the standard input is
60281 a socket. When it is, either the port must be privileged (less than 1024), or
60282 the caller must be root or the Exim user. If any other user passes a socket
60283 with an unprivileged port number, Exim prints a message on the standard error
60284 stream and exits with an error code.
60285 </para>
60286 <para>
60287 By default, Exim does not make a log entry when a remote host connects or
60288 disconnects (either via the daemon or <emphasis>inetd</emphasis>), unless the disconnection is
60289 unexpected. It can be made to write such log entries by setting the
60290 <option>smtp_connection</option> log selector.
60291 </para>
60292 <para>
60293 <indexterm role="concept">
60294 <primary>carriage return</primary>
60295 </indexterm>
60296 <indexterm role="concept">
60297 <primary>linefeed</primary>
60298 </indexterm>
60299 Commands from the remote host are supposed to be terminated by CR followed by
60300 LF. However, there are known to be hosts that do not send CR characters. In
60301 order to be able to interwork with such hosts, Exim treats LF on its own as a
60302 line terminator.
60303 Furthermore, because common code is used for receiving messages from all
60304 sources, a CR on its own is also interpreted as a line terminator. However, the
60305 sequence <quote>CR, dot, CR</quote> does not terminate incoming SMTP data.
60306 </para>
60307 <para>
60308 <indexterm role="concept">
60309 <primary>EHLO</primary>
60310 <secondary>invalid data</secondary>
60311 </indexterm>
60312 <indexterm role="concept">
60313 <primary>HELO</primary>
60314 <secondary>invalid data</secondary>
60315 </indexterm>
60316 One area that sometimes gives rise to problems concerns the EHLO or
60317 HELO commands. Some clients send syntactically invalid versions of these
60318 commands, which Exim rejects by default. (This is nothing to do with verifying
60319 the data that is sent, so <option>helo_verify_hosts</option> is not relevant.) You can tell
60320 Exim not to apply a syntax check by setting <option>helo_accept_junk_hosts</option> to
60321 match the broken hosts that send invalid commands.
60322 </para>
60323 <para>
60324 <indexterm role="concept">
60325 <primary>SIZE option on MAIL command</primary>
60326 </indexterm>
60327 <indexterm role="concept">
60328 <primary>MAIL</primary>
60329 <secondary>SIZE option</secondary>
60330 </indexterm>
60331 The amount of disk space available is checked whenever SIZE is received on
60332 a MAIL command, independently of whether <option>message_size_limit</option> or
60333 <option>check_spool_space</option> is configured, unless <option>smtp_check_spool_space</option> is set
60334 false. A temporary error is given if there is not enough space. If
60335 <option>check_spool_space</option> is set, the check is for that amount of space plus the
60336 value given with SIZE, that is, it checks that the addition of the incoming
60337 message will not reduce the space below the threshold.
60338 </para>
60339 <para>
60340 When a message is successfully received, Exim includes the local message id in
60341 its response to the final <quote>.</quote> that terminates the data. If the remote host
60342 logs this text it can help with tracing what has happened to a message.
60343 </para>
60344 <para>
60345 The Exim daemon can limit the number of simultaneous incoming connections it is
60346 prepared to handle (see the <option>smtp_accept_max</option> option). It can also limit the
60347 number of simultaneous incoming connections from a single remote host (see the
60348 <option>smtp_accept_max_per_host</option> option). Additional connection attempts are
60349 rejected using the SMTP temporary error code 421.
60350 </para>
60351 <para>
60352 The Exim daemon does not rely on the SIGCHLD signal to detect when a
60353 subprocess has finished, as this can get lost at busy times. Instead, it looks
60354 for completed subprocesses every time it wakes up. Provided there are other
60355 things happening (new incoming calls, starts of queue runs), completed
60356 processes will be noticed and tidied away. On very quiet systems you may
60357 sometimes see a <quote>defunct</quote> Exim process hanging about. This is not a problem;
60358 it will be noticed when the daemon next wakes up.
60359 </para>
60360 <para>
60361 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
60362 and can also be set up to reject SMTP calls from non-reserved hosts at times of
60363 high system load &ndash; for details see the <option>smtp_accept_reserve</option>,
60364 <option>smtp_load_reserve</option>, and <option>smtp_reserve_hosts</option> options. The load check
60365 applies in both the daemon and <emphasis>inetd</emphasis> cases.
60366 </para>
60367 <para>
60368 Exim normally starts a delivery process for each message received, though this
60369 can be varied by means of the <option>-odq</option> command line option and the
60370 <option>queue_only</option>, <option>queue_only_file</option>, and <option>queue_only_load</option> options. The
60371 number of simultaneously running delivery processes started in this way from
60372 SMTP input can be limited by the <option>smtp_accept_queue</option> and
60373 <option>smtp_accept_queue_per_connection</option> options. When either limit is reached,
60374 subsequently received messages are just put on the input queue without starting
60375 a delivery process.
60376 </para>
60377 <para>
60378 The controls that involve counts of incoming SMTP calls (<option>smtp_accept_max</option>,
60379 <option>smtp_accept_queue</option>, <option>smtp_accept_reserve</option>) are not available when Exim is
60380 started up from the <emphasis>inetd</emphasis> daemon, because in that case each connection is
60381 handled by an entirely independent Exim process. Control by load average is,
60382 however, available with <emphasis>inetd</emphasis>.
60383 </para>
60384 <para>
60385 Exim can be configured to verify addresses in incoming SMTP commands as they
60386 are received. See chapter <xref linkend="CHAPACL"/> for details. It can also be configured
60387 to rewrite addresses at this time &ndash; before any syntax checking is done. See
60388 section <xref linkend="SECTrewriteS"/>.
60389 </para>
60390 <para>
60391 Exim can also be configured to limit the rate at which a client host submits
60392 MAIL and RCPT commands in a single SMTP session. See the
60393 <option>smtp_ratelimit_hosts</option> option.
60394 </para>
60395 </section>
60396 <section id="SECID234">
60397 <title>Unrecognized SMTP commands</title>
60398 <para>
60399 <indexterm role="concept">
60400 <primary>SMTP</primary>
60401 <secondary>unrecognized commands</secondary>
60402 </indexterm>
60403 If Exim receives more than <option>smtp_max_unknown_commands</option> unrecognized SMTP
60404 commands during a single SMTP connection, it drops the connection after sending
60405 the error response to the last command. The default value for
60406 <option>smtp_max_unknown_commands</option> is 3. This is a defence against some kinds of
60407 abuse that subvert web servers into making connections to SMTP ports; in these
60408 circumstances, a number of non-SMTP lines are sent first.
60409 </para>
60410 </section>
60411 <section id="SECID235">
60412 <title>Syntax and protocol errors in SMTP commands</title>
60413 <para>
60414 <indexterm role="concept">
60415 <primary>SMTP</primary>
60416 <secondary>syntax errors</secondary>
60417 </indexterm>
60418 <indexterm role="concept">
60419 <primary>SMTP</primary>
60420 <secondary>protocol errors</secondary>
60421 </indexterm>
60422 A syntax error is detected if an SMTP command is recognized, but there is
60423 something syntactically wrong with its data, for example, a malformed email
60424 address in a RCPT command. Protocol errors include invalid command
60425 sequencing such as RCPT before MAIL. If Exim receives more than
60426 <option>smtp_max_synprot_errors</option> such commands during a single SMTP connection, it
60427 drops the connection after sending the error response to the last command. The
60428 default value for <option>smtp_max_synprot_errors</option> is 3. This is a defence against
60429 broken clients that loop sending bad commands (yes, it has been seen).
60430 </para>
60431 </section>
60432 <section id="SECID236">
60433 <title>Use of non-mail SMTP commands</title>
60434 <para>
60435 <indexterm role="concept">
60436 <primary>SMTP</primary>
60437 <secondary>non-mail commands</secondary>
60438 </indexterm>
60439 The <quote>non-mail</quote> SMTP commands are those other than MAIL, RCPT, and
60440 DATA. Exim counts such commands, and drops the connection if there are too
60441 many of them in a single SMTP session. This action catches some
60442 denial-of-service attempts and things like repeated failing AUTHs, or a mad
60443 client looping sending EHLO. The global option <option>smtp_accept_max_nonmail</option>
60444 defines what <quote>too many</quote> means. Its default value is 10.
60445 </para>
60446 <para>
60447 When a new message is expected, one occurrence of RSET is not counted. This
60448 allows a client to send one RSET between messages (this is not necessary,
60449 but some clients do it). Exim also allows one uncounted occurrence of HELO
60450 or EHLO, and one occurrence of STARTTLS between messages. After
60451 starting up a TLS session, another EHLO is expected, and so it too is not
60452 counted.
60453 </para>
60454 <para>
60455 The first occurrence of AUTH in a connection, or immediately following
60456 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
60457 RCPT, DATA, and QUIT are counted.
60458 </para>
60459 <para>
60460 You can control which hosts are subject to the limit set by
60461 <option>smtp_accept_max_nonmail</option> by setting
60462 <option>smtp_accept_max_nonmail_hosts</option>. The default value is <literal>*</literal>, which makes
60463 the limit apply to all hosts. This option means that you can exclude any
60464 specific badly-behaved hosts that you have to live with.
60465 </para>
60466 </section>
60467 <section id="SECID237">
60468 <title>The VRFY and EXPN commands</title>
60469 <para>
60470 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
60471 runs the ACL specified by <option>acl_smtp_vrfy</option> or <option>acl_smtp_expn</option> (as
60472 appropriate) in order to decide whether the command should be accepted or not.
60473 If no ACL is defined, the command is rejected.
60474 </para>
60475 <para>
60476 <indexterm role="concept">
60477 <primary>VRFY</primary>
60478 <secondary>processing</secondary>
60479 </indexterm>
60480 When VRFY is accepted, it runs exactly the same code as when Exim is
60481 called with the <option>-bv</option> option.
60482 </para>
60483 <para>
60484 <indexterm role="concept">
60485 <primary>EXPN</primary>
60486 <secondary>processing</secondary>
60487 </indexterm>
60488 When EXPN is accepted, a single-level expansion of the address is done.
60489 EXPN is treated as an <quote>address test</quote> (similar to the <option>-bt</option> option) rather
60490 than a verification (the <option>-bv</option> option). If an unqualified local part is given
60491 as the argument to EXPN, it is qualified with <option>qualify_domain</option>. Rejections
60492 of VRFY and EXPN commands are logged on the main and reject logs, and
60493 VRFY verification failures are logged on the main log for consistency with
60494 RCPT failures.
60495 </para>
60496 </section>
60497 <section id="SECTETRN">
60498 <title>The ETRN command</title>
60499 <para>
60500 <indexterm role="concept">
60501 <primary>ETRN</primary>
60502 <secondary>processing</secondary>
60503 </indexterm>
60504 RFC 1985 describes an SMTP command called ETRN that is designed to
60505 overcome the security problems of the TURN command (which has fallen into
60506 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
60507 the ACL specified by <option>acl_smtp_etrn</option> in order to decide whether the command
60508 should be accepted or not. If no ACL is defined, the command is rejected.
60509 </para>
60510 <para>
60511 The ETRN command is concerned with <quote>releasing</quote> messages that are awaiting
60512 delivery to certain hosts. As Exim does not organize its message queue by host,
60513 the only form of ETRN that is supported by default is the one where the
60514 text starts with the <quote>#</quote> prefix, in which case the remainder of the text is
60515 specific to the SMTP server. A valid ETRN command causes a run of Exim with
60516 the <option>-R</option> option to happen, with the remainder of the ETRN text as its
60517 argument. For example,
60518 </para>
60519 <literallayout class="monospaced">
60520 ETRN #brigadoon
60521 </literallayout>
60522 <para>
60523 runs the command
60524 </para>
60525 <literallayout class="monospaced">
60526 exim -R brigadoon
60527 </literallayout>
60528 <para>
60529 which causes a delivery attempt on all messages with undelivered addresses
60530 containing the text <quote>brigadoon</quote>. When <option>smtp_etrn_serialize</option> is set (the
60531 default), Exim prevents the simultaneous execution of more than one queue run
60532 for the same argument string as a result of an ETRN command. This stops
60533 a misbehaving client from starting more than one queue runner at once.
60534 </para>
60535 <para>
60536 <indexterm role="concept">
60537 <primary>hints database</primary>
60538 <secondary>ETRN serialization</secondary>
60539 </indexterm>
60540 Exim implements the serialization by means of a hints database in which a
60541 record is written whenever a process is started by ETRN, and deleted when
60542 the process completes. However, Exim does not keep the SMTP session waiting for
60543 the ETRN process to complete. Once ETRN is accepted, the client is sent
60544 a <quote>success</quote> return code. Obviously there is scope for hints records to get
60545 left lying around if there is a system or program crash. To guard against this,
60546 Exim ignores any records that are more than six hours old.
60547 </para>
60548 <para>
60549 <indexterm role="option">
60550 <primary><option>smtp_etrn_command</option></primary>
60551 </indexterm>
60552 For more control over what ETRN does, the <option>smtp_etrn_command</option> option can
60553 used. This specifies a command that is run whenever ETRN is received,
60554 whatever the form of its argument. For
60555 example:
60556 </para>
60557 <literallayout class="monospaced">
60558 smtp_etrn_command = /etc/etrn_command $domain \
60559                     $sender_host_address
60560 </literallayout>
60561 <para>
60562 <indexterm role="variable">
60563 <primary><varname>$domain</varname></primary>
60564 </indexterm>
60565 The string is split up into arguments which are independently expanded. The
60566 expansion variable <varname>$domain</varname> is set to the argument of the ETRN command,
60567 and no syntax checking is done on the contents of this argument. Exim does not
60568 wait for the command to complete, so its status code is not checked. Exim runs
60569 under its own uid and gid when receiving incoming SMTP, so it is not possible
60570 for it to change them before running the command.
60571 </para>
60572 </section>
60573 <section id="SECID238">
60574 <title>Incoming local SMTP</title>
60575 <para>
60576 <indexterm role="concept">
60577 <primary>SMTP</primary>
60578 <secondary>local incoming</secondary>
60579 </indexterm>
60580 Some user agents use SMTP to pass messages to their local MTA using the
60581 standard input and output, as opposed to passing the envelope on the command
60582 line and writing the message to the standard input. This is supported by the
60583 <option>-bs</option> option. This form of SMTP is handled in the same way as incoming
60584 messages over TCP/IP (including the use of ACLs), except that the envelope
60585 sender given in a MAIL command is ignored unless the caller is trusted. In
60586 an ACL you can detect this form of SMTP input by testing for an empty host
60587 identification. It is common to have this as the first line in the ACL that
60588 runs for RCPT commands:
60589 </para>
60590 <literallayout class="monospaced">
60591 accept hosts = :
60592 </literallayout>
60593 <para>
60594 This accepts SMTP messages from local processes without doing any other tests.
60595 </para>
60596 </section>
60597 <section id="SECTbatchSMTP">
60598 <title>Outgoing batched SMTP</title>
60599 <para>
60600 <indexterm role="concept">
60601 <primary>SMTP</primary>
60602 <secondary>batched outgoing</secondary>
60603 </indexterm>
60604 <indexterm role="concept">
60605 <primary>batched SMTP output</primary>
60606 </indexterm>
60607 Both the <command>appendfile</command> and <command>pipe</command> transports can be used for handling
60608 batched SMTP. Each has an option called <option>use_bsmtp</option> which causes messages to
60609 be output in BSMTP format. No SMTP responses are possible for this form of
60610 delivery. All it is doing is using SMTP commands as a way of transmitting the
60611 envelope along with the message.
60612 </para>
60613 <para>
60614 The message is written to the file or pipe preceded by the SMTP commands
60615 MAIL and RCPT, and followed by a line containing a single dot. Lines in
60616 the message that start with a dot have an extra dot added. The SMTP command
60617 HELO is not normally used. If it is required, the <option>message_prefix</option> option
60618 can be used to specify it.
60619 </para>
60620 <para>
60621 Because <command>appendfile</command> and <command>pipe</command> are both local transports, they accept only
60622 one recipient address at a time by default. However, you can arrange for them
60623 to handle several addresses at once by setting the <option>batch_max</option> option. When
60624 this is done for BSMTP, messages may contain multiple RCPT commands. See
60625 chapter <xref linkend="CHAPbatching"/> for more details.
60626 </para>
60627 <para>
60628 <indexterm role="variable">
60629 <primary><varname>$host</varname></primary>
60630 </indexterm>
60631 When one or more addresses are routed to a BSMTP transport by a router that
60632 sets up a host list, the name of the first host on the list is available to the
60633 transport in the variable <varname>$host</varname>. Here is an example of such a transport and
60634 router:
60635 </para>
60636 <literallayout class="monospaced">
60637 begin routers
60638 route_append:
60639   driver = manualroute
60640   transport = smtp_appendfile
60641   route_list = domain.example  batch.host.example
60642
60643 begin transports
60644 smtp_appendfile:
60645   driver = appendfile
60646   directory = /var/bsmtp/$host
60647   batch_max = 1000
60648   use_bsmtp
60649   user = exim
60650 </literallayout>
60651 <para>
60652 This causes messages addressed to <emphasis>domain.example</emphasis> to be written in BSMTP
60653 format to <filename>/var/bsmtp/batch.host.example</filename>, with only a single copy of each
60654 message (unless there are more than 1000 recipients).
60655 </para>
60656 </section>
60657 <section id="SECTincomingbatchedSMTP">
60658 <title>Incoming batched SMTP</title>
60659 <para>
60660 <indexterm role="concept">
60661 <primary>SMTP</primary>
60662 <secondary>batched incoming</secondary>
60663 </indexterm>
60664 <indexterm role="concept">
60665 <primary>batched SMTP input</primary>
60666 </indexterm>
60667 The <option>-bS</option> command line option causes Exim to accept one or more messages by
60668 reading SMTP on the standard input, but to generate no responses. If the caller
60669 is trusted, the senders in the MAIL commands are believed; otherwise the
60670 sender is always the caller of Exim. Unqualified senders and receivers are not
60671 rejected (there seems little point) but instead just get qualified. HELO
60672 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
60673 as NOOP; QUIT quits.
60674 </para>
60675 <para>
60676 Minimal policy checking is done for BSMTP input. Only the non-SMTP
60677 ACL is run in the same way as for non-SMTP local input.
60678 </para>
60679 <para>
60680 If an error is detected while reading a message, including a missing <quote>.</quote> at
60681 the end, Exim gives up immediately. It writes details of the error to the
60682 standard output in a stylized way that the calling program should be able to
60683 make some use of automatically, for example:
60684 </para>
60685 <literallayout class="monospaced">
60686 554 Unexpected end of file
60687 Transaction started in line 10
60688 Error detected in line 14
60689 </literallayout>
60690 <para>
60691 It writes a more verbose version, for human consumption, to the standard error
60692 file, for example:
60693 </para>
60694 <literallayout class="monospaced">
60695 An error was detected while processing a file of BSMTP input.
60696 The error message was:
60697
60698 501 '&gt;' missing at end of address
60699
60700 The SMTP transaction started in line 10.
60701 The error was detected in line 12.
60702 The SMTP command at fault was:
60703
60704 rcpt to:&lt;malformed@in.com.plete
60705
60706 1 previous message was successfully processed.
60707 The rest of the batch was abandoned.
60708 </literallayout>
60709 <para>
60710 The return code from Exim is zero only if there were no errors. It is 1 if some
60711 messages were accepted before an error was detected, and 2 if no messages were
60712 accepted.
60713 <indexterm role="concept" startref="IIDsmtpproc1" class="endofrange"/>
60714 <indexterm role="concept" startref="IIDsmtpproc2" class="endofrange"/>
60715 </para>
60716 </section>
60717 </chapter>
60718
60719 <chapter id="CHAPemsgcust">
60720 <title>Customizing bounce and warning messages</title>
60721 <titleabbrev>Customizing messages</titleabbrev>
60722 <para>
60723 When a message fails to be delivered, or remains on the queue for more than a
60724 configured amount of time, Exim sends a message to the original sender, or
60725 to an alternative configured address. The text of these messages is built into
60726 the code of Exim, but it is possible to change it, either by adding a single
60727 string, or by replacing each of the paragraphs by text supplied in a file.
60728 </para>
60729 <para>
60730 The <emphasis>From:</emphasis> and <emphasis>To:</emphasis> header lines are automatically generated; you can
60731 cause a <emphasis>Reply-To:</emphasis> line to be added by setting the <option>errors_reply_to</option>
60732 option. Exim also adds the line
60733 </para>
60734 <literallayout class="monospaced">
60735 Auto-Submitted: auto-generated
60736 </literallayout>
60737 <para>
60738 to all warning and bounce messages,
60739 </para>
60740 <section id="SECID239">
60741 <title>Customizing bounce messages</title>
60742 <para>
60743 <indexterm role="concept">
60744 <primary>customizing</primary>
60745 <secondary>bounce message</secondary>
60746 </indexterm>
60747 <indexterm role="concept">
60748 <primary>bounce message</primary>
60749 <secondary>customizing</secondary>
60750 </indexterm>
60751 If <option>bounce_message_text</option> is set, its contents are included in the default
60752 message immediately after <quote>This message was created automatically by mail
60753 delivery software.</quote> The string is not expanded. It is not used if
60754 <option>bounce_message_file</option> is set.
60755 </para>
60756 <para>
60757 When <option>bounce_message_file</option> is set, it must point to a template file for
60758 constructing error messages. The file consists of a series of text items,
60759 separated by lines consisting of exactly four asterisks. If the file cannot be
60760 opened, default text is used and a message is written to the main and panic
60761 logs. If any text item in the file is empty, default text is used for that
60762 item.
60763 </para>
60764 <para>
60765 <indexterm role="variable">
60766 <primary><varname>$bounce_recipient</varname></primary>
60767 </indexterm>
60768 <indexterm role="variable">
60769 <primary><varname>$bounce_return_size_limit</varname></primary>
60770 </indexterm>
60771 Each item of text that is read from the file is expanded, and there are two
60772 expansion variables which can be of use here: <varname>$bounce_recipient</varname> is set to
60773 the recipient of an error message while it is being created, and
60774 <varname>$bounce_return_size_limit</varname> contains the value of the <option>return_size_limit</option>
60775 option, rounded to a whole number.
60776 </para>
60777 <para>
60778 The items must appear in the file in the following order:
60779 </para>
60780 <itemizedlist>
60781 <listitem>
60782 <para>
60783 The first item is included in the headers, and should include at least a
60784 <emphasis>Subject:</emphasis> header. Exim does not check the syntax of these headers.
60785 </para>
60786 </listitem>
60787 <listitem>
60788 <para>
60789 The second item forms the start of the error message. After it, Exim lists the
60790 failing addresses with their error messages.
60791 </para>
60792 </listitem>
60793 <listitem>
60794 <para>
60795 The third item is used to introduce any text from pipe transports that is to be
60796 returned to the sender. It is omitted if there is no such text.
60797 </para>
60798 </listitem>
60799 <listitem>
60800 <para>
60801 The fourth item is used to introduce the copy of the message that is returned
60802 as part of the error report.
60803 </para>
60804 </listitem>
60805 <listitem>
60806 <para>
60807 The fifth item is added after the fourth one if the returned message is
60808 truncated because it is bigger than <option>return_size_limit</option>.
60809 </para>
60810 </listitem>
60811 <listitem>
60812 <para>
60813 The sixth item is added after the copy of the original message.
60814 </para>
60815 </listitem>
60816 </itemizedlist>
60817 <para>
60818 The default state (<option>bounce_message_file</option> unset) is equivalent to the
60819 following file, in which the sixth item is empty. The <emphasis>Subject:</emphasis> and some
60820 other lines have been split in order to fit them on the page:
60821 </para>
60822 <literallayout class="monospaced">
60823 Subject: Mail delivery failed
60824   ${if eq{$sender_address}{$bounce_recipient}
60825   {: returning message to sender}}
60826 ****
60827 This message was created automatically by mail delivery software.
60828
60829 A message ${if eq{$sender_address}{$bounce_recipient}
60830   {that you sent }{sent by
60831
60832 &lt;$sender_address&gt;
60833
60834 }}could not be delivered to all of its recipients.
60835 This is a permanent error. The following address(es) failed:
60836 ****
60837 The following text was generated during the delivery attempt(s):
60838 ****
60839 ------ This is a copy of the message, including all the headers.
60840   ------
60841 ****
60842 ------ The body of the message is $message_size characters long;
60843   only the first
60844 ------ $bounce_return_size_limit or so are included here.
60845 ****
60846 </literallayout>
60847 </section>
60848 <section id="SECTcustwarn">
60849 <title>Customizing warning messages</title>
60850 <para>
60851 <indexterm role="concept">
60852 <primary>customizing</primary>
60853 <secondary>warning message</secondary>
60854 </indexterm>
60855 <indexterm role="concept">
60856 <primary>warning of delay</primary>
60857 <secondary>customizing the message</secondary>
60858 </indexterm>
60859 The option <option>warn_message_file</option> can be pointed at a template file for use when
60860 warnings about message delays are created. In this case there are only three
60861 text sections:
60862 </para>
60863 <itemizedlist>
60864 <listitem>
60865 <para>
60866 The first item is included in the headers, and should include at least a
60867 <emphasis>Subject:</emphasis> header. Exim does not check the syntax of these headers.
60868 </para>
60869 </listitem>
60870 <listitem>
60871 <para>
60872 The second item forms the start of the warning message. After it, Exim lists
60873 the delayed addresses.
60874 </para>
60875 </listitem>
60876 <listitem>
60877 <para>
60878 The third item then ends the message.
60879 </para>
60880 </listitem>
60881 </itemizedlist>
60882 <para>
60883 The default state is equivalent to the following file, except that some lines
60884 have been split here, in order to fit them on the page:
60885 </para>
60886 <literallayout class="monospaced">
60887 Subject: Warning: message $message_exim_id delayed
60888   $warn_message_delay
60889 ****
60890 This message was created automatically by mail delivery software.
60891
60892 A message ${if eq{$sender_address}{$warn_message_recipients}
60893 {that you sent }{sent by
60894
60895 &lt;$sender_address&gt;
60896
60897 }}has not been delivered to all of its recipients after
60898 more than $warn_message_delay on the queue on $primary_hostname.
60899
60900 The message identifier is:     $message_exim_id
60901 The subject of the message is: $h_subject
60902 The date of the message is:    $h_date
60903
60904 The following address(es) have not yet been delivered:
60905 ****
60906 No action is required on your part. Delivery attempts will
60907 continue for some time, and this warning may be repeated at
60908 intervals if the message remains undelivered. Eventually the
60909 mail delivery software will give up, and when that happens,
60910 the message will be returned to you.
60911 </literallayout>
60912 <para>
60913 <indexterm role="variable">
60914 <primary><varname>$warn_message_delay</varname></primary>
60915 </indexterm>
60916 <indexterm role="variable">
60917 <primary><varname>$warn_message_recipients</varname></primary>
60918 </indexterm>
60919 However, in the default state the subject and date lines are omitted if no
60920 appropriate headers exist. During the expansion of this file,
60921 <varname>$warn_message_delay</varname> is set to the delay time in one of the forms <quote>&lt;<emphasis>n</emphasis>&gt;
60922 minutes</quote> or <quote>&lt;<emphasis>n</emphasis>&gt; hours</quote>, and <varname>$warn_message_recipients</varname> contains a list
60923 of recipients for the warning message. There may be more than one if there are
60924 multiple addresses with different <option>errors_to</option> settings on the routers that
60925 handled them.
60926 </para>
60927 </section>
60928 </chapter>
60929
60930 <chapter id="CHAPcomconreq">
60931 <title>Some common configuration settings</title>
60932 <para>
60933 This chapter discusses some configuration settings that seem to be fairly
60934 common. More examples and discussion can be found in the Exim book.
60935 </para>
60936 <section id="SECID240">
60937 <title>Sending mail to a smart host</title>
60938 <para>
60939 <indexterm role="concept">
60940 <primary>smart host</primary>
60941 <secondary>example router</secondary>
60942 </indexterm>
60943 If you want to send all mail for non-local domains to a <quote>smart host</quote>, you
60944 should replace the default <command>dnslookup</command> router with a router which does the
60945 routing explicitly:
60946 </para>
60947 <literallayout class="monospaced">
60948 send_to_smart_host:
60949   driver = manualroute
60950   route_list = !+local_domains smart.host.name
60951   transport = remote_smtp
60952 </literallayout>
60953 <para>
60954 You can use the smart host&#x2019;s IP address instead of the name if you wish.
60955 If you are using Exim only to submit messages to a smart host, and not for
60956 receiving incoming messages, you can arrange for it to do the submission
60957 synchronously by setting the <option>mua_wrapper</option> option (see chapter
60958 <xref linkend="CHAPnonqueueing"/>).
60959 </para>
60960 </section>
60961 <section id="SECTmailinglists">
60962 <title>Using Exim to handle mailing lists</title>
60963 <para>
60964 <indexterm role="concept">
60965 <primary>mailing lists</primary>
60966 </indexterm>
60967 Exim can be used to run simple mailing lists, but for large and/or complicated
60968 requirements, the use of additional specialized mailing list software such as
60969 Majordomo or Mailman is recommended.
60970 </para>
60971 <para>
60972 The <command>redirect</command> router can be used to handle mailing lists where each list
60973 is maintained in a separate file, which can therefore be managed by an
60974 independent manager. The <option>domains</option> router option can be used to run these
60975 lists in a separate domain from normal mail. For example:
60976 </para>
60977 <literallayout class="monospaced">
60978 lists:
60979   driver = redirect
60980   domains = lists.example
60981   file = /usr/lists/$local_part
60982   forbid_pipe
60983   forbid_file
60984   errors_to = $local_part-request@lists.example
60985   no_more
60986 </literallayout>
60987 <para>
60988 This router is skipped for domains other than <emphasis>lists.example</emphasis>. For addresses
60989 in that domain, it looks for a file that matches the local part. If there is no
60990 such file, the router declines, but because <option>no_more</option> is set, no subsequent
60991 routers are tried, and so the whole delivery fails.
60992 </para>
60993 <para>
60994 The <option>forbid_pipe</option> and <option>forbid_file</option> options prevent a local part from being
60995 expanded into a file name or a pipe delivery, which is usually inappropriate in
60996 a mailing list.
60997 </para>
60998 <para>
60999 <indexterm role="option">
61000 <primary><option>errors_to</option></primary>
61001 </indexterm>
61002 The <option>errors_to</option> option specifies that any delivery errors caused by addresses
61003 taken from a mailing list are to be sent to the given address rather than the
61004 original sender of the message. However, before acting on this, Exim verifies
61005 the error address, and ignores it if verification fails.
61006 </para>
61007 <para>
61008 For example, using the configuration above, mail sent to
61009 <emphasis>dicts@lists.example</emphasis> is passed on to those addresses contained in
61010 <filename>/usr/lists/dicts</filename>, with error reports directed to
61011 <emphasis>dicts-request@lists.example</emphasis>, provided that this address can be verified.
61012 There could be a file called <filename>/usr/lists/dicts-request</filename> containing
61013 the address(es) of this particular list&#x2019;s manager(s), but other approaches,
61014 such as setting up an earlier router (possibly using the <option>local_part_prefix</option>
61015 or <option>local_part_suffix</option> options) to handle addresses of the form
61016 <option>owner-</option><emphasis>xxx</emphasis> or <option>xxx-</option><emphasis>request</emphasis>, are also possible.
61017 </para>
61018 </section>
61019 <section id="SECID241">
61020 <title>Syntax errors in mailing lists</title>
61021 <para>
61022 <indexterm role="concept">
61023 <primary>mailing lists</primary>
61024 <secondary>syntax errors in</secondary>
61025 </indexterm>
61026 If an entry in redirection data contains a syntax error, Exim normally defers
61027 delivery of the original address. That means that a syntax error in a mailing
61028 list holds up all deliveries to the list. This may not be appropriate when a
61029 list is being maintained automatically from data supplied by users, and the
61030 addresses are not rigorously checked.
61031 </para>
61032 <para>
61033 If the <option>skip_syntax_errors</option> option is set, the <command>redirect</command> router just skips
61034 entries that fail to parse, noting the incident in the log. If in addition
61035 <option>syntax_errors_to</option> is set to a verifiable address, a message is sent to it
61036 whenever a broken address is skipped. It is usually appropriate to set
61037 <option>syntax_errors_to</option> to the same address as <option>errors_to</option>.
61038 </para>
61039 </section>
61040 <section id="SECID242">
61041 <title>Re-expansion of mailing lists</title>
61042 <para>
61043 <indexterm role="concept">
61044 <primary>mailing lists</primary>
61045 <secondary>re-expansion of</secondary>
61046 </indexterm>
61047 Exim remembers every individual address to which a message has been delivered,
61048 in order to avoid duplication, but it normally stores only the original
61049 recipient addresses with a message. If all the deliveries to a mailing list
61050 cannot be done at the first attempt, the mailing list is re-expanded when the
61051 delivery is next tried. This means that alterations to the list are taken into
61052 account at each delivery attempt, so addresses that have been added to
61053 the list since the message arrived will therefore receive a copy of the
61054 message, even though it pre-dates their subscription.
61055 </para>
61056 <para>
61057 If this behaviour is felt to be undesirable, the <option>one_time</option> option can be set
61058 on the <command>redirect</command> router. If this is done, any addresses generated by the
61059 router that fail to deliver at the first attempt are added to the message as
61060 <quote>top level</quote> addresses, and the parent address that generated them is marked
61061 <quote>delivered</quote>. Thus, expansion of the mailing list does not happen again at the
61062 subsequent delivery attempts. The disadvantage of this is that if any of the
61063 failing addresses are incorrect, correcting them in the file has no effect on
61064 pre-existing messages.
61065 </para>
61066 <para>
61067 The original top-level address is remembered with each of the generated
61068 addresses, and is output in any log messages. However, any intermediate parent
61069 addresses are not recorded. This makes a difference to the log only if the
61070 <option>all_parents</option> selector is set, but for mailing lists there is normally only
61071 one level of expansion anyway.
61072 </para>
61073 </section>
61074 <section id="SECID243">
61075 <title>Closed mailing lists</title>
61076 <para>
61077 <indexterm role="concept">
61078 <primary>mailing lists</primary>
61079 <secondary>closed</secondary>
61080 </indexterm>
61081 The examples so far have assumed open mailing lists, to which anybody may
61082 send mail. It is also possible to set up closed lists, where mail is accepted
61083 from specified senders only. This is done by making use of the generic
61084 <option>senders</option> option to restrict the router that handles the list.
61085 </para>
61086 <para>
61087 The following example uses the same file as a list of recipients and as a list
61088 of permitted senders. It requires three routers:
61089 </para>
61090 <literallayout class="monospaced">
61091 lists_request:
61092   driver = redirect
61093   domains = lists.example
61094   local_part_suffix = -request
61095   file = /usr/lists/$local_part$local_part_suffix
61096   no_more
61097
61098 lists_post:
61099   driver = redirect
61100   domains = lists.example
61101   senders = ${if exists {/usr/lists/$local_part}\
61102              {lsearch;/usr/lists/$local_part}{*}}
61103   file = /usr/lists/$local_part
61104   forbid_pipe
61105   forbid_file
61106   errors_to = $local_part-request@lists.example
61107   no_more
61108
61109 lists_closed:
61110   driver = redirect
61111   domains = lists.example
61112   allow_fail
61113   data = :fail: $local_part@lists.example is a closed mailing list
61114 </literallayout>
61115 <para>
61116 All three routers have the same <option>domains</option> setting, so for any other domains,
61117 they are all skipped. The first router runs only if the local part ends in
61118 <option>-request</option>. It handles messages to the list manager(s) by means of an open
61119 mailing list.
61120 </para>
61121 <para>
61122 The second router runs only if the <option>senders</option> precondition is satisfied. It
61123 checks for the existence of a list that corresponds to the local part, and then
61124 checks that the sender is on the list by means of a linear search. It is
61125 necessary to check for the existence of the file before trying to search it,
61126 because otherwise Exim thinks there is a configuration error. If the file does
61127 not exist, the expansion of <option>senders</option> is *, which matches all senders. This
61128 means that the router runs, but because there is no list, declines, and
61129 <option>no_more</option> ensures that no further routers are run. The address fails with an
61130 <quote>unrouteable address</quote> error.
61131 </para>
61132 <para>
61133 The third router runs only if the second router is skipped, which happens when
61134 a mailing list exists, but the sender is not on it. This router forcibly fails
61135 the address, giving a suitable error message.
61136 </para>
61137 </section>
61138 <section id="SECTverp">
61139 <title>Variable Envelope Return Paths (VERP)</title>
61140 <para>
61141 <indexterm role="concept">
61142 <primary>VERP</primary>
61143 </indexterm>
61144 <indexterm role="concept">
61145 <primary>Variable Envelope Return Paths</primary>
61146 </indexterm>
61147 <indexterm role="concept">
61148 <primary>envelope sender</primary>
61149 </indexterm>
61150 Variable Envelope Return Paths &ndash; see <emphasis role="bold"><ulink url="http://cr.yp.to/proto/verp.txt">http://cr.yp.to/proto/verp.txt</ulink></emphasis> &ndash;
61151 are a way of helping mailing list administrators discover which subscription
61152 address is the cause of a particular delivery failure. The idea is to encode
61153 the original recipient address in the outgoing envelope sender address, so that
61154 if the message is forwarded by another host and then subsequently bounces, the
61155 original recipient can be extracted from the recipient address of the bounce.
61156 </para>
61157 <para>
61158 <indexterm role="option">
61159 <primary><option>errors_to</option></primary>
61160 </indexterm>
61161 <indexterm role="option">
61162 <primary><option>return_path</option></primary>
61163 </indexterm>
61164 Envelope sender addresses can be modified by Exim using two different
61165 facilities: the <option>errors_to</option> option on a router (as shown in previous mailing
61166 list examples), or the <option>return_path</option> option on a transport. The second of
61167 these is effective only if the message is successfully delivered to another
61168 host; it is not used for errors detected on the local host (see the description
61169 of <option>return_path</option> in chapter <xref linkend="CHAPtransportgeneric"/>). Here is an example
61170 of the use of <option>return_path</option> to implement VERP on an <command>smtp</command> transport:
61171 </para>
61172 <literallayout class="monospaced">
61173 verp_smtp:
61174   driver = smtp
61175   max_rcpt = 1
61176   return_path = \
61177     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
61178       {$1-request+$local_part=$domain@your.dom.example}fail}
61179 </literallayout>
61180 <para>
61181 This has the effect of rewriting the return path (envelope sender) on outgoing
61182 SMTP messages, if the local part of the original return path ends in
61183 <quote>-request</quote>, and the domain is <emphasis>your.dom.example</emphasis>. The rewriting inserts the
61184 local part and domain of the recipient into the return path. Suppose, for
61185 example, that a message whose return path has been set to
61186 <emphasis>somelist-request@your.dom.example</emphasis> is sent to
61187 <emphasis>subscriber@other.dom.example</emphasis>. In the transport, the return path is
61188 rewritten as
61189 </para>
61190 <literallayout class="monospaced">
61191 somelist-request+subscriber=other.dom.example@your.dom.example
61192 </literallayout>
61193 <para>
61194 <indexterm role="variable">
61195 <primary><varname>$local_part</varname></primary>
61196 </indexterm>
61197 For this to work, you must tell Exim to send multiple copies of messages that
61198 have more than one recipient, so that each copy has just one recipient. This is
61199 achieved by setting <option>max_rcpt</option> to 1. Without this, a single copy of a message
61200 might be sent to several different recipients in the same domain, in which case
61201 <varname>$local_part</varname> is not available in the transport, because it is not unique.
61202 </para>
61203 <para>
61204 Unless your host is doing nothing but mailing list deliveries, you should
61205 probably use a separate transport for the VERP deliveries, so as not to use
61206 extra resources in making one-per-recipient copies for other deliveries. This
61207 can easily be done by expanding the <option>transport</option> option in the router:
61208 </para>
61209 <literallayout class="monospaced">
61210 dnslookup:
61211   driver = dnslookup
61212   domains = ! +local_domains
61213   transport = \
61214     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
61215       {verp_smtp}{remote_smtp}}
61216   no_more
61217 </literallayout>
61218 <para>
61219 If you want to change the return path using <option>errors_to</option> in a router instead
61220 of using <option>return_path</option> in the transport, you need to set <option>errors_to</option> on all
61221 routers that handle mailing list addresses. This will ensure that all delivery
61222 errors, including those detected on the local host, are sent to the VERP
61223 address.
61224 </para>
61225 <para>
61226 On a host that does no local deliveries and has no manual routing, only the
61227 <command>dnslookup</command> router needs to be changed. A special transport is not needed for
61228 SMTP deliveries. Every mailing list recipient has its own return path value,
61229 and so Exim must hand them to the transport one at a time. Here is an example
61230 of a <command>dnslookup</command> router that implements VERP:
61231 </para>
61232 <literallayout class="monospaced">
61233 verp_dnslookup:
61234   driver = dnslookup
61235   domains = ! +local_domains
61236   transport = remote_smtp
61237   errors_to = \
61238     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
61239      {$1-request+$local_part=$domain@your.dom.example}fail}
61240   no_more
61241 </literallayout>
61242 <para>
61243 Before you start sending out messages with VERPed return paths, you must also
61244 configure Exim to accept the bounce messages that come back to those paths.
61245 Typically this is done by setting a <option>local_part_suffix</option> option for a
61246 router, and using this to route the messages to wherever you want to handle
61247 them.
61248 </para>
61249 <para>
61250 The overhead incurred in using VERP depends very much on the size of the
61251 message, the number of recipient addresses that resolve to the same remote
61252 host, and the speed of the connection over which the message is being sent. If
61253 a lot of addresses resolve to the same host and the connection is slow, sending
61254 a separate copy of the message for each address may take substantially longer
61255 than sending a single copy with many recipients (for which VERP cannot be
61256 used).
61257 </para>
61258 </section>
61259 <section id="SECTvirtualdomains">
61260 <title>Virtual domains</title>
61261 <para>
61262 <indexterm role="concept">
61263 <primary>virtual domains</primary>
61264 </indexterm>
61265 <indexterm role="concept">
61266 <primary>domain</primary>
61267 <secondary>virtual</secondary>
61268 </indexterm>
61269 The phrase <emphasis>virtual domain</emphasis> is unfortunately used with two rather different
61270 meanings:
61271 </para>
61272 <itemizedlist>
61273 <listitem>
61274 <para>
61275 A domain for which there are no real mailboxes; all valid local parts are
61276 aliases for other email addresses. Common examples are organizational
61277 top-level domains and <quote>vanity</quote> domains.
61278 </para>
61279 </listitem>
61280 <listitem>
61281 <para>
61282 One of a number of independent domains that are all handled by the same host,
61283 with mailboxes on that host, but where the mailbox owners do not necessarily
61284 have login accounts on that host.
61285 </para>
61286 </listitem>
61287 </itemizedlist>
61288 <para>
61289 The first usage is probably more common, and does seem more <quote>virtual</quote> than
61290 the second. This kind of domain can be handled in Exim with a straightforward
61291 aliasing router. One approach is to create a separate alias file for each
61292 virtual domain. Exim can test for the existence of the alias file to determine
61293 whether the domain exists. The <command>dsearch</command> lookup type is useful here, leading
61294 to a router of this form:
61295 </para>
61296 <literallayout class="monospaced">
61297 virtual:
61298   driver = redirect
61299   domains = dsearch;/etc/mail/virtual
61300   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
61301   no_more
61302 </literallayout>
61303 <para>
61304 The <option>domains</option> option specifies that the router is to be skipped, unless there
61305 is a file in the <filename>/etc/mail/virtual</filename> directory whose name is the same as the
61306 domain that is being processed. When the router runs, it looks up the local
61307 part in the file to find a new address (or list of addresses). The <option>no_more</option>
61308 setting ensures that if the lookup fails (leading to <option>data</option> being an empty
61309 string), Exim gives up on the address without trying any subsequent routers.
61310 </para>
61311 <para>
61312 This one router can handle all the virtual domains because the alias file names
61313 follow a fixed pattern. Permissions can be arranged so that appropriate people
61314 can edit the different alias files. A successful aliasing operation results in
61315 a new envelope recipient address, which is then routed from scratch.
61316 </para>
61317 <para>
61318 The other kind of <quote>virtual</quote> domain can also be handled in a straightforward
61319 way. One approach is to create a file for each domain containing a list of
61320 valid local parts, and use it in a router like this:
61321 </para>
61322 <literallayout class="monospaced">
61323 my_domains:
61324   driver = accept
61325   domains = dsearch;/etc/mail/domains
61326   local_parts = lsearch;/etc/mail/domains/$domain
61327   transport = my_mailboxes
61328 </literallayout>
61329 <para>
61330 The address is accepted if there is a file for the domain, and the local part
61331 can be found in the file. The <option>domains</option> option is used to check for the
61332 file&#x2019;s existence because <option>domains</option> is tested before the <option>local_parts</option>
61333 option (see section <xref linkend="SECTrouprecon"/>). You cannot use <option>require_files</option>,
61334 because that option is tested after <option>local_parts</option>. The transport is as
61335 follows:
61336 </para>
61337 <literallayout class="monospaced">
61338 my_mailboxes:
61339   driver = appendfile
61340   file = /var/mail/$domain/$local_part
61341   user = mail
61342 </literallayout>
61343 <para>
61344 This uses a directory of mailboxes for each domain. The <option>user</option> setting is
61345 required, to specify which uid is to be used for writing to the mailboxes.
61346 </para>
61347 <para>
61348 The configuration shown here is just one example of how you might support this
61349 requirement. There are many other ways this kind of configuration can be set
61350 up, for example, by using a database instead of separate files to hold all the
61351 information about the domains.
61352 </para>
61353 </section>
61354 <section id="SECTmulbox">
61355 <title>Multiple user mailboxes</title>
61356 <para>
61357 <indexterm role="concept">
61358 <primary>multiple mailboxes</primary>
61359 </indexterm>
61360 <indexterm role="concept">
61361 <primary>mailbox</primary>
61362 <secondary>multiple</secondary>
61363 </indexterm>
61364 <indexterm role="concept">
61365 <primary>local part</primary>
61366 <secondary>prefix</secondary>
61367 </indexterm>
61368 <indexterm role="concept">
61369 <primary>local part</primary>
61370 <secondary>suffix</secondary>
61371 </indexterm>
61372 Heavy email users often want to operate with multiple mailboxes, into which
61373 incoming mail is automatically sorted. A popular way of handling this is to
61374 allow users to use multiple sender addresses, so that replies can easily be
61375 identified. Users are permitted to add prefixes or suffixes to their local
61376 parts for this purpose. The wildcard facility of the generic router options
61377 <option>local_part_prefix</option> and <option>local_part_suffix</option> can be used for this. For
61378 example, consider this router:
61379 </para>
61380 <literallayout class="monospaced">
61381 userforward:
61382   driver = redirect
61383   check_local_user
61384   file = $home/.forward
61385   local_part_suffix = -*
61386   local_part_suffix_optional
61387   allow_filter
61388 </literallayout>
61389 <para>
61390 <indexterm role="variable">
61391 <primary><varname>$local_part_suffix</varname></primary>
61392 </indexterm>
61393 It runs a user&#x2019;s <filename>.forward</filename> file for all local parts of the form
61394 <emphasis>username-*</emphasis>. Within the filter file the user can distinguish different
61395 cases by testing the variable <varname>$local_part_suffix</varname>. For example:
61396 </para>
61397 <literallayout class="monospaced">
61398 if $local_part_suffix contains -special then
61399 save /home/$local_part/Mail/special
61400 endif
61401 </literallayout>
61402 <para>
61403 If the filter file does not exist, or does not deal with such addresses, they
61404 fall through to subsequent routers, and, assuming no subsequent use of the
61405 <option>local_part_suffix</option> option is made, they presumably fail. Thus, users have
61406 control over which suffixes are valid.
61407 </para>
61408 <para>
61409 Alternatively, a suffix can be used to trigger the use of a different
61410 <filename>.forward</filename> file &ndash; which is the way a similar facility is implemented in
61411 another MTA:
61412 </para>
61413 <literallayout class="monospaced">
61414 userforward:
61415   driver = redirect
61416   check_local_user
61417   file = $home/.forward$local_part_suffix
61418   local_part_suffix = -*
61419   local_part_suffix_optional
61420   allow_filter
61421 </literallayout>
61422 <para>
61423 If there is no suffix, <filename>.forward</filename> is used; if the suffix is <emphasis>-special</emphasis>, for
61424 example, <filename>.forward-special</filename> is used. Once again, if the appropriate file
61425 does not exist, or does not deal with the address, it is passed on to
61426 subsequent routers, which could, if required, look for an unqualified
61427 <filename>.forward</filename> file to use as a default.
61428 </para>
61429 </section>
61430 <section id="SECID244">
61431 <title>Simplified vacation processing</title>
61432 <para>
61433 <indexterm role="concept">
61434 <primary>vacation processing</primary>
61435 </indexterm>
61436 The traditional way of running the <emphasis>vacation</emphasis> program is for a user to set up
61437 a pipe command in a <filename>.forward</filename> file
61438 (see section <xref linkend="SECTspecitredli"/> for syntax details).
61439 This is prone to error by inexperienced users. There are two features of Exim
61440 that can be used to make this process simpler for users:
61441 </para>
61442 <itemizedlist>
61443 <listitem>
61444 <para>
61445 A local part prefix such as <quote>vacation-</quote> can be specified on a router which
61446 can cause the message to be delivered directly to the <emphasis>vacation</emphasis> program, or
61447 alternatively can use Exim&#x2019;s <command>autoreply</command> transport. The contents of a user&#x2019;s
61448 <filename>.forward</filename> file are then much simpler. For example:
61449 </para>
61450 <literallayout class="monospaced">
61451 spqr, vacation-spqr
61452 </literallayout>
61453 </listitem>
61454 <listitem>
61455 <para>
61456 The <option>require_files</option> generic router option can be used to trigger a
61457 vacation delivery by checking for the existence of a certain file in the
61458 user&#x2019;s home directory. The <option>unseen</option> generic option should also be used, to
61459 ensure that the original delivery also proceeds. In this case, all the user has
61460 to do is to create a file called, say, <filename>.vacation</filename>, containing a vacation
61461 message.
61462 </para>
61463 </listitem>
61464 </itemizedlist>
61465 <para>
61466 Another advantage of both these methods is that they both work even when the
61467 use of arbitrary pipes by users is locked out.
61468 </para>
61469 </section>
61470 <section id="SECID245">
61471 <title>Taking copies of mail</title>
61472 <para>
61473 <indexterm role="concept">
61474 <primary>message</primary>
61475 <secondary>copying every</secondary>
61476 </indexterm>
61477 Some installations have policies that require archive copies of all messages to
61478 be made. A single copy of each message can easily be taken by an appropriate
61479 command in a system filter, which could, for example, use a different file for
61480 each day&#x2019;s messages.
61481 </para>
61482 <para>
61483 There is also a shadow transport mechanism that can be used to take copies of
61484 messages that are successfully delivered by local transports, one copy per
61485 delivery. This could be used, <emphasis>inter alia</emphasis>, to implement automatic
61486 notification of delivery by sites that insist on doing such things.
61487 </para>
61488 </section>
61489 <section id="SECID246">
61490 <title>Intermittently connected hosts</title>
61491 <para>
61492 <indexterm role="concept">
61493 <primary>intermittently connected hosts</primary>
61494 </indexterm>
61495 It has become quite common (because it is cheaper) for hosts to connect to the
61496 Internet periodically rather than remain connected all the time. The normal
61497 arrangement is that mail for such hosts accumulates on a system that is
61498 permanently connected.
61499 </para>
61500 <para>
61501 Exim was designed for use on permanently connected hosts, and so it is not
61502 particularly well-suited to use in an intermittently connected environment.
61503 Nevertheless there are some features that can be used.
61504 </para>
61505 </section>
61506 <section id="SECID247">
61507 <title>Exim on the upstream server host</title>
61508 <para>
61509 It is tempting to arrange for incoming mail for the intermittently connected
61510 host to remain on Exim&#x2019;s queue until the client connects. However, this
61511 approach does not scale very well. Two different kinds of waiting message are
61512 being mixed up in the same queue &ndash; those that cannot be delivered because of
61513 some temporary problem, and those that are waiting for their destination host
61514 to connect. This makes it hard to manage the queue, as well as wasting
61515 resources, because each queue runner scans the entire queue.
61516 </para>
61517 <para>
61518 A better approach is to separate off those messages that are waiting for an
61519 intermittently connected host. This can be done by delivering these messages
61520 into local files in batch SMTP, <quote>mailstore</quote>, or other envelope-preserving
61521 format, from where they are transmitted by other software when their
61522 destination connects. This makes it easy to collect all the mail for one host
61523 in a single directory, and to apply local timeout rules on a per-message basis
61524 if required.
61525 </para>
61526 <para>
61527 On a very small scale, leaving the mail on Exim&#x2019;s queue can be made to work. If
61528 you are doing this, you should configure Exim with a long retry period for the
61529 intermittent host. For example:
61530 </para>
61531 <literallayout class="monospaced">
61532 cheshire.wonderland.fict.example    *   F,5d,24h
61533 </literallayout>
61534 <para>
61535 This stops a lot of failed delivery attempts from occurring, but Exim remembers
61536 which messages it has queued up for that host. Once the intermittent host comes
61537 online, forcing delivery of one message (either by using the <option>-M</option> or <option>-R</option>
61538 options, or by using the ETRN SMTP command (see section <xref linkend="SECTETRN"/>)
61539 causes all the queued up messages to be delivered, often down a single SMTP
61540 connection. While the host remains connected, any new messages get delivered
61541 immediately.
61542 </para>
61543 <para>
61544 If the connecting hosts do not have fixed IP addresses, that is, if a host is
61545 issued with a different IP address each time it connects, Exim&#x2019;s retry
61546 mechanisms on the holding host get confused, because the IP address is normally
61547 used as part of the key string for holding retry information. This can be
61548 avoided by unsetting <option>retry_include_ip_address</option> on the <command>smtp</command> transport.
61549 Since this has disadvantages for permanently connected hosts, it is best to
61550 arrange a separate transport for the intermittently connected ones.
61551 </para>
61552 </section>
61553 <section id="SECID248">
61554 <title>Exim on the intermittently connected client host</title>
61555 <para>
61556 The value of <option>smtp_accept_queue_per_connection</option> should probably be
61557 increased, or even set to zero (that is, disabled) on the intermittently
61558 connected host, so that all incoming messages down a single connection get
61559 delivered immediately.
61560 </para>
61561 <para>
61562 <indexterm role="concept">
61563 <primary>SMTP</primary>
61564 <secondary>passed connection</secondary>
61565 </indexterm>
61566 <indexterm role="concept">
61567 <primary>SMTP</primary>
61568 <secondary>multiple deliveries</secondary>
61569 </indexterm>
61570 <indexterm role="concept">
61571 <primary>multiple SMTP deliveries</primary>
61572 </indexterm>
61573 Mail waiting to be sent from an intermittently connected host will probably
61574 not have been routed, because without a connection DNS lookups are not
61575 possible. This means that if a normal queue run is done at connection time,
61576 each message is likely to be sent in a separate SMTP session. This can be
61577 avoided by starting the queue run with a command line option beginning with
61578 <option>-qq</option> instead of <option>-q</option>. In this case, the queue is scanned twice. In the
61579 first pass, routing is done but no deliveries take place. The second pass is a
61580 normal queue run; since all the messages have been previously routed, those
61581 destined for the same host are likely to get sent as multiple deliveries in a
61582 single SMTP connection.
61583 </para>
61584 </section>
61585 </chapter>
61586
61587 <chapter id="CHAPnonqueueing">
61588 <title>Using Exim as a non-queueing client</title>
61589 <titleabbrev>Exim as a non-queueing client</titleabbrev>
61590 <para>
61591 <indexterm role="concept">
61592 <primary>client, non-queueing</primary>
61593 </indexterm>
61594 <indexterm role="concept">
61595 <primary>smart host</primary>
61596 <secondary>suppressing queueing</secondary>
61597 </indexterm>
61598 On a personal computer, it is a common requirement for all
61599 email to be sent to a <quote>smart host</quote>. There are plenty of MUAs that can be
61600 configured to operate that way, for all the popular operating systems.
61601 However, there are some MUAs for Unix-like systems that cannot be so
61602 configured: they submit messages using the command line interface of
61603 <filename>/usr/sbin/sendmail</filename>. Furthermore, utility programs such as <emphasis>cron</emphasis> submit
61604 messages this way.
61605 </para>
61606 <para>
61607 If the personal computer runs continuously, there is no problem, because it can
61608 run a conventional MTA that handles delivery to the smart host, and deal with
61609 any delays via its queueing mechanism. However, if the computer does not run
61610 continuously or runs different operating systems at different times, queueing
61611 email is not desirable.
61612 </para>
61613 <para>
61614 There is therefore a requirement for something that can provide the
61615 <filename>/usr/sbin/sendmail</filename> interface but deliver messages to a smart host without
61616 any queueing or retrying facilities. Furthermore, the delivery to the smart
61617 host should be synchronous, so that if it fails, the sending MUA is immediately
61618 informed. In other words, we want something that extends an MUA that submits
61619 to a local MTA via the command line so that it behaves like one that submits
61620 to a remote smart host using TCP/SMTP.
61621 </para>
61622 <para>
61623 There are a number of applications (for example, there is one called <emphasis>ssmtp</emphasis>)
61624 that do this job. However, people have found them to be lacking in various
61625 ways. For instance, you might want to allow aliasing and forwarding to be done
61626 before sending a message to the smart host.
61627 </para>
61628 <para>
61629 Exim already had the necessary infrastructure for doing this job. Just a few
61630 tweaks were needed to make it behave as required, though it is somewhat of an
61631 overkill to use a fully-featured MTA for this purpose.
61632 </para>
61633 <para>
61634 <indexterm role="option">
61635 <primary><option>mua_wrapper</option></primary>
61636 </indexterm>
61637 There is a Boolean global option called <option>mua_wrapper</option>, defaulting false.
61638 Setting <option>mua_wrapper</option> true causes Exim to run in a special mode where it
61639 assumes that it is being used to <quote>wrap</quote> a command-line MUA in the manner
61640 just described. As well as setting <option>mua_wrapper</option>, you also need to provide a
61641 compatible router and transport configuration. Typically there will be just one
61642 router and one transport, sending everything to a smart host.
61643 </para>
61644 <para>
61645 When run in MUA wrapping mode, the behaviour of Exim changes in the
61646 following ways:
61647 </para>
61648 <itemizedlist>
61649 <listitem>
61650 <para>
61651 A daemon cannot be run, nor will Exim accept incoming messages from <emphasis>inetd</emphasis>.
61652 In other words, the only way to submit messages is via the command line.
61653 </para>
61654 </listitem>
61655 <listitem>
61656 <para>
61657 Each message is synchronously delivered as soon as it is received (<option>-odi</option> is
61658 assumed). All queueing options (<option>queue_only</option>, <option>queue_smtp_domains</option>,
61659 <option>control</option> in an ACL, etc.) are quietly ignored. The Exim reception process
61660 does not finish until the delivery attempt is complete. If the delivery is
61661 successful, a zero return code is given.
61662 </para>
61663 </listitem>
61664 <listitem>
61665 <para>
61666 Address redirection is permitted, but the final routing for all addresses must
61667 be to the same remote transport, and to the same list of hosts. Furthermore,
61668 the return address (envelope sender) must be the same for all recipients, as
61669 must any added or deleted header lines. In other words, it must be possible to
61670 deliver the message in a single SMTP transaction, however many recipients there
61671 are.
61672 </para>
61673 </listitem>
61674 <listitem>
61675 <para>
61676 If these conditions are not met, or if routing any address results in a
61677 failure or defer status, or if Exim is unable to deliver all the recipients
61678 successfully to one of the smart hosts, delivery of the entire message fails.
61679 </para>
61680 </listitem>
61681 <listitem>
61682 <para>
61683 Because no queueing is allowed, all failures are treated as permanent; there
61684 is no distinction between 4<emphasis>xx</emphasis> and 5<emphasis>xx</emphasis> SMTP response codes from the
61685 smart host. Furthermore, because only a single yes/no response can be given to
61686 the caller, it is not possible to deliver to some recipients and not others. If
61687 there is an error (temporary or permanent) for any recipient, all are failed.
61688 </para>
61689 </listitem>
61690 <listitem>
61691 <para>
61692 If more than one smart host is listed, Exim will try another host after a
61693 connection failure or a timeout, in the normal way. However, if this kind of
61694 failure happens for all the hosts, the delivery fails.
61695 </para>
61696 </listitem>
61697 <listitem>
61698 <para>
61699 When delivery fails, an error message is written to the standard error stream
61700 (as well as to Exim&#x2019;s log), and Exim exits to the caller with a return code
61701 value 1. The message is expunged from Exim&#x2019;s spool files. No bounce messages
61702 are ever generated.
61703 </para>
61704 </listitem>
61705 <listitem>
61706 <para>
61707 No retry data is maintained, and any retry rules are ignored.
61708 </para>
61709 </listitem>
61710 <listitem>
61711 <para>
61712 A number of Exim options are overridden: <option>deliver_drop_privilege</option> is forced
61713 true, <option>max_rcpt</option> in the <command>smtp</command> transport is forced to <quote>unlimited</quote>,
61714 <option>remote_max_parallel</option> is forced to one, and fallback hosts are ignored.
61715 </para>
61716 </listitem>
61717 </itemizedlist>
61718 <para>
61719 The overall effect is that Exim makes a single synchronous attempt to deliver
61720 the message, failing if there is any kind of problem. Because no local
61721 deliveries are done and no daemon can be run, Exim does not need root
61722 privilege. It should be possible to run it setuid to <emphasis>exim</emphasis> instead of setuid
61723 to <emphasis>root</emphasis>. See section <xref linkend="SECTrunexiwitpri"/> for a general discussion about
61724 the advantages and disadvantages of running without root privilege.
61725 </para>
61726 </chapter>
61727
61728 <chapter id="CHAPlog">
61729 <title>Log files</title>
61730 <para>
61731 <indexterm role="concept" id="IIDloggen" class="startofrange">
61732 <primary>log</primary>
61733 <secondary>general description</secondary>
61734 </indexterm>
61735 <indexterm role="concept">
61736 <primary>log</primary>
61737 <secondary>types of</secondary>
61738 </indexterm>
61739 Exim writes three different logs, referred to as the main log, the reject log,
61740 and the panic log:
61741 </para>
61742 <itemizedlist>
61743 <listitem>
61744 <para>
61745 <indexterm role="concept">
61746 <primary>main log</primary>
61747 </indexterm>
61748 The main log records the arrival of each message and each delivery in a single
61749 line in each case. The format is as compact as possible, in an attempt to keep
61750 down the size of log files. Two-character flag sequences make it easy to pick
61751 out these lines. A number of other events are recorded in the main log. Some of
61752 them are optional, in which case the <option>log_selector</option> option controls whether
61753 they are included or not. A Perl script called <emphasis>eximstats</emphasis>, which does simple
61754 analysis of main log files, is provided in the Exim distribution (see section
61755 <xref linkend="SECTmailstat"/>).
61756 </para>
61757 </listitem>
61758 <listitem>
61759 <para>
61760 <indexterm role="concept">
61761 <primary>reject log</primary>
61762 </indexterm>
61763 The reject log records information from messages that are rejected as a result
61764 of a configuration option (that is, for policy reasons).
61765 The first line of each rejection is a copy of the line that is also written to
61766 the main log. Then, if the message&#x2019;s header has been read at the time the log
61767 is written, its contents are written to this log. Only the original header
61768 lines are available; header lines added by ACLs are not logged. You can use the
61769 reject log to check that your policy controls are working correctly; on a busy
61770 host this may be easier than scanning the main log for rejection messages. You
61771 can suppress the writing of the reject log by setting <option>write_rejectlog</option>
61772 false.
61773 </para>
61774 </listitem>
61775 <listitem>
61776 <para>
61777 <indexterm role="concept">
61778 <primary>panic log</primary>
61779 </indexterm>
61780 <indexterm role="concept">
61781 <primary>system log</primary>
61782 </indexterm>
61783 When certain serious errors occur, Exim writes entries to its panic log. If the
61784 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
61785 are usually written to the main log as well, but can get lost amid the mass of
61786 other entries. The panic log should be empty under normal circumstances. It is
61787 therefore a good idea to check it (or to have a <emphasis>cron</emphasis> script check it)
61788 regularly, in order to become aware of any problems. When Exim cannot open its
61789 panic log, it tries as a last resort to write to the system log (syslog). This
61790 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
61791 message itself is written at priority LOG_CRIT.
61792 </para>
61793 </listitem>
61794 </itemizedlist>
61795 <para>
61796 Every log line starts with a timestamp, in the format shown in the following
61797 example. Note that many of the examples shown in this chapter are line-wrapped.
61798 In the log file, this would be all on one line:
61799 </para>
61800 <literallayout class="monospaced">
61801 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
61802   by QUIT
61803 </literallayout>
61804 <para>
61805 By default, the timestamps are in the local timezone. There are two
61806 ways of changing this:
61807 </para>
61808 <itemizedlist>
61809 <listitem>
61810 <para>
61811 You can set the <option>timezone</option> option to a different time zone; in particular, if
61812 you set
61813 </para>
61814 <literallayout class="monospaced">
61815 timezone = UTC
61816 </literallayout>
61817 <para>
61818 the timestamps will be in UTC (aka GMT).
61819 </para>
61820 </listitem>
61821 <listitem>
61822 <para>
61823 If you set <option>log_timezone</option> true, the time zone is added to the timestamp, for
61824 example:
61825 </para>
61826 <literallayout class="monospaced">
61827 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
61828 </literallayout>
61829 </listitem>
61830 </itemizedlist>
61831 <para>
61832 <indexterm role="concept">
61833 <primary>log</primary>
61834 <secondary>process ids in</secondary>
61835 </indexterm>
61836 <indexterm role="concept">
61837 <primary>pid (process id)</primary>
61838 <secondary>in log lines</secondary>
61839 </indexterm>
61840 Exim does not include its process id in log lines by default, but you can
61841 request that it does so by specifying the <literal>pid</literal> log selector (see section
61842 <xref linkend="SECTlogselector"/>). When this is set, the process id is output, in square
61843 brackets, immediately after the time and date.
61844 </para>
61845 <section id="SECTwhelogwri">
61846 <title>Where the logs are written</title>
61847 <para>
61848 <indexterm role="concept">
61849 <primary>log</primary>
61850 <secondary>destination</secondary>
61851 </indexterm>
61852 <indexterm role="concept">
61853 <primary>log</primary>
61854 <secondary>to file</secondary>
61855 </indexterm>
61856 <indexterm role="concept">
61857 <primary>log</primary>
61858 <secondary>to syslog</secondary>
61859 </indexterm>
61860 <indexterm role="concept">
61861 <primary>syslog</primary>
61862 </indexterm>
61863 The logs may be written to local files, or to syslog, or both. However, it
61864 should be noted that many syslog implementations use UDP as a transport, and
61865 are therefore unreliable in the sense that messages are not guaranteed to
61866 arrive at the loghost, nor is the ordering of messages necessarily maintained.
61867 It has also been reported that on large log files (tens of megabytes) you may
61868 need to tweak syslog to prevent it syncing the file with each write &ndash; on
61869 Linux this has been seen to make syslog take 90% plus of CPU time.
61870 </para>
61871 <para>
61872 The destination for Exim&#x2019;s logs is configured by setting LOG_FILE_PATH in
61873 <filename>Local/Makefile</filename> or by setting <option>log_file_path</option> in the run time
61874 configuration. This latter string is expanded, so it can contain, for example,
61875 references to the host name:
61876 </para>
61877 <literallayout class="monospaced">
61878 log_file_path = /var/log/$primary_hostname/exim_%slog
61879 </literallayout>
61880 <para>
61881 It is generally advisable, however, to set the string in <filename>Local/Makefile</filename>
61882 rather than at run time, because then the setting is available right from the
61883 start of Exim&#x2019;s execution. Otherwise, if there&#x2019;s something it wants to log
61884 before it has read the configuration file (for example, an error in the
61885 configuration file) it will not use the path you want, and may not be able to
61886 log at all.
61887 </para>
61888 <para>
61889 The value of LOG_FILE_PATH or <option>log_file_path</option> is a colon-separated
61890 list, currently limited to at most two items. This is one option where the
61891 facility for changing a list separator may not be used. The list must always be
61892 colon-separated. If an item in the list is <quote>syslog</quote> then syslog is used;
61893 otherwise the item must either be an absolute path, containing <literal>%s</literal> at the
61894 point where <quote>main</quote>, <quote>reject</quote>, or <quote>panic</quote> is to be inserted, or be empty,
61895 implying the use of a default path.
61896 </para>
61897 <para>
61898 When Exim encounters an empty item in the list, it searches the list defined by
61899 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
61900 <quote>syslog</quote>. This means that an empty item in <option>log_file_path</option> can be used to
61901 mean <quote>use the path specified at build time</quote>. It no such item exists, log
61902 files are written in the <filename>log</filename> subdirectory of the spool directory. This is
61903 equivalent to the setting:
61904 </para>
61905 <literallayout class="monospaced">
61906 log_file_path = $spool_directory/log/%slog
61907 </literallayout>
61908 <para>
61909 If you do not specify anything at build time or run time, that is where the
61910 logs are written.
61911 </para>
61912 <para>
61913 A log file path may also contain <literal>%D</literal> or <literal>%M</literal> if datestamped log file names
61914 are in use &ndash; see section <xref linkend="SECTdatlogfil"/> below.
61915 </para>
61916 <para>
61917 Here are some examples of possible settings:
61918 </para>
61919 <literallayout>
61920 <literal>LOG_FILE_PATH=syslog                    </literal> syslog only
61921 <literal>LOG_FILE_PATH=:syslog                   </literal> syslog and default path
61922 <literal>LOG_FILE_PATH=syslog : /usr/log/exim_%s </literal> syslog and specified path
61923 <literal>LOG_FILE_PATH=/usr/log/exim_%s          </literal> specified path only
61924 </literallayout>
61925 <para>
61926 If there are more than two paths in the list, the first is used and a panic
61927 error is logged.
61928 </para>
61929 </section>
61930 <section id="SECID285">
61931 <title>Logging to local files that are periodically <quote>cycled</quote></title>
61932 <para>
61933 <indexterm role="concept">
61934 <primary>log</primary>
61935 <secondary>cycling local files</secondary>
61936 </indexterm>
61937 <indexterm role="concept">
61938 <primary>cycling logs</primary>
61939 </indexterm>
61940 <indexterm role="concept">
61941 <primary><emphasis>exicyclog</emphasis></primary>
61942 </indexterm>
61943 <indexterm role="concept">
61944 <primary>log</primary>
61945 <secondary>local files; writing to</secondary>
61946 </indexterm>
61947 Some operating systems provide centralized and standardized methods for cycling
61948 log files. For those that do not, a utility script called <emphasis>exicyclog</emphasis> is
61949 provided (see section <xref linkend="SECTcyclogfil"/>). This renames and compresses the
61950 main and reject logs each time it is called. The maximum number of old logs to
61951 keep can be set. It is suggested this script is run as a daily <emphasis>cron</emphasis> job.
61952 </para>
61953 <para>
61954 An Exim delivery process opens the main log when it first needs to write to it,
61955 and it keeps the file open in case subsequent entries are required &ndash; for
61956 example, if a number of different deliveries are being done for the same
61957 message. However, remote SMTP deliveries can take a long time, and this means
61958 that the file may be kept open long after it is renamed if <emphasis>exicyclog</emphasis> or
61959 something similar is being used to rename log files on a regular basis. To
61960 ensure that a switch of log files is noticed as soon as possible, Exim calls
61961 <function>stat()</function> on the main log&#x2019;s name before reusing an open file, and if the file
61962 does not exist, or its inode has changed, the old file is closed and Exim
61963 tries to open the main log from scratch. Thus, an old log file may remain open
61964 for quite some time, but no Exim processes should write to it once it has been
61965 renamed.
61966 </para>
61967 </section>
61968 <section id="SECTdatlogfil">
61969 <title>Datestamped log files</title>
61970 <para>
61971 <indexterm role="concept">
61972 <primary>log</primary>
61973 <secondary>datestamped files</secondary>
61974 </indexterm>
61975 Instead of cycling the main and reject log files by renaming them
61976 periodically, some sites like to use files whose names contain a datestamp,
61977 for example, <filename>mainlog-20031225</filename>. The datestamp is in the form <filename>yyyymmdd</filename> or
61978 <filename>yyyymm</filename>. Exim has support for this way of working. It is enabled by setting
61979 the <option>log_file_path</option> option to a path that includes <literal>%D</literal> or <literal>%M</literal> at the
61980 point where the datestamp is required. For example:
61981 </para>
61982 <literallayout class="monospaced">
61983 log_file_path = /var/spool/exim/log/%slog-%D
61984 log_file_path = /var/log/exim-%s-%D.log
61985 log_file_path = /var/spool/exim/log/%D-%slog
61986 log_file_path = /var/log/exim/%s.%M
61987 </literallayout>
61988 <para>
61989 As before, <literal>%s</literal> is replaced by <quote>main</quote> or <quote>reject</quote>; the following are
61990 examples of names generated by the above examples:
61991 </para>
61992 <literallayout class="monospaced">
61993 /var/spool/exim/log/mainlog-20021225
61994 /var/log/exim-reject-20021225.log
61995 /var/spool/exim/log/20021225-mainlog
61996 /var/log/exim/main.200212
61997 </literallayout>
61998 <para>
61999 When this form of log file is specified, Exim automatically switches to new
62000 files at midnight. It does not make any attempt to compress old logs; you
62001 will need to write your own script if you require this. You should not
62002 run <emphasis>exicyclog</emphasis> with this form of logging.
62003 </para>
62004 <para>
62005 The location of the panic log is also determined by <option>log_file_path</option>, but it
62006 is not datestamped, because rotation of the panic log does not make sense.
62007 When generating the name of the panic log, <literal>%D</literal> or <literal>%M</literal> are removed from
62008 the string. In addition, if it immediately follows a slash, a following
62009 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
62010 character is removed. Thus, the four examples above would give these panic
62011 log names:
62012 </para>
62013 <literallayout class="monospaced">
62014 /var/spool/exim/log/paniclog
62015 /var/log/exim-panic.log
62016 /var/spool/exim/log/paniclog
62017 /var/log/exim/panic
62018 </literallayout>
62019 </section>
62020 <section id="SECID249">
62021 <title>Logging to syslog</title>
62022 <para>
62023 <indexterm role="concept">
62024 <primary>log</primary>
62025 <secondary>syslog; writing to</secondary>
62026 </indexterm>
62027 The use of syslog does not change what Exim logs or the format of its messages,
62028 except in one respect. If <option>syslog_timestamp</option> is set false, the timestamps on
62029 Exim&#x2019;s log lines are omitted when these lines are sent to syslog. Apart from
62030 that, the same strings are written to syslog as to log files. The syslog
62031 <quote>facility</quote> is set to LOG_MAIL, and the program name to <quote>exim</quote>
62032 by default, but you can change these by setting the <option>syslog_facility</option> and
62033 <option>syslog_processname</option> options, respectively. If Exim was compiled with
62034 SYSLOG_LOG_PID set in <filename>Local/Makefile</filename> (this is the default in
62035 <filename>src/EDITME</filename>), then, on systems that permit it (all except ULTRIX), the
62036 LOG_PID flag is set so that the <function>syslog()</function> call adds the pid as well as
62037 the time and host name to each line.
62038 The three log streams are mapped onto syslog priorities as follows:
62039 </para>
62040 <itemizedlist>
62041 <listitem>
62042 <para>
62043 <emphasis>mainlog</emphasis> is mapped to LOG_INFO
62044 </para>
62045 </listitem>
62046 <listitem>
62047 <para>
62048 <emphasis>rejectlog</emphasis> is mapped to LOG_NOTICE
62049 </para>
62050 </listitem>
62051 <listitem>
62052 <para>
62053 <emphasis>paniclog</emphasis> is mapped to LOG_ALERT
62054 </para>
62055 </listitem>
62056 </itemizedlist>
62057 <para>
62058 Many log lines are written to both <emphasis>mainlog</emphasis> and <emphasis>rejectlog</emphasis>, and some are
62059 written to both <emphasis>mainlog</emphasis> and <emphasis>paniclog</emphasis>, so there will be duplicates if
62060 these are routed by syslog to the same place. You can suppress this duplication
62061 by setting <option>syslog_duplication</option> false.
62062 </para>
62063 <para>
62064 Exim&#x2019;s log lines can sometimes be very long, and some of its <emphasis>rejectlog</emphasis>
62065 entries contain multiple lines when headers are included. To cope with both
62066 these cases, entries written to syslog are split into separate <function>syslog()</function>
62067 calls at each internal newline, and also after a maximum of
62068 870 data characters. (This allows for a total syslog line length of 1024, when
62069 additions such as timestamps are added.) If you are running a syslog
62070 replacement that can handle lines longer than the 1024 characters allowed by
62071 RFC 3164, you should set
62072 </para>
62073 <literallayout class="monospaced">
62074 SYSLOG_LONG_LINES=yes
62075 </literallayout>
62076 <para>
62077 in <filename>Local/Makefile</filename> before building Exim. That stops Exim from splitting long
62078 lines, but it still splits at internal newlines in <emphasis>reject</emphasis> log entries.
62079 </para>
62080 <para>
62081 To make it easy to re-assemble split lines later, each component of a split
62082 entry starts with a string of the form [&lt;<emphasis>n</emphasis>&gt;/&lt;<emphasis>m</emphasis>&gt;] or [&lt;<emphasis>n</emphasis>&gt;\&lt;<emphasis>m</emphasis>&gt;]
62083 where &lt;<emphasis>n</emphasis>&gt; is the component number and &lt;<emphasis>m</emphasis>&gt; is the total number of
62084 components in the entry. The / delimiter is used when the line was split
62085 because it was too long; if it was split because of an internal newline, the \
62086 delimiter is used. For example, supposing the length limit to be 50 instead of
62087 870, the following would be the result of a typical rejection message to
62088 <emphasis>mainlog</emphasis> (LOG_INFO), each line in addition being preceded by the time, host
62089 name, and pid as added by syslog:
62090 </para>
62091 <literallayout class="monospaced">
62092 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
62093 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
62094 [3/5]  when scanning for sender: missing or malformed lo
62095 [4/5] cal part in "&lt;&gt;" (envelope sender is &lt;ph10@cam.exa
62096 [5/5] mple&gt;)
62097 </literallayout>
62098 <para>
62099 The same error might cause the following lines to be written to <quote>rejectlog</quote>
62100 (LOG_NOTICE):
62101 </para>
62102 <literallayout class="monospaced">
62103 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
62104 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
62105 [3/18] er when scanning for sender: missing or malformed
62106 [4/18]  local part in "&lt;&gt;" (envelope sender is &lt;ph10@cam
62107 [5\18] .example&gt;)
62108 [6\18] Recipients: ph10@some.domain.cam.example
62109 [7\18] P Received: from [127.0.0.1] (ident=ph10)
62110 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
62111 [9\18]        id 16RdAL-0006pc-00
62112 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
62113 [11\18] 09:43 +0100
62114 [12\18] F From: &lt;&gt;
62115 [13\18]   Subject: this is a test header
62116 [18\18]   X-something: this is another header
62117 [15/18] I Message-Id: &lt;E16RdAL-0006pc-00@xxxxx.cam.examp
62118 [16\18] le&gt;
62119 [17\18] B Bcc:
62120 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
62121 </literallayout>
62122 <para>
62123 Log lines that are neither too long nor contain newlines are written to syslog
62124 without modification.
62125 </para>
62126 <para>
62127 If only syslog is being used, the Exim monitor is unable to provide a log tail
62128 display, unless syslog is routing <emphasis>mainlog</emphasis> to a file on the local host and
62129 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
62130 where it is.
62131 </para>
62132 </section>
62133 <section id="SECID250">
62134 <title>Log line flags</title>
62135 <para>
62136 One line is written to the main log for each message received, and for each
62137 successful, unsuccessful, and delayed delivery. These lines can readily be
62138 picked out by the distinctive two-character flags that immediately follow the
62139 timestamp. The flags are:
62140 </para>
62141 <literallayout>
62142 <literal>&lt;=</literal>     message arrival
62143 <literal>=&gt;</literal>     normal message delivery
62144 <literal>-&gt;</literal>     additional address in same delivery
62145 <literal>&gt;&gt;</literal>     cutthrough message delivery
62146 <literal>*&gt;</literal>     delivery suppressed by <option>-N</option>
62147 <literal>**</literal>     delivery failed; address bounced
62148 <literal>==</literal>     delivery deferred; temporary problem
62149 </literallayout>
62150 </section>
62151 <section id="SECID251">
62152 <title>Logging message reception</title>
62153 <para>
62154 <indexterm role="concept">
62155 <primary>log</primary>
62156 <secondary>reception line</secondary>
62157 </indexterm>
62158 The format of the single-line entry in the main log that is written for every
62159 message received is shown in the basic example below, which is split over
62160 several lines in order to fit it on the page:
62161 </para>
62162 <literallayout class="monospaced">
62163 2002-10-31 08:57:53 16ZCW1-0005MB-00 &lt;= kryten@dwarf.fict.example
62164   H=mailer.fict.example [192.168.123.123] U=exim
62165   P=smtp S=5678 id=&lt;incoming message id&gt;
62166 </literallayout>
62167 <para>
62168 The address immediately following <quote>&lt;=</quote> is the envelope sender address. A
62169 bounce message is shown with the sender address <quote>&lt;&gt;</quote>, and if it is locally
62170 generated, this is followed by an item of the form
62171 </para>
62172 <literallayout class="monospaced">
62173 R=&lt;message id&gt;
62174 </literallayout>
62175 <para>
62176 which is a reference to the message that caused the bounce to be sent.
62177 </para>
62178 <para>
62179 <indexterm role="concept">
62180 <primary>HELO</primary>
62181 </indexterm>
62182 <indexterm role="concept">
62183 <primary>EHLO</primary>
62184 </indexterm>
62185 For messages from other hosts, the H and U fields identify the remote host and
62186 record the RFC 1413 identity of the user that sent the message, if one was
62187 received. The number given in square brackets is the IP address of the sending
62188 host. If there is a single, unparenthesized  host name in the H field, as
62189 above, it has been verified to correspond to the IP address (see the
62190 <option>host_lookup</option> option). If the name is in parentheses, it was the name quoted
62191 by the remote host in the SMTP HELO or EHLO command, and has not been
62192 verified. If verification yields a different name to that given for HELO or
62193 EHLO, the verified name appears first, followed by the HELO or EHLO
62194 name in parentheses.
62195 </para>
62196 <para>
62197 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
62198 without brackets, in the HELO or EHLO command, leading to entries in
62199 the log containing text like these examples:
62200 </para>
62201 <literallayout class="monospaced">
62202 H=(10.21.32.43) [192.168.8.34]
62203 H=([10.21.32.43]) [192.168.8.34]
62204 </literallayout>
62205 <para>
62206 This can be confusing. Only the final address in square brackets can be relied
62207 on.
62208 </para>
62209 <para>
62210 For locally generated messages (that is, messages not received over TCP/IP),
62211 the H field is omitted, and the U field contains the login name of the caller
62212 of Exim.
62213 </para>
62214 <para>
62215 <indexterm role="concept">
62216 <primary>authentication</primary>
62217 <secondary>logging</secondary>
62218 </indexterm>
62219 <indexterm role="concept">
62220 <primary>AUTH</primary>
62221 <secondary>logging</secondary>
62222 </indexterm>
62223 For all messages, the P field specifies the protocol used to receive the
62224 message. This is the value that is stored in <varname>$received_protocol</varname>. In the case
62225 of incoming SMTP messages, the value indicates whether or not any SMTP
62226 extensions (ESMTP), encryption, or authentication were used. If the SMTP
62227 session was encrypted, there is an additional X field that records the cipher
62228 suite that was used.
62229 </para>
62230 <para>
62231 The protocol is set to <quote>esmtpsa</quote> or <quote>esmtpa</quote> for messages received from
62232 hosts that have authenticated themselves using the SMTP AUTH command. The first
62233 value is used when the SMTP connection was encrypted (<quote>secure</quote>). In this case
62234 there is an additional item A= followed by the name of the authenticator that
62235 was used. If an authenticated identification was set up by the authenticator&#x2019;s
62236 <option>server_set_id</option> option, this is logged too, separated by a colon from the
62237 authenticator name.
62238 </para>
62239 <para>
62240 <indexterm role="concept">
62241 <primary>size</primary>
62242 <secondary>of message</secondary>
62243 </indexterm>
62244 The id field records the existing message id, if present. The size of the
62245 received message is given by the S field. When the message is delivered,
62246 headers may be removed or added, so that the size of delivered copies of the
62247 message may not correspond with this value (and indeed may be different to each
62248 other).
62249 </para>
62250 <para>
62251 The <option>log_selector</option> option can be used to request the logging of additional
62252 data when a message is received. See section <xref linkend="SECTlogselector"/> below.
62253 </para>
62254 </section>
62255 <section id="SECID252">
62256 <title>Logging deliveries</title>
62257 <para>
62258 <indexterm role="concept">
62259 <primary>log</primary>
62260 <secondary>delivery line</secondary>
62261 </indexterm>
62262 The format of the single-line entry in the main log that is written for every
62263 delivery is shown in one of the examples below, for local and remote
62264 deliveries, respectively. Each example has been split into two lines in order
62265 to fit it on the page:
62266 </para>
62267 <literallayout class="monospaced">
62268 2002-10-31 08:59:13 16ZCW1-0005MB-00 =&gt; marv
62269   &lt;marv@hitch.fict.example&gt; R=localuser T=local_delivery
62270 2002-10-31 09:00:10 16ZCW1-0005MB-00 =&gt;
62271   monk@holistic.fict.example R=dnslookup T=remote_smtp
62272   H=holistic.fict.example [192.168.234.234]
62273 </literallayout>
62274 <para>
62275 For ordinary local deliveries, the original address is given in angle brackets
62276 after the final delivery address, which might be a pipe or a file. If
62277 intermediate address(es) exist between the original and the final address, the
62278 last of these is given in parentheses after the final address. The R and T
62279 fields record the router and transport that were used to process the address.
62280 </para>
62281 <para>
62282 If SMTP AUTH was used for the delivery there is an additional item A=
62283 followed by the name of the authenticator that was used.
62284 If an authenticated identification was set up by the authenticator&#x2019;s <option>client_set_id</option>
62285 option, this is logged too, separated by a colon from the authenticator name.
62286 </para>
62287 <para>
62288 If a shadow transport was run after a successful local delivery, the log line
62289 for the successful delivery has an item added on the end, of the form
62290 </para>
62291 <literallayout>
62292 <literal>ST=&lt;</literal><emphasis>shadow transport name</emphasis><literal>&gt;</literal>
62293 </literallayout>
62294 <para>
62295 If the shadow transport did not succeed, the error message is put in
62296 parentheses afterwards.
62297 </para>
62298 <para>
62299 <indexterm role="concept">
62300 <primary>asterisk</primary>
62301 <secondary>after IP address</secondary>
62302 </indexterm>
62303 When more than one address is included in a single delivery (for example, two
62304 SMTP RCPT commands in one transaction) the second and subsequent addresses are
62305 flagged with <literal>-&gt;</literal> instead of <literal>=&gt;</literal>. When two or more messages are delivered
62306 down a single SMTP connection, an asterisk follows the IP address in the log
62307 lines for the second and subsequent messages.
62308 </para>
62309 <para>
62310 <indexterm role="concept">
62311 <primary>delivery</primary>
62312 <secondary>cutthrough; logging</secondary>
62313 </indexterm>
62314 <indexterm role="concept">
62315 <primary>cutthrough</primary>
62316 <secondary>logging</secondary>
62317 </indexterm>
62318 When delivery is done in cutthrough mode it is flagged with <literal>&gt;&gt;</literal> and the log
62319 line precedes the reception line, since cutthrough waits for a possible
62320 rejection from the destination in case it can reject the sourced item.
62321 </para>
62322 <para>
62323 The generation of a reply message by a filter file gets logged as a
62324 <quote>delivery</quote> to the addressee, preceded by <quote>&gt;</quote>.
62325 </para>
62326 <para>
62327 The <option>log_selector</option> option can be used to request the logging of additional
62328 data when a message is delivered. See section <xref linkend="SECTlogselector"/> below.
62329 </para>
62330 </section>
62331 <section id="SECID253">
62332 <title>Discarded deliveries</title>
62333 <para>
62334 <indexterm role="concept">
62335 <primary>discarded messages</primary>
62336 </indexterm>
62337 <indexterm role="concept">
62338 <primary>message</primary>
62339 <secondary>discarded</secondary>
62340 </indexterm>
62341 <indexterm role="concept">
62342 <primary>delivery</primary>
62343 <secondary>discarded; logging</secondary>
62344 </indexterm>
62345 When a message is discarded as a result of the command <quote>seen finish</quote> being
62346 obeyed in a filter file which generates no deliveries, a log entry of the form
62347 </para>
62348 <literallayout class="monospaced">
62349 2002-12-10 00:50:49 16auJc-0001UB-00 =&gt; discarded
62350   &lt;low.club@bridge.example&gt; R=userforward
62351 </literallayout>
62352 <para>
62353 is written, to record why no deliveries are logged. When a message is discarded
62354 because it is aliased to <quote>:blackhole:</quote> the log line is like this:
62355 </para>
62356 <literallayout class="monospaced">
62357 1999-03-02 09:44:33 10HmaX-0005vi-00 =&gt; :blackhole:
62358   &lt;hole@nowhere.example&gt; R=blackhole_router
62359 </literallayout>
62360 </section>
62361 <section id="SECID254">
62362 <title>Deferred deliveries</title>
62363 <para>
62364 When a delivery is deferred, a line of the following form is logged:
62365 </para>
62366 <literallayout class="monospaced">
62367 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
62368   R=dnslookup T=smtp defer (146): Connection refused
62369 </literallayout>
62370 <para>
62371 In the case of remote deliveries, the error is the one that was given for the
62372 last IP address that was tried. Details of individual SMTP failures are also
62373 written to the log, so the above line would be preceded by something like
62374 </para>
62375 <literallayout class="monospaced">
62376 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
62377   mail1.endrest.example [192.168.239.239]: Connection refused
62378 </literallayout>
62379 <para>
62380 When a deferred address is skipped because its retry time has not been reached,
62381 a message is written to the log, but this can be suppressed by setting an
62382 appropriate value in <option>log_selector</option>.
62383 </para>
62384 </section>
62385 <section id="SECID255">
62386 <title>Delivery failures</title>
62387 <para>
62388 <indexterm role="concept">
62389 <primary>delivery</primary>
62390 <secondary>failure; logging</secondary>
62391 </indexterm>
62392 If a delivery fails because an address cannot be routed, a line of the
62393 following form is logged:
62394 </para>
62395 <literallayout class="monospaced">
62396 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
62397   &lt;jim@trek99.example&gt;: unknown mail domain
62398 </literallayout>
62399 <para>
62400 If a delivery fails at transport time, the router and transport are shown, and
62401 the response from the remote host is included, as in this example:
62402 </para>
62403 <literallayout class="monospaced">
62404 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
62405   R=dnslookup T=remote_smtp: SMTP error from remote mailer
62406   after pipelined RCPT TO:&lt;ace400@pb.example&gt;: host
62407   pbmail3.py.example [192.168.63.111]: 553 5.3.0
62408   &lt;ace400@pb.example&gt;...Addressee unknown
62409 </literallayout>
62410 <para>
62411 The word <quote>pipelined</quote> indicates that the SMTP PIPELINING extension was being
62412 used. See <option>hosts_avoid_esmtp</option> in the <command>smtp</command> transport for a way of
62413 disabling PIPELINING. The log lines for all forms of delivery failure are
62414 flagged with <literal>**</literal>.
62415 </para>
62416 </section>
62417 <section id="SECID256">
62418 <title>Fake deliveries</title>
62419 <para>
62420 <indexterm role="concept">
62421 <primary>delivery</primary>
62422 <secondary>fake; logging</secondary>
62423 </indexterm>
62424 If a delivery does not actually take place because the <option>-N</option> option has been
62425 used to suppress it, a normal delivery line is written to the log, except that
62426 <quote>=&gt;</quote> is replaced by <quote>*&gt;</quote>.
62427 </para>
62428 </section>
62429 <section id="SECID257">
62430 <title>Completion</title>
62431 <para>
62432 A line of the form
62433 </para>
62434 <literallayout class="monospaced">
62435 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
62436 </literallayout>
62437 <para>
62438 is written to the main log when a message is about to be removed from the spool
62439 at the end of its processing.
62440 </para>
62441 </section>
62442 <section id="SECID258">
62443 <title>Summary of Fields in Log Lines</title>
62444 <para>
62445 <indexterm role="concept">
62446 <primary>log</primary>
62447 <secondary>summary of fields</secondary>
62448 </indexterm>
62449 A summary of the field identifiers that are used in log lines is shown in
62450 the following table:
62451 </para>
62452 <literallayout>
62453 <literal>A   </literal>        authenticator name (and optional id and sender)
62454 <literal>C   </literal>        SMTP confirmation on delivery
62455 <literal>    </literal>        command list for <quote>no mail in SMTP session</quote>
62456 <literal>CV  </literal>        certificate verification status
62457 <literal>D   </literal>        duration of <quote>no mail in SMTP session</quote>
62458 <literal>DN  </literal>        distinguished name from peer certificate
62459 <literal>DT  </literal>        on <literal>=&gt;</literal> lines: time taken for a delivery
62460 <literal>F   </literal>        sender address (on delivery lines)
62461 <literal>H   </literal>        host name and IP address
62462 <literal>I   </literal>        local interface used
62463 <literal>id  </literal>        message id for incoming message
62464 <literal>P   </literal>        on <literal>&lt;=</literal> lines: protocol used
62465 <literal>    </literal>        on <literal>=&gt;</literal> and <literal>**</literal> lines: return path
62466 <literal>QT  </literal>        on <literal>=&gt;</literal> lines: time spent on queue so far
62467 <literal>    </literal>        on <quote>Completed</quote> lines: time spent on queue
62468 <literal>R   </literal>        on <literal>&lt;=</literal> lines: reference for local bounce
62469 <literal>    </literal>        on <literal>=&gt;</literal>  <literal>**</literal> and <literal>==</literal> lines: router name
62470 <literal>S   </literal>        size of message
62471 <literal>SNI </literal>        server name indication from TLS client hello
62472 <literal>ST  </literal>        shadow transport name
62473 <literal>T   </literal>        on <literal>&lt;=</literal> lines: message subject (topic)
62474 <literal>    </literal>        on <literal>=&gt;</literal> <literal>**</literal> and <literal>==</literal> lines: transport name
62475 <literal>U   </literal>        local user or RFC 1413 identity
62476 <literal>X   </literal>        TLS cipher suite
62477 </literallayout>
62478 </section>
62479 <section id="SECID259">
62480 <title>Other log entries</title>
62481 <para>
62482 Various other types of log entry are written from time to time. Most should be
62483 self-explanatory. Among the more common are:
62484 </para>
62485 <itemizedlist>
62486 <listitem>
62487 <para>
62488 <indexterm role="concept">
62489 <primary>retry</primary>
62490 <secondary>time not reached</secondary>
62491 </indexterm>
62492 <emphasis>retry time not reached</emphasis>&nbsp;&nbsp;An address previously suffered a temporary error
62493 during routing or local delivery, and the time to retry has not yet arrived.
62494 This message is not written to an individual message log file unless it happens
62495 during the first delivery attempt.
62496 </para>
62497 </listitem>
62498 <listitem>
62499 <para>
62500 <emphasis>retry time not reached for any host</emphasis>&nbsp;&nbsp;An address previously suffered
62501 temporary errors during remote delivery, and the retry time has not yet arrived
62502 for any of the hosts to which it is routed.
62503 </para>
62504 </listitem>
62505 <listitem>
62506 <para>
62507 <indexterm role="concept">
62508 <primary>spool directory</primary>
62509 <secondary>file locked</secondary>
62510 </indexterm>
62511 <emphasis>spool file locked</emphasis>&nbsp;&nbsp;An attempt to deliver a message cannot proceed because
62512 some other Exim process is already working on the message. This can be quite
62513 common if queue running processes are started at frequent intervals. The
62514 <emphasis>exiwhat</emphasis> utility script can be used to find out what Exim processes are
62515 doing.
62516 </para>
62517 </listitem>
62518 <listitem>
62519 <para>
62520 <indexterm role="concept">
62521 <primary>error</primary>
62522 <secondary>ignored</secondary>
62523 </indexterm>
62524 <emphasis>error ignored</emphasis>&nbsp;&nbsp;There are several circumstances that give rise to this
62525 message:
62526 </para>
62527 <orderedlist numeration="arabic">
62528 <listitem>
62529 <para>
62530 Exim failed to deliver a bounce message whose age was greater than
62531 <option>ignore_bounce_errors_after</option>. The bounce was discarded.
62532 </para>
62533 </listitem>
62534 <listitem>
62535 <para>
62536 A filter file set up a delivery using the <quote>noerror</quote> option, and the delivery
62537 failed. The delivery was discarded.
62538 </para>
62539 </listitem>
62540 <listitem>
62541 <para>
62542 A delivery set up by a router configured with
62543 </para>
62544 <literallayout class="monospaced">
62545     errors_to = &lt;&gt;
62546 </literallayout>
62547 <para>
62548 failed. The delivery was discarded.
62549 </para>
62550 </listitem>
62551 </orderedlist>
62552 </listitem>
62553 </itemizedlist>
62554 </section>
62555 <section id="SECTlogselector">
62556 <title>Reducing or increasing what is logged</title>
62557 <para>
62558 <indexterm role="concept">
62559 <primary>log</primary>
62560 <secondary>selectors</secondary>
62561 </indexterm>
62562 By setting the <option>log_selector</option> global option, you can disable some of Exim&#x2019;s
62563 default logging, or you can request additional logging. The value of
62564 <option>log_selector</option> is made up of names preceded by plus or minus characters. For
62565 example:
62566 </para>
62567 <literallayout class="monospaced">
62568 log_selector = +arguments -retry_defer
62569 </literallayout>
62570 <para>
62571 The list of optional log items is in the following table, with the default
62572 selection marked by asterisks:
62573 </para>
62574 <literallayout>
62575 <literal> 8bitmime                   </literal>  received 8BITMIME status
62576 <literal>*acl_warn_skipped           </literal>  skipped <option>warn</option> statement in ACL
62577 <literal> address_rewrite            </literal>  address rewriting
62578 <literal> all_parents                </literal>  all parents in =&gt; lines
62579 <literal> arguments                  </literal>  command line arguments
62580 <literal>*connection_reject          </literal>  connection rejections
62581 <literal>*delay_delivery             </literal>  immediate delivery delayed
62582 <literal> deliver_time               </literal>  time taken to perform delivery
62583 <literal> delivery_size              </literal>  add <literal>S=</literal><emphasis>nnn</emphasis> to =&gt; lines
62584 <literal>*dnslist_defer              </literal>  defers of DNS list (aka RBL) lookups
62585 <literal>*etrn                       </literal>  ETRN commands
62586 <literal>*host_lookup_failed         </literal>  as it says
62587 <literal> ident_timeout              </literal>  timeout for ident connection
62588 <literal> incoming_interface         </literal>  incoming interface on &lt;= lines
62589 <literal> incoming_port              </literal>  incoming port on &lt;= lines
62590 <literal>*lost_incoming_connection   </literal>  as it says (includes timeouts)
62591 <literal> outgoing_port              </literal>  add remote port to =&gt; lines
62592 <literal>*queue_run                  </literal>  start and end queue runs
62593 <literal> queue_time                 </literal>  time on queue for one recipient
62594 <literal> queue_time_overall         </literal>  time on queue for whole message
62595 <literal> pid                        </literal>  Exim process id
62596 <literal> received_recipients        </literal>  recipients on &lt;= lines
62597 <literal> received_sender            </literal>  sender on &lt;= lines
62598 <literal>*rejected_header            </literal>  header contents on reject log
62599 <literal>*retry_defer                </literal>  <quote>retry time not reached</quote>
62600 <literal> return_path_on_delivery    </literal>  put return path on =&gt; and ** lines
62601 <literal> sender_on_delivery         </literal>  add sender to =&gt; lines
62602 <literal>*sender_verify_fail         </literal>  sender verification failures
62603 <literal>*size_reject                </literal>  rejection because too big
62604 <literal>*skip_delivery              </literal>  delivery skipped in a queue run
62605 <literal>*smtp_confirmation          </literal>  SMTP confirmation on =&gt; lines
62606 <literal> smtp_connection            </literal>  SMTP connections
62607 <literal> smtp_incomplete_transaction</literal>  incomplete SMTP transactions
62608 <literal> smtp_mailauth              </literal>  AUTH argument to MAIL commands
62609 <literal> smtp_no_mail               </literal>  session with no MAIL commands
62610 <literal> smtp_protocol_error        </literal>  SMTP protocol errors
62611 <literal> smtp_syntax_error          </literal>  SMTP syntax errors
62612 <literal> subject                    </literal>  contents of <emphasis>Subject:</emphasis> on &lt;= lines
62613 <literal> tls_certificate_verified   </literal>  certificate verification status
62614 <literal>*tls_cipher                 </literal>  TLS cipher suite on &lt;= and =&gt; lines
62615 <literal> tls_peerdn                 </literal>  TLS peer DN on &lt;= and =&gt; lines
62616 <literal> tls_sni                    </literal>  TLS SNI on &lt;= lines
62617 <literal> unknown_in_list            </literal>  DNS lookup failed in list match
62618
62619 <literal> all                        </literal>  all of the above
62620 </literallayout>
62621 <para>
62622 More details on each of these items follows:
62623 </para>
62624 <itemizedlist>
62625 <listitem>
62626 <para>
62627 <indexterm role="concept">
62628 <primary>8BITMIME</primary>
62629 </indexterm>
62630 <indexterm role="concept">
62631 <primary>log</primary>
62632 <secondary>8BITMIME</secondary>
62633 </indexterm>
62634 <option>8bitmime</option>: This causes Exim to log any 8BITMIME status of received messages,
62635 which may help in tracking down interoperability issues with ancient MTAs
62636 that are not 8bit clean.  This is added to the <quote>&lt;=</quote> line, tagged with
62637 <literal>M8S=</literal> and a value of <literal>0</literal>, <literal>7</literal> or <literal>8</literal>, corresponding to "not given",
62638 <literal>7BIT</literal> and <literal>8BITMIME</literal> respectively.
62639 </para>
62640 </listitem>
62641 <listitem>
62642 <para>
62643 <indexterm role="concept">
62644 <primary><option>warn</option> ACL verb</primary>
62645 <secondary>log when skipping</secondary>
62646 </indexterm>
62647 <option>acl_warn_skipped</option>: When an ACL <option>warn</option> statement is skipped because one of
62648 its conditions cannot be evaluated, a log line to this effect is written if
62649 this log selector is set.
62650 </para>
62651 </listitem>
62652 <listitem>
62653 <para>
62654 <indexterm role="concept">
62655 <primary>log</primary>
62656 <secondary>rewriting</secondary>
62657 </indexterm>
62658 <indexterm role="concept">
62659 <primary>rewriting</primary>
62660 <secondary>logging</secondary>
62661 </indexterm>
62662 <option>address_rewrite</option>: This applies both to global rewrites and per-transport
62663 rewrites, but not to rewrites in filters run as an unprivileged user (because
62664 such users cannot access the log).
62665 </para>
62666 </listitem>
62667 <listitem>
62668 <para>
62669 <indexterm role="concept">
62670 <primary>log</primary>
62671 <secondary>full parentage</secondary>
62672 </indexterm>
62673 <option>all_parents</option>: Normally only the original and final addresses are logged on
62674 delivery lines; with this selector, intermediate parents are given in
62675 parentheses between them.
62676 </para>
62677 </listitem>
62678 <listitem>
62679 <para>
62680 <indexterm role="concept">
62681 <primary>log</primary>
62682 <secondary>Exim arguments</secondary>
62683 </indexterm>
62684 <indexterm role="concept">
62685 <primary>Exim arguments, logging</primary>
62686 </indexterm>
62687 <option>arguments</option>: This causes Exim to write the arguments with which it was called
62688 to the main log, preceded by the current working directory. This is a debugging
62689 feature, added to make it easier to find out how certain MUAs call
62690 <filename>/usr/sbin/sendmail</filename>. The logging does not happen if Exim has given up root
62691 privilege because it was called with the <option>-C</option> or <option>-D</option> options. Arguments
62692 that are empty or that contain white space are quoted. Non-printing characters
62693 are shown as escape sequences. This facility cannot log unrecognized arguments,
62694 because the arguments are checked before the configuration file is read. The
62695 only way to log such cases is to interpose a script such as <filename>util/logargs.sh</filename>
62696 between the caller and Exim.
62697 </para>
62698 </listitem>
62699 <listitem>
62700 <para>
62701 <indexterm role="concept">
62702 <primary>log</primary>
62703 <secondary>connection rejections</secondary>
62704 </indexterm>
62705 <option>connection_reject</option>: A log entry is written whenever an incoming SMTP
62706 connection is rejected, for whatever reason.
62707 </para>
62708 </listitem>
62709 <listitem>
62710 <para>
62711 <indexterm role="concept">
62712 <primary>log</primary>
62713 <secondary>delayed delivery</secondary>
62714 </indexterm>
62715 <indexterm role="concept">
62716 <primary>delayed delivery, logging</primary>
62717 </indexterm>
62718 <option>delay_delivery</option>: A log entry is written whenever a delivery process is not
62719 started for an incoming message because the load is too high or too many
62720 messages were received on one connection. Logging does not occur if no delivery
62721 process is started because <option>queue_only</option> is set or <option>-odq</option> was used.
62722 </para>
62723 </listitem>
62724 <listitem>
62725 <para>
62726 <indexterm role="concept">
62727 <primary>log</primary>
62728 <secondary>delivery duration</secondary>
62729 </indexterm>
62730 <option>deliver_time</option>: For each delivery, the amount of real time it has taken to
62731 perform the actual delivery is logged as DT=&lt;<emphasis>time</emphasis>&gt;, for example, <literal>DT=1s</literal>.
62732 </para>
62733 </listitem>
62734 <listitem>
62735 <para>
62736 <indexterm role="concept">
62737 <primary>log</primary>
62738 <secondary>message size on delivery</secondary>
62739 </indexterm>
62740 <indexterm role="concept">
62741 <primary>size</primary>
62742 <secondary>of message</secondary>
62743 </indexterm>
62744 <option>delivery_size</option>: For each delivery, the size of message delivered is added to
62745 the <quote>=&gt;</quote> line, tagged with S=.
62746 </para>
62747 </listitem>
62748 <listitem>
62749 <para>
62750 <indexterm role="concept">
62751 <primary>log</primary>
62752 <secondary>dnslist defer</secondary>
62753 </indexterm>
62754 <indexterm role="concept">
62755 <primary>DNS list</primary>
62756 <secondary>logging defer</secondary>
62757 </indexterm>
62758 <indexterm role="concept">
62759 <primary>black list (DNS)</primary>
62760 </indexterm>
62761 <option>dnslist_defer</option>: A log entry is written if an attempt to look up a host in a
62762 DNS black list suffers a temporary error.
62763 </para>
62764 </listitem>
62765 <listitem>
62766 <para>
62767 <indexterm role="concept">
62768 <primary>log</primary>
62769 <secondary>ETRN commands</secondary>
62770 </indexterm>
62771 <indexterm role="concept">
62772 <primary>ETRN</primary>
62773 <secondary>logging</secondary>
62774 </indexterm>
62775 <option>etrn</option>: Every valid ETRN command that is received is logged, before the ACL
62776 is run to determine whether or not it is actually accepted. An invalid ETRN
62777 command, or one received within a message transaction is not logged by this
62778 selector (see <option>smtp_syntax_error</option> and <option>smtp_protocol_error</option>).
62779 </para>
62780 </listitem>
62781 <listitem>
62782 <para>
62783 <indexterm role="concept">
62784 <primary>log</primary>
62785 <secondary>host lookup failure</secondary>
62786 </indexterm>
62787 <option>host_lookup_failed</option>: When a lookup of a host&#x2019;s IP addresses fails to find
62788 any addresses, or when a lookup of an IP address fails to find a host name, a
62789 log line is written. This logging does not apply to direct DNS lookups when
62790 routing email addresses, but it does apply to <quote>byname</quote> lookups.
62791 </para>
62792 </listitem>
62793 <listitem>
62794 <para>
62795 <indexterm role="concept">
62796 <primary>log</primary>
62797 <secondary>ident timeout</secondary>
62798 </indexterm>
62799 <indexterm role="concept">
62800 <primary>RFC 1413</primary>
62801 <secondary>logging timeout</secondary>
62802 </indexterm>
62803 <option>ident_timeout</option>: A log line is written whenever an attempt to connect to a
62804 client&#x2019;s ident port times out.
62805 </para>
62806 </listitem>
62807 <listitem>
62808 <para>
62809 <indexterm role="concept">
62810 <primary>log</primary>
62811 <secondary>incoming interface</secondary>
62812 </indexterm>
62813 <indexterm role="concept">
62814 <primary>interface</primary>
62815 <secondary>logging</secondary>
62816 </indexterm>
62817 <option>incoming_interface</option>: The interface on which a message was received is added
62818 to the <quote>&lt;=</quote> line as an IP address in square brackets, tagged by I= and
62819 followed by a colon and the port number. The local interface and port are also
62820 added to other SMTP log lines, for example <quote>SMTP connection from</quote>, and to
62821 rejection lines.
62822 </para>
62823 </listitem>
62824 <listitem>
62825 <para>
62826 <indexterm role="concept">
62827 <primary>log</primary>
62828 <secondary>incoming remote port</secondary>
62829 </indexterm>
62830 <indexterm role="concept">
62831 <primary>port</primary>
62832 <secondary>logging remote</secondary>
62833 </indexterm>
62834 <indexterm role="concept">
62835 <primary>TCP/IP</primary>
62836 <secondary>logging incoming remote port</secondary>
62837 </indexterm>
62838 <indexterm role="variable">
62839 <primary><varname>$sender_fullhost</varname></primary>
62840 </indexterm>
62841 <indexterm role="variable">
62842 <primary><varname>$sender_rcvhost</varname></primary>
62843 </indexterm>
62844 <option>incoming_port</option>: The remote port number from which a message was received is
62845 added to log entries and <emphasis>Received:</emphasis> header lines, following the IP address
62846 in square brackets, and separated from it by a colon. This is implemented by
62847 changing the value that is put in the <varname>$sender_fullhost</varname> and
62848 <varname>$sender_rcvhost</varname> variables. Recording the remote port number has become more
62849 important with the widening use of NAT (see RFC 2505).
62850 </para>
62851 </listitem>
62852 <listitem>
62853 <para>
62854 <indexterm role="concept">
62855 <primary>log</primary>
62856 <secondary>dropped connection</secondary>
62857 </indexterm>
62858 <option>lost_incoming_connection</option>: A log line is written when an incoming SMTP
62859 connection is unexpectedly dropped.
62860 </para>
62861 </listitem>
62862 <listitem>
62863 <para>
62864 <indexterm role="concept">
62865 <primary>log</primary>
62866 <secondary>outgoing remote port</secondary>
62867 </indexterm>
62868 <indexterm role="concept">
62869 <primary>port</primary>
62870 <secondary>logging outgoint remote</secondary>
62871 </indexterm>
62872 <indexterm role="concept">
62873 <primary>TCP/IP</primary>
62874 <secondary>logging ougtoing remote port</secondary>
62875 </indexterm>
62876 <option>outgoing_port</option>: The remote port number is added to delivery log lines (those
62877 containing =&gt; tags) following the IP address. This option is not included in
62878 the default setting, because for most ordinary configurations, the remote port
62879 number is always 25 (the SMTP port).
62880 </para>
62881 </listitem>
62882 <listitem>
62883 <para>
62884 <indexterm role="concept">
62885 <primary>log</primary>
62886 <secondary>process ids in</secondary>
62887 </indexterm>
62888 <indexterm role="concept">
62889 <primary>pid (process id)</primary>
62890 <secondary>in log lines</secondary>
62891 </indexterm>
62892 <option>pid</option>: The current process id is added to every log line, in square brackets,
62893 immediately after the time and date.
62894 </para>
62895 </listitem>
62896 <listitem>
62897 <para>
62898 <indexterm role="concept">
62899 <primary>log</primary>
62900 <secondary>queue run</secondary>
62901 </indexterm>
62902 <indexterm role="concept">
62903 <primary>queue runner</primary>
62904 <secondary>logging</secondary>
62905 </indexterm>
62906 <option>queue_run</option>: The start and end of every queue run are logged.
62907 </para>
62908 </listitem>
62909 <listitem>
62910 <para>
62911 <indexterm role="concept">
62912 <primary>log</primary>
62913 <secondary>queue time</secondary>
62914 </indexterm>
62915 <option>queue_time</option>: The amount of time the message has been in the queue on the
62916 local host is logged as QT=&lt;<emphasis>time</emphasis>&gt; on delivery (<literal>=&gt;</literal>) lines, for example,
62917 <literal>QT=3m45s</literal>. The clock starts when Exim starts to receive the message, so it
62918 includes reception time as well as the delivery time for the current address.
62919 This means that it may be longer than the difference between the arrival and
62920 delivery log line times, because the arrival log line is not written until the
62921 message has been successfully received.
62922 </para>
62923 </listitem>
62924 <listitem>
62925 <para>
62926 <option>queue_time_overall</option>: The amount of time the message has been in the queue on
62927 the local host is logged as QT=&lt;<emphasis>time</emphasis>&gt; on <quote>Completed</quote> lines, for
62928 example, <literal>QT=3m45s</literal>. The clock starts when Exim starts to receive the
62929 message, so it includes reception time as well as the total delivery time.
62930 </para>
62931 </listitem>
62932 <listitem>
62933 <para>
62934 <indexterm role="concept">
62935 <primary>log</primary>
62936 <secondary>recipients</secondary>
62937 </indexterm>
62938 <option>received_recipients</option>: The recipients of a message are listed in the main log
62939 as soon as the message is received. The list appears at the end of the log line
62940 that is written when a message is received, preceded by the word <quote>for</quote>. The
62941 addresses are listed after they have been qualified, but before any rewriting
62942 has taken place.
62943 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
62944 in the list.
62945 </para>
62946 </listitem>
62947 <listitem>
62948 <para>
62949 <indexterm role="concept">
62950 <primary>log</primary>
62951 <secondary>sender reception</secondary>
62952 </indexterm>
62953 <option>received_sender</option>: The unrewritten original sender of a message is added to
62954 the end of the log line that records the message&#x2019;s arrival, after the word
62955 <quote>from</quote> (before the recipients if <option>received_recipients</option> is also set).
62956 </para>
62957 </listitem>
62958 <listitem>
62959 <para>
62960 <indexterm role="concept">
62961 <primary>log</primary>
62962 <secondary>header lines for rejection</secondary>
62963 </indexterm>
62964 <option>rejected_header</option>: If a message&#x2019;s header has been received at the time a
62965 rejection is written to the reject log, the complete header is added to the
62966 log. Header logging can be turned off individually for messages that are
62967 rejected by the <function>local_scan()</function> function (see section <xref linkend="SECTapiforloc"/>).
62968 </para>
62969 </listitem>
62970 <listitem>
62971 <para>
62972 <indexterm role="concept">
62973 <primary>log</primary>
62974 <secondary>retry defer</secondary>
62975 </indexterm>
62976 <option>retry_defer</option>: A log line is written if a delivery is deferred because a
62977 retry time has not yet been reached. However, this <quote>retry time not reached</quote>
62978 message is always omitted from individual message logs after the first delivery
62979 attempt.
62980 </para>
62981 </listitem>
62982 <listitem>
62983 <para>
62984 <indexterm role="concept">
62985 <primary>log</primary>
62986 <secondary>return path</secondary>
62987 </indexterm>
62988 <option>return_path_on_delivery</option>: The return path that is being transmitted with
62989 the message is included in delivery and bounce lines, using the tag P=.
62990 This is omitted if no delivery actually happens, for example, if routing fails,
62991 or if delivery is to <filename>/dev/null</filename> or to <literal>:blackhole:</literal>.
62992 </para>
62993 </listitem>
62994 <listitem>
62995 <para>
62996 <indexterm role="concept">
62997 <primary>log</primary>
62998 <secondary>sender on delivery</secondary>
62999 </indexterm>
63000 <option>sender_on_delivery</option>: The message&#x2019;s sender address is added to every delivery
63001 and bounce line, tagged by F= (for <quote>from</quote>).
63002 This is the original sender that was received with the message; it is not
63003 necessarily the same as the outgoing return path.
63004 </para>
63005 </listitem>
63006 <listitem>
63007 <para>
63008 <indexterm role="concept">
63009 <primary>log</primary>
63010 <secondary>sender verify failure</secondary>
63011 </indexterm>
63012 <option>sender_verify_fail</option>: If this selector is unset, the separate log line that
63013 gives details of a sender verification failure is not written. Log lines for
63014 the rejection of SMTP commands contain just <quote>sender verify failed</quote>, so some
63015 detail is lost.
63016 </para>
63017 </listitem>
63018 <listitem>
63019 <para>
63020 <indexterm role="concept">
63021 <primary>log</primary>
63022 <secondary>size rejection</secondary>
63023 </indexterm>
63024 <option>size_reject</option>: A log line is written whenever a message is rejected because
63025 it is too big.
63026 </para>
63027 </listitem>
63028 <listitem>
63029 <para>
63030 <indexterm role="concept">
63031 <primary>log</primary>
63032 <secondary>frozen messages; skipped</secondary>
63033 </indexterm>
63034 <indexterm role="concept">
63035 <primary>frozen messages</primary>
63036 <secondary>logging skipping</secondary>
63037 </indexterm>
63038 <option>skip_delivery</option>: A log line is written whenever a message is skipped during a
63039 queue run because it is frozen or because another process is already delivering
63040 it.
63041 <indexterm role="concept">
63042 <primary><quote>spool file is locked</quote></primary>
63043 </indexterm>
63044 The message that is written is <quote>spool file is locked</quote>.
63045 </para>
63046 </listitem>
63047 <listitem>
63048 <para>
63049 <indexterm role="concept">
63050 <primary>log</primary>
63051 <secondary>smtp confirmation</secondary>
63052 </indexterm>
63053 <indexterm role="concept">
63054 <primary>SMTP</primary>
63055 <secondary>logging confirmation</secondary>
63056 </indexterm>
63057 <indexterm role="concept">
63058 <primary>LMTP</primary>
63059 <secondary>logging confirmation</secondary>
63060 </indexterm>
63061 <option>smtp_confirmation</option>: The response to the final <quote>.</quote> in the SMTP or LMTP dialogue for
63062 outgoing messages is added to delivery log lines in the form <literal>C=</literal>&lt;<emphasis>text</emphasis>&gt;.
63063 A number of MTAs (including Exim) return an identifying string in this
63064 response.
63065 </para>
63066 </listitem>
63067 <listitem>
63068 <para>
63069 <indexterm role="concept">
63070 <primary>log</primary>
63071 <secondary>SMTP connections</secondary>
63072 </indexterm>
63073 <indexterm role="concept">
63074 <primary>SMTP</primary>
63075 <secondary>logging connections</secondary>
63076 </indexterm>
63077 <option>smtp_connection</option>: A log line is written whenever an SMTP connection is
63078 established or closed, unless the connection is from a host that matches
63079 <option>hosts_connection_nolog</option>. (In contrast, <option>lost_incoming_connection</option> applies
63080 only when the closure is unexpected.) This applies to connections from local
63081 processes that use <option>-bs</option> as well as to TCP/IP connections. If a connection is
63082 dropped in the middle of a message, a log line is always written, whether or
63083 not this selector is set, but otherwise nothing is written at the start and end
63084 of connections unless this selector is enabled.
63085 </para>
63086 <para>
63087 For TCP/IP connections to an Exim daemon, the current number of connections is
63088 included in the log message for each new connection, but note that the count is
63089 reset if the daemon is restarted.
63090 Also, because connections are closed (and the closure is logged) in
63091 subprocesses, the count may not include connections that have been closed but
63092 whose termination the daemon has not yet noticed. Thus, while it is possible to
63093 match up the opening and closing of connections in the log, the value of the
63094 logged counts may not be entirely accurate.
63095 </para>
63096 </listitem>
63097 <listitem>
63098 <para>
63099 <indexterm role="concept">
63100 <primary>log</primary>
63101 <secondary>SMTP transaction; incomplete</secondary>
63102 </indexterm>
63103 <indexterm role="concept">
63104 <primary>SMTP</primary>
63105 <secondary>logging incomplete transactions</secondary>
63106 </indexterm>
63107 <option>smtp_incomplete_transaction</option>: When a mail transaction is aborted by
63108 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
63109 and the message sender plus any accepted recipients are included in the log
63110 line. This can provide evidence of dictionary attacks.
63111 </para>
63112 </listitem>
63113 <listitem>
63114 <para>
63115 <indexterm role="concept">
63116 <primary>log</primary>
63117 <secondary>non-MAIL SMTP sessions</secondary>
63118 </indexterm>
63119 <indexterm role="concept">
63120 <primary>MAIL</primary>
63121 <secondary>logging session without</secondary>
63122 </indexterm>
63123 <option>smtp_no_mail</option>: A line is written to the main log whenever an accepted SMTP
63124 connection terminates without having issued a MAIL command. This includes both
63125 the case when the connection is dropped, and the case when QUIT is used. It
63126 does not include cases where the connection is rejected right at the start (by
63127 an ACL, or because there are too many connections, or whatever). These cases
63128 already have their own log lines.
63129 </para>
63130 <para>
63131 The log line that is written contains the identity of the client in the usual
63132 way, followed by D= and a time, which records the duration of the connection.
63133 If the connection was authenticated, this fact is logged exactly as it is for
63134 an incoming message, with an A= item. If the connection was encrypted, CV=,
63135 DN=, and X= items may appear as they do for an incoming message, controlled by
63136 the same logging options.
63137 </para>
63138 <para>
63139 Finally, if any SMTP commands were issued during the connection, a C= item
63140 is added to the line, listing the commands that were used. For example,
63141 </para>
63142 <literallayout class="monospaced">
63143 C=EHLO,QUIT
63144 </literallayout>
63145 <para>
63146 shows that the client issued QUIT straight after EHLO. If there were fewer
63147 than 20 commands, they are all listed. If there were more than 20 commands,
63148 the last 20 are listed, preceded by <quote>...</quote>. However, with the default
63149 setting of 10 for <option>smtp_accep_max_nonmail</option>, the connection will in any case
63150 have been aborted before 20 non-mail commands are processed.
63151 </para>
63152 </listitem>
63153 <listitem>
63154 <para>
63155 <option>smtp_mailauth</option>: A third subfield with the authenticated sender,
63156 colon-separated, is appended to the A= item for a message arrival or delivery
63157 log line, if an AUTH argument to the SMTP MAIL command (see <xref linkend="SECTauthparamail"/>)
63158 was accepted or used.
63159 </para>
63160 </listitem>
63161 <listitem>
63162 <para>
63163 <indexterm role="concept">
63164 <primary>log</primary>
63165 <secondary>SMTP protocol error</secondary>
63166 </indexterm>
63167 <indexterm role="concept">
63168 <primary>SMTP</primary>
63169 <secondary>logging protocol error</secondary>
63170 </indexterm>
63171 <option>smtp_protocol_error</option>: A log line is written for every SMTP protocol error
63172 encountered. Exim does not have perfect detection of all protocol errors
63173 because of transmission delays and the use of pipelining. If PIPELINING has
63174 been advertised to a client, an Exim server assumes that the client will use
63175 it, and therefore it does not count <quote>expected</quote> errors (for example, RCPT
63176 received after rejecting MAIL) as protocol errors.
63177 </para>
63178 </listitem>
63179 <listitem>
63180 <para>
63181 <indexterm role="concept">
63182 <primary>SMTP</primary>
63183 <secondary>logging syntax errors</secondary>
63184 </indexterm>
63185 <indexterm role="concept">
63186 <primary>SMTP</primary>
63187 <secondary>syntax errors; logging</secondary>
63188 </indexterm>
63189 <indexterm role="concept">
63190 <primary>SMTP</primary>
63191 <secondary>unknown command; logging</secondary>
63192 </indexterm>
63193 <indexterm role="concept">
63194 <primary>log</primary>
63195 <secondary>unknown SMTP command</secondary>
63196 </indexterm>
63197 <indexterm role="concept">
63198 <primary>log</primary>
63199 <secondary>SMTP syntax error</secondary>
63200 </indexterm>
63201 <option>smtp_syntax_error</option>: A log line is written for every SMTP syntax error
63202 encountered. An unrecognized command is treated as a syntax error. For an
63203 external connection, the host identity is given; for an internal connection
63204 using <option>-bs</option> the sender identification (normally the calling user) is given.
63205 </para>
63206 </listitem>
63207 <listitem>
63208 <para>
63209 <indexterm role="concept">
63210 <primary>log</primary>
63211 <secondary>subject</secondary>
63212 </indexterm>
63213 <indexterm role="concept">
63214 <primary>subject, logging</primary>
63215 </indexterm>
63216 <option>subject</option>: The subject of the message is added to the arrival log line,
63217 preceded by <quote>T=</quote> (T for <quote>topic</quote>, since S is already used for <quote>size</quote>).
63218 Any MIME <quote>words</quote> in the subject are decoded. The <option>print_topbitchars</option> option
63219 specifies whether characters with values greater than 127 should be logged
63220 unchanged, or whether they should be rendered as escape sequences.
63221 </para>
63222 </listitem>
63223 <listitem>
63224 <para>
63225 <indexterm role="concept">
63226 <primary>log</primary>
63227 <secondary>certificate verification</secondary>
63228 </indexterm>
63229 <option>tls_certificate_verified</option>: An extra item is added to &lt;= and =&gt; log lines
63230 when TLS is in use. The item is <literal>CV=yes</literal> if the peer&#x2019;s certificate was
63231 verified, and <literal>CV=no</literal> if not.
63232 </para>
63233 </listitem>
63234 <listitem>
63235 <para>
63236 <indexterm role="concept">
63237 <primary>log</primary>
63238 <secondary>TLS cipher</secondary>
63239 </indexterm>
63240 <indexterm role="concept">
63241 <primary>TLS</primary>
63242 <secondary>logging cipher</secondary>
63243 </indexterm>
63244 <option>tls_cipher</option>: When a message is sent or received over an encrypted
63245 connection, the cipher suite used is added to the log line, preceded by X=.
63246 </para>
63247 </listitem>
63248 <listitem>
63249 <para>
63250 <indexterm role="concept">
63251 <primary>log</primary>
63252 <secondary>TLS peer DN</secondary>
63253 </indexterm>
63254 <indexterm role="concept">
63255 <primary>TLS</primary>
63256 <secondary>logging peer DN</secondary>
63257 </indexterm>
63258 <option>tls_peerdn</option>: When a message is sent or received over an encrypted
63259 connection, and a certificate is supplied by the remote host, the peer DN is
63260 added to the log line, preceded by DN=.
63261 </para>
63262 </listitem>
63263 <listitem>
63264 <para>
63265 <indexterm role="concept">
63266 <primary>log</primary>
63267 <secondary>TLS SNI</secondary>
63268 </indexterm>
63269 <indexterm role="concept">
63270 <primary>TLS</primary>
63271 <secondary>logging SNI</secondary>
63272 </indexterm>
63273 <option>tls_sni</option>: When a message is received over an encrypted connection, and
63274 the remote host provided the Server Name Indication extension, the SNI is
63275 added to the log line, preceded by SNI=.
63276 </para>
63277 </listitem>
63278 <listitem>
63279 <para>
63280 <indexterm role="concept">
63281 <primary>log</primary>
63282 <secondary>DNS failure in list</secondary>
63283 </indexterm>
63284 <option>unknown_in_list</option>: This setting causes a log entry to be written when the
63285 result of a list match is failure because a DNS lookup failed.
63286 </para>
63287 </listitem>
63288 </itemizedlist>
63289 </section>
63290 <section id="SECID260">
63291 <title>Message log</title>
63292 <para>
63293 <indexterm role="concept">
63294 <primary>message</primary>
63295 <secondary>log file for</secondary>
63296 </indexterm>
63297 <indexterm role="concept">
63298 <primary>log</primary>
63299 <secondary>message log; description of</secondary>
63300 </indexterm>
63301 <indexterm role="concept">
63302 <primary><filename>msglog</filename> directory</primary>
63303 </indexterm>
63304 <indexterm role="option">
63305 <primary><option>preserve_message_logs</option></primary>
63306 </indexterm>
63307 In addition to the general log files, Exim writes a log file for each message
63308 that it handles. The names of these per-message logs are the message ids, and
63309 they are kept in the <filename>msglog</filename> sub-directory of the spool directory. Each
63310 message log contains copies of the log lines that apply to the message. This
63311 makes it easier to inspect the status of an individual message without having
63312 to search the main log. A message log is deleted when processing of the message
63313 is complete, unless <option>preserve_message_logs</option> is set, but this should be used
63314 only with great care because they can fill up your disk very quickly.
63315 </para>
63316 <para>
63317 On a heavily loaded system, it may be desirable to disable the use of
63318 per-message logs, in order to reduce disk I/O. This can be done by setting the
63319 <option>message_logs</option> option false.
63320 <indexterm role="concept" startref="IIDloggen" class="endofrange"/>
63321 </para>
63322 </section>
63323 </chapter>
63324
63325 <chapter id="CHAPutils">
63326 <title>Exim utilities</title>
63327 <para>
63328 <indexterm role="concept" id="IIDutils" class="startofrange">
63329 <primary>utilities</primary>
63330 </indexterm>
63331 A number of utility scripts and programs are supplied with Exim and are
63332 described in this chapter. There is also the Exim Monitor, which is covered in
63333 the next chapter. The utilities described here are:
63334 </para>
63335 <informaltable frame="none">
63336 <tgroup cols="3" colsep="0" rowsep="0">
63337 <colspec colwidth="7*" align="left"/>
63338 <colspec colwidth="15*" align="left"/>
63339 <colspec colwidth="40*" align="left"/>
63340 <tbody>
63341 <row>
63342 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<xref linkend="SECTfinoutwha"/></entry>
63343 <entry><emphasis>exiwhat</emphasis></entry>
63344 <entry>list what Exim processes are doing</entry>
63345 </row>
63346 <row>
63347 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<xref linkend="SECTgreptheque"/></entry>
63348 <entry><emphasis>exiqgrep</emphasis></entry>
63349 <entry>grep the queue</entry>
63350 </row>
63351 <row>
63352 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<xref linkend="SECTsumtheque"/></entry>
63353 <entry><emphasis>exiqsumm</emphasis></entry>
63354 <entry>summarize the queue</entry>
63355 </row>
63356 <row>
63357 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<xref linkend="SECTextspeinf"/></entry>
63358 <entry><emphasis>exigrep</emphasis></entry>
63359 <entry>search the main log</entry>
63360 </row>
63361 <row>
63362 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<xref linkend="SECTexipick"/></entry>
63363 <entry><emphasis>exipick</emphasis></entry>
63364 <entry>select messages on various criteria</entry>
63365 </row>
63366 <row>
63367 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<xref linkend="SECTcyclogfil"/></entry>
63368 <entry><emphasis>exicyclog</emphasis></entry>
63369 <entry>cycle (rotate) log files</entry>
63370 </row>
63371 <row>
63372 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<xref linkend="SECTmailstat"/></entry>
63373 <entry><emphasis>eximstats</emphasis></entry>
63374 <entry>extract statistics from the log</entry>
63375 </row>
63376 <row>
63377 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<xref linkend="SECTcheckaccess"/></entry>
63378 <entry><emphasis>exim_checkaccess</emphasis></entry>
63379 <entry>check address acceptance from given IP</entry>
63380 </row>
63381 <row>
63382 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<xref linkend="SECTdbmbuild"/></entry>
63383 <entry><emphasis>exim_dbmbuild</emphasis></entry>
63384 <entry>build a DBM file</entry>
63385 </row>
63386 <row>
63387 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<xref linkend="SECTfinindret"/></entry>
63388 <entry><emphasis>exinext</emphasis></entry>
63389 <entry>extract retry information</entry>
63390 </row>
63391 <row>
63392 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<xref linkend="SECThindatmai"/></entry>
63393 <entry><emphasis>exim_dumpdb</emphasis></entry>
63394 <entry>dump a hints database</entry>
63395 </row>
63396 <row>
63397 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<xref linkend="SECThindatmai"/></entry>
63398 <entry><emphasis>exim_tidydb</emphasis></entry>
63399 <entry>clean up a hints database</entry>
63400 </row>
63401 <row>
63402 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<xref linkend="SECThindatmai"/></entry>
63403 <entry><emphasis>exim_fixdb</emphasis></entry>
63404 <entry>patch a hints database</entry>
63405 </row>
63406 <row>
63407 <entry>&nbsp;&nbsp;&nbsp;&nbsp;<xref linkend="SECTmailboxmaint"/></entry>
63408 <entry><emphasis>exim_lock</emphasis></entry>
63409 <entry>lock a mailbox file</entry>
63410 </row>
63411 </tbody>
63412 </tgroup>
63413 </informaltable>
63414 <para>
63415 Another utility that might be of use to sites with many MTAs is Tom Kistner&#x2019;s
63416 <emphasis>exilog</emphasis>. It provides log visualizations across multiple Exim servers. See
63417 <emphasis role="bold"><ulink url="http://duncanthrax.net/exilog/">http://duncanthrax.net/exilog/</ulink></emphasis> for details.
63418 </para>
63419 <section id="SECTfinoutwha">
63420 <title>Finding out what Exim processes are doing (exiwhat)</title>
63421 <para>
63422 <indexterm role="concept">
63423 <primary><emphasis>exiwhat</emphasis></primary>
63424 </indexterm>
63425 <indexterm role="concept">
63426 <primary>process, querying</primary>
63427 </indexterm>
63428 <indexterm role="concept">
63429 <primary>SIGUSR1</primary>
63430 </indexterm>
63431 On operating systems that can restart a system call after receiving a signal
63432 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
63433 a line describing what it is doing to the file <filename>exim-process.info</filename> in the
63434 Exim spool directory. The <emphasis>exiwhat</emphasis> script sends the signal to all Exim
63435 processes it can find, having first emptied the file. It then waits for one
63436 second to allow the Exim processes to react before displaying the results. In
63437 order to run <emphasis>exiwhat</emphasis> successfully you have to have sufficient privilege to
63438 send the signal to the Exim processes, so it is normally run as root.
63439 </para>
63440 <para>
63441 <emphasis role="bold">Warning</emphasis>: This is not an efficient process. It is intended for occasional
63442 use by system administrators. It is not sensible, for example, to set up a
63443 script that sends SIGUSR1 signals to Exim processes at short intervals.
63444 </para>
63445 <para>
63446 Unfortunately, the <emphasis>ps</emphasis> command that <emphasis>exiwhat</emphasis> uses to find Exim processes
63447 varies in different operating systems. Not only are different options used,
63448 but the format of the output is different. For this reason, there are some
63449 system configuration options that configure exactly how <emphasis>exiwhat</emphasis> works. If
63450 it doesn&#x2019;t seem to be working for you, check the following compile-time
63451 options:
63452 </para>
63453 <literallayout>
63454 <literal>EXIWHAT_PS_CMD    </literal> the command for running <emphasis>ps</emphasis>
63455 <literal>EXIWHAT_PS_ARG    </literal> the argument for <emphasis>ps</emphasis>
63456 <literal>EXIWHAT_EGREP_ARG </literal> the argument for <emphasis>egrep</emphasis> to select from <emphasis>ps</emphasis> output
63457 <literal>EXIWHAT_KILL_ARG  </literal> the argument for the <emphasis>kill</emphasis> command
63458 </literallayout>
63459 <para>
63460 An example of typical output from <emphasis>exiwhat</emphasis> is
63461 </para>
63462 <literallayout class="monospaced">
63463 164 daemon: -q1h, listening on port 25
63464 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
63465 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
63466   [10.19.42.42] (editor@ref.example)
63467 10592 handling incoming call from [192.168.243.242]
63468 10628 accepting a local non-SMTP message
63469 </literallayout>
63470 <para>
63471 The first number in the output line is the process number. The third line has
63472 been split here, in order to fit it on the page.
63473 </para>
63474 </section>
63475 <section id="SECTgreptheque">
63476 <title>Selective queue listing (exiqgrep)</title>
63477 <para>
63478 <indexterm role="concept">
63479 <primary><emphasis>exiqgrep</emphasis></primary>
63480 </indexterm>
63481 <indexterm role="concept">
63482 <primary>queue</primary>
63483 <secondary>grepping</secondary>
63484 </indexterm>
63485 This utility is a Perl script contributed by Matt Hubbard. It runs
63486 </para>
63487 <literallayout class="monospaced">
63488 exim -bpu
63489 </literallayout>
63490 <para>
63491 or (in case <emphasis role="bold">-a</emphasis> switch is specified)
63492 </para>
63493 <literallayout class="monospaced">
63494 exim -bp
63495 </literallayout>
63496 <para revisionflag="changed">
63497 The <emphasis role="bold">-C</emphasis> option is used to specify an alternate <filename>exim.conf</filename> which might
63498 contain alternate exim configuration the queue management might be using.
63499 </para>
63500 <para>
63501 to obtain a queue listing, and then greps the output to select messages 
63502 that match given criteria. The following selection options are available:
63503 </para>
63504 <variablelist>
63505 <varlistentry>
63506 <term><emphasis role="bold">-f</emphasis>&nbsp;&lt;<emphasis>regex</emphasis>&gt;</term>
63507 <listitem>
63508 <para>
63509 Match the sender address using a case-insensitive search. The field that is
63510 tested is enclosed in angle brackets, so you can test for bounce messages with
63511 </para>
63512 <literallayout class="monospaced">
63513 exiqgrep -f '^&lt;&gt;$'
63514 </literallayout>
63515 </listitem></varlistentry>
63516 <varlistentry>
63517 <term><emphasis role="bold">-r</emphasis>&nbsp;&lt;<emphasis>regex</emphasis>&gt;</term>
63518 <listitem>
63519 <para>
63520 Match a recipient address using a case-insensitve search. The field that is
63521 tested is not enclosed in angle brackets.
63522 </para>
63523 </listitem></varlistentry>
63524 <varlistentry>
63525 <term><emphasis role="bold">-s</emphasis>&nbsp;&lt;<emphasis>regex</emphasis>&gt;</term>
63526 <listitem>
63527 <para>
63528 Match against the size field.
63529 </para>
63530 </listitem></varlistentry>
63531 <varlistentry>
63532 <term><emphasis role="bold">-y</emphasis>&nbsp;&lt;<emphasis>seconds</emphasis>&gt;</term>
63533 <listitem>
63534 <para>
63535 Match messages that are younger than the given time.
63536 </para>
63537 </listitem></varlistentry>
63538 <varlistentry>
63539 <term><emphasis role="bold">-o</emphasis>&nbsp;&lt;<emphasis>seconds</emphasis>&gt;</term>
63540 <listitem>
63541 <para>
63542 Match messages that are older than the given time.
63543 </para>
63544 </listitem></varlistentry>
63545 <varlistentry>
63546 <term><emphasis role="bold">-z</emphasis></term>
63547 <listitem>
63548 <para>
63549 Match only frozen messages.
63550 </para>
63551 </listitem></varlistentry>
63552 <varlistentry>
63553 <term><emphasis role="bold">-x</emphasis></term>
63554 <listitem>
63555 <para>
63556 Match only non-frozen messages.
63557 </para>
63558 </listitem></varlistentry>
63559 </variablelist>
63560 <para>
63561 The following options control the format of the output:
63562 </para>
63563 <variablelist>
63564 <varlistentry>
63565 <term><emphasis role="bold">-c</emphasis></term>
63566 <listitem>
63567 <para>
63568 Display only the count of matching messages.
63569 </para>
63570 </listitem></varlistentry>
63571 <varlistentry>
63572 <term><emphasis role="bold">-l</emphasis></term>
63573 <listitem>
63574 <para>
63575 Long format &ndash; display the full message information as output by Exim. This is
63576 the default.
63577 </para>
63578 </listitem></varlistentry>
63579 <varlistentry>
63580 <term><emphasis role="bold">-i</emphasis></term>
63581 <listitem>
63582 <para>
63583 Display message ids only.
63584 </para>
63585 </listitem></varlistentry>
63586 <varlistentry>
63587 <term><emphasis role="bold">-b</emphasis></term>
63588 <listitem>
63589 <para>
63590 Brief format &ndash; one line per message.
63591 </para>
63592 </listitem></varlistentry>
63593 <varlistentry>
63594 <term><emphasis role="bold">-R</emphasis></term>
63595 <listitem>
63596 <para>
63597 Display messages in reverse order.
63598 </para>
63599 </listitem></varlistentry>
63600 <varlistentry>
63601 <term><emphasis role="bold">-a</emphasis></term>
63602 <listitem>
63603 <para>
63604 Include delivered recipients in queue listing.
63605 </para>
63606 </listitem></varlistentry>
63607 </variablelist>
63608 <para>
63609 There is one more option, <option>-h</option>, which outputs a list of options.
63610 </para>
63611 </section>
63612 <section id="SECTsumtheque">
63613 <title>Summarizing the queue (exiqsumm)</title>
63614 <para>
63615 <indexterm role="concept">
63616 <primary><emphasis>exiqsumm</emphasis></primary>
63617 </indexterm>
63618 <indexterm role="concept">
63619 <primary>queue</primary>
63620 <secondary>summary</secondary>
63621 </indexterm>
63622 The <emphasis>exiqsumm</emphasis> utility is a Perl script which reads the output of <literal>exim
63623 -bp</literal> and produces a summary of the messages on the queue. Thus, you use it by
63624 running a command such as
63625 </para>
63626 <literallayout class="monospaced">
63627 exim -bp | exiqsumm
63628 </literallayout>
63629 <para>
63630 The output consists of one line for each domain that has messages waiting for
63631 it, as in the following example:
63632 </para>
63633 <literallayout class="monospaced">
63634 3   2322   74m   66m  msn.com.example
63635 </literallayout>
63636 <para>
63637 Each line lists the number of pending deliveries for a domain, their total
63638 volume, and the length of time that the oldest and the newest messages have
63639 been waiting. Note that the number of pending deliveries is greater than the
63640 number of messages when messages have more than one recipient.
63641 </para>
63642 <para>
63643 A summary line is output at the end. By default the output is sorted on the
63644 domain name, but <emphasis>exiqsumm</emphasis> has the options <option>-a</option> and <option>-c</option>, which cause
63645 the output to be sorted by oldest message and by count of messages,
63646 respectively. There are also three options that split the messages for each
63647 domain into two or more subcounts: <option>-b</option> separates bounce messages, <option>-f</option>
63648 separates frozen messages, and <option>-s</option> separates messages according to their
63649 sender.
63650 </para>
63651 <para>
63652 The output of <emphasis>exim -bp</emphasis> contains the original addresses in the message, so
63653 this also applies to the output from <emphasis>exiqsumm</emphasis>. No domains from addresses
63654 generated by aliasing or forwarding are included (unless the <option>one_time</option>
63655 option of the <command>redirect</command> router has been used to convert them into <quote>top
63656 level</quote> addresses).
63657 </para>
63658 </section>
63659 <section id="SECTextspeinf">
63660 <title>Extracting specific information from the log (exigrep)</title>
63661 <para>
63662 <indexterm role="concept">
63663 <primary><emphasis>exigrep</emphasis></primary>
63664 </indexterm>
63665 <indexterm role="concept">
63666 <primary>log</primary>
63667 <secondary>extracts; grepping for</secondary>
63668 </indexterm>
63669 The <emphasis>exigrep</emphasis> utility is a Perl script that searches one or more main log
63670 files for entries that match a given pattern. When it finds a match, it
63671 extracts all the log entries for the relevant message, not just those that
63672 match the pattern. Thus, <emphasis>exigrep</emphasis> can extract complete log entries for a
63673 given message, or all mail for a given user, or for a given host, for example.
63674 The input files can be in Exim log format or syslog format.
63675 If a matching log line is not associated with a specific message, it is
63676 included in <emphasis>exigrep</emphasis>&#x2019;s output without any additional lines. The usage is:
63677 </para>
63678 <literallayout>
63679 <literal>exigrep [-t&lt;</literal><emphasis>n</emphasis><literal>&gt;] [-I] [-l] [-v] &lt;</literal><emphasis>pattern</emphasis><literal>&gt; [&lt;</literal><emphasis>log file</emphasis><literal>&gt;] ...</literal>
63680 </literallayout>
63681 <para>
63682 If no log file names are given on the command line, the standard input is read.
63683 </para>
63684 <para>
63685 The <option>-t</option> argument specifies a number of seconds. It adds an additional
63686 condition for message selection. Messages that are complete are shown only if
63687 they spent more than &lt;<emphasis>n</emphasis>&gt; seconds on the queue.
63688 </para>
63689 <para>
63690 By default, <emphasis>exigrep</emphasis> does case-insensitive matching. The <option>-I</option> option
63691 makes it case-sensitive. This may give a performance improvement when searching
63692 large log files. Without <option>-I</option>, the Perl pattern matches use Perl&#x2019;s <literal>/i</literal>
63693 option; with <option>-I</option> they do not. In both cases it is possible to change the
63694 case sensitivity within the pattern by using <literal>(?i)</literal> or <literal>(?-i)</literal>.
63695 </para>
63696 <para>
63697 The <option>-l</option> option means <quote>literal</quote>, that is, treat all characters in the
63698 pattern as standing for themselves. Otherwise the pattern must be a Perl
63699 regular expression.
63700 </para>
63701 <para>
63702 The <option>-v</option> option inverts the matching condition. That is, a line is selected
63703 if it does <emphasis>not</emphasis> match the pattern.
63704 </para>
63705 <para>
63706 If the location of a <emphasis>zcat</emphasis> command is known from the definition of
63707 ZCAT_COMMAND in <filename>Local/Makefile</filename>, <emphasis>exigrep</emphasis> automatically passes any file
63708 whose name ends in COMPRESS_SUFFIX through <emphasis>zcat</emphasis> as it searches it.
63709 </para>
63710 </section>
63711 <section id="SECTexipick">
63712 <title>Selecting messages by various criteria (exipick)</title>
63713 <para>
63714 <indexterm role="concept">
63715 <primary><emphasis>exipick</emphasis></primary>
63716 </indexterm>
63717 John Jetmore&#x2019;s <emphasis>exipick</emphasis> utility is included in the Exim distribution. It
63718 lists messages from the queue according to a variety of criteria. For details
63719 of <emphasis>exipick</emphasis>&#x2019;s facilities, visit the web page at
63720 <emphasis role="bold"><ulink url="http://www.exim.org/eximwiki/ToolExipickManPage">http://www.exim.org/eximwiki/ToolExipickManPage</ulink></emphasis> or run <emphasis>exipick</emphasis> with
63721 the <option>--help</option> option.
63722 </para>
63723 </section>
63724 <section id="SECTcyclogfil">
63725 <title>Cycling log files (exicyclog)</title>
63726 <para>
63727 <indexterm role="concept">
63728 <primary>log</primary>
63729 <secondary>cycling local files</secondary>
63730 </indexterm>
63731 <indexterm role="concept">
63732 <primary>cycling logs</primary>
63733 </indexterm>
63734 <indexterm role="concept">
63735 <primary><emphasis>exicyclog</emphasis></primary>
63736 </indexterm>
63737 The <emphasis>exicyclog</emphasis> script can be used to cycle (rotate) <emphasis>mainlog</emphasis> and
63738 <emphasis>rejectlog</emphasis> files. This is not necessary if only syslog is being used, or if
63739 you are using log files with datestamps in their names (see section
63740 <xref linkend="SECTdatlogfil"/>). Some operating systems have their own standard mechanisms
63741 for log cycling, and these can be used instead of <emphasis>exicyclog</emphasis> if preferred.
63742 There are two command line options for <emphasis>exicyclog</emphasis>:
63743 </para>
63744 <itemizedlist>
63745 <listitem>
63746 <para>
63747 <option>-k</option> &lt;<emphasis>count</emphasis>&gt; specifies the number of log files to keep, overriding the
63748 default that is set when Exim is built. The default default is 10.
63749 </para>
63750 </listitem>
63751 <listitem>
63752 <para>
63753 <option>-l</option> &lt;<emphasis>path</emphasis>&gt; specifies the log file path, in the same format as Exim&#x2019;s
63754 <option>log_file_path</option> option (for example, <literal>/var/log/exim_%slog</literal>), again
63755 overriding the script&#x2019;s default, which is to find the setting from Exim&#x2019;s
63756 configuration.
63757 </para>
63758 </listitem>
63759 </itemizedlist>
63760 <para>
63761 Each time <emphasis>exicyclog</emphasis> is run the file names get <quote>shuffled down</quote> by one. If
63762 the main log file name is <filename>mainlog</filename> (the default) then when <emphasis>exicyclog</emphasis> is
63763 run <filename>mainlog</filename> becomes <filename>mainlog.01</filename>, the previous <filename>mainlog.01</filename> becomes
63764 <filename>mainlog.02</filename> and so on, up to the limit that is set in the script or by the
63765 <option>-k</option> option. Log files whose numbers exceed the limit are discarded. Reject
63766 logs are handled similarly.
63767 </para>
63768 <para>
63769 If the limit is greater than 99, the script uses 3-digit numbers such as
63770 <filename>mainlog.001</filename>, <filename>mainlog.002</filename>, etc. If you change from a number less than 99
63771 to one that is greater, or <emphasis>vice versa</emphasis>, you will have to fix the names of
63772 any existing log files.
63773 </para>
63774 <para>
63775 If no <filename>mainlog</filename> file exists, the script does nothing. Files that <quote>drop off</quote>
63776 the end are deleted. All files with numbers greater than 01 are compressed,
63777 using a compression command which is configured by the COMPRESS_COMMAND
63778 setting in <filename>Local/Makefile</filename>. It is usual to run <emphasis>exicyclog</emphasis> daily from a
63779 root <option>crontab</option> entry of the form
63780 </para>
63781 <literallayout class="monospaced">
63782 1 0 * * * su exim -c /usr/exim/bin/exicyclog
63783 </literallayout>
63784 <para>
63785 assuming you have used the name <quote>exim</quote> for the Exim user. You can run
63786 <emphasis>exicyclog</emphasis> as root if you wish, but there is no need.
63787 </para>
63788 </section>
63789 <section id="SECTmailstat">
63790 <title>Mail statistics (eximstats)</title>
63791 <para>
63792 <indexterm role="concept">
63793 <primary>statistics</primary>
63794 </indexterm>
63795 <indexterm role="concept">
63796 <primary><emphasis>eximstats</emphasis></primary>
63797 </indexterm>
63798 A Perl script called <emphasis>eximstats</emphasis> is provided for extracting statistical
63799 information from log files. The output is either plain text, or HTML.
63800 Exim log files are also supported by the <emphasis>Lire</emphasis> system produced by the
63801 LogReport Foundation <emphasis role="bold"><ulink url="http://www.logreport.org">http://www.logreport.org</ulink></emphasis>.
63802 </para>
63803 <para>
63804 The <emphasis>eximstats</emphasis> script has been hacked about quite a bit over time. The
63805 latest version is the result of some extensive revision by Steve Campbell. A
63806 lot of information is given by default, but there are options for suppressing
63807 various parts of it. Following any options, the arguments to the script are a
63808 list of files, which should be main log files. For example:
63809 </para>
63810 <literallayout class="monospaced">
63811 eximstats -nr /var/spool/exim/log/mainlog.01
63812 </literallayout>
63813 <para>
63814 By default, <emphasis>eximstats</emphasis> extracts information about the number and volume of
63815 messages received from or delivered to various hosts. The information is sorted
63816 both by message count and by volume, and the top fifty hosts in each category
63817 are listed on the standard output. Similar information, based on email
63818 addresses or domains instead of hosts can be requested by means of various
63819 options. For messages delivered and received locally, similar statistics are
63820 also produced per user.
63821 </para>
63822 <para>
63823 The output also includes total counts and statistics about delivery errors, and
63824 histograms showing the number of messages received and deliveries made in each
63825 hour of the day. A delivery with more than one address in its envelope (for
63826 example, an SMTP transaction with more than one RCPT command) is counted
63827 as a single delivery by <emphasis>eximstats</emphasis>.
63828 </para>
63829 <para>
63830 Though normally more deliveries than receipts are reported (as messages may
63831 have multiple recipients), it is possible for <emphasis>eximstats</emphasis> to report more
63832 messages received than delivered, even though the queue is empty at the start
63833 and end of the period in question. If an incoming message contains no valid
63834 recipients, no deliveries are recorded for it. A bounce message is handled as
63835 an entirely separate message.
63836 </para>
63837 <para>
63838 <emphasis>eximstats</emphasis> always outputs a grand total summary giving the volume and number
63839 of messages received and deliveries made, and the number of hosts involved in
63840 each case. It also outputs the number of messages that were delayed (that is,
63841 not completely delivered at the first attempt), and the number that had at
63842 least one address that failed.
63843 </para>
63844 <para>
63845 The remainder of the output is in sections that can be independently disabled
63846 or modified by various options. It consists of a summary of deliveries by
63847 transport, histograms of messages received and delivered per time interval
63848 (default per hour), information about the time messages spent on the queue,
63849 a list of relayed messages, lists of the top fifty sending hosts, local
63850 senders, destination hosts, and destination local users by count and by volume,
63851 and a list of delivery errors that occurred.
63852 </para>
63853 <para>
63854 The relay information lists messages that were actually relayed, that is, they
63855 came from a remote host and were directly delivered to some other remote host,
63856 without being processed (for example, for aliasing or forwarding) locally.
63857 </para>
63858 <para>
63859 There are quite a few options for <emphasis>eximstats</emphasis> to control exactly what it
63860 outputs. These are documented in the Perl script itself, and can be extracted
63861 by running the command <command>perldoc</command> on the script. For example:
63862 </para>
63863 <literallayout class="monospaced">
63864 perldoc /usr/exim/bin/eximstats
63865 </literallayout>
63866 </section>
63867 <section id="SECTcheckaccess">
63868 <title>Checking access policy (exim_checkaccess)</title>
63869 <para>
63870 <indexterm role="concept">
63871 <primary><emphasis>exim_checkaccess</emphasis></primary>
63872 </indexterm>
63873 <indexterm role="concept">
63874 <primary>policy control</primary>
63875 <secondary>checking access</secondary>
63876 </indexterm>
63877 <indexterm role="concept">
63878 <primary>checking access</primary>
63879 </indexterm>
63880 The <option>-bh</option> command line argument allows you to run a fake SMTP session with
63881 debugging output, in order to check what Exim is doing when it is applying
63882 policy controls to incoming SMTP mail. However, not everybody is sufficiently
63883 familiar with the SMTP protocol to be able to make full use of <option>-bh</option>, and
63884 sometimes you just want to answer the question <quote>Does this address have
63885 access?</quote> without bothering with any further details.
63886 </para>
63887 <para>
63888 The <emphasis>exim_checkaccess</emphasis> utility is a <quote>packaged</quote> version of <option>-bh</option>. It takes
63889 two arguments, an IP address and an email address:
63890 </para>
63891 <literallayout class="monospaced">
63892 exim_checkaccess 10.9.8.7 A.User@a.domain.example
63893 </literallayout>
63894 <para>
63895 The utility runs a call to Exim with the <option>-bh</option> option, to test whether the
63896 given email address would be accepted in a RCPT command in a TCP/IP
63897 connection from the host with the given IP address. The output of the utility
63898 is either the word <quote>accepted</quote>, or the SMTP error response, for example:
63899 </para>
63900 <literallayout class="monospaced">
63901 Rejected:
63902 550 Relay not permitted
63903 </literallayout>
63904 <para>
63905 When running this test, the utility uses <literal>&lt;&gt;</literal> as the envelope sender address
63906 for the MAIL command, but you can change this by providing additional
63907 options. These are passed directly to the Exim command. For example, to specify
63908 that the test is to be run with the sender address <emphasis>himself@there.example</emphasis>
63909 you can use:
63910 </para>
63911 <literallayout class="monospaced">
63912 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
63913                  -f himself@there.example
63914 </literallayout>
63915 <para>
63916 Note that these additional Exim command line items must be given after the two
63917 mandatory arguments.
63918 </para>
63919 <para>
63920 Because the <option>exim_checkaccess</option> uses <option>-bh</option>, it does not perform callouts
63921 while running its checks. You can run checks that include callouts by using
63922 <option>-bhc</option>, but this is not yet available in a <quote>packaged</quote> form.
63923 </para>
63924 </section>
63925 <section id="SECTdbmbuild">
63926 <title>Making DBM files (exim_dbmbuild)</title>
63927 <para>
63928 <indexterm role="concept">
63929 <primary>DBM</primary>
63930 <secondary>building dbm files</secondary>
63931 </indexterm>
63932 <indexterm role="concept">
63933 <primary>building DBM files</primary>
63934 </indexterm>
63935 <indexterm role="concept">
63936 <primary><emphasis>exim_dbmbuild</emphasis></primary>
63937 </indexterm>
63938 <indexterm role="concept">
63939 <primary>lower casing</primary>
63940 </indexterm>
63941 <indexterm role="concept">
63942 <primary>binary zero</primary>
63943 <secondary>in lookup key</secondary>
63944 </indexterm>
63945 The <emphasis>exim_dbmbuild</emphasis> program reads an input file containing keys and data in
63946 the format used by the <command>lsearch</command> lookup (see section
63947 <xref linkend="SECTsinglekeylookups"/>). It writes a DBM file using the lower-cased alias
63948 names as keys and the remainder of the information as data. The lower-casing
63949 can be prevented by calling the program with the <option>-nolc</option> option.
63950 </para>
63951 <para>
63952 A terminating zero is included as part of the key string. This is expected by
63953 the <command>dbm</command> lookup type. However, if the option <option>-nozero</option> is given,
63954 <emphasis>exim_dbmbuild</emphasis> creates files without terminating zeroes in either the key
63955 strings or the data strings. The <command>dbmnz</command> lookup type can be used with such
63956 files.
63957 </para>
63958 <para>
63959 The program requires two arguments: the name of the input file (which can be a
63960 single hyphen to indicate the standard input), and the name of the output file.
63961 It creates the output under a temporary name, and then renames it if all went
63962 well.
63963 </para>
63964 <para>
63965 <indexterm role="concept">
63966 <primary>USE_DB</primary>
63967 </indexterm>
63968 If the native DB interface is in use (USE_DB is set in a compile-time
63969 configuration file &ndash; this is common in free versions of Unix) the two file
63970 names must be different, because in this mode the Berkeley DB functions create
63971 a single output file using exactly the name given. For example,
63972 </para>
63973 <literallayout class="monospaced">
63974 exim_dbmbuild /etc/aliases /etc/aliases.db
63975 </literallayout>
63976 <para>
63977 reads the system alias file and creates a DBM version of it in
63978 <filename>/etc/aliases.db</filename>.
63979 </para>
63980 <para>
63981 In systems that use the <emphasis>ndbm</emphasis> routines (mostly proprietary versions of
63982 Unix), two files are used, with the suffixes <filename>.dir</filename> and <filename>.pag</filename>. In this
63983 environment, the suffixes are added to the second argument of
63984 <emphasis>exim_dbmbuild</emphasis>, so it can be the same as the first. This is also the case
63985 when the Berkeley functions are used in compatibility mode (though this is not
63986 recommended), because in that case it adds a <filename>.db</filename> suffix to the file name.
63987 </para>
63988 <para>
63989 If a duplicate key is encountered, the program outputs a warning, and when it
63990 finishes, its return code is 1 rather than zero, unless the <option>-noduperr</option>
63991 option is used. By default, only the first of a set of duplicates is used &ndash;
63992 this makes it compatible with <command>lsearch</command> lookups. There is an option
63993 <option>-lastdup</option> which causes it to use the data for the last duplicate instead.
63994 There is also an option <option>-nowarn</option>, which stops it listing duplicate keys to
63995 <option>stderr</option>. For other errors, where it doesn&#x2019;t actually make a new file, the
63996 return code is 2.
63997 </para>
63998 </section>
63999 <section id="SECTfinindret">
64000 <title>Finding individual retry times (exinext)</title>
64001 <para>
64002 <indexterm role="concept">
64003 <primary>retry</primary>
64004 <secondary>times</secondary>
64005 </indexterm>
64006 <indexterm role="concept">
64007 <primary><emphasis>exinext</emphasis></primary>
64008 </indexterm>
64009 A utility called <emphasis>exinext</emphasis> (mostly a Perl script) provides the ability to
64010 fish specific information out of the retry database. Given a mail domain (or a
64011 complete address), it looks up the hosts for that domain, and outputs any retry
64012 information for the hosts or for the domain. At present, the retry information
64013 is obtained by running <emphasis>exim_dumpdb</emphasis> (see below) and post-processing the
64014 output. For example:
64015 </para>
64016 <literallayout class="monospaced">
64017 $ exinext piglet@milne.fict.example
64018 kanga.milne.example:192.168.8.1 error 146: Connection refused
64019   first failed: 21-Feb-1996 14:57:34
64020   last tried:   21-Feb-1996 14:57:34
64021   next try at:  21-Feb-1996 15:02:34
64022 roo.milne.example:192.168.8.3 error 146: Connection refused
64023   first failed: 20-Jan-1996 13:12:08
64024   last tried:   21-Feb-1996 11:42:03
64025   next try at:  21-Feb-1996 19:42:03
64026   past final cutoff time
64027 </literallayout>
64028 <para>
64029 You can also give <emphasis>exinext</emphasis> a local part, without a domain, and it
64030 will give any retry information for that local part in your default domain.
64031 A message id can be used to obtain retry information pertaining to a specific
64032 message. This exists only when an attempt to deliver a message to a remote host
64033 suffers a message-specific error (see section <xref linkend="SECToutSMTPerr"/>).
64034 <emphasis>exinext</emphasis> is not particularly efficient, but then it is not expected to be
64035 run very often.
64036 </para>
64037 <para>
64038 The <emphasis>exinext</emphasis> utility calls Exim to find out information such as the location
64039 of the spool directory. The utility has <option>-C</option> and <option>-D</option> options, which are
64040 passed on to the <emphasis>exim</emphasis> commands. The first specifies an alternate Exim
64041 configuration file, and the second sets macros for use within the configuration
64042 file. These features are mainly to help in testing, but might also be useful in
64043 environments where more than one configuration file is in use.
64044 </para>
64045 </section>
64046 <section id="SECThindatmai">
64047 <title>Hints database maintenance</title>
64048 <para>
64049 <indexterm role="concept">
64050 <primary>hints database</primary>
64051 <secondary>maintenance</secondary>
64052 </indexterm>
64053 <indexterm role="concept">
64054 <primary>maintaining Exim&#x2019;s hints database</primary>
64055 </indexterm>
64056 Three utility programs are provided for maintaining the DBM files that Exim
64057 uses to contain its delivery hint information. Each program requires two
64058 arguments. The first specifies the name of Exim&#x2019;s spool directory, and the
64059 second is the name of the database it is to operate on. These are as follows:
64060 </para>
64061 <itemizedlist>
64062 <listitem>
64063 <para>
64064 <emphasis>retry</emphasis>: the database of retry information
64065 </para>
64066 </listitem>
64067 <listitem>
64068 <para>
64069 <emphasis>wait-</emphasis>&lt;<emphasis>transport name</emphasis>&gt;: databases of information about messages waiting
64070 for remote hosts
64071 </para>
64072 </listitem>
64073 <listitem>
64074 <para>
64075 <emphasis>callout</emphasis>: the callout cache
64076 </para>
64077 </listitem>
64078 <listitem>
64079 <para>
64080 <emphasis>ratelimit</emphasis>: the data for implementing the ratelimit ACL condition
64081 </para>
64082 </listitem>
64083 <listitem>
64084 <para>
64085 <emphasis>misc</emphasis>: other hints data
64086 </para>
64087 </listitem>
64088 </itemizedlist>
64089 <para>
64090 The <emphasis>misc</emphasis> database is used for
64091 </para>
64092 <itemizedlist>
64093 <listitem>
64094 <para>
64095 Serializing ETRN runs (when <option>smtp_etrn_serialize</option> is set)
64096 </para>
64097 </listitem>
64098 <listitem>
64099 <para>
64100 Serializing delivery to a specific host (when <option>serialize_hosts</option> is set in an
64101 <command>smtp</command> transport)
64102 </para>
64103 </listitem>
64104 </itemizedlist>
64105 </section>
64106 <section id="SECID261">
64107 <title>exim_dumpdb</title>
64108 <para>
64109 <indexterm role="concept">
64110 <primary><emphasis>exim_dumpdb</emphasis></primary>
64111 </indexterm>
64112 The entire contents of a database are written to the standard output by the
64113 <emphasis>exim_dumpdb</emphasis> program, which has no options or arguments other than the
64114 spool and database names. For example, to dump the retry database:
64115 </para>
64116 <literallayout class="monospaced">
64117 exim_dumpdb /var/spool/exim retry
64118 </literallayout>
64119 <para>
64120 Two lines of output are produced for each entry:
64121 </para>
64122 <literallayout class="monospaced">
64123 T:mail.ref.example:192.168.242.242 146 77 Connection refused
64124 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
64125 </literallayout>
64126 <para>
64127 The first item on the first line is the key of the record. It starts with one
64128 of the letters R, or T, depending on whether it refers to a routing or
64129 transport retry. For a local delivery, the next part is the local address; for
64130 a remote delivery it is the name of the remote host, followed by its failing IP
64131 address (unless <option>retry_include_ip_address</option> is set false on the <command>smtp</command>
64132 transport). If the remote port is not the standard one (port 25), it is added
64133 to the IP address. Then there follows an error code, an additional error code,
64134 and a textual description of the error.
64135 </para>
64136 <para>
64137 The three times on the second line are the time of first failure, the time of
64138 the last delivery attempt, and the computed time for the next attempt. The line
64139 ends with an asterisk if the cutoff time for the last retry rule has been
64140 exceeded.
64141 </para>
64142 <para>
64143 Each output line from <emphasis>exim_dumpdb</emphasis> for the <emphasis>wait-xxx</emphasis> databases
64144 consists of a host name followed by a list of ids for messages that are or were
64145 waiting to be delivered to that host. If there are a very large number for any
64146 one host, continuation records, with a sequence number added to the host name,
64147 may be seen. The data in these records is often out of date, because a message
64148 may be routed to several alternative hosts, and Exim makes no effort to keep
64149 cross-references.
64150 </para>
64151 </section>
64152 <section id="SECID262">
64153 <title>exim_tidydb</title>
64154 <para>
64155 <indexterm role="concept">
64156 <primary><emphasis>exim_tidydb</emphasis></primary>
64157 </indexterm>
64158 The <emphasis>exim_tidydb</emphasis> utility program is used to tidy up the contents of a hints
64159 database. If run with no options, it removes all records that are more than 30
64160 days old. The age is calculated from the date and time that the record was last
64161 updated. Note that, in the case of the retry database, it is <emphasis>not</emphasis> the time
64162 since the first delivery failure. Information about a host that has been down
64163 for more than 30 days will remain in the database, provided that the record is
64164 updated sufficiently often.
64165 </para>
64166 <para>
64167 The cutoff date can be altered by means of the <option>-t</option> option, which must be
64168 followed by a time. For example, to remove all records older than a week from
64169 the retry database:
64170 </para>
64171 <literallayout class="monospaced">
64172 exim_tidydb -t 7d /var/spool/exim retry
64173 </literallayout>
64174 <para>
64175 Both the <emphasis>wait-xxx</emphasis> and <emphasis>retry</emphasis> databases contain items that involve
64176 message ids. In the former these appear as data in records keyed by host &ndash;
64177 they were messages that were waiting for that host &ndash; and in the latter they
64178 are the keys for retry information for messages that have suffered certain
64179 types of error. When <emphasis>exim_tidydb</emphasis> is run, a check is made to ensure that
64180 message ids in database records are those of messages that are still on the
64181 queue. Message ids for messages that no longer exist are removed from
64182 <emphasis>wait-xxx</emphasis> records, and if this leaves any records empty, they are deleted.
64183 For the <emphasis>retry</emphasis> database, records whose keys are non-existent message ids are
64184 removed. The <emphasis>exim_tidydb</emphasis> utility outputs comments on the standard output
64185 whenever it removes information from the database.
64186 </para>
64187 <para>
64188 Certain records are automatically removed by Exim when they are no longer
64189 needed, but others are not. For example, if all the MX hosts for a domain are
64190 down, a retry record is created for each one. If the primary MX host comes back
64191 first, its record is removed when Exim successfully delivers to it, but the
64192 records for the others remain because Exim has not tried to use those hosts.
64193 </para>
64194 <para>
64195 It is important, therefore, to run <emphasis>exim_tidydb</emphasis> periodically on all the
64196 hints databases. You should do this at a quiet time of day, because it requires
64197 a database to be locked (and therefore inaccessible to Exim) while it does its
64198 work. Removing records from a DBM file does not normally make the file smaller,
64199 but all the common DBM libraries are able to re-use the space that is released.
64200 After an initial phase of increasing in size, the databases normally reach a
64201 point at which they no longer get any bigger, as long as they are regularly
64202 tidied.
64203 </para>
64204 <para>
64205 <emphasis role="bold">Warning</emphasis>: If you never run <emphasis>exim_tidydb</emphasis>, the space used by the hints
64206 databases is likely to keep on increasing.
64207 </para>
64208 </section>
64209 <section id="SECID263">
64210 <title>exim_fixdb</title>
64211 <para>
64212 <indexterm role="concept">
64213 <primary><emphasis>exim_fixdb</emphasis></primary>
64214 </indexterm>
64215 The <emphasis>exim_fixdb</emphasis> program is a utility for interactively modifying databases.
64216 Its main use is for testing Exim, but it might also be occasionally useful for
64217 getting round problems in a live system. It has no options, and its interface
64218 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
64219 key of a database record can then be entered, and the data for that record is
64220 displayed.
64221 </para>
64222 <para>
64223 If <quote>d</quote> is typed at the next prompt, the entire record is deleted. For all
64224 except the <emphasis>retry</emphasis> database, that is the only operation that can be carried
64225 out. For the <emphasis>retry</emphasis> database, each field is output preceded by a number, and
64226 data for individual fields can be changed by typing the field number followed
64227 by new data, for example:
64228 </para>
64229 <literallayout class="monospaced">
64230 &gt; 4 951102:1000
64231 </literallayout>
64232 <para>
64233 resets the time of the next delivery attempt. Time values are given as a
64234 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
64235 used as optional separators.
64236 </para>
64237 </section>
64238 <section id="SECTmailboxmaint">
64239 <title>Mailbox maintenance (exim_lock)</title>
64240 <para>
64241 <indexterm role="concept">
64242 <primary>mailbox</primary>
64243 <secondary>maintenance</secondary>
64244 </indexterm>
64245 <indexterm role="concept">
64246 <primary><emphasis>exim_lock</emphasis></primary>
64247 </indexterm>
64248 <indexterm role="concept">
64249 <primary>locking mailboxes</primary>
64250 </indexterm>
64251 The <emphasis>exim_lock</emphasis> utility locks a mailbox file using the same algorithm as
64252 Exim. For a discussion of locking issues, see section <xref linkend="SECTopappend"/>.
64253 <emphasis>Exim_lock</emphasis> can be used to prevent any modification of a mailbox by Exim or
64254 a user agent while investigating a problem. The utility requires the name of
64255 the file as its first argument. If the locking is successful, the second
64256 argument is run as a command (using C&#x2019;s <function>system()</function> function); if there is no
64257 second argument, the value of the SHELL environment variable is used; if this
64258 is unset or empty, <filename>/bin/sh</filename> is run. When the command finishes, the mailbox
64259 is unlocked and the utility ends. The following options are available:
64260 </para>
64261 <variablelist>
64262 <varlistentry>
64263 <term><option>-fcntl</option></term>
64264 <listitem>
64265 <para>
64266 Use <function>fcntl()</function> locking on the open mailbox.
64267 </para>
64268 </listitem></varlistentry>
64269 <varlistentry>
64270 <term><option>-flock</option></term>
64271 <listitem>
64272 <para>
64273 Use <function>flock()</function> locking on the open mailbox, provided the operating system
64274 supports it.
64275 </para>
64276 </listitem></varlistentry>
64277 <varlistentry>
64278 <term><option>-interval</option></term>
64279 <listitem>
64280 <para>
64281 This must be followed by a number, which is a number of seconds; it sets the
64282 interval to sleep between retries (default 3).
64283 </para>
64284 </listitem></varlistentry>
64285 <varlistentry>
64286 <term><option>-lockfile</option></term>
64287 <listitem>
64288 <para>
64289 Create a lock file before opening the mailbox.
64290 </para>
64291 </listitem></varlistentry>
64292 <varlistentry>
64293 <term><option>-mbx</option></term>
64294 <listitem>
64295 <para>
64296 Lock the mailbox using MBX rules.
64297 </para>
64298 </listitem></varlistentry>
64299 <varlistentry>
64300 <term><option>-q</option></term>
64301 <listitem>
64302 <para>
64303 Suppress verification output.
64304 </para>
64305 </listitem></varlistentry>
64306 <varlistentry>
64307 <term><option>-retries</option></term>
64308 <listitem>
64309 <para>
64310 This must be followed by a number; it sets the number of times to try to get
64311 the lock (default 10).
64312 </para>
64313 </listitem></varlistentry>
64314 <varlistentry>
64315 <term><option>-restore_time</option></term>
64316 <listitem>
64317 <para>
64318 This option causes <option>exim_lock</option> to restore the modified and read times to the
64319 locked file before exiting. This allows you to access a locked mailbox (for
64320 example, to take a backup copy) without disturbing the times that the user
64321 subsequently sees.
64322 </para>
64323 </listitem></varlistentry>
64324 <varlistentry>
64325 <term><option>-timeout</option></term>
64326 <listitem>
64327 <para>
64328 This must be followed by a number, which is a number of seconds; it sets a
64329 timeout to be used with a blocking <function>fcntl()</function> lock. If it is not set (the
64330 default), a non-blocking call is used.
64331 </para>
64332 </listitem></varlistentry>
64333 <varlistentry>
64334 <term><option>-v</option></term>
64335 <listitem>
64336 <para>
64337 Generate verbose output.
64338 </para>
64339 </listitem></varlistentry>
64340 </variablelist>
64341 <para>
64342 If none of <option>-fcntl</option>, <option>-flock</option>, <option>-lockfile</option> or <option>-mbx</option> are given, the
64343 default is to create a lock file and also to use <function>fcntl()</function> locking on the
64344 mailbox, which is the same as Exim&#x2019;s default. The use of <option>-flock</option> or
64345 <option>-fcntl</option> requires that the file be writeable; the use of <option>-lockfile</option>
64346 requires that the directory containing the file be writeable. Locking by lock
64347 file does not last for ever; Exim assumes that a lock file is expired if it is
64348 more than 30 minutes old.
64349 </para>
64350 <para>
64351 The <option>-mbx</option> option can be used with either or both of <option>-fcntl</option> or
64352 <option>-flock</option>. It assumes <option>-fcntl</option> by default. MBX locking causes a shared lock
64353 to be taken out on the open mailbox, and an exclusive lock on the file
64354 <filename>/tmp/.n.m</filename> where <emphasis>n</emphasis> and <emphasis>m</emphasis> are the device number and inode
64355 number of the mailbox file. When the locking is released, if an exclusive lock
64356 can be obtained for the mailbox, the file in <filename>/tmp</filename> is deleted.
64357 </para>
64358 <para>
64359 The default output contains verification of the locking that takes place. The
64360 <option>-v</option> option causes some additional information to be given. The <option>-q</option> option
64361 suppresses all output except error messages.
64362 </para>
64363 <para>
64364 A command such as
64365 </para>
64366 <literallayout class="monospaced">
64367 exim_lock /var/spool/mail/spqr
64368 </literallayout>
64369 <para>
64370 runs an interactive shell while the file is locked, whereas
64371 </para>
64372 <literallayout>
64373 <literal>exim_lock -q /var/spool/mail/spqr &lt;&lt;End</literal>
64374 &lt;<emphasis>some commands</emphasis>&gt;
64375 <literal>End</literal>
64376 </literallayout>
64377 <para>
64378 runs a specific non-interactive sequence of commands while the file is locked,
64379 suppressing all verification output. A single command can be run by a command
64380 such as
64381 </para>
64382 <literallayout class="monospaced">
64383 exim_lock -q /var/spool/mail/spqr \
64384   "cp /var/spool/mail/spqr /some/where"
64385 </literallayout>
64386 <para>
64387 Note that if a command is supplied, it must be entirely contained within the
64388 second argument &ndash; hence the quotes.
64389 <indexterm role="concept" startref="IIDutils" class="endofrange"/>
64390 </para>
64391 </section>
64392 </chapter>
64393
64394 <chapter id="CHAPeximon">
64395 <title>The Exim monitor</title>
64396 <para>
64397 <indexterm role="concept" id="IIDeximon" class="startofrange">
64398 <primary>Exim monitor</primary>
64399 <secondary>description</secondary>
64400 </indexterm>
64401 <indexterm role="concept">
64402 <primary>X-windows</primary>
64403 </indexterm>
64404 <indexterm role="concept">
64405 <primary><emphasis>eximon</emphasis></primary>
64406 </indexterm>
64407 <indexterm role="concept">
64408 <primary>Local/eximon.conf</primary>
64409 </indexterm>
64410 <indexterm role="concept">
64411 <primary><filename>exim_monitor/EDITME</filename></primary>
64412 </indexterm>
64413 The Exim monitor is an application which displays in an X window information
64414 about the state of Exim&#x2019;s queue and what Exim is doing. An admin user can
64415 perform certain operations on messages from this GUI interface; however all
64416 such facilities are also available from the command line, and indeed, the
64417 monitor itself makes use of the command line to perform any actions requested.
64418 </para>
64419 <section id="SECID264">
64420 <title>Running the monitor</title>
64421 <para>
64422 The monitor is started by running the script called <emphasis>eximon</emphasis>. This is a shell
64423 script that sets up a number of environment variables, and then runs the
64424 binary called <filename>eximon.bin</filename>. The default appearance of the monitor window can
64425 be changed by editing the <filename>Local/eximon.conf</filename> file created by editing
64426 <filename>exim_monitor/EDITME</filename>. Comments in that file describe what the various
64427 parameters are for.
64428 </para>
64429 <para>
64430 The parameters that get built into the <emphasis>eximon</emphasis> script can be overridden for
64431 a particular invocation by setting up environment variables of the same names,
64432 preceded by <literal>EXIMON_</literal>. For example, a shell command such as
64433 </para>
64434 <literallayout class="monospaced">
64435 EXIMON_LOG_DEPTH=400 eximon
64436 </literallayout>
64437 <para>
64438 (in a Bourne-compatible shell) runs <emphasis>eximon</emphasis> with an overriding setting of
64439 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
64440 overrides the Exim log file configuration. This makes it possible to have
64441 <emphasis>eximon</emphasis> tailing log data that is written to syslog, provided that MAIL.INFO
64442 syslog messages are routed to a file on the local host.
64443 </para>
64444 <para>
64445 X resources can be used to change the appearance of the window in the normal
64446 way. For example, a resource setting of the form
64447 </para>
64448 <literallayout class="monospaced">
64449 Eximon*background: gray94
64450 </literallayout>
64451 <para>
64452 changes the colour of the background to light grey rather than white. The
64453 stripcharts are drawn with both the data lines and the reference lines in
64454 black. This means that the reference lines are not visible when on top of the
64455 data. However, their colour can be changed by setting a resource called
64456 <quote>highlight</quote> (an odd name, but that&#x2019;s what the Athena stripchart widget uses).
64457 For example, if your X server is running Unix, you could set up lighter
64458 reference lines in the stripcharts by obeying
64459 </para>
64460 <literallayout class="monospaced">
64461 xrdb -merge &lt;&lt;End
64462 Eximon*highlight: gray
64463 End
64464 </literallayout>
64465 <para>
64466 <indexterm role="concept">
64467 <primary>admin user</primary>
64468 </indexterm>
64469 In order to see the contents of messages on the queue, and to operate on them,
64470 <emphasis>eximon</emphasis> must either be run as root or by an admin user.
64471 </para>
64472 <para>
64473 The command-line parameters of <emphasis>eximon</emphasis> are passed to <filename>eximon.bin</filename> and may
64474 contain X11 resource parameters interpreted by the X11 library.  In addition,
64475 if the first parameter starts with the string "gdb" then it is removed and the
64476 binary is invoked under gdb (the parameter is used as the gdb command-name, so
64477 versioned variants of gdb can be invoked).
64478 </para>
64479 <para>
64480 The monitor&#x2019;s window is divided into three parts. The first contains one or
64481 more stripcharts and two action buttons, the second contains a <quote>tail</quote> of the
64482 main log file, and the third is a display of the queue of messages awaiting
64483 delivery, with two more action buttons. The following sections describe these
64484 different parts of the display.
64485 </para>
64486 </section>
64487 <section id="SECID265">
64488 <title>The stripcharts</title>
64489 <para>
64490 <indexterm role="concept">
64491 <primary>stripchart</primary>
64492 </indexterm>
64493 The first stripchart is always a count of messages on the queue. Its name can
64494 be configured by setting QUEUE_STRIPCHART_NAME in the
64495 <filename>Local/eximon.conf</filename> file. The remaining stripcharts are defined in the
64496 configuration script by regular expression matches on log file entries, making
64497 it possible to display, for example, counts of messages delivered to certain
64498 hosts or using certain transports. The supplied defaults display counts of
64499 received and delivered messages, and of local and SMTP deliveries. The default
64500 period between stripchart updates is one minute; this can be adjusted by a
64501 parameter in the <filename>Local/eximon.conf</filename> file.
64502 </para>
64503 <para>
64504 The stripchart displays rescale themselves automatically as the value they are
64505 displaying changes. There are always 10 horizontal lines in each chart; the
64506 title string indicates the value of each division when it is greater than one.
64507 For example, <quote>x2</quote> means that each division represents a value of 2.
64508 </para>
64509 <para>
64510 It is also possible to have a stripchart which shows the percentage fullness of
64511 a particular disk partition, which is useful when local deliveries are confined
64512 to a single partition.
64513 </para>
64514 <para>
64515 <indexterm role="concept">
64516 <primary><option>statvfs</option> function</primary>
64517 </indexterm>
64518 This relies on the availability of the <function>statvfs()</function> function or equivalent in
64519 the operating system. Most, but not all versions of Unix that support Exim have
64520 this. For this particular stripchart, the top of the chart always represents
64521 100%, and the scale is given as <quote>x10%</quote>. This chart is configured by setting
64522 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
64523 <filename>Local/eximon.conf</filename> file.
64524 </para>
64525 </section>
64526 <section id="SECID266">
64527 <title>Main action buttons</title>
64528 <para>
64529 <indexterm role="concept">
64530 <primary>size</primary>
64531 <secondary>of monitor window</secondary>
64532 </indexterm>
64533 <indexterm role="concept">
64534 <primary>Exim monitor</primary>
64535 <secondary>window size</secondary>
64536 </indexterm>
64537 <indexterm role="concept">
64538 <primary>window size</primary>
64539 </indexterm>
64540 Below the stripcharts there is an action button for quitting the monitor. Next
64541 to this is another button marked <quote>Size</quote>. They are placed here so that
64542 shrinking the window to its default minimum size leaves just the queue count
64543 stripchart and these two buttons visible. Pressing the <quote>Size</quote> button causes
64544 the window to expand to its maximum size, unless it is already at the maximum,
64545 in which case it is reduced to its minimum.
64546 </para>
64547 <para>
64548 When expanding to the maximum, if the window cannot be fully seen where it
64549 currently is, it is moved back to where it was the last time it was at full
64550 size. When it is expanding from its minimum size, the old position is
64551 remembered, and next time it is reduced to the minimum it is moved back there.
64552 </para>
64553 <para>
64554 The idea is that you can keep a reduced window just showing one or two
64555 stripcharts at a convenient place on your screen, easily expand it to show
64556 the full window when required, and just as easily put it back to what it was.
64557 The idea is copied from what the <emphasis>twm</emphasis> window manager does for its
64558 <emphasis>f.fullzoom</emphasis> action. The minimum size of the window can be changed by setting
64559 the MIN_HEIGHT and MIN_WIDTH values in <filename>Local/eximon.conf</filename>.
64560 </para>
64561 <para>
64562 Normally, the monitor starts up with the window at its full size, but it can be
64563 built so that it starts up with the window at its smallest size, by setting
64564 START_SMALL=yes in <filename>Local/eximon.conf</filename>.
64565 </para>
64566 </section>
64567 <section id="SECID267">
64568 <title>The log display</title>
64569 <para>
64570 <indexterm role="concept">
64571 <primary>log</primary>
64572 <secondary>tail of; in monitor</secondary>
64573 </indexterm>
64574 The second section of the window is an area in which a display of the tail of
64575 the main log is maintained.
64576 To save space on the screen, the timestamp on each log line is shortened by
64577 removing the date and, if <option>log_timezone</option> is set, the timezone.
64578 The log tail is not available when the only destination for logging data is
64579 syslog, unless the syslog lines are routed to a local file whose name is passed
64580 to <emphasis>eximon</emphasis> via the EXIMON_LOG_FILE_PATH environment variable.
64581 </para>
64582 <para>
64583 The log sub-window has a scroll bar at its lefthand side which can be used to
64584 move back to look at earlier text, and the up and down arrow keys also have a
64585 scrolling effect. The amount of log that is kept depends on the setting of
64586 LOG_BUFFER in <filename>Local/eximon.conf</filename>, which specifies the amount of memory
64587 to use. When this is full, the earlier 50% of data is discarded &ndash; this is
64588 much more efficient than throwing it away line by line. The sub-window also has
64589 a horizontal scroll bar for accessing the ends of long log lines. This is the
64590 only means of horizontal scrolling; the right and left arrow keys are not
64591 available. Text can be cut from this part of the window using the mouse in the
64592 normal way. The size of this subwindow is controlled by parameters in the
64593 configuration file <filename>Local/eximon.conf</filename>.
64594 </para>
64595 <para>
64596 Searches of the text in the log window can be carried out by means of the ^R
64597 and ^S keystrokes, which default to a reverse and a forward search,
64598 respectively. The search covers only the text that is displayed in the window.
64599 It cannot go further back up the log.
64600 </para>
64601 <para>
64602 The point from which the search starts is indicated by a caret marker. This is
64603 normally at the end of the text in the window, but can be positioned explicitly
64604 by pointing and clicking with the left mouse button, and is moved automatically
64605 by a successful search. If new text arrives in the window when it is scrolled
64606 back, the caret remains where it is, but if the window is not scrolled back,
64607 the caret is moved to the end of the new text.
64608 </para>
64609 <para>
64610 Pressing ^R or ^S pops up a window into which the search text can be typed.
64611 There are buttons for selecting forward or reverse searching, for carrying out
64612 the search, and for cancelling. If the <quote>Search</quote> button is pressed, the search
64613 happens and the window remains so that further searches can be done. If the
64614 <quote>Return</quote> key is pressed, a single search is done and the window is closed. If
64615 ^C is typed the search is cancelled.
64616 </para>
64617 <para>
64618 The searching facility is implemented using the facilities of the Athena text
64619 widget. By default this pops up a window containing both <quote>search</quote> and
64620 <quote>replace</quote> options. In order to suppress the unwanted <quote>replace</quote> portion for
64621 eximon, a modified version of the <option>TextPop</option> widget is distributed with Exim.
64622 However, the linkers in BSDI and HP-UX seem unable to handle an externally
64623 provided version of <option>TextPop</option> when the remaining parts of the text widget
64624 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
64625 unset to cut out the modified <option>TextPop</option>, making it possible to build Eximon
64626 on these systems, at the expense of having unwanted items in the search popup
64627 window.
64628 </para>
64629 </section>
64630 <section id="SECID268">
64631 <title>The queue display</title>
64632 <para>
64633 <indexterm role="concept">
64634 <primary>queue</primary>
64635 <secondary>display in monitor</secondary>
64636 </indexterm>
64637 The bottom section of the monitor window contains a list of all messages that
64638 are on the queue, which includes those currently being received or delivered,
64639 as well as those awaiting delivery. The size of this subwindow is controlled by
64640 parameters in the configuration file <filename>Local/eximon.conf</filename>, and the frequency
64641 at which it is updated is controlled by another parameter in the same file &ndash;
64642 the default is 5 minutes, since queue scans can be quite expensive. However,
64643 there is an <quote>Update</quote> action button just above the display which can be used
64644 to force an update of the queue display at any time.
64645 </para>
64646 <para>
64647 When a host is down for some time, a lot of pending mail can build up for it,
64648 and this can make it hard to deal with other messages on the queue. To help
64649 with this situation there is a button next to <quote>Update</quote> called <quote>Hide</quote>. If
64650 pressed, a dialogue box called <quote>Hide addresses ending with</quote> is put up. If you
64651 type anything in here and press <quote>Return</quote>, the text is added to a chain of
64652 such texts, and if every undelivered address in a message matches at least one
64653 of the texts, the message is not displayed.
64654 </para>
64655 <para>
64656 If there is an address that does not match any of the texts, all the addresses
64657 are displayed as normal. The matching happens on the ends of addresses so, for
64658 example, <emphasis>cam.ac.uk</emphasis> specifies all addresses in Cambridge, while
64659 <emphasis>xxx@foo.com.example</emphasis> specifies just one specific address. When any hiding
64660 has been set up, a button called <quote>Unhide</quote> is displayed. If pressed, it
64661 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
64662 a hide request is automatically cancelled after one hour.
64663 </para>
64664 <para>
64665 While the dialogue box is displayed, you can&#x2019;t press any buttons or do anything
64666 else to the monitor window. For this reason, if you want to cut text from the
64667 queue display to use in the dialogue box, you have to do the cutting before
64668 pressing the <quote>Hide</quote> button.
64669 </para>
64670 <para>
64671 The queue display contains, for each unhidden queued message, the length of
64672 time it has been on the queue, the size of the message, the message id, the
64673 message sender, and the first undelivered recipient, all on one line. If it is
64674 a bounce message, the sender is shown as <quote>&lt;&gt;</quote>. If there is more than one
64675 recipient to which the message has not yet been delivered, subsequent ones are
64676 listed on additional lines, up to a maximum configured number, following which
64677 an ellipsis is displayed. Recipients that have already received the message are
64678 not shown.
64679 </para>
64680 <para>
64681 <indexterm role="concept">
64682 <primary>frozen messages</primary>
64683 <secondary>display</secondary>
64684 </indexterm>
64685 If a message is frozen, an asterisk is displayed at the left-hand side.
64686 </para>
64687 <para>
64688 The queue display has a vertical scroll bar, and can also be scrolled by means
64689 of the arrow keys. Text can be cut from it using the mouse in the normal way.
64690 The text searching facilities, as described above for the log window, are also
64691 available, but the caret is always moved to the end of the text when the queue
64692 display is updated.
64693 </para>
64694 </section>
64695 <section id="SECID269">
64696 <title>The queue menu</title>
64697 <para>
64698 <indexterm role="concept">
64699 <primary>queue</primary>
64700 <secondary>menu in monitor</secondary>
64701 </indexterm>
64702 If the <option>shift</option> key is held down and the left button is clicked when the mouse
64703 pointer is over the text for any message, an action menu pops up, and the first
64704 line of the queue display for the message is highlighted. This does not affect
64705 any selected text.
64706 </para>
64707 <para>
64708 If you want to use some other event for popping up the menu, you can set the
64709 MENU_EVENT parameter in <filename>Local/eximon.conf</filename> to change the default, or
64710 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
64711 value set in this parameter is a standard X event description. For example, to
64712 run eximon using <option>ctrl</option> rather than <option>shift</option> you could use
64713 </para>
64714 <literallayout class="monospaced">
64715 EXIMON_MENU_EVENT='Ctrl&lt;Btn1Down&gt;' eximon
64716 </literallayout>
64717 <para>
64718 The title of the menu is the message id, and it contains entries which act as
64719 follows:
64720 </para>
64721 <itemizedlist>
64722 <listitem>
64723 <para>
64724 <emphasis>message log</emphasis>: The contents of the message log for the message are displayed
64725 in a new text window.
64726 </para>
64727 </listitem>
64728 <listitem>
64729 <para>
64730 <emphasis>headers</emphasis>: Information from the spool file that contains the envelope
64731 information and headers is displayed in a new text window. See chapter
64732 <xref linkend="CHAPspool"/> for a description of the format of spool files.
64733 </para>
64734 </listitem>
64735 <listitem>
64736 <para>
64737 <emphasis>body</emphasis>: The contents of the spool file containing the body of the message are
64738 displayed in a new text window. There is a default limit of 20,000 bytes to the
64739 amount of data displayed. This can be changed by setting the BODY_MAX
64740 option at compile time, or the EXIMON_BODY_MAX option at run time.
64741 </para>
64742 </listitem>
64743 <listitem>
64744 <para>
64745 <emphasis>deliver message</emphasis>: A call to Exim is made using the <option>-M</option> option to request
64746 delivery of the message. This causes an automatic thaw if the message is
64747 frozen. The <option>-v</option> option is also set, and the output from Exim is displayed in
64748 a new text window. The delivery is run in a separate process, to avoid holding
64749 up the monitor while the delivery proceeds.
64750 </para>
64751 </listitem>
64752 <listitem>
64753 <para>
64754 <emphasis>freeze message</emphasis>: A call to Exim is made using the <option>-Mf</option> option to request
64755 that the message be frozen.
64756 </para>
64757 </listitem>
64758 <listitem>
64759 <para>
64760 <indexterm role="concept">
64761 <primary>thawing messages</primary>
64762 </indexterm>
64763 <indexterm role="concept">
64764 <primary>unfreezing messages</primary>
64765 </indexterm>
64766 <indexterm role="concept">
64767 <primary>frozen messages</primary>
64768 <secondary>thawing</secondary>
64769 </indexterm>
64770 <emphasis>thaw message</emphasis>: A call to Exim is made using the <option>-Mt</option> option to request
64771 that the message be thawed.
64772 </para>
64773 </listitem>
64774 <listitem>
64775 <para>
64776 <indexterm role="concept">
64777 <primary>delivery</primary>
64778 <secondary>forcing failure</secondary>
64779 </indexterm>
64780 <emphasis>give up on msg</emphasis>: A call to Exim is made using the <option>-Mg</option> option to request
64781 that Exim gives up trying to deliver the message. A bounce message is generated
64782 for any remaining undelivered addresses.
64783 </para>
64784 </listitem>
64785 <listitem>
64786 <para>
64787 <emphasis>remove message</emphasis>: A call to Exim is made using the <option>-Mrm</option> option to request
64788 that the message be deleted from the system without generating a bounce
64789 message.
64790 </para>
64791 </listitem>
64792 <listitem>
64793 <para>
64794 <emphasis>add recipient</emphasis>: A dialog box is displayed into which a recipient address can
64795 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
64796 is set in <filename>Local/eximon.conf</filename>, the address is qualified with that domain.
64797 Otherwise it must be entered as a fully qualified address. Pressing RETURN
64798 causes a call to Exim to be made using the <option>-Mar</option> option to request that an
64799 additional recipient be added to the message, unless the entry box is empty, in
64800 which case no action is taken.
64801 </para>
64802 </listitem>
64803 <listitem>
64804 <para>
64805 <emphasis>mark delivered</emphasis>: A dialog box is displayed into which a recipient address
64806 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
64807 is set in <filename>Local/eximon.conf</filename>, the address is qualified with that domain.
64808 Otherwise it must be entered as a fully qualified address. Pressing RETURN
64809 causes a call to Exim to be made using the <option>-Mmd</option> option to mark the given
64810 recipient address as already delivered, unless the entry box is empty, in which
64811 case no action is taken.
64812 </para>
64813 </listitem>
64814 <listitem>
64815 <para>
64816 <emphasis>mark all delivered</emphasis>: A call to Exim is made using the <option>-Mmad</option> option to
64817 mark all recipient addresses as already delivered.
64818 </para>
64819 </listitem>
64820 <listitem>
64821 <para>
64822 <emphasis>edit sender</emphasis>: A dialog box is displayed initialized with the current
64823 sender&#x2019;s address. Pressing RETURN causes a call to Exim to be made using the
64824 <option>-Mes</option> option to replace the sender address, unless the entry box is empty,
64825 in which case no action is taken. If you want to set an empty sender (as in
64826 bounce messages), you must specify it as <quote>&lt;&gt;</quote>. Otherwise, if the address is
64827 not qualified and the QUALIFY_DOMAIN parameter is set in <filename>Local/eximon.conf</filename>,
64828 the address is qualified with that domain.
64829 </para>
64830 </listitem>
64831 </itemizedlist>
64832 <para>
64833 When a delivery is forced, a window showing the <option>-v</option> output is displayed. In
64834 other cases when a call to Exim is made, if there is any output from Exim (in
64835 particular, if the command fails) a window containing the command and the
64836 output is displayed. Otherwise, the results of the action are normally apparent
64837 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
64838 <filename>Local/eximon.conf</filename>, a window showing the Exim command is always opened, even
64839 if no output is generated.
64840 </para>
64841 <para>
64842 The queue display is automatically updated for actions such as freezing and
64843 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
64844 <filename>Local/eximon.conf</filename>. In this case the <quote>Update</quote> button has to be used to
64845 force an update of the display after one of these actions.
64846 </para>
64847 <para>
64848 In any text window that is displayed as result of a menu action, the normal
64849 cut-and-paste facility is available, and searching can be carried out using ^R
64850 and ^S, as described above for the log tail window.
64851 <indexterm role="concept" startref="IIDeximon" class="endofrange"/>
64852 </para>
64853 </section>
64854 </chapter>
64855
64856 <chapter id="CHAPsecurity">
64857 <title>Security considerations</title>
64858 <para>
64859 <indexterm role="concept" id="IIDsecurcon" class="startofrange">
64860 <primary>security</primary>
64861 <secondary>discussion of</secondary>
64862 </indexterm>
64863 This chapter discusses a number of issues concerned with security, some of
64864 which are also covered in other parts of this manual.
64865 </para>
64866 <para>
64867 For reasons that this author does not understand, some people have promoted
64868 Exim as a <quote>particularly secure</quote> mailer. Perhaps it is because of the
64869 existence of this chapter in the documentation. However, the intent of the
64870 chapter is simply to describe the way Exim works in relation to certain
64871 security concerns, not to make any specific claims about the effectiveness of
64872 its security as compared with other MTAs.
64873 </para>
64874 <para>
64875 What follows is a description of the way Exim is supposed to be. Best efforts
64876 have been made to try to ensure that the code agrees with the theory, but an
64877 absence of bugs can never be guaranteed. Any that are reported will get fixed
64878 as soon as possible.
64879 </para>
64880 <section id="SECID286">
64881 <title>Building a more <quote>hardened</quote> Exim</title>
64882 <para>
64883 <indexterm role="concept">
64884 <primary>security</primary>
64885 <secondary>build-time features</secondary>
64886 </indexterm>
64887 There are a number of build-time options that can be set in <filename>Local/Makefile</filename>
64888 to create Exim binaries that are <quote>harder</quote> to attack, in particular by a rogue
64889 Exim administrator who does not have the root password, or by someone who has
64890 penetrated the Exim (but not the root) account. These options are as follows:
64891 </para>
64892 <itemizedlist>
64893 <listitem>
64894 <para>
64895 ALT_CONFIG_PREFIX can be set to a string that is required to match the
64896 start of any file names used with the <option>-C</option> option. When it is set, these file
64897 names are also not allowed to contain the sequence <quote>/../</quote>. (However, if the
64898 value of the <option>-C</option> option is identical to the value of CONFIGURE_FILE in
64899 <filename>Local/Makefile</filename>, Exim ignores <option>-C</option> and proceeds as usual.) There is no
64900 default setting for <option>ALT_CONFIG_PREFIX</option>.
64901 </para>
64902 <para>
64903 If the permitted configuration files are confined to a directory to
64904 which only root has access, this guards against someone who has broken
64905 into the Exim account from running a privileged Exim with an arbitrary
64906 configuration file, and using it to break into other accounts.
64907 </para>
64908 </listitem>
64909 <listitem>
64910 <para>
64911 If a non-trusted configuration file (i.e. not the default configuration file
64912 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
64913 file) is specified with <option>-C</option>, or if macros are given with <option>-D</option> (but see
64914 the next item), then root privilege is retained only if the caller of Exim is
64915 root. This locks out the possibility of testing a configuration using <option>-C</option>
64916 right through message reception and delivery, even if the caller is root. The
64917 reception works, but by that time, Exim is running as the Exim user, so when
64918 it re-execs to regain privilege for the delivery, the use of <option>-C</option> causes
64919 privilege to be lost. However, root can test reception and delivery using two
64920 separate commands.
64921 </para>
64922 </listitem>
64923 <listitem>
64924 <para>
64925 The WHITELIST_D_MACROS build option declares some macros to be safe to override
64926 with <option>-D</option> if the real uid is one of root, the Exim run-time user or the
64927 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
64928 requiring the run-time value supplied to <option>-D</option> to match a regex that errs on
64929 the restrictive side.  Requiring build-time selection of safe macros is onerous
64930 but this option is intended solely as a transition mechanism to permit
64931 previously-working configurations to continue to work after release 4.73.
64932 </para>
64933 </listitem>
64934 <listitem>
64935 <para>
64936 If DISABLE_D_OPTION is defined, the use of the <option>-D</option> command line option
64937 is disabled.
64938 </para>
64939 </listitem>
64940 <listitem>
64941 <para>
64942 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
64943 never to be used for any deliveries. This is like the <option>never_users</option> runtime
64944 option, but it cannot be overridden; the runtime option adds additional users
64945 to the list. The default setting is <quote>root</quote>; this prevents a non-root user who
64946 is permitted to modify the runtime file from using Exim as a way to get root.
64947 </para>
64948 </listitem>
64949 </itemizedlist>
64950 </section>
64951 <section id="SECID270">
64952 <title>Root privilege</title>
64953 <para>
64954 <indexterm role="concept">
64955 <primary>setuid</primary>
64956 </indexterm>
64957 <indexterm role="concept">
64958 <primary>root privilege</primary>
64959 </indexterm>
64960 The Exim binary is normally setuid to root, which means that it gains root
64961 privilege (runs as root) when it starts execution. In some special cases (for
64962 example, when the daemon is not in use and there are no local deliveries), it
64963 may be possible to run Exim setuid to some user other than root. This is
64964 discussed in the next section. However, in most installations, root privilege
64965 is required for two things:
64966 </para>
64967 <itemizedlist>
64968 <listitem>
64969 <para>
64970 To set up a socket connected to the standard SMTP port (25) when initialising
64971 the listening daemon. If Exim is run from <emphasis>inetd</emphasis>, this privileged action is
64972 not required.
64973 </para>
64974 </listitem>
64975 <listitem>
64976 <para>
64977 To be able to change uid and gid in order to read users&#x2019; <filename>.forward</filename> files and
64978 perform local deliveries as the receiving user or as specified in the
64979 configuration.
64980 </para>
64981 </listitem>
64982 </itemizedlist>
64983 <para>
64984 It is not necessary to be root to do any of the other things Exim does, such as
64985 receiving messages and delivering them externally over SMTP, and it is
64986 obviously more secure if Exim does not run as root except when necessary.
64987 For this reason, a user and group for Exim to use must be defined in
64988 <filename>Local/Makefile</filename>. These are known as <quote>the Exim user</quote> and <quote>the Exim
64989 group</quote>. Their values can be changed by the run time configuration, though this
64990 is not recommended. Often a user called <emphasis>exim</emphasis> is used, but some sites use
64991 <emphasis>mail</emphasis> or another user name altogether.
64992 </para>
64993 <para>
64994 Exim uses <function>setuid()</function> whenever it gives up root privilege. This is a permanent
64995 abdication; the process cannot regain root afterwards. Prior to release 4.00,
64996 <function>seteuid()</function> was used in some circumstances, but this is no longer the case.
64997 </para>
64998 <para>
64999 After a new Exim process has interpreted its command line options, it changes
65000 uid and gid in the following cases:
65001 </para>
65002 <itemizedlist>
65003 <listitem>
65004 <para>
65005 <indexterm role="option">
65006 <primary><option>-C</option></primary>
65007 </indexterm>
65008 <indexterm role="option">
65009 <primary><option>-D</option></primary>
65010 </indexterm>
65011 If the <option>-C</option> option is used to specify an alternate configuration file, or if
65012 the <option>-D</option> option is used to define macro values for the configuration, and the
65013 calling process is not running as root, the uid and gid are changed to those of
65014 the calling process.
65015 However, if DISABLE_D_OPTION is defined in <filename>Local/Makefile</filename>, the <option>-D</option>
65016 option may not be used at all.
65017 If WHITELIST_D_MACROS is defined in <filename>Local/Makefile</filename>, then some macro values
65018 can be supplied if the calling process is running as root, the Exim run-time
65019 user or CONFIGURE_OWNER, if defined.
65020 </para>
65021 </listitem>
65022 <listitem>
65023 <para>
65024 <indexterm role="option">
65025 <primary><option>-be</option></primary>
65026 </indexterm>
65027 <indexterm role="option">
65028 <primary><option>-bf</option></primary>
65029 </indexterm>
65030 <indexterm role="option">
65031 <primary><option>-bF</option></primary>
65032 </indexterm>
65033 If the expansion test option (<option>-be</option>) or one of the filter testing options
65034 (<option>-bf</option> or <option>-bF</option>) are used, the uid and gid are changed to those of the
65035 calling process.
65036 </para>
65037 </listitem>
65038 <listitem>
65039 <para>
65040 If the process is not a daemon process or a queue runner process or a delivery
65041 process or a process for testing address routing (started with <option>-bt</option>), the
65042 uid and gid are changed to the Exim user and group. This means that Exim always
65043 runs under its own uid and gid when receiving messages. This also applies when
65044 testing address verification
65045 <indexterm role="option">
65046 <primary><option>-bv</option></primary>
65047 </indexterm>
65048 <indexterm role="option">
65049 <primary><option>-bh</option></primary>
65050 </indexterm>
65051 (the <option>-bv</option> option) and testing incoming message policy controls (the <option>-bh</option>
65052 option).
65053 </para>
65054 </listitem>
65055 <listitem>
65056 <para>
65057 For a daemon, queue runner, delivery, or address testing process, the uid
65058 remains as root at this stage, but the gid is changed to the Exim group.
65059 </para>
65060 </listitem>
65061 </itemizedlist>
65062 <para>
65063 The processes that initially retain root privilege behave as follows:
65064 </para>
65065 <itemizedlist>
65066 <listitem>
65067 <para>
65068 A daemon process changes the gid to the Exim group and the uid to the Exim
65069 user after setting up one or more listening sockets. The <function>initgroups()</function>
65070 function is called, so that if the Exim user is in any additional groups, they
65071 will be used during message reception.
65072 </para>
65073 </listitem>
65074 <listitem>
65075 <para>
65076 A queue runner process retains root privilege throughout its execution. Its
65077 job is to fork a controlled sequence of delivery processes.
65078 </para>
65079 </listitem>
65080 <listitem>
65081 <para>
65082 A delivery process retains root privilege throughout most of its execution,
65083 but any actual deliveries (that is, the transports themselves) are run in
65084 subprocesses which always change to a non-root uid and gid. For local
65085 deliveries this is typically the uid and gid of the owner of the mailbox; for
65086 remote deliveries, the Exim uid and gid are used. Once all the delivery
65087 subprocesses have been run, a delivery process changes to the Exim uid and gid
65088 while doing post-delivery tidying up such as updating the retry database and
65089 generating bounce and warning messages.
65090 </para>
65091 <para>
65092 While the recipient addresses in a message are being routed, the delivery
65093 process runs as root. However, if a user&#x2019;s filter file has to be processed,
65094 this is done in a subprocess that runs under the individual user&#x2019;s uid and
65095 gid. A system filter is run as root unless <option>system_filter_user</option> is set.
65096 </para>
65097 </listitem>
65098 <listitem>
65099 <para>
65100 A process that is testing addresses (the <option>-bt</option> option) runs as root so that
65101 the routing is done in the same environment as a message delivery.
65102 </para>
65103 </listitem>
65104 </itemizedlist>
65105 </section>
65106 <section id="SECTrunexiwitpri">
65107 <title>Running Exim without privilege</title>
65108 <para>
65109 <indexterm role="concept">
65110 <primary>privilege, running without</primary>
65111 </indexterm>
65112 <indexterm role="concept">
65113 <primary>unprivileged running</primary>
65114 </indexterm>
65115 <indexterm role="concept">
65116 <primary>root privilege</primary>
65117 <secondary>running without</secondary>
65118 </indexterm>
65119 Some installations like to run Exim in an unprivileged state for more of its
65120 operation, for added security. Support for this mode of operation is provided
65121 by the global option <option>deliver_drop_privilege</option>. When this is set, the uid and
65122 gid are changed to the Exim user and group at the start of a delivery process
65123 (and also queue runner and address testing processes). This means that address
65124 routing is no longer run as root, and the deliveries themselves cannot change
65125 to any other uid.
65126 </para>
65127 <para>
65128 <indexterm role="concept">
65129 <primary>SIGHUP</primary>
65130 </indexterm>
65131 <indexterm role="concept">
65132 <primary>daemon</primary>
65133 <secondary>restarting</secondary>
65134 </indexterm>
65135 Leaving the binary setuid to root, but setting <option>deliver_drop_privilege</option> means
65136 that the daemon can still be started in the usual way, and it can respond
65137 correctly to SIGHUP because the re-invocation regains root privilege.
65138 </para>
65139 <para>
65140 An alternative approach is to make Exim setuid to the Exim user and also setgid
65141 to the Exim group. If you do this, the daemon must be started from a root
65142 process. (Calling Exim from a root process makes it behave in the way it does
65143 when it is setuid root.) However, the daemon cannot restart itself after a
65144 SIGHUP signal because it cannot regain privilege.
65145 </para>
65146 <para>
65147 It is still useful to set <option>deliver_drop_privilege</option> in this case, because it
65148 stops Exim from trying to re-invoke itself to do a delivery after a message has
65149 been received. Such a re-invocation is a waste of resources because it has no
65150 effect.
65151 </para>
65152 <para>
65153 If restarting the daemon is not an issue (for example, if <option>mua_wrapper</option> is
65154 set, or <emphasis>inetd</emphasis> is being used instead of a daemon), having the binary setuid
65155 to the Exim user seems a clean approach, but there is one complication:
65156 </para>
65157 <para>
65158 In this style of operation, Exim is running with the real uid and gid set to
65159 those of the calling process, and the effective uid/gid set to Exim&#x2019;s values.
65160 Ideally, any association with the calling process&#x2019; uid/gid should be dropped,
65161 that is, the real uid/gid should be reset to the effective values so as to
65162 discard any privileges that the caller may have. While some operating systems
65163 have a function that permits this action for a non-root effective uid, quite a
65164 number of them do not. Because of this lack of standardization, Exim does not
65165 address this problem at this time.
65166 </para>
65167 <para>
65168 For this reason, the recommended approach for <quote>mostly unprivileged</quote> running
65169 is to keep the Exim binary setuid to root, and to set
65170 <option>deliver_drop_privilege</option>. This also has the advantage of allowing a daemon to
65171 be used in the most straightforward way.
65172 </para>
65173 <para>
65174 If you configure Exim not to run delivery processes as root, there are a
65175 number of restrictions on what you can do:
65176 </para>
65177 <itemizedlist>
65178 <listitem>
65179 <para>
65180 You can deliver only as the Exim user/group. You should  explicitly use the
65181 <option>user</option> and <option>group</option> options to override routers or local transports that
65182 normally deliver as the recipient. This makes sure that configurations that
65183 work in this mode function the same way in normal mode. Any implicit or
65184 explicit specification of another user causes an error.
65185 </para>
65186 </listitem>
65187 <listitem>
65188 <para>
65189 Use of <filename>.forward</filename> files is severely restricted, such that it is usually
65190 not worthwhile to include them in the configuration.
65191 </para>
65192 </listitem>
65193 <listitem>
65194 <para>
65195 Users who wish to use <filename>.forward</filename> would have to make their home directory and
65196 the file itself accessible to the Exim user. Pipe and append-to-file entries,
65197 and their equivalents in Exim filters, cannot be used. While they could be
65198 enabled in the Exim user&#x2019;s name, that would be insecure and not very useful.
65199 </para>
65200 </listitem>
65201 <listitem>
65202 <para>
65203 Unless the local user mailboxes are all owned by the Exim user (possible in
65204 some POP3 or IMAP-only environments):
65205 </para>
65206 <orderedlist numeration="arabic">
65207 <listitem>
65208 <para>
65209 They must be owned by the Exim group and be writeable by that group. This
65210 implies you must set <option>mode</option> in the appendfile configuration, as well as the
65211 mode of the mailbox files themselves.
65212 </para>
65213 </listitem>
65214 <listitem>
65215 <para>
65216 You must set <option>no_check_owner</option>, since most or all of the files will not be
65217 owned by the Exim user.
65218 </para>
65219 </listitem>
65220 <listitem>
65221 <para>
65222 You must set <option>file_must_exist</option>, because Exim cannot set the owner correctly
65223 on a newly created mailbox when unprivileged. This also implies that new
65224 mailboxes need to be created manually.
65225 </para>
65226 </listitem>
65227 </orderedlist>
65228 </listitem>
65229 </itemizedlist>
65230 <para>
65231 These restrictions severely restrict what can be done in local deliveries.
65232 However, there are no restrictions on remote deliveries. If you are running a
65233 gateway host that does no local deliveries, setting <option>deliver_drop_privilege</option>
65234 gives more security at essentially no cost.
65235 </para>
65236 <para>
65237 If you are using the <option>mua_wrapper</option> facility (see chapter
65238 <xref linkend="CHAPnonqueueing"/>), <option>deliver_drop_privilege</option> is forced to be true.
65239 </para>
65240 </section>
65241 <section id="SECID271">
65242 <title>Delivering to local files</title>
65243 <para>
65244 Full details of the checks applied by <command>appendfile</command> before it writes to a file
65245 are given in chapter <xref linkend="CHAPappendfile"/>.
65246 </para>
65247 </section>
65248 <section id="SECTsecconslocalcmds">
65249 <title>Running local commands</title>
65250 <para>
65251 <indexterm role="concept">
65252 <primary>security</primary>
65253 <secondary>local commands</secondary>
65254 </indexterm>
65255 <indexterm role="concept">
65256 <primary>security</primary>
65257 <secondary>command injection attacks</secondary>
65258 </indexterm>
65259 There are a number of ways in which an administrator can configure Exim to run
65260 commands based upon received, untrustworthy, data. Further, in some
65261 configurations a user who can control a <filename>.forward</filename> file can also arrange to
65262 run commands. Configuration to check includes, but is not limited to:
65263 </para>
65264 <itemizedlist>
65265 <listitem>
65266 <para>
65267 Use of <option>use_shell</option> in the pipe transport: various forms of shell command
65268 injection may be possible with this option present. It is dangerous and should
65269 be used only with considerable caution. Consider constraints which whitelist
65270 allowed characters in a variable which is to be used in a pipe transport that
65271 has <option>use_shell</option> enabled.
65272 </para>
65273 </listitem>
65274 <listitem>
65275 <para>
65276 A number of options such as <option>forbid_filter_run</option>, <option>forbid_filter_perl</option>,
65277 <option>forbid_filter_dlfunc</option> and so forth which restrict facilities available to
65278 <filename>.forward</filename> files in a redirect router. If Exim is running on a central mail
65279 hub to which ordinary users do not have shell access, but home directories are
65280 NFS mounted (for instance) then administrators should review the list of these
65281 forbid options available, and should bear in mind that the options that may
65282 need forbidding can change as new features are added between releases.
65283 </para>
65284 </listitem>
65285 <listitem>
65286 <para>
65287 The <option>${run...}</option> expansion item does not use a shell by default, but
65288 administrators can configure use of <filename>/bin/sh</filename> as part of the command.
65289 Such invocations should be viewed with prejudicial suspicion.
65290 </para>
65291 </listitem>
65292 <listitem>
65293 <para>
65294 Administrators who use embedded Perl are advised to explore how Perl&#x2019;s
65295 taint checking might apply to their usage.
65296 </para>
65297 </listitem>
65298 <listitem>
65299 <para>
65300 Use of <option>${expand...}</option> is somewhat analagous to shell&#x2019;s eval builtin and
65301 administrators are well advised to view its use with suspicion, in case (for
65302 instance) it allows a local-part to contain embedded Exim directives.
65303 </para>
65304 </listitem>
65305 <listitem>
65306 <para>
65307 Use of <option>${match_local_part...}</option> and friends becomes more dangerous if
65308 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
65309 each can reference arbitrary lists and files, rather than just being a list
65310 of opaque strings.
65311 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
65312 real-world security vulnerabilities caused by its use with untrustworthy data
65313 injected in, for SQL injection attacks.
65314 Consider the use of the <option>inlisti</option> expansion condition instead.
65315 </para>
65316 </listitem>
65317 </itemizedlist>
65318 </section>
65319 <section id="SECTsecconfdata">
65320 <title>Trust in configuration data</title>
65321 <para>
65322 <indexterm role="concept">
65323 <primary>security</primary>
65324 <secondary>data sources</secondary>
65325 </indexterm>
65326 <indexterm role="concept">
65327 <primary>security</primary>
65328 <secondary>regular expressions</secondary>
65329 </indexterm>
65330 <indexterm role="concept">
65331 <primary>regular expressions</primary>
65332 <secondary>security</secondary>
65333 </indexterm>
65334 <indexterm role="concept">
65335 <primary>PCRE</primary>
65336 <secondary>security</secondary>
65337 </indexterm>
65338 If configuration data for Exim can come from untrustworthy sources, there
65339 are some issues to be aware of:
65340 </para>
65341 <itemizedlist>
65342 <listitem>
65343 <para>
65344 Use of <option>${expand...}</option> may provide a path for shell injection attacks.
65345 </para>
65346 </listitem>
65347 <listitem>
65348 <para>
65349 Letting untrusted data provide a regular expression is unwise.
65350 </para>
65351 </listitem>
65352 <listitem>
65353 <para>
65354 Using <option>${match...}</option> to apply a fixed regular expression against untrusted
65355 data may result in pathological behaviour within PCRE.  Be aware of what
65356 "backtracking" means and consider options for being more strict with a regular
65357 expression. Avenues to explore include limiting what can match (avoiding <literal>.</literal>
65358 when <literal>[a-z0-9]</literal> or other character class will do), use of atomic grouping and
65359 possessive quantifiers or just not using regular expressions against untrusted
65360 data.
65361 </para>
65362 </listitem>
65363 <listitem>
65364 <para>
65365 It can be important to correctly use <option>${quote:...}</option>,
65366 <option>${quote_local_part:...}</option> and <option>${quote_</option>&lt;<emphasis>lookup-type</emphasis>&gt;<option>:...}</option> expansion
65367 items to ensure that data is correctly constructed.
65368 </para>
65369 </listitem>
65370 <listitem>
65371 <para>
65372 Some lookups might return multiple results, even though normal usage is only
65373 expected to yield one result.
65374 </para>
65375 </listitem>
65376 </itemizedlist>
65377 </section>
65378 <section id="SECID272">
65379 <title>IPv4 source routing</title>
65380 <para>
65381 <indexterm role="concept">
65382 <primary>source routing</primary>
65383 <secondary>in IP packets</secondary>
65384 </indexterm>
65385 <indexterm role="concept">
65386 <primary>IP source routing</primary>
65387 </indexterm>
65388 Many operating systems suppress IP source-routed packets in the kernel, but
65389 some cannot be made to do this, so Exim does its own check. It logs incoming
65390 IPv4 source-routed TCP calls, and then drops them. Things are all different in
65391 IPv6. No special checking is currently done.
65392 </para>
65393 </section>
65394 <section id="SECID273">
65395 <title>The VRFY, EXPN, and ETRN commands in SMTP</title>
65396 <para>
65397 Support for these SMTP commands is disabled by default. If required, they can
65398 be enabled by defining suitable ACLs.
65399 </para>
65400 </section>
65401 <section id="SECID274">
65402 <title>Privileged users</title>
65403 <para>
65404 <indexterm role="concept">
65405 <primary>trusted users</primary>
65406 </indexterm>
65407 <indexterm role="concept">
65408 <primary>admin user</primary>
65409 </indexterm>
65410 <indexterm role="concept">
65411 <primary>privileged user</primary>
65412 </indexterm>
65413 <indexterm role="concept">
65414 <primary>user</primary>
65415 <secondary>trusted</secondary>
65416 </indexterm>
65417 <indexterm role="concept">
65418 <primary>user</primary>
65419 <secondary>admin</secondary>
65420 </indexterm>
65421 Exim recognizes two sets of users with special privileges. Trusted users are
65422 able to submit new messages to Exim locally, but supply their own sender
65423 addresses and information about a sending host. For other users submitting
65424 local messages, Exim sets up the sender address from the uid, and doesn&#x2019;t
65425 permit a remote host to be specified.
65426 </para>
65427 <para>
65428 <indexterm role="option">
65429 <primary><option>-f</option></primary>
65430 </indexterm>
65431 However, an untrusted user is permitted to use the <option>-f</option> command line option
65432 in the special form <option>-f &lt;&gt;</option> to indicate that a delivery failure for the
65433 message should not cause an error report. This affects the message&#x2019;s envelope,
65434 but it does not affect the <emphasis>Sender:</emphasis> header. Untrusted users may also be
65435 permitted to use specific forms of address with the <option>-f</option> option by setting
65436 the <option>untrusted_set_sender</option> option.
65437 </para>
65438 <para>
65439 Trusted users are used to run processes that receive mail messages from some
65440 other mail domain and pass them on to Exim for delivery either locally, or over
65441 the Internet. Exim trusts a caller that is running as root, as the Exim user,
65442 as any user listed in the <option>trusted_users</option> configuration option, or under any
65443 group listed in the <option>trusted_groups</option> option.
65444 </para>
65445 <para>
65446 Admin users are permitted to do things to the messages on Exim&#x2019;s queue. They
65447 can freeze or thaw messages, cause them to be returned to their senders, remove
65448 them entirely, or modify them in various ways. In addition, admin users can run
65449 the Exim monitor and see all the information it is capable of providing, which
65450 includes the contents of files on the spool.
65451 </para>
65452 <para>
65453 <indexterm role="option">
65454 <primary><option>-M</option></primary>
65455 </indexterm>
65456 <indexterm role="option">
65457 <primary><option>-q</option></primary>
65458 </indexterm>
65459 By default, the use of the <option>-M</option> and <option>-q</option> options to cause Exim to attempt
65460 delivery of messages on its queue is restricted to admin users. This
65461 restriction can be relaxed by setting the <option>no_prod_requires_admin</option> option.
65462 Similarly, the use of <option>-bp</option> (and its variants) to list the contents of the
65463 queue is also restricted to admin users. This restriction can be relaxed by
65464 setting <option>no_queue_list_requires_admin</option>.
65465 </para>
65466 <para>
65467 Exim recognizes an admin user if the calling process is running as root or as
65468 the Exim user or if any of the groups associated with the calling process is
65469 the Exim group. It is not necessary actually to be running under the Exim
65470 group. However, if admin users who are not root or the Exim user are to access
65471 the contents of files on the spool via the Exim monitor (which runs
65472 unprivileged), Exim must be built to allow group read access to its spool
65473 files.
65474 </para>
65475 </section>
65476 <section id="SECID275">
65477 <title>Spool files</title>
65478 <para>
65479 <indexterm role="concept">
65480 <primary>spool directory</primary>
65481 <secondary>files</secondary>
65482 </indexterm>
65483 Exim&#x2019;s spool directory and everything it contains is owned by the Exim user and
65484 set to the Exim group. The mode for spool files is defined in the
65485 <filename>Local/Makefile</filename> configuration file, and defaults to 0640. This means that
65486 any user who is a member of the Exim group can access these files.
65487 </para>
65488 </section>
65489 <section id="SECID276">
65490 <title>Use of argv[0]</title>
65491 <para>
65492 Exim examines the last component of <option>argv[0]</option>, and if it matches one of a set
65493 of specific strings, Exim assumes certain options. For example, calling Exim
65494 with the last component of <option>argv[0]</option> set to <quote>rsmtp</quote> is exactly equivalent
65495 to calling it with the option <option>-bS</option>. There are no security implications in
65496 this.
65497 </para>
65498 </section>
65499 <section id="SECID277">
65500 <title>Use of %f formatting</title>
65501 <para>
65502 The only use made of <quote>%f</quote> by Exim is in formatting load average values. These
65503 are actually stored in integer variables as 1000 times the load average.
65504 Consequently, their range is limited and so therefore is the length of the
65505 converted output.
65506 </para>
65507 </section>
65508 <section id="SECID278">
65509 <title>Embedded Exim path</title>
65510 <para>
65511 Exim uses its own path name, which is embedded in the code, only when it needs
65512 to re-exec in order to regain root privilege. Therefore, it is not root when it
65513 does so. If some bug allowed the path to get overwritten, it would lead to an
65514 arbitrary program&#x2019;s being run as exim, not as root.
65515 </para>
65516 </section>
65517 <section id="SECTdynmoddir">
65518 <title>Dynamic module directory</title>
65519 <para>
65520 Any dynamically loadable modules must be installed into the directory
65521 defined in <literal>LOOKUP_MODULE_DIR</literal> in <filename>Local/Makefile</filename> for Exim to permit
65522 loading it.
65523 </para>
65524 </section>
65525 <section id="SECID279">
65526 <title>Use of sprintf()</title>
65527 <para>
65528 <indexterm role="concept">
65529 <primary><function>sprintf()</function></primary>
65530 </indexterm>
65531 A large number of occurrences of <quote>sprintf</quote> in the code are actually calls to
65532 <emphasis>string_sprintf()</emphasis>, a function that returns the result in malloc&#x2019;d store.
65533 The intermediate formatting is done into a large fixed buffer by a function
65534 that runs through the format string itself, and checks the length of each
65535 conversion before performing it, thus preventing buffer overruns.
65536 </para>
65537 <para>
65538 The remaining uses of <function>sprintf()</function> happen in controlled circumstances where
65539 the output buffer is known to be sufficiently long to contain the converted
65540 string.
65541 </para>
65542 </section>
65543 <section id="SECID280">
65544 <title>Use of debug_printf() and log_write()</title>
65545 <para>
65546 Arbitrary strings are passed to both these functions, but they do their
65547 formatting by calling the function <emphasis>string_vformat()</emphasis>, which runs through
65548 the format string itself, and checks the length of each conversion.
65549 </para>
65550 </section>
65551 <section id="SECID281">
65552 <title>Use of strcat() and strcpy()</title>
65553 <para>
65554 These are used only in cases where the output buffer is known to be large
65555 enough to hold the result.
65556 <indexterm role="concept" startref="IIDsecurcon" class="endofrange"/>
65557 </para>
65558 </section>
65559 </chapter>
65560
65561 <chapter id="CHAPspool">
65562 <title>Format of spool files</title>
65563 <para>
65564 <indexterm role="concept" id="IIDforspo1" class="startofrange">
65565 <primary>format</primary>
65566 <secondary>spool files</secondary>
65567 </indexterm>
65568 <indexterm role="concept" id="IIDforspo2" class="startofrange">
65569 <primary>spool directory</primary>
65570 <secondary>format of files</secondary>
65571 </indexterm>
65572 <indexterm role="concept" id="IIDforspo3" class="startofrange">
65573 <primary>spool files</primary>
65574 <secondary>format of</secondary>
65575 </indexterm>
65576 <indexterm role="concept">
65577 <primary>spool files</primary>
65578 <secondary>editing</secondary>
65579 </indexterm>
65580 A message on Exim&#x2019;s queue consists of two files, whose names are the message id
65581 followed by -D and -H, respectively. The data portion of the message is kept in
65582 the -D file on its own. The message&#x2019;s envelope, status, and headers are all
65583 kept in the -H file, whose format is described in this chapter. Each of these
65584 two files contains the final component of its own name as its first line. This
65585 is insurance against disk crashes where the directory is lost but the files
65586 themselves are recoverable.
65587 </para>
65588 <para>
65589 Some people are tempted into editing -D files in order to modify messages. You
65590 need to be extremely careful if you do this; it is not recommended and you are
65591 on your own if you do it. Here are some of the pitfalls:
65592 </para>
65593 <itemizedlist>
65594 <listitem>
65595 <para>
65596 You must ensure that Exim does not try to deliver the message while you are
65597 fiddling with it. The safest way is to take out a write lock on the -D file,
65598 which is what Exim itself does, using <function>fcntl()</function>. If you update the file in
65599 place, the lock will be retained. If you write a new file and rename it, the
65600 lock will be lost at the instant of rename.
65601 </para>
65602 </listitem>
65603 <listitem>
65604 <para>
65605 <indexterm role="variable">
65606 <primary><varname>$body_linecount</varname></primary>
65607 </indexterm>
65608 If you change the number of lines in the file, the value of
65609 <varname>$body_linecount</varname>, which is stored in the -H file, will be incorrect. At
65610 present, this value is not used by Exim, but there is no guarantee that this
65611 will always be the case.
65612 </para>
65613 </listitem>
65614 <listitem>
65615 <para>
65616 If the message is in MIME format, you must take care not to break it.
65617 </para>
65618 </listitem>
65619 <listitem>
65620 <para>
65621 If the message is cryptographically signed, any change will invalidate the
65622 signature.
65623 </para>
65624 </listitem>
65625 </itemizedlist>
65626 <para>
65627 All in all, modifying -D files is fraught with danger.
65628 </para>
65629 <para>
65630 Files whose names end with -J may also be seen in the <filename>input</filename> directory (or
65631 its subdirectories when <option>split_spool_directory</option> is set). These are journal
65632 files, used to record addresses to which the message has been delivered during
65633 the course of a delivery attempt. If there are still undelivered recipients at
65634 the end, the -H file is updated, and the -J file is deleted. If, however, there
65635 is some kind of crash (for example, a power outage) before this happens, the -J
65636 file remains in existence. When Exim next processes the message, it notices the
65637 -J file and uses it to update the -H file before starting the next delivery
65638 attempt.
65639 </para>
65640 <section id="SECID282">
65641 <title>Format of the -H file</title>
65642 <para>
65643 <indexterm role="concept">
65644 <primary>uid (user id)</primary>
65645 <secondary>in spool file</secondary>
65646 </indexterm>
65647 <indexterm role="concept">
65648 <primary>gid (group id)</primary>
65649 <secondary>in spool file</secondary>
65650 </indexterm>
65651 The second line of the -H file contains the login name for the uid of the
65652 process that called Exim to read the message, followed by the numerical uid and
65653 gid. For a locally generated message, this is normally the user who sent the
65654 message. For a message received over TCP/IP via the daemon, it is
65655 normally the Exim user.
65656 </para>
65657 <para>
65658 The third line of the file contains the address of the message&#x2019;s sender as
65659 transmitted in the envelope, contained in angle brackets. The sender address is
65660 empty for bounce messages. For incoming SMTP mail, the sender address is given
65661 in the MAIL command. For locally generated mail, the sender address is
65662 created by Exim from the login name of the current user and the configured
65663 <option>qualify_domain</option>. However, this can be overridden by the <option>-f</option> option or a
65664 leading <quote>From&nbsp;</quote> line if the caller is trusted, or if the supplied address is
65665 <quote>&lt;&gt;</quote> or an address that matches <option>untrusted_set_senders</option>.
65666 </para>
65667 <para>
65668 The fourth line contains two numbers. The first is the time that the message
65669 was received, in the conventional Unix form &ndash; the number of seconds since the
65670 start of the epoch. The second number is a count of the number of messages
65671 warning of delayed delivery that have been sent to the sender.
65672 </para>
65673 <para>
65674 There follow a number of lines starting with a hyphen. These can appear in any
65675 order, and are omitted when not relevant:
65676 </para>
65677 <variablelist>
65678 <varlistentry>
65679 <term><option>-acl</option>&nbsp;&lt;<emphasis>number</emphasis>&gt;&nbsp;&lt;<emphasis>length</emphasis>&gt;</term>
65680 <listitem>
65681 <para>
65682 This item is obsolete, and is not generated from Exim release 4.61 onwards;
65683 <option>-aclc</option> and <option>-aclm</option> are used instead. However, <option>-acl</option> is still
65684 recognized, to provide backward compatibility. In the old format, a line of
65685 this form is present for every ACL variable that is not empty. The number
65686 identifies the variable; the <option>acl_c</option><emphasis role="bold">x</emphasis> variables are numbered 0&ndash;9 and
65687 the <option>acl_m</option><emphasis role="bold">x</emphasis> variables are numbered 10&ndash;19. The length is the length of
65688 the data string for the variable. The string itself starts at the beginning of
65689 the next line, and is followed by a newline character. It may contain internal
65690 newlines.
65691 </para>
65692 </listitem></varlistentry>
65693 <varlistentry>
65694 <term><option>-aclc</option>&nbsp;&lt;<emphasis>rest-of-name</emphasis>&gt;&nbsp;&lt;<emphasis>length</emphasis>&gt;</term>
65695 <listitem>
65696 <para>
65697 A line of this form is present for every ACL connection variable that is
65698 defined. Note that there is a space between <option>-aclc</option> and the rest of the name.
65699 The length is the length of the data string for the variable. The string itself
65700 starts at the beginning of the next line, and is followed by a newline
65701 character. It may contain internal newlines.
65702 </para>
65703 </listitem></varlistentry>
65704 <varlistentry>
65705 <term><option>-aclm</option>&nbsp;&lt;<emphasis>rest-of-name</emphasis>&gt;&nbsp;&lt;<emphasis>length</emphasis>&gt;</term>
65706 <listitem>
65707 <para>
65708 A line of this form is present for every ACL message variable that is defined.
65709 Note that there is a space between <option>-aclm</option> and the rest of the name. The
65710 length is the length of the data string for the variable. The string itself
65711 starts at the beginning of the next line, and is followed by a newline
65712 character. It may contain internal newlines.
65713 </para>
65714 </listitem></varlistentry>
65715 <varlistentry>
65716 <term><option>-active_hostname</option>&nbsp;&lt;<emphasis>hostname</emphasis>&gt;</term>
65717 <listitem>
65718 <para>
65719 This is present if, when the message was received over SMTP, the value of
65720 <varname>$smtp_active_hostname</varname> was different to the value of <varname>$primary_hostname</varname>.
65721 </para>
65722 </listitem></varlistentry>
65723 <varlistentry>
65724 <term><option>-allow_unqualified_recipient</option></term>
65725 <listitem>
65726 <para>
65727 This is present if unqualified recipient addresses are permitted in header
65728 lines (to stop such addresses from being qualified if rewriting occurs at
65729 transport time). Local messages that were input using <option>-bnq</option> and remote
65730 messages from hosts that match <option>recipient_unqualified_hosts</option> set this flag.
65731 </para>
65732 </listitem></varlistentry>
65733 <varlistentry>
65734 <term><option>-allow_unqualified_sender</option></term>
65735 <listitem>
65736 <para>
65737 This is present if unqualified sender addresses are permitted in header lines
65738 (to stop such addresses from being qualified if rewriting occurs at transport
65739 time). Local messages that were input using <option>-bnq</option> and remote messages from
65740 hosts that match <option>sender_unqualified_hosts</option> set this flag.
65741 </para>
65742 </listitem></varlistentry>
65743 <varlistentry>
65744 <term><option>-auth_id</option>&nbsp;&lt;<emphasis>text</emphasis>&gt;</term>
65745 <listitem>
65746 <para>
65747 The id information for a message received on an authenticated SMTP connection
65748 &ndash; the value of the <varname>$authenticated_id</varname> variable.
65749 </para>
65750 </listitem></varlistentry>
65751 <varlistentry>
65752 <term><option>-auth_sender</option>&nbsp;&lt;<emphasis>address</emphasis>&gt;</term>
65753 <listitem>
65754 <para>
65755 The address of an authenticated sender &ndash; the value of the
65756 <varname>$authenticated_sender</varname> variable.
65757 </para>
65758 </listitem></varlistentry>
65759 <varlistentry>
65760 <term><option>-body_linecount</option>&nbsp;&lt;<emphasis>number</emphasis>&gt;</term>
65761 <listitem>
65762 <para>
65763 This records the number of lines in the body of the message, and is always
65764 present.
65765 </para>
65766 </listitem></varlistentry>
65767 <varlistentry>
65768 <term><option>-body_zerocount</option>&nbsp;&lt;<emphasis>number</emphasis>&gt;</term>
65769 <listitem>
65770 <para>
65771 This records the number of binary zero bytes in the body of the message, and is
65772 present if the number is greater than zero.
65773 </para>
65774 </listitem></varlistentry>
65775 <varlistentry>
65776 <term><option>-deliver_firsttime</option></term>
65777 <listitem>
65778 <para>
65779 This is written when a new message is first added to the spool. When the spool
65780 file is updated after a deferral, it is omitted.
65781 </para>
65782 </listitem></varlistentry>
65783 <varlistentry>
65784 <term><option>-frozen</option>&nbsp;&lt;<emphasis>time</emphasis>&gt;</term>
65785 <listitem>
65786 <para>
65787 <indexterm role="concept">
65788 <primary>frozen messages</primary>
65789 <secondary>spool data</secondary>
65790 </indexterm>
65791 The message is frozen, and the freezing happened at &lt;<emphasis>time</emphasis>&gt;.
65792 </para>
65793 </listitem></varlistentry>
65794 <varlistentry>
65795 <term><option>-helo_name</option>&nbsp;&lt;<emphasis>text</emphasis>&gt;</term>
65796 <listitem>
65797 <para>
65798 This records the host name as specified by a remote host in a HELO or EHLO
65799 command.
65800 </para>
65801 </listitem></varlistentry>
65802 <varlistentry>
65803 <term><option>-host_address</option>&nbsp;&lt;<emphasis>address</emphasis>&gt;.&lt;<emphasis>port</emphasis>&gt;</term>
65804 <listitem>
65805 <para>
65806 This records the IP address of the host from which the message was received and
65807 the remote port number that was used. It is omitted for locally generated
65808 messages.
65809 </para>
65810 </listitem></varlistentry>
65811 <varlistentry>
65812 <term><option>-host_auth</option>&nbsp;&lt;<emphasis>text</emphasis>&gt;</term>
65813 <listitem>
65814 <para>
65815 If the message was received on an authenticated SMTP connection, this records
65816 the name of the authenticator &ndash; the value of the
65817 <varname>$sender_host_authenticated</varname> variable.
65818 </para>
65819 </listitem></varlistentry>
65820 <varlistentry>
65821 <term><option>-host_lookup_failed</option></term>
65822 <listitem>
65823 <para>
65824 This is present if an attempt to look up the sending host&#x2019;s name from its IP
65825 address failed. It corresponds to the <varname>$host_lookup_failed</varname> variable.
65826 </para>
65827 </listitem></varlistentry>
65828 <varlistentry>
65829 <term><option>-host_name</option>&nbsp;&lt;<emphasis>text</emphasis>&gt;</term>
65830 <listitem>
65831 <para>
65832 <indexterm role="concept">
65833 <primary>reverse DNS lookup</primary>
65834 </indexterm>
65835 <indexterm role="concept">
65836 <primary>DNS</primary>
65837 <secondary>reverse lookup</secondary>
65838 </indexterm>
65839 This records the name of the remote host from which the message was received,
65840 if the host name was looked up from the IP address when the message was being
65841 received. It is not present if no reverse lookup was done.
65842 </para>
65843 </listitem></varlistentry>
65844 <varlistentry>
65845 <term><option>-ident</option>&nbsp;&lt;<emphasis>text</emphasis>&gt;</term>
65846 <listitem>
65847 <para>
65848 For locally submitted messages, this records the login of the originating user,
65849 unless it was a trusted user and the <option>-oMt</option> option was used to specify an
65850 ident value. For messages received over TCP/IP, this records the ident string
65851 supplied by the remote host, if any.
65852 </para>
65853 </listitem></varlistentry>
65854 <varlistentry>
65855 <term><option>-interface_address</option>&nbsp;&lt;<emphasis>address</emphasis>&gt;.&lt;<emphasis>port</emphasis>&gt;</term>
65856 <listitem>
65857 <para>
65858 This records the IP address of the local interface and the port number through
65859 which a message was received from a remote host. It is omitted for locally
65860 generated messages.
65861 </para>
65862 </listitem></varlistentry>
65863 <varlistentry>
65864 <term><option>-local</option></term>
65865 <listitem>
65866 <para>
65867 The message is from a local sender.
65868 </para>
65869 </listitem></varlistentry>
65870 <varlistentry>
65871 <term><option>-localerror</option></term>
65872 <listitem>
65873 <para>
65874 The message is a locally-generated bounce message.
65875 </para>
65876 </listitem></varlistentry>
65877 <varlistentry>
65878 <term><option>-local_scan</option>&nbsp;&lt;<emphasis>string</emphasis>&gt;</term>
65879 <listitem>
65880 <para>
65881 This records the data string that was returned by the <function>local_scan()</function> function
65882 when the message was received &ndash; the value of the <varname>$local_scan_data</varname>
65883 variable. It is omitted if no data was returned.
65884 </para>
65885 </listitem></varlistentry>
65886 <varlistentry>
65887 <term><option>-manual_thaw</option></term>
65888 <listitem>
65889 <para>
65890 The message was frozen but has been thawed manually, that is, by an explicit
65891 Exim command rather than via the auto-thaw process.
65892 </para>
65893 </listitem></varlistentry>
65894 <varlistentry>
65895 <term><option>-N</option></term>
65896 <listitem>
65897 <para>
65898 A testing delivery process was started using the <option>-N</option> option to suppress any
65899 actual deliveries, but delivery was deferred. At any further delivery attempts,
65900 <option>-N</option> is assumed.
65901 </para>
65902 </listitem></varlistentry>
65903 <varlistentry>
65904 <term><option>-received_protocol</option></term>
65905 <listitem>
65906 <para>
65907 This records the value of the <varname>$received_protocol</varname> variable, which contains
65908 the name of the protocol by which the message was received.
65909 </para>
65910 </listitem></varlistentry>
65911 <varlistentry>
65912 <term><option>-sender_set_untrusted</option></term>
65913 <listitem>
65914 <para>
65915 The envelope sender of this message was set by an untrusted local caller (used
65916 to ensure that the caller is displayed in queue listings).
65917 </para>
65918 </listitem></varlistentry>
65919 <varlistentry>
65920 <term><option>-spam_score_int</option>&nbsp;&lt;<emphasis>number</emphasis>&gt;</term>
65921 <listitem>
65922 <para>
65923 If a message was scanned by SpamAssassin, this is present. It records the value
65924 of <varname>$spam_score_int</varname>.
65925 </para>
65926 </listitem></varlistentry>
65927 <varlistentry>
65928 <term><option>-tls_certificate_verified</option></term>
65929 <listitem>
65930 <para>
65931 A TLS certificate was received from the client that sent this message, and the
65932 certificate was verified by the server.
65933 </para>
65934 </listitem></varlistentry>
65935 <varlistentry>
65936 <term><option>-tls_cipher</option>&nbsp;&lt;<emphasis>cipher name</emphasis>&gt;</term>
65937 <listitem>
65938 <para>
65939 When the message was received over an encrypted connection, this records the
65940 name of the cipher suite that was used.
65941 </para>
65942 </listitem></varlistentry>
65943 <varlistentry>
65944 <term><option>-tls_peerdn</option>&nbsp;&lt;<emphasis>peer DN</emphasis>&gt;</term>
65945 <listitem>
65946 <para>
65947 When the message was received over an encrypted connection, and a certificate
65948 was received from the client, this records the Distinguished Name from that
65949 certificate.
65950 </para>
65951 </listitem></varlistentry>
65952 </variablelist>
65953 <para>
65954 Following the options there is a list of those addresses to which the message
65955 is not to be delivered. This set of addresses is initialized from the command
65956 line when the <option>-t</option> option is used and <option>extract_addresses_remove_arguments</option>
65957 is set; otherwise it starts out empty. Whenever a successful delivery is made,
65958 the address is added to this set. The addresses are kept internally as a
65959 balanced binary tree, and it is a representation of that tree which is written
65960 to the spool file. If an address is expanded via an alias or forward file, the
65961 original address is added to the tree when deliveries to all its child
65962 addresses are complete.
65963 </para>
65964 <para>
65965 If the tree is empty, there is a single line in the spool file containing just
65966 the text <quote>XX</quote>. Otherwise, each line consists of two letters, which are either
65967 Y or N, followed by an address. The address is the value for the node of the
65968 tree, and the letters indicate whether the node has a left branch and/or a
65969 right branch attached to it, respectively. If branches exist, they immediately
65970 follow. Here is an example of a three-node tree:
65971 </para>
65972 <literallayout class="monospaced">
65973 YY darcy@austen.fict.example
65974 NN alice@wonderland.fict.example
65975 NN editor@thesaurus.ref.example
65976 </literallayout>
65977 <para>
65978 After the non-recipients tree, there is a list of the message&#x2019;s recipients.
65979 This is a simple list, preceded by a count. It includes all the original
65980 recipients of the message, including those to whom the message has already been
65981 delivered. In the simplest case, the list contains one address per line. For
65982 example:
65983 </para>
65984 <literallayout class="monospaced">
65985 4
65986 editor@thesaurus.ref.example
65987 darcy@austen.fict.example
65988 rdo@foundation
65989 alice@wonderland.fict.example
65990 </literallayout>
65991 <para>
65992 However, when a child address has been added to the top-level addresses as a
65993 result of the use of the <option>one_time</option> option on a <command>redirect</command> router, each
65994 line is of the following form:
65995 </para>
65996 <literallayout>
65997 &lt;<emphasis>top-level address</emphasis>&gt; &lt;<emphasis>errors_to address</emphasis>&gt; &lt;<emphasis>length</emphasis>&gt;,&lt;<emphasis>parent number</emphasis>&gt;#&lt;<emphasis>flag bits</emphasis>&gt;
65998 </literallayout>
65999 <para>
66000 The 01 flag bit indicates the presence of the three other fields that follow
66001 the top-level address. Other bits may be used in future to support additional
66002 fields. The &lt;<emphasis>parent number</emphasis>&gt; is the offset in the recipients list of the
66003 original parent of the <quote>one time</quote> address. The first two fields are the
66004 envelope sender that is associated with this address and its length. If the
66005 length is zero, there is no special envelope sender (there are then two space
66006 characters in the line). A non-empty field can arise from a <command>redirect</command> router
66007 that has an <option>errors_to</option> setting.
66008 </para>
66009 <para>
66010 A blank line separates the envelope and status information from the headers
66011 which follow. A header may occupy several lines of the file, and to save effort
66012 when reading it in, each header is preceded by a number and an identifying
66013 character. The number is the number of characters in the header, including any
66014 embedded newlines and the terminating newline. The character is one of the
66015 following:
66016 </para>
66017 <informaltable frame="none">
66018 <tgroup cols="2" colsep="0" rowsep="0">
66019 <colspec colwidth="50pt" align="left"/>
66020 <colspec colwidth="254pt" align="left"/>
66021 <tbody>
66022 <row>
66023 <entry>&lt;<emphasis>blank</emphasis>&gt;</entry>
66024 <entry>header in which Exim has no special interest</entry>
66025 </row>
66026 <row>
66027 <entry><literal>B</literal></entry>
66028 <entry><emphasis>Bcc:</emphasis> header</entry>
66029 </row>
66030 <row>
66031 <entry><literal>C</literal></entry>
66032 <entry><emphasis>Cc:</emphasis> header</entry>
66033 </row>
66034 <row>
66035 <entry><literal>F</literal></entry>
66036 <entry><emphasis>From:</emphasis> header</entry>
66037 </row>
66038 <row>
66039 <entry><literal>I</literal></entry>
66040 <entry><emphasis>Message-id:</emphasis> header</entry>
66041 </row>
66042 <row>
66043 <entry><literal>P</literal></entry>
66044 <entry><emphasis>Received:</emphasis> header &ndash; P for <quote>postmark</quote></entry>
66045 </row>
66046 <row>
66047 <entry><literal>R</literal></entry>
66048 <entry><emphasis>Reply-To:</emphasis> header</entry>
66049 </row>
66050 <row>
66051 <entry><literal>S</literal></entry>
66052 <entry><emphasis>Sender:</emphasis> header</entry>
66053 </row>
66054 <row>
66055 <entry><literal>T</literal></entry>
66056 <entry><emphasis>To:</emphasis> header</entry>
66057 </row>
66058 <row>
66059 <entry><literal>*</literal></entry>
66060 <entry>replaced or deleted header</entry>
66061 </row>
66062 </tbody>
66063 </tgroup>
66064 </informaltable>
66065 <para>
66066 Deleted or replaced (rewritten) headers remain in the spool file for debugging
66067 purposes. They are not transmitted when the message is delivered. Here is a
66068 typical set of headers:
66069 </para>
66070 <literallayout class="monospaced">
66071 111P Received: by hobbit.fict.example with local (Exim 4.00)
66072 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
66073 049  Message-Id: &lt;E14y9EI-00026G-00@hobbit.fict.example&gt;
66074 038* X-rewrote-sender: bb@hobbit.fict.example
66075 042* From: Bilbo Baggins &lt;bb@hobbit.fict.example&gt;
66076 049F From: Bilbo Baggins &lt;B.Baggins@hobbit.fict.example&gt;
66077 099* To: alice@wonderland.fict.example, rdo@foundation,
66078 darcy@austen.fict.example, editor@thesaurus.ref.example
66079 104T To: alice@wonderland.fict.example, rdo@foundation.example,
66080 darcy@austen.fict.example, editor@thesaurus.ref.example
66081 038  Date: Fri, 11 May 2001 10:28:59 +0100
66082 </literallayout>
66083 <para>
66084 The asterisked headers indicate that the envelope sender, <emphasis>From:</emphasis> header, and
66085 <emphasis>To:</emphasis> header have been rewritten, the last one because routing expanded the
66086 unqualified domain <emphasis>foundation</emphasis>.
66087 <indexterm role="concept" startref="IIDforspo1" class="endofrange"/>
66088 <indexterm role="concept" startref="IIDforspo2" class="endofrange"/>
66089 <indexterm role="concept" startref="IIDforspo3" class="endofrange"/>
66090 </para>
66091 </section>
66092 </chapter>
66093
66094 <chapter id="CHAPdkim">
66095 <title>Support for DKIM (DomainKeys Identified Mail)</title>
66096 <titleabbrev>DKIM Support</titleabbrev>
66097 <para>
66098 <indexterm role="concept">
66099 <primary>DKIM</primary>
66100 </indexterm>
66101 </para>
66102 <para>
66103 DKIM is a mechanism by which messages sent by some entity can be provably
66104 linked to a domain which that entity controls.  It permits reputation to
66105 be tracked on a per-domain basis, rather than merely upon source IP address.
66106 DKIM is documented in RFC 4871.
66107 </para>
66108 <para>
66109 Since version 4.70, DKIM support is compiled into Exim by default. It can be
66110 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
66111 </para>
66112 <para>
66113 Exim&#x2019;s DKIM implementation allows to
66114 </para>
66115 <orderedlist numeration="arabic">
66116 <listitem>
66117 <para>
66118 Sign outgoing messages: This function is implemented in the SMTP transport.
66119 It can co-exist with all other Exim features
66120 (including transport filters)
66121 except cutthrough delivery.
66122 </para>
66123 </listitem>
66124 <listitem>
66125 <para>
66126 Verify signatures in incoming messages: This is implemented by an additional
66127 ACL (acl_smtp_dkim), which can be called several times per message, with
66128 different signature contexts.
66129 </para>
66130 </listitem>
66131 </orderedlist>
66132 <para>
66133 In typical Exim style, the verification implementation does not include any
66134 default "policy". Instead it enables you to build your own policy using
66135 Exim&#x2019;s standard controls.
66136 </para>
66137 <para>
66138 Please note that verification of DKIM signatures in incoming mail is turned
66139 on by default for logging purposes. For each signature in incoming email,
66140 exim will log a line displaying the most important signature details, and the
66141 signature status. Here is an example (with line-breaks added for clarity):
66142 </para>
66143 <literallayout class="monospaced">
66144 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
66145     d=facebookmail.com s=q1-2009b
66146     c=relaxed/relaxed a=rsa-sha1
66147     i=@facebookmail.com t=1252484542 [verification succeeded]
66148 </literallayout>
66149 <para>
66150 You might want to turn off DKIM verification processing entirely for internal
66151 or relay mail sources. To do that, set the <option>dkim_disable_verify</option> ACL
66152 control modifier. This should typically be done in the RCPT ACL, at points
66153 where you accept mail from relay sources (internal hosts or authenticated
66154 senders).
66155 </para>
66156 <section id="SECID513">
66157 <title>Signing outgoing messages</title>
66158 <para>
66159 <indexterm role="concept">
66160 <primary>DKIM</primary>
66161 <secondary>signing</secondary>
66162 </indexterm>
66163 </para>
66164 <para>
66165 Signing is implemented by setting private options on the SMTP transport.
66166 These options take (expandable) strings as arguments.
66167 </para>
66168 <para>
66169 <indexterm role="option">
66170 <primary><option>dkim_domain</option></primary>
66171 </indexterm>
66172 </para>
66173 <informaltable frame="all">
66174 <tgroup cols="4" colsep="0" rowsep="0">
66175 <colspec colwidth="8*" align="left"/>
66176 <colspec colwidth="6*" align="center"/>
66177 <colspec colwidth="6*" align="center"/>
66178 <colspec colwidth="6*" align="right"/>
66179 <tbody>
66180 <row>
66181 <entry><option>dkim_domain</option></entry>
66182 <entry>Use: <emphasis>smtp</emphasis></entry>
66183 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
66184 <entry>Default: <emphasis>unset</emphasis></entry>
66185 </row>
66186 </tbody>
66187 </tgroup>
66188 </informaltable>
66189 <para>
66190 MANDATORY:
66191 The domain you want to sign with. The result of this expanded
66192 option is put into the <option>$dkim_domain</option> expansion variable.
66193 </para>
66194 <para>
66195 <indexterm role="option">
66196 <primary><option>dkim_selector</option></primary>
66197 </indexterm>
66198 </para>
66199 <informaltable frame="all">
66200 <tgroup cols="4" colsep="0" rowsep="0">
66201 <colspec colwidth="8*" align="left"/>
66202 <colspec colwidth="6*" align="center"/>
66203 <colspec colwidth="6*" align="center"/>
66204 <colspec colwidth="6*" align="right"/>
66205 <tbody>
66206 <row>
66207 <entry><option>dkim_selector</option></entry>
66208 <entry>Use: <emphasis>smtp</emphasis></entry>
66209 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
66210 <entry>Default: <emphasis>unset</emphasis></entry>
66211 </row>
66212 </tbody>
66213 </tgroup>
66214 </informaltable>
66215 <para>
66216 MANDATORY:
66217 This sets the key selector string. You can use the <option>$dkim_domain</option> expansion
66218 variable to look up a matching selector. The result is put in the expansion
66219 variable <option>$dkim_selector</option> which should be used in the <option>dkim_private_key</option>
66220 option along with <option>$dkim_domain</option>.
66221 </para>
66222 <para>
66223 <indexterm role="option">
66224 <primary><option>dkim_private_key</option></primary>
66225 </indexterm>
66226 </para>
66227 <informaltable frame="all">
66228 <tgroup cols="4" colsep="0" rowsep="0">
66229 <colspec colwidth="8*" align="left"/>
66230 <colspec colwidth="6*" align="center"/>
66231 <colspec colwidth="6*" align="center"/>
66232 <colspec colwidth="6*" align="right"/>
66233 <tbody>
66234 <row>
66235 <entry><option>dkim_private_key</option></entry>
66236 <entry>Use: <emphasis>smtp</emphasis></entry>
66237 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
66238 <entry>Default: <emphasis>unset</emphasis></entry>
66239 </row>
66240 </tbody>
66241 </tgroup>
66242 </informaltable>
66243 <para>
66244 MANDATORY:
66245 This sets the private key to use. You can use the <option>$dkim_domain</option> and
66246 <option>$dkim_selector</option> expansion variables to determine the private key to use.
66247 The result can either
66248 </para>
66249 <itemizedlist>
66250 <listitem>
66251 <para>
66252 be a valid RSA private key in ASCII armor, including line breaks.
66253 </para>
66254 </listitem>
66255 <listitem>
66256 <para>
66257 start with a slash, in which case it is treated as a file that contains
66258 the private key.
66259 </para>
66260 </listitem>
66261 <listitem>
66262 <para>
66263 be "0", "false" or the empty string, in which case the message will not
66264 be signed. This case will not result in an error, even if <option>dkim_strict</option>
66265 is set.
66266 </para>
66267 </listitem>
66268 </itemizedlist>
66269 <para>
66270 <indexterm role="option">
66271 <primary><option>dkim_canon</option></primary>
66272 </indexterm>
66273 </para>
66274 <informaltable frame="all">
66275 <tgroup cols="4" colsep="0" rowsep="0">
66276 <colspec colwidth="8*" align="left"/>
66277 <colspec colwidth="6*" align="center"/>
66278 <colspec colwidth="6*" align="center"/>
66279 <colspec colwidth="6*" align="right"/>
66280 <tbody>
66281 <row>
66282 <entry><option>dkim_canon</option></entry>
66283 <entry>Use: <emphasis>smtp</emphasis></entry>
66284 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
66285 <entry>Default: <emphasis>unset</emphasis></entry>
66286 </row>
66287 </tbody>
66288 </tgroup>
66289 </informaltable>
66290 <para>
66291 OPTIONAL:
66292 This option sets the canonicalization method used when signing a message.
66293 The DKIM RFC currently supports two methods: "simple" and "relaxed".
66294 The option defaults to "relaxed" when unset. Note: the current implementation
66295 only supports using the same canonicalization method for both headers and body.
66296 </para>
66297 <para>
66298 <indexterm role="option">
66299 <primary><option>dkim_strict</option></primary>
66300 </indexterm>
66301 </para>
66302 <informaltable frame="all">
66303 <tgroup cols="4" colsep="0" rowsep="0">
66304 <colspec colwidth="8*" align="left"/>
66305 <colspec colwidth="6*" align="center"/>
66306 <colspec colwidth="6*" align="center"/>
66307 <colspec colwidth="6*" align="right"/>
66308 <tbody>
66309 <row>
66310 <entry><option>dkim_strict</option></entry>
66311 <entry>Use: <emphasis>smtp</emphasis></entry>
66312 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
66313 <entry>Default: <emphasis>unset</emphasis></entry>
66314 </row>
66315 </tbody>
66316 </tgroup>
66317 </informaltable>
66318 <para>
66319 OPTIONAL:
66320 This  option  defines  how  Exim  behaves  when  signing a message that
66321 should be signed fails for some reason.  When the expansion evaluates to
66322 either "1" or "true", Exim will defer. Otherwise Exim will send the message
66323 unsigned. You can use the <option>$dkim_domain</option> and <option>$dkim_selector</option> expansion
66324 variables here.
66325 </para>
66326 <para>
66327 <indexterm role="option">
66328 <primary><option>dkim_sign_headers</option></primary>
66329 </indexterm>
66330 </para>
66331 <informaltable frame="all">
66332 <tgroup cols="4" colsep="0" rowsep="0">
66333 <colspec colwidth="8*" align="left"/>
66334 <colspec colwidth="6*" align="center"/>
66335 <colspec colwidth="6*" align="center"/>
66336 <colspec colwidth="6*" align="right"/>
66337 <tbody>
66338 <row>
66339 <entry><option>dkim_sign_headers</option></entry>
66340 <entry>Use: <emphasis>smtp</emphasis></entry>
66341 <entry>Type: <emphasis>string</emphasis>&dagger;<emphasis></emphasis></entry>
66342 <entry>Default: <emphasis>unset</emphasis></entry>
66343 </row>
66344 </tbody>
66345 </tgroup>
66346 </informaltable>
66347 <para>
66348 OPTIONAL:
66349 When set, this option must expand to (or be specified as) a colon-separated
66350 list of header names. Headers with these names will be included in the message
66351 signature. When unspecified, the header names recommended in RFC4871 will be
66352 used.
66353 </para>
66354 </section>
66355 <section id="SECID514">
66356 <title>Verifying DKIM signatures in incoming mail</title>
66357 <para>
66358 <indexterm role="concept">
66359 <primary>DKIM</primary>
66360 <secondary>verification</secondary>
66361 </indexterm>
66362 </para>
66363 <para>
66364 Verification of DKIM signatures in incoming email is implemented via the
66365 <option>acl_smtp_dkim</option> ACL. By default, this ACL is called once for each
66366 syntactically(!) correct signature in the incoming message.
66367 A missing ACL definition defaults to accept.
66368 If any ACL call does not acccept, the message is not accepted.
66369 If a cutthrough delivery was in progress for the message it is
66370 summarily dropped (having wasted the transmission effort).
66371 </para>
66372 <para>
66373 To evaluate the signature in the ACL a large number of expansion variables
66374 containing the signature status and its details are set up during the
66375 runtime of the ACL.
66376 </para>
66377 <para>
66378 Calling the ACL only for existing signatures is not sufficient to build
66379 more advanced policies. For that reason, the global option
66380 <option>dkim_verify_signers</option>, and a global expansion variable
66381 <option>$dkim_signers</option> exist.
66382 </para>
66383 <para>
66384 The global option <option>dkim_verify_signers</option> can be set to a colon-separated
66385 list of DKIM domains or identities for which the ACL <option>acl_smtp_dkim</option> is
66386 called. It is expanded when the message has been received. At this point,
66387 the expansion variable <option>$dkim_signers</option> already contains a colon-separated
66388 list of signer domains and identities for the message. When
66389 <option>dkim_verify_signers</option> is not specified in the main configuration,
66390 it defaults as:
66391 </para>
66392 <literallayout class="monospaced">
66393 dkim_verify_signers = $dkim_signers
66394 </literallayout>
66395 <para>
66396 This leads to the default behaviour of calling <option>acl_smtp_dkim</option> for each
66397 DKIM signature in the message. Current DKIM verifiers may want to explicitly
66398 call the ACL for known domains or identities. This would be achieved as follows:
66399 </para>
66400 <literallayout class="monospaced">
66401 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
66402 </literallayout>
66403 <para>
66404 This would result in <option>acl_smtp_dkim</option> always being called for "paypal.com"
66405 and "ebay.com", plus all domains and identities that have signatures in the message.
66406 You can also be more creative in constructing your policy. For example:
66407 </para>
66408 <literallayout class="monospaced">
66409 dkim_verify_signers = $sender_address_domain:$dkim_signers
66410 </literallayout>
66411 <para>
66412 If a domain or identity is listed several times in the (expanded) value of
66413 <option>dkim_verify_signers</option>, the ACL is only called once for that domain or identity.
66414 </para>
66415 <para>
66416 Inside the <option>acl_smtp_dkim</option>, the following expansion variables are
66417 available (from most to least important):
66418 </para>
66419 <variablelist>
66420 <varlistentry>
66421 <term><option>$dkim_cur_signer</option></term>
66422 <listitem>
66423 <para>
66424 The signer that is being evaluated in this ACL run. This can be a domain or
66425 an identity. This is one of the list items from the expanded main option
66426 <option>dkim_verify_signers</option> (see above).
66427 </para>
66428 </listitem></varlistentry>
66429 <varlistentry>
66430 <term><option>$dkim_verify_status</option></term>
66431 <listitem>
66432 <para>
66433 A string describing the general status of the signature. One of
66434 </para>
66435 <itemizedlist>
66436 <listitem>
66437 <para>
66438 <option>none</option>: There is no signature in the message for the current domain or
66439 identity (as reflected by <option>$dkim_cur_signer</option>).
66440 </para>
66441 </listitem>
66442 <listitem>
66443 <para>
66444 <option>invalid</option>: The signature could not be verified due to a processing error.
66445 More detail is available in <option>$dkim_verify_reason</option>.
66446 </para>
66447 </listitem>
66448 <listitem>
66449 <para>
66450 <option>fail</option>: Verification of the signature failed.  More detail is
66451 available in <option>$dkim_verify_reason</option>.
66452 </para>
66453 </listitem>
66454 <listitem>
66455 <para>
66456 <option>pass</option>: The signature passed verification. It is valid.
66457 </para>
66458 </listitem>
66459 </itemizedlist>
66460 </listitem></varlistentry>
66461 <varlistentry>
66462 <term><option>$dkim_verify_reason</option></term>
66463 <listitem>
66464 <para>
66465 A string giving a litte bit more detail when <option>$dkim_verify_status</option> is either
66466 "fail" or "invalid". One of
66467 </para>
66468 <itemizedlist>
66469 <listitem>
66470 <para>
66471 <option>pubkey_unavailable</option> (when <option>$dkim_verify_status</option>="invalid"): The public
66472 key for the domain could not be retrieved. This may be a temporary problem.
66473 </para>
66474 </listitem>
66475 <listitem>
66476 <para>
66477 <option>pubkey_syntax</option> (when <option>$dkim_verify_status</option>="invalid"): The public key
66478 record for the domain is syntactically invalid.
66479 </para>
66480 </listitem>
66481 <listitem>
66482 <para>
66483 <option>bodyhash_mismatch</option> (when <option>$dkim_verify_status</option>="fail"): The calculated
66484 body hash does not match the one specified in the signature header. This
66485 means that the message body was modified in transit.
66486 </para>
66487 </listitem>
66488 <listitem>
66489 <para>
66490 <option>signature_incorrect</option> (when <option>$dkim_verify_status</option>="fail"): The signature
66491 could not be verified. This may mean that headers were modified,
66492 re-written or otherwise changed in a way which is incompatible with
66493 DKIM verification. It may of course also mean that the signature is forged.
66494 </para>
66495 </listitem>
66496 </itemizedlist>
66497 </listitem></varlistentry>
66498 <varlistentry>
66499 <term><option>$dkim_domain</option></term>
66500 <listitem>
66501 <para>
66502 The signing domain. IMPORTANT: This variable is only populated if there is
66503 an actual signature in the message for the current domain or identity (as
66504 reflected by <option>$dkim_cur_signer</option>).
66505 </para>
66506 </listitem></varlistentry>
66507 <varlistentry>
66508 <term><option>$dkim_identity</option></term>
66509 <listitem>
66510 <para>
66511 The signing identity, if present. IMPORTANT: This variable is only populated
66512 if there is an actual signature in the message for the current domain or
66513 identity (as reflected by <option>$dkim_cur_signer</option>).
66514 </para>
66515 </listitem></varlistentry>
66516 <varlistentry>
66517 <term><option>$dkim_selector</option></term>
66518 <listitem>
66519 <para>
66520 The key record selector string.
66521 </para>
66522 </listitem></varlistentry>
66523 <varlistentry>
66524 <term><option>$dkim_algo</option></term>
66525 <listitem>
66526 <para>
66527 The algorithm used. One of &#x2019;rsa-sha1&#x2019; or &#x2019;rsa-sha256&#x2019;.
66528 </para>
66529 </listitem></varlistentry>
66530 <varlistentry>
66531 <term><option>$dkim_canon_body</option></term>
66532 <listitem>
66533 <para>
66534 The body canonicalization method. One of &#x2019;relaxed&#x2019; or &#x2019;simple&#x2019;.
66535 </para>
66536 </listitem></varlistentry>
66537 <varlistentry>
66538 <term><option>dkim_canon_headers</option></term>
66539 <listitem>
66540 <para>
66541 The header canonicalization method. One of &#x2019;relaxed&#x2019; or &#x2019;simple&#x2019;.
66542 </para>
66543 </listitem></varlistentry>
66544 <varlistentry>
66545 <term><option>$dkim_copiedheaders</option></term>
66546 <listitem>
66547 <para>
66548 A transcript of headers and their values which are included in the signature
66549 (copied from the &#x2019;z=&#x2019; tag of the signature).
66550 </para>
66551 </listitem></varlistentry>
66552 <varlistentry>
66553 <term><option>$dkim_bodylength</option></term>
66554 <listitem>
66555 <para>
66556 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
66557 limit was set by the signer, "9999999999999" is returned. This makes sure
66558 that this variable always expands to an integer value.
66559 </para>
66560 </listitem></varlistentry>
66561 <varlistentry>
66562 <term><option>$dkim_created</option></term>
66563 <listitem>
66564 <para>
66565 UNIX timestamp reflecting the date and time when the signature was created.
66566 When this was not specified by the signer, "0" is returned.
66567 </para>
66568 </listitem></varlistentry>
66569 <varlistentry>
66570 <term><option>$dkim_expires</option></term>
66571 <listitem>
66572 <para>
66573 UNIX timestamp reflecting the date and time when the signer wants the
66574 signature to be treated as "expired". When this was not specified by the
66575 signer, "9999999999999" is returned. This makes it possible to do useful
66576 integer size comparisons against this value.
66577 </para>
66578 </listitem></varlistentry>
66579 <varlistentry>
66580 <term><option>$dkim_headernames</option></term>
66581 <listitem>
66582 <para>
66583 A colon-separated list of names of headers included in the signature.
66584 </para>
66585 </listitem></varlistentry>
66586 <varlistentry>
66587 <term><option>$dkim_key_testing</option></term>
66588 <listitem>
66589 <para>
66590 "1" if the key record has the "testing" flag set, "0" if not.
66591 </para>
66592 </listitem></varlistentry>
66593 <varlistentry>
66594 <term><option>$dkim_key_nosubdomains</option></term>
66595 <listitem>
66596 <para>
66597 "1" if the key record forbids subdomaining, "0" otherwise.
66598 </para>
66599 </listitem></varlistentry>
66600 <varlistentry>
66601 <term><option>$dkim_key_srvtype</option></term>
66602 <listitem>
66603 <para>
66604 Service type (tag s=) from the key record. Defaults to "*" if not specified
66605 in the key record.
66606 </para>
66607 </listitem></varlistentry>
66608 <varlistentry>
66609 <term><option>$dkim_key_granularity</option></term>
66610 <listitem>
66611 <para>
66612 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
66613 in the key record.
66614 </para>
66615 </listitem></varlistentry>
66616 <varlistentry>
66617 <term><option>$dkim_key_notes</option></term>
66618 <listitem>
66619 <para>
66620 Notes from the key record (tag n=).
66621 </para>
66622 </listitem></varlistentry>
66623 </variablelist>
66624 <para>
66625 In addition, two ACL conditions are provided:
66626 </para>
66627 <variablelist>
66628 <varlistentry>
66629 <term><option>dkim_signers</option></term>
66630 <listitem>
66631 <para>
66632 ACL condition that checks a colon-separated list of domains or identities
66633 for a match against the domain or identity that the ACL is currently verifying
66634 (reflected by <option>$dkim_cur_signer</option>). This is typically used to restrict an ACL
66635 verb to a group of domains or identities. For example:
66636 </para>
66637 <literallayout class="monospaced">
66638 # Warn when Mail purportedly from GMail has no signature at all
66639 warn log_message = GMail sender without DKIM signature
66640      sender_domains = gmail.com
66641      dkim_signers = gmail.com
66642      dkim_status = none
66643 </literallayout>
66644 </listitem></varlistentry>
66645 <varlistentry>
66646 <term><option>dkim_status</option></term>
66647 <listitem>
66648 <para>
66649 ACL condition that checks a colon-separated list of possible DKIM verification
66650 results against the actual result of verification. This is typically used
66651 to restrict an ACL verb to a list of verification outcomes, for example:
66652 </para>
66653 <literallayout class="monospaced">
66654 deny message = Mail from Paypal with invalid/missing signature
66655      sender_domains = paypal.com:paypal.de
66656      dkim_signers = paypal.com:paypal.de
66657      dkim_status = none:invalid:fail
66658 </literallayout>
66659 <para>
66660 The possible status keywords are: &#x2019;none&#x2019;,&#x2019;invalid&#x2019;,&#x2019;fail&#x2019; and &#x2019;pass&#x2019;. Please
66661 see the documentation of the <option>$dkim_verify_status</option> expansion variable above
66662 for more information of what they mean.
66663 </para>
66664 </listitem></varlistentry>
66665 </variablelist>
66666 </section>
66667 </chapter>
66668
66669 <chapter id="CHID13">
66670 <title>Adding new drivers or lookup types</title>
66671 <titleabbrev>Adding drivers or lookups</titleabbrev>
66672 <para>
66673 <indexterm role="concept">
66674 <primary>adding drivers</primary>
66675 </indexterm>
66676 <indexterm role="concept">
66677 <primary>new drivers, adding</primary>
66678 </indexterm>
66679 <indexterm role="concept">
66680 <primary>drivers</primary>
66681 <secondary>adding new</secondary>
66682 </indexterm>
66683 The following actions have to be taken in order to add a new router, transport,
66684 authenticator, or lookup type to Exim:
66685 </para>
66686 <orderedlist numeration="arabic">
66687 <listitem>
66688 <para>
66689 Choose a name for the driver or lookup type that does not conflict with any
66690 existing name; I will use <quote>newdriver</quote> in what follows.
66691 </para>
66692 </listitem>
66693 <listitem>
66694 <para>
66695 Add to <filename>src/EDITME</filename> the line:
66696 </para>
66697 <literallayout>
66698 &lt;<emphasis>type</emphasis>&gt;<literal>_NEWDRIVER=yes</literal>
66699 </literallayout>
66700 <para>
66701 where &lt;<emphasis>type</emphasis>&gt; is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
66702 code is not to be included in the binary by default, comment this line out. You
66703 should also add any relevant comments about the driver or lookup type.
66704 </para>
66705 </listitem>
66706 <listitem>
66707 <para>
66708 Add to <filename>src/config.h.defaults</filename> the line:
66709 </para>
66710 <literallayout class="monospaced">
66711 #define &lt;type&gt;_NEWDRIVER
66712 </literallayout>
66713 </listitem>
66714 <listitem>
66715 <para>
66716 Edit <filename>src/drtables.c</filename>, adding conditional code to pull in the private header
66717 and create a table entry as is done for all the other drivers and lookup types.
66718 </para>
66719 </listitem>
66720 <listitem>
66721 <para>
66722 Edit <filename>scripts/lookups-Makefile</filename> if this is a new lookup; there is a for-loop
66723 near the bottom, ranging the <literal>name_mod</literal> variable over a list of all lookups.
66724 Add your <literal>NEWDRIVER</literal> to that list.
66725 As long as the dynamic module would be named <filename>newdriver.so</filename>, you can use the
66726 simple form that most lookups have.
66727 </para>
66728 </listitem>
66729 <listitem>
66730 <para>
66731 Edit <filename>Makefile</filename> in the appropriate sub-directory (<filename>src/routers</filename>,
66732 <filename>src/transports</filename>, <filename>src/auths</filename>, or <filename>src/lookups</filename>); add a line for the new
66733 driver or lookup type and add it to the definition of OBJ.
66734 </para>
66735 </listitem>
66736 <listitem>
66737 <para>
66738 Create <filename>newdriver.h</filename> and <filename>newdriver.c</filename> in the appropriate sub-directory of
66739 <filename>src</filename>.
66740 </para>
66741 </listitem>
66742 <listitem>
66743 <para>
66744 Edit <filename>scripts/MakeLinks</filename> and add commands to link the <filename>.h</filename> and <filename>.c</filename> files
66745 as for other drivers and lookups.
66746 </para>
66747 </listitem>
66748 </orderedlist>
66749 <para>
66750 Then all you need to do is write the code! A good way to start is to make a
66751 proforma by copying an existing module of the same type, globally changing all
66752 occurrences of the name, and cutting out most of the code. Note that any
66753 options you create must be listed in alphabetical order, because the tables are
66754 searched using a binary chop procedure.
66755 </para>
66756 <para>
66757 There is a <filename>README</filename> file in each of the sub-directories of <filename>src</filename> describing
66758 the interface that is expected.
66759 </para>
66760 <?sdop
66761   format="newpage"
66762   foot_right_recto="&chaptertitle;"
66763   foot_right_verso="&chaptertitle;"
66764 ?>
66765 </chapter>
66766
66767 <index role="option">
66768 <title>Options index</title>
66769 </index>
66770
66771 <index role="variable">
66772 <title>Variables index</title>
66773 </index>
66774
66775 <index role="concept">
66776 <title>Concept index</title>
66777 </index>
66778
66779 </book>