]> git.netwichtig.de Git - user/henk/code/exim.git/blob - doc/doc-docbook/spec.xfpt
529861208b2480409878e304b0447a635041444a
[user/henk/code/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printable and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generates the outermost <book> element that wraps the entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.95"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .set drivernamemax "64"
55
56 .macro copyyear
57 2021
58 .endmacro
59
60 . /////////////////////////////////////////////////////////////////////////////
61 . Additional xfpt markup used by this document, over and above the default
62 . provided in the xfpt library.
63 . /////////////////////////////////////////////////////////////////////////////
64
65 . --- Override the &$ flag to automatically insert a $ with the variable name.
66
67 .flag &$  $&   "<varname>$"  "</varname>"
68
69 . --- Short flags for daggers in option headings. They will always be inside
70 . --- an italic string, but we want the daggers to be in Roman.
71
72 .flag &!!      "</emphasis>&dagger;<emphasis>"
73 .flag &!?      "</emphasis>&Dagger;<emphasis>"
74
75 . --- A macro for an Exim option definition heading, generating a one-line
76 . --- table with four columns. For cases when the option name is given with
77 . --- a space, so that it can be split, a fifth argument is used for the
78 . --- index entry.
79
80 .macro option
81 .arg 5
82 .oindex "&%$5%&"
83 .endarg
84 .arg -5
85 .oindex "&%$1%&"
86 .endarg
87 .itable all 0 0 4 8* left 6* center 6* center 6* right
88 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
89 .endtable
90 .endmacro
91
92 . --- A macro for the common 2-column tables. The width of the first column
93 . --- is suitable for the many tables at the start of the main options chapter;
94 . --- a small number of other 2-column tables override it.
95
96 .macro table2 196pt 254pt
97 .itable none 0 0 2 $1 left $2 left
98 .endmacro
99
100 . --- A macro that generates .row, but puts &I; at the start of the first
101 . --- argument, thus indenting it. Assume a minimum of two arguments, and
102 . --- allow up to four arguments, which is as many as we'll ever need.
103
104 .macro irow
105 .arg 4
106 .row "&I;$1" "$2" "$3" "$4"
107 .endarg
108 .arg -4
109 .arg 3
110 .row "&I;$1" "$2" "$3"
111 .endarg
112 .arg -3
113 .row "&I;$1" "$2"
114 .endarg
115 .endarg
116 .endmacro
117
118 . --- Macros for option, variable, and concept index entries. For a "range"
119 . --- style of entry, use .scindex for the start and .ecindex for the end. The
120 . --- first argument of .scindex and the only argument of .ecindex must be the
121 . --- ID that ties them together.
122
123 .macro cindex
124 &<indexterm role="concept">&
125 &<primary>&$1&</primary>&
126 .arg 2
127 &<secondary>&$2&</secondary>&
128 .endarg
129 &</indexterm>&
130 .endmacro
131
132 .macro scindex
133 &<indexterm role="concept" id="$1" class="startofrange">&
134 &<primary>&$2&</primary>&
135 .arg 3
136 &<secondary>&$3&</secondary>&
137 .endarg
138 &</indexterm>&
139 .endmacro
140
141 .macro ecindex
142 &<indexterm role="concept" startref="$1" class="endofrange"/>&
143 .endmacro
144
145 .macro oindex
146 &<indexterm role="option">&
147 &<primary>&$1&</primary>&
148 .arg 2
149 &<secondary>&$2&</secondary>&
150 .endarg
151 &</indexterm>&
152 .endmacro
153
154 .macro vindex
155 &<indexterm role="variable">&
156 &<primary>&$1&</primary>&
157 .arg 2
158 &<secondary>&$2&</secondary>&
159 .endarg
160 &</indexterm>&
161 .endmacro
162
163 .macro index
164 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
165 .endmacro
166
167
168 . use this for a concept-index entry for a header line
169 .macro chindex
170 .cindex "&'$1'& header line"
171 .cindex "header lines" $1
172 .endmacro
173 . ////////////////////////////////////////////////////////////////////////////
174
175
176 . ////////////////////////////////////////////////////////////////////////////
177 . The <bookinfo> element is removed from the XML before processing for ASCII
178 . output formats.
179 . ////////////////////////////////////////////////////////////////////////////
180
181 .literal xml
182 <bookinfo>
183 <title>Specification of the Exim Mail Transfer Agent</title>
184 <titleabbrev>The Exim MTA</titleabbrev>
185 <date>
186 .fulldate
187 </date>
188 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
189 <authorinitials>EM</authorinitials>
190 <revhistory><revision>
191 .versiondatexml
192   <authorinitials>EM</authorinitials>
193 </revision></revhistory>
194 <copyright><year>
195 .copyyear
196            </year><holder>The Exim Maintainers</holder></copyright>
197 </bookinfo>
198 .literal off
199
200
201 . /////////////////////////////////////////////////////////////////////////////
202 . This chunk of literal XML implements index entries of the form "x, see y" and
203 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
204 . at the top level, so we have to put the .chapter directive first.
205
206 . These do not turn up in the HTML output, unfortunately.  The PDF does get them.
207 . /////////////////////////////////////////////////////////////////////////////
208
209 .chapter "Introduction" "CHID1"
210 .literal xml
211
212 <indexterm role="variable">
213   <primary>$1, $2, etc.</primary>
214   <see><emphasis>numerical variables</emphasis></see>
215 </indexterm>
216 <indexterm role="concept">
217   <primary>address</primary>
218   <secondary>rewriting</secondary>
219   <see><emphasis>rewriting</emphasis></see>
220 </indexterm>
221 <indexterm role="concept">
222   <primary>Bounce Address Tag Validation</primary>
223   <see><emphasis>BATV</emphasis></see>
224 </indexterm>
225 <indexterm role="concept">
226   <primary>Client SMTP Authorization</primary>
227   <see><emphasis>CSA</emphasis></see>
228 </indexterm>
229 <indexterm role="concept">
230   <primary>CR character</primary>
231   <see><emphasis>carriage return</emphasis></see>
232 </indexterm>
233 <indexterm role="concept">
234   <primary>CRL</primary>
235   <see><emphasis>certificate revocation list</emphasis></see>
236 </indexterm>
237 <indexterm role="concept">
238   <primary>delivery</primary>
239   <secondary>failure report</secondary>
240   <see><emphasis>bounce message</emphasis></see>
241 </indexterm>
242 <indexterm role="concept">
243   <primary>de-tainting</primary>
244   <see><emphasis>tainting, de-tainting</emphasis></see>
245 </indexterm>
246 <indexterm role="concept">
247   <primary>detainting</primary>
248   <see><emphasis>tainting, de-tainting</emphasis></see>
249 </indexterm>
250 <indexterm role="concept">
251   <primary>dialup</primary>
252   <see><emphasis>intermittently connected hosts</emphasis></see>
253 </indexterm>
254 <indexterm role="concept">
255   <primary>exiscan</primary>
256   <see><emphasis>content scanning</emphasis></see>
257 </indexterm>
258 <indexterm role="concept">
259   <primary>failover</primary>
260   <see><emphasis>fallback</emphasis></see>
261 </indexterm>
262 <indexterm role="concept">
263   <primary>fallover</primary>
264   <see><emphasis>fallback</emphasis></see>
265 </indexterm>
266 <indexterm role="concept">
267   <primary>filter</primary>
268   <secondary>Sieve</secondary>
269   <see><emphasis>Sieve filter</emphasis></see>
270 </indexterm>
271 <indexterm role="concept">
272   <primary>ident</primary>
273   <see><emphasis>RFC 1413</emphasis></see>
274 </indexterm>
275 <indexterm role="concept">
276   <primary>LF character</primary>
277   <see><emphasis>linefeed</emphasis></see>
278 </indexterm>
279 <indexterm role="concept">
280   <primary>maximum</primary>
281   <seealso><emphasis>limit</emphasis></seealso>
282 </indexterm>
283 <indexterm role="concept">
284   <primary>monitor</primary>
285   <see><emphasis>Exim monitor</emphasis></see>
286 </indexterm>
287 <indexterm role="concept">
288   <primary>no_<emphasis>xxx</emphasis></primary>
289   <see>entry for xxx</see>
290 </indexterm>
291 <indexterm role="concept">
292   <primary>NUL</primary>
293   <see><emphasis>binary zero</emphasis></see>
294 </indexterm>
295 <indexterm role="concept">
296   <primary>passwd file</primary>
297   <see><emphasis>/etc/passwd</emphasis></see>
298 </indexterm>
299 <indexterm role="concept">
300   <primary>process id</primary>
301   <see><emphasis>pid</emphasis></see>
302 </indexterm>
303 <indexterm role="concept">
304   <primary>RBL</primary>
305   <see><emphasis>DNS list</emphasis></see>
306 </indexterm>
307 <indexterm role="concept">
308   <primary>redirection</primary>
309   <see><emphasis>address redirection</emphasis></see>
310 </indexterm>
311 <indexterm role="concept">
312   <primary>return path</primary>
313   <seealso><emphasis>envelope sender</emphasis></seealso>
314 </indexterm>
315 <indexterm role="concept">
316   <primary>scanning</primary>
317   <see><emphasis>content scanning</emphasis></see>
318 </indexterm>
319 <indexterm role="concept">
320   <primary>SSL</primary>
321   <see><emphasis>TLS</emphasis></see>
322 </indexterm>
323 <indexterm role="concept">
324   <primary>string</primary>
325   <secondary>expansion</secondary>
326   <see><emphasis>expansion</emphasis></see>
327 </indexterm>
328 <indexterm role="concept">
329   <primary>top bit</primary>
330   <see><emphasis>8-bit characters</emphasis></see>
331 </indexterm>
332 <indexterm role="concept">
333   <primary>variables</primary>
334   <see><emphasis>expansion, variables</emphasis></see>
335 </indexterm>
336 <indexterm role="concept">
337   <primary>zero, binary</primary>
338   <see><emphasis>binary zero</emphasis></see>
339 </indexterm>
340 <indexterm role="concept">
341   <primary>headers</primary>
342   <see><emphasis>header lines</emphasis></see>
343 </indexterm>
344
345 .literal off
346
347
348 . /////////////////////////////////////////////////////////////////////////////
349 . This is the real start of the first chapter. See the comment above as to why
350 . we can't have the .chapter line here.
351 . chapter "Introduction"
352 . /////////////////////////////////////////////////////////////////////////////
353
354 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
355 Unix-like operating systems. It was designed on the assumption that it would be
356 run on hosts that are permanently connected to the Internet. However, it can be
357 used on intermittently connected hosts with suitable configuration adjustments.
358
359 Configuration files currently exist for the following operating systems: AIX,
360 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
361 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
362 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
363 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
364 Some of these operating systems are no longer current and cannot easily be
365 tested, so the configuration files may no longer work in practice.
366
367 There are also configuration files for compiling Exim in the Cygwin environment
368 that can be installed on systems running Windows. However, this document does
369 not contain any information about running Exim in the Cygwin environment.
370
371 The terms and conditions for the use and distribution of Exim are contained in
372 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
373 Public Licence, a copy of which may be found in the file &_LICENCE_&.
374
375 The use, supply, or promotion of Exim for the purpose of sending bulk,
376 unsolicited electronic mail is incompatible with the basic aims of Exim,
377 which revolve around the free provision of a service that enhances the quality
378 of personal communications. The author of Exim regards indiscriminate
379 mass-mailing as an antisocial, irresponsible abuse of the Internet.
380
381 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
382 experience of running and working on the Smail 3 code, I could never have
383 contemplated starting to write a new MTA. Many of the ideas and user interfaces
384 were originally taken from Smail 3, though the actual code of Exim is entirely
385 new, and has developed far beyond the initial concept.
386
387 Many people, both in Cambridge and around the world, have contributed to the
388 development and the testing of Exim, and to porting it to various operating
389 systems. I am grateful to them all. The distribution now contains a file called
390 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
391 contributors.
392
393
394 .section "Exim documentation" "SECID1"
395 . Keep this example change bar when updating the documentation!
396
397 .new
398 .cindex "documentation"
399 This edition of the Exim specification applies to version &version() of Exim.
400 Substantive changes from the &previousversion; edition are marked in some
401 renditions of this document; this paragraph is so marked if the rendition is
402 capable of showing a change indicator.
403 .wen
404
405 This document is very much a reference manual; it is not a tutorial. The reader
406 is expected to have some familiarity with the SMTP mail transfer protocol and
407 with general Unix system administration. Although there are some discussions
408 and examples in places, the information is mostly organized in a way that makes
409 it easy to look up, rather than in a natural order for sequential reading.
410 Furthermore, this manual aims to cover every aspect of Exim in detail, including
411 a number of rarely-used, special-purpose features that are unlikely to be of
412 very wide interest.
413
414 .cindex "books about Exim"
415 An &"easier"& discussion of Exim which provides more in-depth explanatory,
416 introductory, and tutorial material can be found in a book entitled &'The Exim
417 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
418 (&url(https://www.uit.co.uk/exim-book/)).
419
420 The book also contains a chapter that gives a general introduction to SMTP and
421 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
422 with the latest release of Exim. (Note that the earlier book about Exim,
423 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
424
425 .cindex "Debian" "information sources"
426 If you are using a Debian distribution of Exim, you will find information about
427 Debian-specific features in the file
428 &_/usr/share/doc/exim4-base/README.Debian_&.
429 The command &(man update-exim.conf)& is another source of Debian-specific
430 information.
431
432 .cindex "&_doc/NewStuff_&"
433 .cindex "&_doc/ChangeLog_&"
434 .cindex "change log"
435 As Exim develops, there may be features in newer versions that have not
436 yet made it into this document, which is updated only when the most significant
437 digit of the fractional part of the version number changes. Specifications of
438 new features that are not yet in this manual are placed in the file
439 &_doc/NewStuff_& in the Exim distribution.
440
441 Some features may be classified as &"experimental"&. These may change
442 incompatibly while they are developing, or even be withdrawn. For this reason,
443 they are not documented in this manual. Information about experimental features
444 can be found in the file &_doc/experimental.txt_&.
445
446 All changes to Exim (whether new features, bug fixes, or other kinds of
447 change) are noted briefly in the file called &_doc/ChangeLog_&.
448
449 .cindex "&_doc/spec.txt_&"
450 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
451 that it can easily be searched with a text editor. Other files in the &_doc_&
452 directory are:
453
454 .table2 100pt
455 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
456 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
457 .row &_exim.8_&              "a man page of Exim's command line options"
458 .row &_experimental.txt_&    "documentation of experimental features"
459 .row &_filter.txt_&          "specification of the filter language"
460 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
461 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
462 .row &_openssl.txt_&         "installing a current OpenSSL release"
463 .endtable
464
465 The main specification and the specification of the filtering language are also
466 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
467 &<<SECTavail>>& below tells you how to get hold of these.
468
469
470
471 .section "FTP site and websites" "SECID2"
472 .cindex "website"
473 .cindex "FTP site"
474 The primary site for Exim source distributions is the &%exim.org%& FTP site,
475 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
476 website, are hosted at the University of Cambridge.
477
478 .cindex "wiki"
479 .cindex "FAQ"
480 As well as Exim distribution tar files, the Exim website contains a number of
481 differently formatted versions of the documentation. A recent addition to the
482 online information is the Exim wiki (&url(https://wiki.exim.org)),
483 which contains what used to be a separate FAQ, as well as various other
484 examples, tips, and know-how that have been contributed by Exim users.
485 The wiki site should always redirect to the correct place, which is currently
486 provided by GitHub, and is open to editing by anyone with a GitHub account.
487
488 .cindex Bugzilla
489 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
490 this to report bugs, and also to add items to the wish list. Please search
491 first to check that you are not duplicating a previous entry.
492 Please do not ask for configuration help in the bug-tracker.
493
494
495 .section "Mailing lists" "SECID3"
496 .cindex "mailing lists" "for Exim users"
497 The following Exim mailing lists exist:
498
499 .table2 140pt
500 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
501 .row &'exim-users@exim.org'&      "General discussion list"
502 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
503 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
504 .endtable
505
506 You can subscribe to these lists, change your existing subscriptions, and view
507 or search the archives via the mailing lists link on the Exim home page.
508 .cindex "Debian" "mailing list for"
509 If you are using a Debian distribution of Exim, you may wish to subscribe to
510 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
511 via this web page:
512 .display
513 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
514 .endd
515 Please ask Debian-specific questions on that list and not on the general Exim
516 lists.
517
518 .section "Bug reports" "SECID5"
519 .cindex "bug reports"
520 .cindex "reporting bugs"
521 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
522 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
523 whether some behaviour is a bug or not, the best thing to do is to post a
524 message to the &'exim-dev'& mailing list and have it discussed.
525
526
527
528 .section "Where to find the Exim distribution" "SECTavail"
529 .cindex "FTP site"
530 .cindex "HTTPS download site"
531 .cindex "distribution" "FTP site"
532 .cindex "distribution" "https site"
533 The master distribution site for the Exim distribution is
534 .display
535 &url(https://downloads.exim.org/)
536 .endd
537 The service is available over HTTPS, HTTP and FTP.
538 We encourage people to migrate to HTTPS.
539
540 The content served at &url(https://downloads.exim.org/) is identical to the
541 content served at &url(https://ftp.exim.org/pub/exim) and
542 &url(ftp://ftp.exim.org/pub/exim).
543
544 If accessing via a hostname containing &'ftp'&, then the file references that
545 follow are relative to the &_exim_& directories at these sites.
546 If accessing via the hostname &'downloads'& then the subdirectories described
547 here are top-level directories.
548
549 There are now quite a number of independent mirror sites around
550 the world. Those that I know about are listed in the file called &_Mirrors_&.
551
552 Within the top exim directory there are subdirectories called &_exim3_& (for
553 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
554 distributions), and &_Testing_& for testing versions. In the &_exim4_&
555 subdirectory, the current release can always be found in files called
556 .display
557 &_exim-n.nn.tar.xz_&
558 &_exim-n.nn.tar.gz_&
559 &_exim-n.nn.tar.bz2_&
560 .endd
561 where &'n.nn'& is the highest such version number in the directory. The three
562 files contain identical data; the only difference is the type of compression.
563 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
564 most portable to old systems.
565
566 .cindex "distribution" "signing details"
567 .cindex "distribution" "public key"
568 .cindex "public key for signed distribution"
569 The distributions will be PGP signed by an individual key of the Release
570 Coordinator.  This key will have a uid containing an email address in the
571 &'exim.org'& domain and will have signatures from other people, including
572 other Exim maintainers.  We expect that the key will be in the "strong set" of
573 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
574 PGP keys, a version of which can be found in the release directory in the file
575 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
576 such as &'pool.sks-keyservers.net'&.
577
578 At the time of the last update, releases were being made by Jeremy Harris and signed
579 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
580 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
581 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
582
583 The signatures for the tar bundles are in:
584 .display
585 &_exim-n.nn.tar.xz.asc_&
586 &_exim-n.nn.tar.gz.asc_&
587 &_exim-n.nn.tar.bz2.asc_&
588 .endd
589 For each released version, the log of changes is made available in a
590 separate file in the directory &_ChangeLogs_& so that it is possible to
591 find out what has changed without having to download the entire distribution.
592
593 .cindex "documentation" "available formats"
594 The main distribution contains ASCII versions of this specification and other
595 documentation; other formats of the documents are available in separate files
596 inside the &_exim4_& directory of the FTP site:
597 .display
598 &_exim-html-n.nn.tar.gz_&
599 &_exim-pdf-n.nn.tar.gz_&
600 &_exim-postscript-n.nn.tar.gz_&
601 &_exim-texinfo-n.nn.tar.gz_&
602 .endd
603 These tar files contain only the &_doc_& directory, not the complete
604 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
605
606
607 .section "Limitations" "SECID6"
608 .ilist
609 .cindex "limitations of Exim"
610 .cindex "bang paths" "not handled by Exim"
611 Exim is designed for use as an Internet MTA, and therefore handles addresses in
612 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
613 simple two-component bang paths can be converted by a straightforward rewriting
614 configuration. This restriction does not prevent Exim from being interfaced to
615 UUCP as a transport mechanism, provided that domain addresses are used.
616 .next
617 .cindex "domainless addresses"
618 .cindex "address" "without domain"
619 Exim insists that every address it handles has a domain attached. For incoming
620 local messages, domainless addresses are automatically qualified with a
621 configured domain value. Configuration options specify from which remote
622 systems unqualified addresses are acceptable. These are then qualified on
623 arrival.
624 .next
625 .cindex "transport" "external"
626 .cindex "external transports"
627 The only external transport mechanisms that are currently implemented are SMTP
628 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
629 transport is available, and there are facilities for writing messages to files
630 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
631 to send messages to other transport mechanisms such as UUCP, provided they can
632 handle domain-style addresses. Batched SMTP input is also catered for.
633 .next
634 Exim is not designed for storing mail for dial-in hosts. When the volumes of
635 such mail are large, it is better to get the messages &"delivered"& into files
636 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
637 other means.
638 .next
639 Although Exim does have basic facilities for scanning incoming messages, these
640 are not comprehensive enough to do full virus or spam scanning. Such operations
641 are best carried out using additional specialized software packages. If you
642 compile Exim with the content-scanning extension, straightforward interfaces to
643 a number of common scanners are provided.
644 .endlist
645
646
647 .section "Runtime configuration" "SECID7"
648 Exim's runtime configuration is held in a single text file that is divided
649 into a number of sections. The entries in this file consist of keywords and
650 values, in the style of Smail 3 configuration files. A default configuration
651 file which is suitable for simple online installations is provided in the
652 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
653
654
655 .section "Calling interface" "SECID8"
656 .cindex "Sendmail compatibility" "command line interface"
657 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
658 can be a straight replacement for &_/usr/lib/sendmail_& or
659 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
660 about Sendmail in order to run Exim. For actions other than sending messages,
661 Sendmail-compatible options also exist, but those that produce output (for
662 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
663 format. There are also some additional options that are compatible with Smail
664 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
665 documents all Exim's command line options. This information is automatically
666 made into the man page that forms part of the Exim distribution.
667
668 Control of messages in the queue can be done via certain privileged command
669 line options. There is also an optional monitor program called &'eximon'&,
670 which displays current information in an X window, and which contains a menu
671 interface to Exim's command line administration options.
672
673
674
675 .section "Terminology" "SECID9"
676 .cindex "terminology definitions"
677 .cindex "body of message" "definition of"
678 The &'body'& of a message is the actual data that the sender wants to transmit.
679 It is the last part of a message and is separated from the &'header'& (see
680 below) by a blank line.
681
682 .cindex "bounce message" "definition of"
683 When a message cannot be delivered, it is normally returned to the sender in a
684 delivery failure message or a &"non-delivery report"& (NDR). The term
685 &'bounce'& is commonly used for this action, and the error reports are often
686 called &'bounce messages'&. This is a convenient shorthand for &"delivery
687 failure error report"&. Such messages have an empty sender address in the
688 message's &'envelope'& (see below) to ensure that they cannot themselves give
689 rise to further bounce messages.
690
691 The term &'default'& appears frequently in this manual. It is used to qualify a
692 value which is used in the absence of any setting in the configuration. It may
693 also qualify an action which is taken unless a configuration setting specifies
694 otherwise.
695
696 The term &'defer'& is used when the delivery of a message to a specific
697 destination cannot immediately take place for some reason (a remote host may be
698 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
699 until a later time.
700
701 The word &'domain'& is sometimes used to mean all but the first component of a
702 host's name. It is &'not'& used in that sense here, where it normally refers to
703 the part of an email address following the @ sign.
704
705 .cindex "envelope, definition of"
706 .cindex "sender" "definition of"
707 A message in transit has an associated &'envelope'&, as well as a header and a
708 body. The envelope contains a sender address (to which bounce messages should
709 be delivered), and any number of recipient addresses. References to the
710 sender or the recipients of a message usually mean the addresses in the
711 envelope. An MTA uses these addresses for delivery, and for returning bounce
712 messages, not the addresses that appear in the header lines.
713
714 .cindex "message" "header, definition of"
715 .cindex "header section" "definition of"
716 The &'header'& of a message is the first part of a message's text, consisting
717 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
718 &'Subject:'&, etc. Long header lines can be split over several text lines by
719 indenting the continuations. The header is separated from the body by a blank
720 line.
721
722 .cindex "local part" "definition of"
723 .cindex "domain" "definition of"
724 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
725 part of an email address that precedes the @ sign. The part that follows the
726 @ sign is called the &'domain'& or &'mail domain'&.
727
728 .cindex "local delivery" "definition of"
729 .cindex "remote delivery, definition of"
730 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
731 delivery to a file or a pipe on the local host from delivery by SMTP over
732 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
733 host it is running on are &'remote'&.
734
735 .cindex "return path" "definition of"
736 &'Return path'& is another name that is used for the sender address in a
737 message's envelope.
738
739 .cindex "queue" "definition of"
740 The term &'queue'& is used to refer to the set of messages awaiting delivery
741 because this term is in widespread use in the context of MTAs. However, in
742 Exim's case, the reality is more like a pool than a queue, because there is
743 normally no ordering of waiting messages.
744
745 .cindex "queue runner" "definition of"
746 The term &'queue runner'& is used to describe a process that scans the queue
747 and attempts to deliver those messages whose retry times have come. This term
748 is used by other MTAs and also relates to the command &%runq%&, but in Exim
749 the waiting messages are normally processed in an unpredictable order.
750
751 .cindex "spool directory" "definition of"
752 The term &'spool directory'& is used for a directory in which Exim keeps the
753 messages in its queue &-- that is, those that it is in the process of
754 delivering. This should not be confused with the directory in which local
755 mailboxes are stored, which is called a &"spool directory"& by some people. In
756 the Exim documentation, &"spool"& is always used in the first sense.
757
758
759
760
761
762
763 . ////////////////////////////////////////////////////////////////////////////
764 . ////////////////////////////////////////////////////////////////////////////
765
766 .chapter "Incorporated code" "CHID2"
767 .cindex "incorporated code"
768 .cindex "regular expressions" "library"
769 .cindex "PCRE"
770 .cindex "OpenDMARC"
771 A number of pieces of external code are included in the Exim distribution.
772
773 .ilist
774 Regular expressions are supported in the main Exim program and in the
775 Exim monitor using the freely-distributable PCRE library, copyright
776 &copy; University of Cambridge. The source to PCRE is no longer shipped with
777 Exim, so you will need to use the version of PCRE shipped with your system,
778 or obtain and install the full version of the library from
779 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
780 .next
781 .cindex "cdb" "acknowledgment"
782 Support for the cdb (Constant DataBase) lookup method is provided by code
783 contributed by Nigel Metheringham of (at the time he contributed it) Planet
784 Online Ltd. The implementation is completely contained within the code of Exim.
785 It does not link against an external cdb library. The code contains the
786 following statements:
787
788 .blockquote
789 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
790
791 This program is free software; you can redistribute it and/or modify it under
792 the terms of the GNU General Public License as published by the Free Software
793 Foundation; either version 2 of the License, or (at your option) any later
794 version.
795 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
796 the spec and sample code for cdb can be obtained from
797 &url(https://cr.yp.to/cdb.html). This implementation borrows
798 some code from Dan Bernstein's implementation (which has no license
799 restrictions applied to it).
800 .endblockquote
801 .next
802 .cindex "SPA authentication"
803 .cindex "Samba project"
804 .cindex "Microsoft Secure Password Authentication"
805 Client support for Microsoft's &'Secure Password Authentication'& is provided
806 by code contributed by Marc Prud'hommeaux. Server support was contributed by
807 Tom Kistner. This includes code taken from the Samba project, which is released
808 under the Gnu GPL.
809 .next
810 .cindex "Cyrus"
811 .cindex "&'pwcheck'& daemon"
812 .cindex "&'pwauthd'& daemon"
813 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
814 by code taken from the Cyrus-SASL library and adapted by Alexander S.
815 Sabourenkov. The permission notice appears below, in accordance with the
816 conditions expressed therein.
817
818 .blockquote
819 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
820
821 Redistribution and use in source and binary forms, with or without
822 modification, are permitted provided that the following conditions
823 are met:
824
825 .olist
826 Redistributions of source code must retain the above copyright
827 notice, this list of conditions and the following disclaimer.
828 .next
829 Redistributions in binary form must reproduce the above copyright
830 notice, this list of conditions and the following disclaimer in
831 the documentation and/or other materials provided with the
832 distribution.
833 .next
834 The name &"Carnegie Mellon University"& must not be used to
835 endorse or promote products derived from this software without
836 prior written permission. For permission or any other legal
837 details, please contact
838 .display
839               Office of Technology Transfer
840               Carnegie Mellon University
841               5000 Forbes Avenue
842               Pittsburgh, PA  15213-3890
843               (412) 268-4387, fax: (412) 268-7395
844               tech-transfer@andrew.cmu.edu
845 .endd
846 .next
847 Redistributions of any form whatsoever must retain the following
848 acknowledgment:
849
850 &"This product includes software developed by Computing Services
851 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
852
853 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
854 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
855 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
856 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
857 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
858 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
859 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
860 .endlist
861 .endblockquote
862
863 .next
864 .cindex "Exim monitor" "acknowledgment"
865 .cindex "X-windows"
866 .cindex "Athena"
867 The Exim Monitor program, which is an X-Window application, includes
868 modified versions of the Athena StripChart and TextPop widgets.
869 This code is copyright by DEC and MIT, and their permission notice appears
870 below, in accordance with the conditions expressed therein.
871
872 .blockquote
873 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
874 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
875
876 All Rights Reserved
877
878 Permission to use, copy, modify, and distribute this software and its
879 documentation for any purpose and without fee is hereby granted,
880 provided that the above copyright notice appear in all copies and that
881 both that copyright notice and this permission notice appear in
882 supporting documentation, and that the names of Digital or MIT not be
883 used in advertising or publicity pertaining to distribution of the
884 software without specific, written prior permission.
885
886 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
887 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
888 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
889 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
890 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
891 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
892 SOFTWARE.
893 .endblockquote
894
895 .next
896 .cindex "opendmarc" "acknowledgment"
897 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
898 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
899 derived code are indicated in the respective source files. The full OpenDMARC
900 license is provided in the LICENSE.opendmarc file contained in the distributed
901 source code.
902
903 .next
904 Many people have contributed code fragments, some large, some small, that were
905 not covered by any specific license requirements. It is assumed that the
906 contributors are happy to see their code incorporated into Exim under the GPL.
907 .endlist
908
909
910
911
912
913 . ////////////////////////////////////////////////////////////////////////////
914 . ////////////////////////////////////////////////////////////////////////////
915
916 .chapter "How Exim receives and delivers mail" "CHID11" &&&
917          "Receiving and delivering mail"
918
919
920 .section "Overall philosophy" "SECID10"
921 .cindex "design philosophy"
922 Exim is designed to work efficiently on systems that are permanently connected
923 to the Internet and are handling a general mix of mail. In such circumstances,
924 most messages can be delivered immediately. Consequently, Exim does not
925 maintain independent queues of messages for specific domains or hosts, though
926 it does try to send several messages in a single SMTP connection after a host
927 has been down, and it also maintains per-host retry information.
928
929
930 .section "Policy control" "SECID11"
931 .cindex "policy control" "overview"
932 Policy controls are now an important feature of MTAs that are connected to the
933 Internet. Perhaps their most important job is to stop MTAs from being abused as
934 &"open relays"& by misguided individuals who send out vast amounts of
935 unsolicited junk and want to disguise its source. Exim provides flexible
936 facilities for specifying policy controls on incoming mail:
937
938 .ilist
939 .cindex "&ACL;" "introduction"
940 Exim 4 (unlike previous versions of Exim) implements policy controls on
941 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
942 series of statements that may either grant or deny access. ACLs can be used at
943 several places in the SMTP dialogue while receiving a message from a remote
944 host. However, the most common places are after each RCPT command, and at the
945 very end of the message. The sysadmin can specify conditions for accepting or
946 rejecting individual recipients or the entire message, respectively, at these
947 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
948 error code.
949 .next
950 An ACL is also available for locally generated, non-SMTP messages. In this
951 case, the only available actions are to accept or deny the entire message.
952 .next
953 When Exim is compiled with the content-scanning extension, facilities are
954 provided in the ACL mechanism for passing the message to external virus and/or
955 spam scanning software. The result of such a scan is passed back to the ACL,
956 which can then use it to decide what to do with the message.
957 .next
958 When a message has been received, either from a remote host or from the local
959 host, but before the final acknowledgment has been sent, a locally supplied C
960 function called &[local_scan()]& can be run to inspect the message and decide
961 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
962 is accepted, the list of recipients can be modified by the function.
963 .next
964 Using the &[local_scan()]& mechanism is another way of calling external scanner
965 software. The &%SA-Exim%& add-on package works this way. It does not require
966 Exim to be compiled with the content-scanning extension.
967 .next
968 After a message has been accepted, a further checking mechanism is available in
969 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
970 runs at the start of every delivery process.
971 .endlist
972
973
974
975 .section "User filters" "SECID12"
976 .cindex "filter" "introduction"
977 .cindex "Sieve filter"
978 In a conventional Exim configuration, users are able to run private filters by
979 setting up appropriate &_.forward_& files in their home directories. See
980 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
981 configuration needed to support this, and the separate document entitled
982 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
983 of filtering are available:
984
985 .ilist
986 Sieve filters are written in the standard filtering language that is defined
987 by RFC 3028.
988 .next
989 Exim filters are written in a syntax that is unique to Exim, but which is more
990 powerful than Sieve, which it pre-dates.
991 .endlist
992
993 User filters are run as part of the routing process, described below.
994
995
996
997 .section "Message identification" "SECTmessiden"
998 .cindex "message ids" "details of format"
999 .cindex "format" "of message id"
1000 .cindex "id of message"
1001 .cindex "base62"
1002 .cindex "base36"
1003 .cindex "Darwin"
1004 .cindex "Cygwin"
1005 Every message handled by Exim is given a &'message id'& which is sixteen
1006 characters long. It is divided into three parts, separated by hyphens, for
1007 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
1008 normally encoding numbers in base 62. However, in the Darwin operating
1009 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
1010 (avoiding the use of lower case letters) is used instead, because the message
1011 id is used to construct filenames, and the names of files in those systems are
1012 not always case-sensitive.
1013
1014 .cindex "pid (process id)" "re-use of"
1015 The detail of the contents of the message id have changed as Exim has evolved.
1016 Earlier versions relied on the operating system not re-using a process id (pid)
1017 within one second. On modern operating systems, this assumption can no longer
1018 be made, so the algorithm had to be changed. To retain backward compatibility,
1019 the format of the message id was retained, which is why the following rules are
1020 somewhat eccentric:
1021
1022 .ilist
1023 The first six characters of the message id are the time at which the message
1024 started to be received, to a granularity of one second. That is, this field
1025 contains the number of seconds since the start of the epoch (the normal Unix
1026 way of representing the date and time of day).
1027 .next
1028 After the first hyphen, the next six characters are the id of the process that
1029 received the message.
1030 .next
1031 There are two different possibilities for the final two characters:
1032 .olist
1033 .oindex "&%localhost_number%&"
1034 If &%localhost_number%& is not set, this value is the fractional part of the
1035 time of reception, normally in units of 1/2000 of a second, but for systems
1036 that must use base 36 instead of base 62 (because of case-insensitive file
1037 systems), the units are 1/1000 of a second.
1038 .next
1039 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1040 the fractional part of the time, which in this case is in units of 1/200
1041 (1/100) of a second.
1042 .endlist
1043 .endlist
1044
1045 After a message has been received, Exim waits for the clock to tick at the
1046 appropriate resolution before proceeding, so that if another message is
1047 received by the same process, or by another process with the same (re-used)
1048 pid, it is guaranteed that the time will be different. In most cases, the clock
1049 will already have ticked while the message was being received.
1050
1051
1052 .section "Receiving mail" "SECID13"
1053 .cindex "receiving mail"
1054 .cindex "message" "reception"
1055 The only way Exim can receive mail from another host is using SMTP over
1056 TCP/IP, in which case the sender and recipient addresses are transferred using
1057 SMTP commands. However, from a locally running process (such as a user's MUA),
1058 there are several possibilities:
1059
1060 .ilist
1061 If the process runs Exim with the &%-bm%& option, the message is read
1062 non-interactively (usually via a pipe), with the recipients taken from the
1063 command line, or from the body of the message if &%-t%& is also used.
1064 .next
1065 If the process runs Exim with the &%-bS%& option, the message is also read
1066 non-interactively, but in this case the recipients are listed at the start of
1067 the message in a series of SMTP RCPT commands, terminated by a DATA
1068 command. This is called &"batch SMTP"& format,
1069 but it isn't really SMTP. The SMTP commands are just another way of passing
1070 envelope addresses in a non-interactive submission.
1071 .next
1072 If the process runs Exim with the &%-bs%& option, the message is read
1073 interactively, using the SMTP protocol. A two-way pipe is normally used for
1074 passing data between the local process and the Exim process.
1075 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1076 example, the ACLs for SMTP commands are used for this form of submission.
1077 .next
1078 A local process may also make a TCP/IP call to the host's loopback address
1079 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1080 does not treat the loopback address specially. It treats all such connections
1081 in the same way as connections from other hosts.
1082 .endlist
1083
1084
1085 .cindex "message sender, constructed by Exim"
1086 .cindex "sender" "constructed by Exim"
1087 In the three cases that do not involve TCP/IP, the sender address is
1088 constructed from the login name of the user that called Exim and a default
1089 qualification domain (which can be set by the &%qualify_domain%& configuration
1090 option). For local or batch SMTP, a sender address that is passed using the
1091 SMTP MAIL command is ignored. However, the system administrator may allow
1092 certain users (&"trusted users"&) to specify a different sender addresses
1093 unconditionally, or all users to specify certain forms of different sender
1094 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1095 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1096 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1097 users to change sender addresses.
1098
1099 Messages received by either of the non-interactive mechanisms are subject to
1100 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1101 (either over TCP/IP or interacting with a local process) can be checked by a
1102 number of ACLs that operate at different times during the SMTP session. Either
1103 individual recipients or the entire message can be rejected if local policy
1104 requirements are not met. The &[local_scan()]& function (see chapter
1105 &<<CHAPlocalscan>>&) is run for all incoming messages.
1106
1107 Exim can be configured not to start a delivery process when a message is
1108 received; this can be unconditional, or depend on the number of incoming SMTP
1109 connections or the system load. In these situations, new messages wait on the
1110 queue until a queue runner process picks them up. However, in standard
1111 configurations under normal conditions, delivery is started as soon as a
1112 message is received.
1113
1114
1115
1116
1117
1118 .section "Handling an incoming message" "SECID14"
1119 .cindex "spool directory" "files that hold a message"
1120 .cindex "file" "how a message is held"
1121 When Exim accepts a message, it writes two files in its spool directory. The
1122 first contains the envelope information, the current status of the message, and
1123 the header lines, and the second contains the body of the message. The names of
1124 the two spool files consist of the message id, followed by &`-H`& for the
1125 file containing the envelope and header, and &`-D`& for the data file.
1126
1127 .cindex "spool directory" "&_input_& sub-directory"
1128 By default, all these message files are held in a single directory called
1129 &_input_& inside the general Exim spool directory. Some operating systems do
1130 not perform very well if the number of files in a directory gets large; to
1131 improve performance in such cases, the &%split_spool_directory%& option can be
1132 used. This causes Exim to split up the input files into 62 sub-directories
1133 whose names are single letters or digits. When this is done, the queue is
1134 processed one sub-directory at a time instead of all at once, which can improve
1135 overall performance even when there are not enough files in each directory to
1136 affect file system performance.
1137
1138 The envelope information consists of the address of the message's sender and
1139 the addresses of the recipients. This information is entirely separate from
1140 any addresses contained in the header lines. The status of the message includes
1141 a list of recipients who have already received the message. The format of the
1142 first spool file is described in chapter &<<CHAPspool>>&.
1143
1144 .cindex "rewriting" "addresses"
1145 Address rewriting that is specified in the rewrite section of the configuration
1146 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1147 both in the header lines and the envelope, at the time the message is accepted.
1148 If during the course of delivery additional addresses are generated (for
1149 example, via aliasing), these new addresses are rewritten as soon as they are
1150 generated. At the time a message is actually delivered (transported) further
1151 rewriting can take place; because this is a transport option, it can be
1152 different for different forms of delivery. It is also possible to specify the
1153 addition or removal of certain header lines at the time the message is
1154 delivered (see chapters &<<CHAProutergeneric>>& and
1155 &<<CHAPtransportgeneric>>&).
1156
1157
1158
1159 .section "Life of a message" "SECID15"
1160 .cindex "message" "life of"
1161 .cindex "message" "frozen"
1162 A message remains in the spool directory until it is completely delivered to
1163 its recipients or to an error address, or until it is deleted by an
1164 administrator or by the user who originally created it. In cases when delivery
1165 cannot proceed &-- for example when a message can neither be delivered to its
1166 recipients nor returned to its sender, the message is marked &"frozen"& on the
1167 spool, and no more deliveries are attempted.
1168
1169 .cindex "frozen messages" "thawing"
1170 .cindex "message" "thawing frozen"
1171 An administrator can &"thaw"& such messages when the problem has been
1172 corrected, and can also freeze individual messages by hand if necessary. In
1173 addition, an administrator can force a delivery error, causing a bounce message
1174 to be sent.
1175
1176 .oindex "&%timeout_frozen_after%&"
1177 .oindex "&%ignore_bounce_errors_after%&"
1178 There are options called &%ignore_bounce_errors_after%& and
1179 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1180 The first applies only to frozen bounces, the second to all frozen messages.
1181
1182 .cindex "message" "log file for"
1183 .cindex "log" "file for each message"
1184 While Exim is working on a message, it writes information about each delivery
1185 attempt to its main log file. This includes successful, unsuccessful, and
1186 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1187 lines are also written to a separate &'message log'& file for each message.
1188 These logs are solely for the benefit of the administrator and are normally
1189 deleted along with the spool files when processing of a message is complete.
1190 The use of individual message logs can be disabled by setting
1191 &%no_message_logs%&; this might give an improvement in performance on very busy
1192 systems.
1193
1194 .cindex "journal file"
1195 .cindex "file" "journal"
1196 All the information Exim itself needs to set up a delivery is kept in the first
1197 spool file, along with the header lines. When a successful delivery occurs, the
1198 address is immediately written at the end of a journal file, whose name is the
1199 message id followed by &`-J`&. At the end of a delivery run, if there are some
1200 addresses left to be tried again later, the first spool file (the &`-H`& file)
1201 is updated to indicate which these are, and the journal file is then deleted.
1202 Updating the spool file is done by writing a new file and renaming it, to
1203 minimize the possibility of data loss.
1204
1205 Should the system or Exim crash after a successful delivery but before
1206 the spool file has been updated, the journal is left lying around. The next
1207 time Exim attempts to deliver the message, it reads the journal file and
1208 updates the spool file before proceeding. This minimizes the chances of double
1209 deliveries caused by crashes.
1210
1211
1212
1213 .section "Processing an address for delivery" "SECTprocaddress"
1214 .cindex "drivers" "definition of"
1215 .cindex "router" "definition of"
1216 .cindex "transport" "definition of"
1217 The main delivery processing elements of Exim are called &'routers'& and
1218 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1219 number of them is provided in the source distribution, and compile-time options
1220 specify which ones are included in the binary. Runtime options specify which
1221 ones are actually used for delivering messages.
1222
1223 .cindex "drivers" "instance definition"
1224 Each driver that is specified in the runtime configuration is an &'instance'&
1225 of that particular driver type. Multiple instances are allowed; for example,
1226 you can set up several different &(smtp)& transports, each with different
1227 option values that might specify different ports or different timeouts. Each
1228 instance has its own identifying name. In what follows we will normally use the
1229 instance name when discussing one particular instance (that is, one specific
1230 configuration of the driver), and the generic driver name when discussing
1231 the driver's features in general.
1232
1233 A &'router'& is a driver that operates on an address, either determining how
1234 its delivery should happen, by assigning it to a specific transport, or
1235 converting the address into one or more new addresses (for example, via an
1236 alias file). A router may also explicitly choose to fail an address, causing it
1237 to be bounced.
1238
1239 A &'transport'& is a driver that transmits a copy of the message from Exim's
1240 spool to some destination. There are two kinds of transport: for a &'local'&
1241 transport, the destination is a file or a pipe on the local host, whereas for a
1242 &'remote'& transport the destination is some other host. A message is passed
1243 to a specific transport as a result of successful routing. If a message has
1244 several recipients, it may be passed to a number of different transports.
1245
1246 .cindex "preconditions" "definition of"
1247 An address is processed by passing it to each configured router instance in
1248 turn, subject to certain preconditions, until a router accepts the address or
1249 specifies that it should be bounced. We will describe this process in more
1250 detail shortly. First, as a simple example, we consider how each recipient
1251 address in a message is processed in a small configuration of three routers.
1252
1253 To make this a more concrete example, it is described in terms of some actual
1254 routers, but remember, this is only an example. You can configure Exim's
1255 routers in many different ways, and there may be any number of routers in a
1256 configuration.
1257
1258 The first router that is specified in a configuration is often one that handles
1259 addresses in domains that are not recognized specifically by the local host.
1260 Typically these are addresses for arbitrary domains on the Internet. A precondition
1261 is set up which looks for the special domains known to the host (for example,
1262 its own domain name), and the router is run for addresses that do &'not'&
1263 match. Typically, this is a router that looks up domains in the DNS in order to
1264 find the hosts to which this address routes. If it succeeds, the address is
1265 assigned to a suitable SMTP transport; if it does not succeed, the router is
1266 configured to fail the address.
1267
1268 The second router is reached only when the domain is recognized as one that
1269 &"belongs"& to the local host. This router does redirection &-- also known as
1270 aliasing and forwarding. When it generates one or more new addresses from the
1271 original, each of them is routed independently from the start. Otherwise, the
1272 router may cause an address to fail, or it may simply decline to handle the
1273 address, in which case the address is passed to the next router.
1274
1275 The final router in many configurations is one that checks to see if the
1276 address belongs to a local mailbox. The precondition may involve a check to
1277 see if the local part is the name of a login account, or it may look up the
1278 local part in a file or a database. If its preconditions are not met, or if
1279 the router declines, we have reached the end of the routers. When this happens,
1280 the address is bounced.
1281
1282
1283
1284 .section "Processing an address for verification" "SECID16"
1285 .cindex "router" "for verification"
1286 .cindex "verifying address" "overview"
1287 As well as being used to decide how to deliver to an address, Exim's routers
1288 are also used for &'address verification'&. Verification can be requested as
1289 one of the checks to be performed in an ACL for incoming messages, on both
1290 sender and recipient addresses, and it can be tested using the &%-bv%& and
1291 &%-bvs%& command line options.
1292
1293 When an address is being verified, the routers are run in &"verify mode"&. This
1294 does not affect the way the routers work, but it is a state that can be
1295 detected. By this means, a router can be skipped or made to behave differently
1296 when verifying. A common example is a configuration in which the first router
1297 sends all messages to a message-scanning program unless they have been
1298 previously scanned. Thus, the first router accepts all addresses without any
1299 checking, making it useless for verifying. Normally, the &%no_verify%& option
1300 would be set for such a router, causing it to be skipped in verify mode.
1301
1302
1303
1304
1305 .section "Running an individual router" "SECTrunindrou"
1306 .cindex "router" "running details"
1307 .cindex "preconditions" "checking"
1308 .cindex "router" "result of running"
1309 As explained in the example above, a number of preconditions are checked before
1310 running a router. If any are not met, the router is skipped, and the address is
1311 passed to the next router. When all the preconditions on a router &'are'& met,
1312 the router is run. What happens next depends on the outcome, which is one of
1313 the following:
1314
1315 .ilist
1316 &'accept'&: The router accepts the address, and either assigns it to a
1317 transport or generates one or more &"child"& addresses. Processing the
1318 original address ceases
1319 .oindex "&%unseen%&"
1320 unless the &%unseen%& option is set on the router. This option
1321 can be used to set up multiple deliveries with different routing (for example,
1322 for keeping archive copies of messages). When &%unseen%& is set, the address is
1323 passed to the next router. Normally, however, an &'accept'& return marks the
1324 end of routing.
1325
1326 Any child addresses generated by the router are processed independently,
1327 starting with the first router by default. It is possible to change this by
1328 setting the &%redirect_router%& option to specify which router to start at for
1329 child addresses. Unlike &%pass_router%& (see below) the router specified by
1330 &%redirect_router%& may be anywhere in the router configuration.
1331 .next
1332 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1333 requests that the address be passed to another router. By default, the address
1334 is passed to the next router, but this can be changed by setting the
1335 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1336 must be below the current router (to avoid loops).
1337 .next
1338 &'decline'&: The router declines to accept the address because it does not
1339 recognize it at all. By default, the address is passed to the next router, but
1340 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1341 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1342 &'decline'& into &'fail'&.
1343 .next
1344 &'fail'&: The router determines that the address should fail, and queues it for
1345 the generation of a bounce message. There is no further processing of the
1346 original address unless &%unseen%& is set on the router.
1347 .next
1348 &'defer'&: The router cannot handle the address at the present time. (A
1349 database may be offline, or a DNS lookup may have timed out.) No further
1350 processing of the address happens in this delivery attempt. It is tried again
1351 next time the message is considered for delivery.
1352 .next
1353 &'error'&: There is some error in the router (for example, a syntax error in
1354 its configuration). The action is as for defer.
1355 .endlist
1356
1357 If an address reaches the end of the routers without having been accepted by
1358 any of them, it is bounced as unrouteable. The default error message in this
1359 situation is &"unrouteable address"&, but you can set your own message by
1360 making use of the &%cannot_route_message%& option. This can be set for any
1361 router; the value from the last router that &"saw"& the address is used.
1362
1363 Sometimes while routing you want to fail a delivery when some conditions are
1364 met but others are not, instead of passing the address on for further routing.
1365 You can do this by having a second router that explicitly fails the delivery
1366 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1367 facility for this purpose.
1368
1369
1370 .section "Duplicate addresses" "SECID17"
1371 .cindex "case of local parts"
1372 .cindex "address duplicate, discarding"
1373 .cindex "duplicate addresses"
1374 Once routing is complete, Exim scans the addresses that are assigned to local
1375 and remote transports and discards any duplicates that it finds. During this
1376 check, local parts are treated case-sensitively. This happens only when
1377 actually delivering a message; when testing routers with &%-bt%&, all the
1378 routed addresses are shown.
1379
1380
1381
1382 .section "Router preconditions" "SECTrouprecon"
1383 .cindex "router" "preconditions, order of processing"
1384 .cindex "preconditions" "order of processing"
1385 The preconditions that are tested for each router are listed below, in the
1386 order in which they are tested. The individual configuration options are
1387 described in more detail in chapter &<<CHAProutergeneric>>&.
1388
1389 .ilist
1390 .cindex affix "router precondition"
1391 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1392 the local parts handled by the router may or must have certain prefixes and/or
1393 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1394 skipped. These conditions are tested first. When an affix is present, it is
1395 removed from the local part before further processing, including the evaluation
1396 of any other conditions.
1397 .next
1398 Routers can be designated for use only when not verifying an address, that is,
1399 only when routing it for delivery (or testing its delivery routing). If the
1400 &%verify%& option is set false, the router is skipped when Exim is verifying an
1401 address.
1402 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1403 &%verify_recipient%&, which independently control the use of the router for
1404 sender and recipient verification. You can set these options directly if
1405 you want a router to be used for only one type of verification.
1406 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1407 .next
1408 If the &%address_test%& option is set false, the router is skipped when Exim is
1409 run with the &%-bt%& option to test an address routing. This can be helpful
1410 when the first router sends all new messages to a scanner of some sort; it
1411 makes it possible to use &%-bt%& to test subsequent delivery routing without
1412 having to simulate the effect of the scanner.
1413 .next
1414 Routers can be designated for use only when verifying an address, as
1415 opposed to routing it for delivery. The &%verify_only%& option controls this.
1416 Again, cutthrough delivery counts as a verification.
1417 .next
1418 Individual routers can be explicitly skipped when running the routers to
1419 check an address given in the SMTP EXPN command (see the &%expn%& option).
1420
1421 .next
1422 If the &%domains%& option is set, the domain of the address must be in the set
1423 of domains that it defines.
1424 .cindex "tainted data" "de-tainting"
1425 A match verifies the variable &$domain$& (which carries tainted data)
1426 and assigns an untainted value to the &$domain_data$& variable.
1427 Such an untainted value is often needed in the transport.
1428 For specifics of the matching operation and the resulting untainted value,
1429 refer to section &<<SECTdomainlist>>&.
1430
1431 When an untainted value is wanted, use this option
1432 rather than the generic &%condition%& option.
1433
1434 .next
1435 .vindex "&$local_part_prefix$&"
1436 .vindex "&$local_part_prefix_v$&"
1437 .vindex "&$local_part$&"
1438 .vindex "&$local_part_suffix$&"
1439 .vindex "&$local_part_suffix_v$&"
1440 .cindex affix "router precondition"
1441 If the &%local_parts%& option is set, the local part of the address must be in
1442 the set of local parts that it defines.
1443 A match verifies the variable &$local_part$& (which carries tainted data)
1444 and assigns an untainted value to the &$local_part_data$& variable.
1445 Such an untainted value is often needed in the transport.
1446 For specifics of the matching operation and the resulting untainted value,
1447 refer to section &<<SECTlocparlis>>&.
1448
1449 When an untainted value is wanted, use this option
1450 rather than the generic &%condition%& option.
1451
1452 If &%local_part_prefix%& or
1453 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1454 part before this check. If you want to do precondition tests on local parts
1455 that include affixes, you can do so by using a &%condition%& option (see below)
1456 that uses the variables &$local_part$&, &$local_part_prefix$&,
1457 &$local_part_prefix_v$&, &$local_part_suffix$&
1458 and &$local_part_suffix_v$& as necessary.
1459
1460 .next
1461 .vindex "&$local_user_uid$&"
1462 .vindex "&$local_user_gid$&"
1463 .vindex "&$home$&"
1464 If the &%check_local_user%& option is set, the local part must be the name of
1465 an account on the local host. If this check succeeds, the uid and gid of the
1466 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1467 user's home directory is placed in &$home$&; these values can be used in the
1468 remaining preconditions.
1469
1470 .next
1471 If the &%router_home_directory%& option is set, it is expanded at this point,
1472 because it overrides the value of &$home$&. If this expansion were left till
1473 later, the value of &$home$& as set by &%check_local_user%& would be used in
1474 subsequent tests. Having two different values of &$home$& in the same router
1475 could lead to confusion.
1476
1477 .next
1478 If the &%senders%& option is set, the envelope sender address must be in the
1479 set of addresses that it defines.
1480
1481 .next
1482 If the &%require_files%& option is set, the existence or non-existence of
1483 specified files is tested.
1484
1485 .next
1486 .cindex "customizing" "precondition"
1487 If the &%condition%& option is set, it is evaluated and tested. This option
1488 uses an expanded string to allow you to set up your own custom preconditions.
1489 Expanded strings are described in chapter &<<CHAPexpand>>&.
1490
1491 Note that while using
1492 this option for address matching technically works,
1493 it does not set any de-tainted values.
1494 Such values are often needed, either for router-specific options or
1495 for transport options.
1496 Using the &%domains%& and &%local_parts%& options is usually the most
1497 convenient way to obtain them.
1498 .endlist
1499
1500
1501 Note that &%require_files%& comes near the end of the list, so you cannot use
1502 it to check for the existence of a file in which to lookup up a domain, local
1503 part, or sender. However, as these options are all expanded, you can use the
1504 &%exists%& expansion condition to make such tests within each condition. The
1505 &%require_files%& option is intended for checking files that the router may be
1506 going to use internally, or which are needed by a specific transport (for
1507 example, &_.procmailrc_&).
1508
1509
1510
1511 .section "Delivery in detail" "SECID18"
1512 .cindex "delivery" "in detail"
1513 When a message is to be delivered, the sequence of events is as follows:
1514
1515 .ilist
1516 If a system-wide filter file is specified, the message is passed to it. The
1517 filter may add recipients to the message, replace the recipients, discard the
1518 message, cause a new message to be generated, or cause the message delivery to
1519 fail. The format of the system filter file is the same as for Exim user filter
1520 files, described in the separate document entitled &'Exim's interfaces to mail
1521 filtering'&.
1522 .cindex "Sieve filter" "not available for system filter"
1523 (&*Note*&: Sieve cannot be used for system filter files.)
1524
1525 Some additional features are available in system filters &-- see chapter
1526 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1527 filter only once per delivery attempt, however many recipients it has. However,
1528 if there are several delivery attempts because one or more addresses could not
1529 be immediately delivered, the system filter is run each time. The filter
1530 condition &%first_delivery%& can be used to detect the first run of the system
1531 filter.
1532 .next
1533 Each recipient address is offered to each configured router, in turn, subject to
1534 its preconditions, until one is able to handle it. If no router can handle the
1535 address, that is, if they all decline, the address is failed. Because routers
1536 can be targeted at particular domains, several locally handled domains can be
1537 processed entirely independently of each other.
1538 .next
1539 .cindex "routing" "loops in"
1540 .cindex "loop" "while routing"
1541 A router that accepts an address may assign it to a local or a remote
1542 transport. However, the transport is not run at this time. Instead, the address
1543 is placed on a list for the particular transport, which will be run later.
1544 Alternatively, the router may generate one or more new addresses (typically
1545 from alias, forward, or filter files). New addresses are fed back into this
1546 process from the top, but in order to avoid loops, a router ignores any address
1547 which has an identically-named ancestor that was processed by itself.
1548 .next
1549 When all the routing has been done, addresses that have been successfully
1550 handled are passed to their assigned transports. When local transports are
1551 doing real local deliveries, they handle only one address at a time, but if a
1552 local transport is being used as a pseudo-remote transport (for example, to
1553 collect batched SMTP messages for transmission by some other means) multiple
1554 addresses can be handled. Remote transports can always handle more than one
1555 address at a time, but can be configured not to do so, or to restrict multiple
1556 addresses to the same domain.
1557 .next
1558 Each local delivery to a file or a pipe runs in a separate process under a
1559 non-privileged uid, and these deliveries are run one at a time. Remote
1560 deliveries also run in separate processes, normally under a uid that is private
1561 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1562 run in parallel. The maximum number of simultaneous remote deliveries for any
1563 one message is set by the &%remote_max_parallel%& option.
1564 The order in which deliveries are done is not defined, except that all local
1565 deliveries happen before any remote deliveries.
1566 .next
1567 .cindex "queue runner"
1568 When it encounters a local delivery during a queue run, Exim checks its retry
1569 database to see if there has been a previous temporary delivery failure for the
1570 address before running the local transport. If there was a previous failure,
1571 Exim does not attempt a new delivery until the retry time for the address is
1572 reached. However, this happens only for delivery attempts that are part of a
1573 queue run. Local deliveries are always attempted when delivery immediately
1574 follows message reception, even if retry times are set for them. This makes for
1575 better behaviour if one particular message is causing problems (for example,
1576 causing quota overflow, or provoking an error in a filter file).
1577 .next
1578 .cindex "delivery" "retry in remote transports"
1579 Remote transports do their own retry handling, since an address may be
1580 deliverable to one of a number of hosts, each of which may have a different
1581 retry time. If there have been previous temporary failures and no host has
1582 reached its retry time, no delivery is attempted, whether in a queue run or
1583 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1584 .next
1585 If there were any permanent errors, a bounce message is returned to an
1586 appropriate address (the sender in the common case), with details of the error
1587 for each failing address. Exim can be configured to send copies of bounce
1588 messages to other addresses.
1589 .next
1590 .cindex "delivery" "deferral"
1591 If one or more addresses suffered a temporary failure, the message is left on
1592 the queue, to be tried again later. Delivery of these addresses is said to be
1593 &'deferred'&.
1594 .next
1595 When all the recipient addresses have either been delivered or bounced,
1596 handling of the message is complete. The spool files and message log are
1597 deleted, though the message log can optionally be preserved if required.
1598 .endlist
1599
1600
1601
1602
1603 .section "Retry mechanism" "SECID19"
1604 .cindex "delivery" "retry mechanism"
1605 .cindex "retry" "description of mechanism"
1606 .cindex "queue runner"
1607 Exim's mechanism for retrying messages that fail to get delivered at the first
1608 attempt is the queue runner process. You must either run an Exim daemon that
1609 uses the &%-q%& option with a time interval to start queue runners at regular
1610 intervals or use some other means (such as &'cron'&) to start them. If you do
1611 not arrange for queue runners to be run, messages that fail temporarily at the
1612 first attempt will remain in your queue forever. A queue runner process works
1613 its way through the queue, one message at a time, trying each delivery that has
1614 passed its retry time.
1615 You can run several queue runners at once.
1616
1617 Exim uses a set of configured rules to determine when next to retry the failing
1618 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1619 should give up trying to deliver to the address, at which point it generates a
1620 bounce message. If no retry rules are set for a particular host, address, and
1621 error combination, no retries are attempted, and temporary errors are treated
1622 as permanent.
1623
1624
1625
1626 .section "Temporary delivery failure" "SECID20"
1627 .cindex "delivery" "temporary failure"
1628 There are many reasons why a message may not be immediately deliverable to a
1629 particular address. Failure to connect to a remote machine (because it, or the
1630 connection to it, is down) is one of the most common. Temporary failures may be
1631 detected during routing as well as during the transport stage of delivery.
1632 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1633 is on a file system where the user is over quota. Exim can be configured to
1634 impose its own quotas on local mailboxes; where system quotas are set they will
1635 also apply.
1636
1637 If a host is unreachable for a period of time, a number of messages may be
1638 waiting for it by the time it recovers, and sending them in a single SMTP
1639 connection is clearly beneficial. Whenever a delivery to a remote host is
1640 deferred,
1641 .cindex "hints database" "deferred deliveries"
1642 Exim makes a note in its hints database, and whenever a successful
1643 SMTP delivery has happened, it looks to see if any other messages are waiting
1644 for the same host. If any are found, they are sent over the same SMTP
1645 connection, subject to a configuration limit as to the maximum number in any
1646 one connection.
1647
1648
1649
1650 .section "Permanent delivery failure" "SECID21"
1651 .cindex "delivery" "permanent failure"
1652 .cindex "bounce message" "when generated"
1653 When a message cannot be delivered to some or all of its intended recipients, a
1654 bounce message is generated. Temporary delivery failures turn into permanent
1655 errors when their timeout expires. All the addresses that fail in a given
1656 delivery attempt are listed in a single message. If the original message has
1657 many recipients, it is possible for some addresses to fail in one delivery
1658 attempt and others to fail subsequently, giving rise to more than one bounce
1659 message. The wording of bounce messages can be customized by the administrator.
1660 See chapter &<<CHAPemsgcust>>& for details.
1661
1662 .cindex "&'X-Failed-Recipients:'& header line"
1663 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1664 failed addresses, for the benefit of programs that try to analyse such messages
1665 automatically.
1666
1667 .cindex "bounce message" "recipient of"
1668 A bounce message is normally sent to the sender of the original message, as
1669 obtained from the message's envelope. For incoming SMTP messages, this is the
1670 address given in the MAIL command. However, when an address is expanded via a
1671 forward or alias file, an alternative address can be specified for delivery
1672 failures of the generated addresses. For a mailing list expansion (see section
1673 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1674 of the list.
1675
1676
1677
1678 .section "Failures to deliver bounce messages" "SECID22"
1679 .cindex "bounce message" "failure to deliver"
1680 If a bounce message (either locally generated or received from a remote host)
1681 itself suffers a permanent delivery failure, the message is left in the queue,
1682 but it is frozen, awaiting the attention of an administrator. There are options
1683 that can be used to make Exim discard such failed messages, or to keep them
1684 for only a short time (see &%timeout_frozen_after%& and
1685 &%ignore_bounce_errors_after%&).
1686
1687
1688
1689
1690
1691 . ////////////////////////////////////////////////////////////////////////////
1692 . ////////////////////////////////////////////////////////////////////////////
1693
1694 .chapter "Building and installing Exim" "CHID3"
1695 .scindex IIDbuex "building Exim"
1696
1697 .section "Unpacking" "SECID23"
1698 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1699 creates a directory with the name of the current release (for example,
1700 &_exim-&version()_&) into which the following files are placed:
1701
1702 .table2 140pt
1703 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1704 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1705   documented"
1706 .irow &_LICENCE_&         "the GNU General Public Licence"
1707 .irow &_Makefile_&        "top-level make file"
1708 .irow &_NOTICE_&          "conditions for the use of Exim"
1709 .irow &_README_&          "list of files, directories and simple build &&&
1710   instructions"
1711 .endtable
1712
1713 Other files whose names begin with &_README_& may also be present. The
1714 following subdirectories are created:
1715
1716 .table2 140pt
1717 .irow &_Local_&           "an empty directory for local configuration files"
1718 .irow &_OS_&              "OS-specific files"
1719 .irow &_doc_&             "documentation files"
1720 .irow &_exim_monitor_&    "source files for the Exim monitor"
1721 .irow &_scripts_&         "scripts used in the build process"
1722 .irow &_src_&             "remaining source files"
1723 .irow &_util_&            "independent utilities"
1724 .endtable
1725
1726 The main utility programs are contained in the &_src_& directory and are built
1727 with the Exim binary. The &_util_& directory contains a few optional scripts
1728 that may be useful to some sites.
1729
1730
1731 .section "Multiple machine architectures and operating systems" "SECID24"
1732 .cindex "building Exim" "multiple OS/architectures"
1733 The building process for Exim is arranged to make it easy to build binaries for
1734 a number of different architectures and operating systems from the same set of
1735 source files. Compilation does not take place in the &_src_& directory.
1736 Instead, a &'build directory'& is created for each architecture and operating
1737 system.
1738 .cindex "symbolic link" "to build directory"
1739 Symbolic links to the sources are installed in this directory, which is where
1740 the actual building takes place. In most cases, Exim can discover the machine
1741 architecture and operating system for itself, but the defaults can be
1742 overridden if necessary.
1743 .cindex compiler requirements
1744 .cindex compiler version
1745 A C99-capable compiler will be required for the build.
1746
1747
1748 .section "PCRE library" "SECTpcre"
1749 .cindex "PCRE library"
1750 Exim no longer has an embedded PCRE library as the vast majority of
1751 modern systems include PCRE as a system library, although you may need to
1752 install the PCRE package or the PCRE development package for your operating
1753 system. If your system has a normal PCRE installation the Exim build
1754 process will need no further configuration. If the library or the
1755 headers are in an unusual location you will need to either set the PCRE_LIBS
1756 and INCLUDE directives appropriately,
1757 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1758 If your operating system has no
1759 PCRE support then you will need to obtain and build the current PCRE
1760 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1761 More information on PCRE is available at &url(https://www.pcre.org/).
1762
1763 .section "DBM libraries" "SECTdb"
1764 .cindex "DBM libraries" "discussion of"
1765 .cindex "hints database" "DBM files used for"
1766 Even if you do not use any DBM files in your configuration, Exim still needs a
1767 DBM library in order to operate, because it uses indexed files for its hints
1768 databases. Unfortunately, there are a number of DBM libraries in existence, and
1769 different operating systems often have different ones installed.
1770
1771 .cindex "Solaris" "DBM library for"
1772 .cindex "IRIX, DBM library for"
1773 .cindex "BSD, DBM library for"
1774 .cindex "Linux, DBM library for"
1775 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1776 Linux distribution, the DBM configuration should happen automatically, and you
1777 may be able to ignore this section. Otherwise, you may have to learn more than
1778 you would like about DBM libraries from what follows.
1779
1780 .cindex "&'ndbm'& DBM library"
1781 Licensed versions of Unix normally contain a library of DBM functions operating
1782 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1783 versions of Unix seem to vary in what they contain as standard. In particular,
1784 some early versions of Linux have no default DBM library, and different
1785 distributors have chosen to bundle different libraries with their packaged
1786 versions. However, the more recent releases seem to have standardized on the
1787 Berkeley DB library.
1788
1789 Different DBM libraries have different conventions for naming the files they
1790 use. When a program opens a file called &_dbmfile_&, there are several
1791 possibilities:
1792
1793 .olist
1794 A traditional &'ndbm'& implementation, such as that supplied as part of
1795 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1796 .next
1797 .cindex "&'gdbm'& DBM library"
1798 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1799 compatibility interface it makes two different hard links to it with names
1800 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1801 filename is used unmodified.
1802 .next
1803 .cindex "Berkeley DB library"
1804 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1805 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1806 programmer exactly the same as the traditional &'ndbm'& implementation.
1807 .next
1808 If the Berkeley package is used in its native mode, it operates on a single
1809 file called &_dbmfile_&; the programmer's interface is somewhat different to
1810 the traditional &'ndbm'& interface.
1811 .next
1812 To complicate things further, there are several very different versions of the
1813 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1814 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1815 Maintenance of some of the earlier releases has ceased. All versions of
1816 Berkeley DB could be obtained from
1817 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1818 page with far newer versions listed.
1819 It is probably wise to plan to move your storage configurations away from
1820 Berkeley DB format, as today there are smaller and simpler alternatives more
1821 suited to Exim's usage model.
1822 .next
1823 .cindex "&'tdb'& DBM library"
1824 Yet another DBM library, called &'tdb'&, is available from
1825 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1826 operates on a single file.
1827 .endlist
1828
1829 .cindex "USE_DB"
1830 .cindex "DBM libraries" "configuration for building"
1831 Exim and its utilities can be compiled to use any of these interfaces. In order
1832 to use any version of the Berkeley DB package in native mode, you must set
1833 USE_DB in an appropriate configuration file (typically
1834 &_Local/Makefile_&). For example:
1835 .code
1836 USE_DB=yes
1837 .endd
1838 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1839 error is diagnosed if you set more than one of these.
1840
1841 At the lowest level, the build-time configuration sets none of these options,
1842 thereby assuming an interface of type (1). However, some operating system
1843 configuration files (for example, those for the BSD operating systems and
1844 Linux) assume type (4) by setting USE_DB as their default, and the
1845 configuration files for Cygwin set USE_GDBM. Anything you set in
1846 &_Local/Makefile_&, however, overrides these system defaults.
1847
1848 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1849 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1850 in one of these lines:
1851 .code
1852 DBMLIB = -ldb
1853 DBMLIB = -ltdb
1854 .endd
1855 Settings like that will work if the DBM library is installed in the standard
1856 place. Sometimes it is not, and the library's header file may also not be in
1857 the default path. You may need to set INCLUDE to specify where the header
1858 file is, and to specify the path to the library more fully in DBMLIB, as in
1859 this example:
1860 .code
1861 INCLUDE=-I/usr/local/include/db-4.1
1862 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1863 .endd
1864 There is further detailed discussion about the various DBM libraries in the
1865 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1866
1867
1868
1869 .section "Pre-building configuration" "SECID25"
1870 .cindex "building Exim" "pre-building configuration"
1871 .cindex "configuration for building Exim"
1872 .cindex "&_Local/Makefile_&"
1873 .cindex "&_src/EDITME_&"
1874 Before building Exim, a local configuration file that specifies options
1875 independent of any operating system has to be created with the name
1876 &_Local/Makefile_&. A template for this file is supplied as the file
1877 &_src/EDITME_&, and it contains full descriptions of all the option settings
1878 therein. These descriptions are therefore not repeated here. If you are
1879 building Exim for the first time, the simplest thing to do is to copy
1880 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1881
1882 There are three settings that you must supply, because Exim will not build
1883 without them. They are the location of the runtime configuration file
1884 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1885 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1886 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1887 a colon-separated list of filenames; Exim uses the first of them that exists.
1888
1889 There are a few other parameters that can be specified either at build time or
1890 at runtime, to enable the same binary to be used on a number of different
1891 machines. However, if the locations of Exim's spool directory and log file
1892 directory (if not within the spool directory) are fixed, it is recommended that
1893 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1894 detected early in Exim's execution (such as a malformed configuration file) can
1895 be logged.
1896
1897 .cindex "content scanning" "specifying at build time"
1898 Exim's interfaces for calling virus and spam scanning software directly from
1899 access control lists are not compiled by default. If you want to include these
1900 facilities, you need to set
1901 .code
1902 WITH_CONTENT_SCAN=yes
1903 .endd
1904 in your &_Local/Makefile_&. For details of the facilities themselves, see
1905 chapter &<<CHAPexiscan>>&.
1906
1907
1908 .cindex "&_Local/eximon.conf_&"
1909 .cindex "&_exim_monitor/EDITME_&"
1910 If you are going to build the Exim monitor, a similar configuration process is
1911 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1912 your installation and saved under the name &_Local/eximon.conf_&. If you are
1913 happy with the default settings described in &_exim_monitor/EDITME_&,
1914 &_Local/eximon.conf_& can be empty, but it must exist.
1915
1916 This is all the configuration that is needed in straightforward cases for known
1917 operating systems. However, the building process is set up so that it is easy
1918 to override options that are set by default or by operating-system-specific
1919 configuration files, for example, to change the C compiler, which
1920 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1921 do this.
1922
1923
1924
1925 .section "Support for iconv()" "SECID26"
1926 .cindex "&[iconv()]& support"
1927 .cindex "RFC 2047"
1928 The contents of header lines in messages may be encoded according to the rules
1929 described RFC 2047. This makes it possible to transmit characters that are not
1930 in the ASCII character set, and to label them as being in a particular
1931 character set. When Exim is inspecting header lines by means of the &%$h_%&
1932 mechanism, it decodes them, and translates them into a specified character set
1933 (default is set at build time). The translation is possible only if the operating system
1934 supports the &[iconv()]& function.
1935
1936 However, some of the operating systems that supply &[iconv()]& do not support
1937 very many conversions. The GNU &%libiconv%& library (available from
1938 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1939 systems to remedy this deficiency, as well as on systems that do not supply
1940 &[iconv()]& at all. After installing &%libiconv%&, you should add
1941 .code
1942 HAVE_ICONV=yes
1943 .endd
1944 to your &_Local/Makefile_& and rebuild Exim.
1945
1946
1947
1948 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1949 .cindex "TLS" "including support for TLS"
1950 .cindex "encryption" "including support for"
1951 .cindex "OpenSSL" "building Exim with"
1952 .cindex "GnuTLS" "building Exim with"
1953 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1954 command as per RFC 2487. It can also support clients that expect to
1955 start a TLS session immediately on connection to a non-standard port (see the
1956 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1957 line option).
1958
1959 If you want to build Exim with TLS support, you must first install either the
1960 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1961 implementing SSL.
1962
1963 If you do not want TLS support you should set
1964 .code
1965 DISABLE_TLS=yes
1966 .endd
1967 in &_Local/Makefile_&.
1968
1969 If OpenSSL is installed, you should set
1970 .code
1971 USE_OPENSL=yes
1972 TLS_LIBS=-lssl -lcrypto
1973 .endd
1974 in &_Local/Makefile_&. You may also need to specify the locations of the
1975 OpenSSL library and include files. For example:
1976 .code
1977 USE_OPENSSL=yes
1978 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1979 TLS_INCLUDE=-I/usr/local/openssl/include/
1980 .endd
1981 .cindex "pkg-config" "OpenSSL"
1982 If you have &'pkg-config'& available, then instead you can just use:
1983 .code
1984 USE_OPENSSL=yes
1985 USE_OPENSSL_PC=openssl
1986 .endd
1987 .cindex "USE_GNUTLS"
1988 If GnuTLS is installed, you should set
1989 .code
1990 USE_GNUTLS=yes
1991 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1992 .endd
1993 in &_Local/Makefile_&, and again you may need to specify the locations of the
1994 library and include files. For example:
1995 .code
1996 USE_GNUTLS=yes
1997 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1998 TLS_INCLUDE=-I/usr/gnu/include
1999 .endd
2000 .cindex "pkg-config" "GnuTLS"
2001 If you have &'pkg-config'& available, then instead you can just use:
2002 .code
2003 USE_GNUTLS=yes
2004 USE_GNUTLS_PC=gnutls
2005 .endd
2006
2007 You do not need to set TLS_INCLUDE if the relevant directory is already
2008 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
2009 given in chapter &<<CHAPTLS>>&.
2010
2011
2012
2013
2014 .section "Use of tcpwrappers" "SECID27"
2015
2016 .cindex "tcpwrappers, building Exim to support"
2017 .cindex "USE_TCP_WRAPPERS"
2018 .cindex "TCP_WRAPPERS_DAEMON_NAME"
2019 .cindex "tcp_wrappers_daemon_name"
2020 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
2021 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
2022 alternative to Exim's own checking facilities for installations that are
2023 already making use of &'tcpwrappers'& for other purposes. To do this, you
2024 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
2025 &_tcpd.h_& to be available at compile time, and also ensure that the library
2026 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
2027 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
2028 you might have
2029 .code
2030 USE_TCP_WRAPPERS=yes
2031 CFLAGS=-O -I/usr/local/include
2032 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
2033 .endd
2034 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
2035 files is &"exim"&. For example, the line
2036 .code
2037 exim : LOCAL  192.168.1.  .friendly.domain.example
2038 .endd
2039 in your &_/etc/hosts.allow_& file allows connections from the local host, from
2040 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
2041 All other connections are denied. The daemon name used by &'tcpwrappers'&
2042 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
2043 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
2044 configure file. Consult the &'tcpwrappers'& documentation for
2045 further details.
2046
2047
2048 .section "Including support for IPv6" "SECID28"
2049 .cindex "IPv6" "including support for"
2050 Exim contains code for use on systems that have IPv6 support. Setting
2051 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
2052 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
2053 where the IPv6 support is not fully integrated into the normal include and
2054 library files.
2055
2056 Two different types of DNS record for handling IPv6 addresses have been
2057 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2058 currently seen as the mainstream. Another record type called A6 was proposed
2059 as better than AAAA because it had more flexibility. However, it was felt to be
2060 over-complex, and its status was reduced to &"experimental"&.
2061 Exim used to
2062 have a compile option for including A6 record support but this has now been
2063 withdrawn.
2064
2065
2066
2067 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2068 .cindex "lookup modules"
2069 .cindex "dynamic modules"
2070 .cindex ".so building"
2071 On some platforms, Exim supports not compiling all lookup types directly into
2072 the main binary, instead putting some into external modules which can be loaded
2073 on demand.
2074 This permits packagers to build Exim with support for lookups with extensive
2075 library dependencies without requiring all users to install all of those
2076 dependencies.
2077 Most, but not all, lookup types can be built this way.
2078
2079 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2080 installed; Exim will only load modules from that directory, as a security
2081 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2082 for your OS; see &_OS/Makefile-Linux_& for an example.
2083 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2084 see &_src/EDITME_& for details.
2085
2086 Then, for each module to be loaded dynamically, define the relevant
2087 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2088 For example, this will build in lsearch but load sqlite and mysql support
2089 on demand:
2090 .code
2091 LOOKUP_LSEARCH=yes
2092 LOOKUP_SQLITE=2
2093 LOOKUP_MYSQL=2
2094 .endd
2095
2096
2097 .section "The building process" "SECID29"
2098 .cindex "build directory"
2099 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2100 created, run &'make'& at the top level. It determines the architecture and
2101 operating system types, and creates a build directory if one does not exist.
2102 For example, on a Sun system running Solaris 8, the directory
2103 &_build-SunOS5-5.8-sparc_& is created.
2104 .cindex "symbolic link" "to source files"
2105 Symbolic links to relevant source files are installed in the build directory.
2106
2107 If this is the first time &'make'& has been run, it calls a script that builds
2108 a make file inside the build directory, using the configuration files from the
2109 &_Local_& directory. The new make file is then passed to another instance of
2110 &'make'&. This does the real work, building a number of utility scripts, and
2111 then compiling and linking the binaries for the Exim monitor (if configured), a
2112 number of utility programs, and finally Exim itself. The command &`make
2113 makefile`& can be used to force a rebuild of the make file in the build
2114 directory, should this ever be necessary.
2115
2116 If you have problems building Exim, check for any comments there may be in the
2117 &_README_& file concerning your operating system, and also take a look at the
2118 FAQ, where some common problems are covered.
2119
2120
2121
2122 .section 'Output from &"make"&' "SECID283"
2123 The output produced by the &'make'& process for compile lines is often very
2124 unreadable, because these lines can be very long. For this reason, the normal
2125 output is suppressed by default, and instead output similar to that which
2126 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2127 each module that is being compiled or linked. However, it is still possible to
2128 get the full output, by calling &'make'& like this:
2129 .code
2130 FULLECHO='' make -e
2131 .endd
2132 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2133 command reflection in &'make'&. When you ask for the full output, it is
2134 given in addition to the short output.
2135
2136
2137
2138 .section "Overriding build-time options for Exim" "SECToverride"
2139 .cindex "build-time options, overriding"
2140 The main make file that is created at the beginning of the building process
2141 consists of the concatenation of a number of files which set configuration
2142 values, followed by a fixed set of &'make'& instructions. If a value is set
2143 more than once, the last setting overrides any previous ones. This provides a
2144 convenient way of overriding defaults. The files that are concatenated are, in
2145 order:
2146 .display
2147 &_OS/Makefile-Default_&
2148 &_OS/Makefile-_&<&'ostype'&>
2149 &_Local/Makefile_&
2150 &_Local/Makefile-_&<&'ostype'&>
2151 &_Local/Makefile-_&<&'archtype'&>
2152 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2153 &_OS/Makefile-Base_&
2154 .endd
2155 .cindex "&_Local/Makefile_&"
2156 .cindex "building Exim" "operating system type"
2157 .cindex "building Exim" "architecture type"
2158 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2159 architecture type. &_Local/Makefile_& is required to exist, and the building
2160 process fails if it is absent. The other three &_Local_& files are optional,
2161 and are often not needed.
2162
2163 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2164 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2165 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2166 values are used, thereby providing a means of forcing particular settings.
2167 Otherwise, the scripts try to get values from the &%uname%& command. If this
2168 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2169 of &'ad hoc'& transformations are then applied, to produce the standard names
2170 that Exim expects. You can run these scripts directly from the shell in order
2171 to find out what values are being used on your system.
2172
2173
2174 &_OS/Makefile-Default_& contains comments about the variables that are set
2175 therein. Some (but not all) are mentioned below. If there is something that
2176 needs changing, review the contents of this file and the contents of the make
2177 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2178 default values are.
2179
2180
2181 .cindex "building Exim" "overriding default settings"
2182 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2183 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2184 need to change the original files. Instead, you should make the changes by
2185 putting the new values in an appropriate &_Local_& file. For example,
2186 .cindex "Tru64-Unix build-time settings"
2187 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2188 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2189 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2190 called with the option &%-std1%&, to make it recognize some of the features of
2191 Standard C that Exim uses. (Most other compilers recognize Standard C by
2192 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2193 containing the lines
2194 .code
2195 CC=cc
2196 CFLAGS=-std1
2197 .endd
2198 If you are compiling for just one operating system, it may be easier to put
2199 these lines directly into &_Local/Makefile_&.
2200
2201 Keeping all your local configuration settings separate from the distributed
2202 files makes it easy to transfer them to new versions of Exim simply by copying
2203 the contents of the &_Local_& directory.
2204
2205
2206 .cindex "NIS lookup type" "including support for"
2207 .cindex "NIS+ lookup type" "including support for"
2208 .cindex "LDAP" "including support for"
2209 .cindex "lookup" "inclusion in binary"
2210 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2211 lookup, but not all systems have these components installed, so the default is
2212 not to include the relevant code in the binary. All the different kinds of file
2213 and database lookup that Exim supports are implemented as separate code modules
2214 which are included only if the relevant compile-time options are set. In the
2215 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2216 .code
2217 LOOKUP_LDAP=yes
2218 LOOKUP_NIS=yes
2219 LOOKUP_NISPLUS=yes
2220 .endd
2221 and similar settings apply to the other lookup types. They are all listed in
2222 &_src/EDITME_&. In many cases the relevant include files and interface
2223 libraries need to be installed before compiling Exim.
2224 .cindex "cdb" "including support for"
2225 However, there are some optional lookup types (such as cdb) for which
2226 the code is entirely contained within Exim, and no external include
2227 files or libraries are required. When a lookup type is not included in the
2228 binary, attempts to configure Exim to use it cause runtime configuration
2229 errors.
2230
2231 .cindex "pkg-config" "lookups"
2232 .cindex "pkg-config" "authenticators"
2233 Many systems now use a tool called &'pkg-config'& to encapsulate information
2234 about how to compile against a library; Exim has some initial support for
2235 being able to use pkg-config for lookups and authenticators.  For any given
2236 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2237 variable with the &`_PC`& suffix in the name and assign as the value the
2238 name of the package to be queried.  The results of querying via the
2239 &'pkg-config'& command will be added to the appropriate Makefile variables
2240 with &`+=`& directives, so your version of &'make'& will need to support that
2241 syntax.  For instance:
2242 .code
2243 LOOKUP_SQLITE=yes
2244 LOOKUP_SQLITE_PC=sqlite3
2245 AUTH_GSASL=yes
2246 AUTH_GSASL_PC=libgsasl
2247 AUTH_HEIMDAL_GSSAPI=yes
2248 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2249 .endd
2250
2251 .cindex "Perl" "including support for"
2252 Exim can be linked with an embedded Perl interpreter, allowing Perl
2253 subroutines to be called during string expansion. To enable this facility,
2254 .code
2255 EXIM_PERL=perl.o
2256 .endd
2257 must be defined in &_Local/Makefile_&. Details of this facility are given in
2258 chapter &<<CHAPperl>>&.
2259
2260 .cindex "X11 libraries, location of"
2261 The location of the X11 libraries is something that varies a lot between
2262 operating systems, and there may be different versions of X11 to cope
2263 with. Exim itself makes no use of X11, but if you are compiling the Exim
2264 monitor, the X11 libraries must be available.
2265 The following three variables are set in &_OS/Makefile-Default_&:
2266 .code
2267 X11=/usr/X11R6
2268 XINCLUDE=-I$(X11)/include
2269 XLFLAGS=-L$(X11)/lib
2270 .endd
2271 These are overridden in some of the operating-system configuration files. For
2272 example, in &_OS/Makefile-SunOS5_& there is
2273 .code
2274 X11=/usr/openwin
2275 XINCLUDE=-I$(X11)/include
2276 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2277 .endd
2278 If you need to override the default setting for your operating system, place a
2279 definition of all three of these variables into your
2280 &_Local/Makefile-<ostype>_& file.
2281
2282 .cindex "EXTRALIBS"
2283 If you need to add any extra libraries to the link steps, these can be put in a
2284 variable called EXTRALIBS, which appears in all the link commands, but by
2285 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2286 command for linking the main Exim binary, and not for any associated utilities.
2287
2288 .cindex "DBM libraries" "configuration for building"
2289 There is also DBMLIB, which appears in the link commands for binaries that
2290 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2291 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2292 binary, and which can be used, for example, to include additional X11
2293 libraries.
2294
2295 .cindex "configuration file" "editing"
2296 The make file copes with rebuilding Exim correctly if any of the configuration
2297 files are edited. However, if an optional configuration file is deleted, it is
2298 necessary to touch the associated non-optional file (that is,
2299 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2300
2301
2302 .section "OS-specific header files" "SECID30"
2303 .cindex "&_os.h_&"
2304 .cindex "building Exim" "OS-specific C header files"
2305 The &_OS_& directory contains a number of files with names of the form
2306 &_os.h-<ostype>_&. These are system-specific C header files that should not
2307 normally need to be changed. There is a list of macro settings that are
2308 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2309 are porting Exim to a new operating system.
2310
2311
2312
2313 .section "Overriding build-time options for the monitor" "SECID31"
2314 .cindex "building Eximon"
2315 A similar process is used for overriding things when building the Exim monitor,
2316 where the files that are involved are
2317 .display
2318 &_OS/eximon.conf-Default_&
2319 &_OS/eximon.conf-_&<&'ostype'&>
2320 &_Local/eximon.conf_&
2321 &_Local/eximon.conf-_&<&'ostype'&>
2322 &_Local/eximon.conf-_&<&'archtype'&>
2323 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2324 .endd
2325 .cindex "&_Local/eximon.conf_&"
2326 As with Exim itself, the final three files need not exist, and in this case the
2327 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2328 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2329 variables of the same name, preceded by EXIMON_. For example, setting
2330 EXIMON_LOG_DEPTH in the environment overrides the value of
2331 LOG_DEPTH at runtime.
2332 .ecindex IIDbuex
2333
2334
2335 .section "Installing Exim binaries and scripts" "SECID32"
2336 .cindex "installing Exim"
2337 .cindex "BIN_DIRECTORY"
2338 The command &`make install`& runs the &(exim_install)& script with no
2339 arguments. The script copies binaries and utility scripts into the directory
2340 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2341 .cindex "setuid" "installing Exim with"
2342 The install script copies files only if they are newer than the files they are
2343 going to replace. The Exim binary is required to be owned by root and have the
2344 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2345 install`& as root so that it can set up the Exim binary in this way. However, in
2346 some special situations (for example, if a host is doing no local deliveries)
2347 it may be possible to run Exim without making the binary setuid root (see
2348 chapter &<<CHAPsecurity>>& for details).
2349
2350 .cindex "CONFIGURE_FILE"
2351 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2352 in &_Local/Makefile_&. If this names a single file, and the file does not
2353 exist, the default configuration file &_src/configure.default_& is copied there
2354 by the installation script. If a runtime configuration file already exists, it
2355 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2356 alternative files, no default is installed.
2357
2358 .cindex "system aliases file"
2359 .cindex "&_/etc/aliases_&"
2360 One change is made to the default configuration file when it is installed: the
2361 default configuration contains a router that references a system aliases file.
2362 The path to this file is set to the value specified by
2363 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2364 If the system aliases file does not exist, the installation script creates it,
2365 and outputs a comment to the user.
2366
2367 The created file contains no aliases, but it does contain comments about the
2368 aliases a site should normally have. Mail aliases have traditionally been
2369 kept in &_/etc/aliases_&. However, some operating systems are now using
2370 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2371 Exim's configuration if necessary.
2372
2373 The default configuration uses the local host's name as the only local domain,
2374 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2375 running as the local user. System aliases and &_.forward_& files in users' home
2376 directories are supported, but no NIS or NIS+ support is configured. Domains
2377 other than the name of the local host are routed using the DNS, with delivery
2378 over SMTP.
2379
2380 It is possible to install Exim for special purposes (such as building a binary
2381 distribution) in a private part of the file system. You can do this by a
2382 command such as
2383 .code
2384 make DESTDIR=/some/directory/ install
2385 .endd
2386 This has the effect of pre-pending the specified directory to all the file
2387 paths, except the name of the system aliases file that appears in the default
2388 configuration. (If a default alias file is created, its name &'is'& modified.)
2389 For backwards compatibility, ROOT is used if DESTDIR is not set,
2390 but this usage is deprecated.
2391
2392 .cindex "installing Exim" "what is not installed"
2393 Running &'make install'& does not copy the Exim 4 conversion script
2394 &'convert4r4'&. You will probably run this only once if you are
2395 upgrading from Exim 3. None of the documentation files in the &_doc_&
2396 directory are copied, except for the info files when you have set
2397 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2398
2399 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2400 to their names. The Exim binary itself, however, is handled differently. It is
2401 installed under a name that includes the version number and the compile number,
2402 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2403 called &_exim_& to point to the binary. If you are updating a previous version
2404 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2405 from the directory (as seen by other processes).
2406
2407 .cindex "installing Exim" "testing the script"
2408 If you want to see what the &'make install'& will do before running it for
2409 real, you can pass the &%-n%& option to the installation script by this
2410 command:
2411 .code
2412 make INSTALL_ARG=-n install
2413 .endd
2414 The contents of the variable INSTALL_ARG are passed to the installation
2415 script. You do not need to be root to run this test. Alternatively, you can run
2416 the installation script directly, but this must be from within the build
2417 directory. For example, from the top-level Exim directory you could use this
2418 command:
2419 .code
2420 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2421 .endd
2422 .cindex "installing Exim" "install script options"
2423 There are two other options that can be supplied to the installation script.
2424
2425 .ilist
2426 &%-no_chown%& bypasses the call to change the owner of the installed binary
2427 to root, and the call to make it a setuid binary.
2428 .next
2429 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2430 installed binary.
2431 .endlist
2432
2433 INSTALL_ARG can be used to pass these options to the script. For example:
2434 .code
2435 make INSTALL_ARG=-no_symlink install
2436 .endd
2437 The installation script can also be given arguments specifying which files are
2438 to be copied. For example, to install just the Exim binary, and nothing else,
2439 without creating the symbolic link, you could use:
2440 .code
2441 make INSTALL_ARG='-no_symlink exim' install
2442 .endd
2443
2444
2445
2446 .section "Installing info documentation" "SECTinsinfdoc"
2447 .cindex "installing Exim" "&'info'& documentation"
2448 Not all systems use the GNU &'info'& system for documentation, and for this
2449 reason, the Texinfo source of Exim's documentation is not included in the main
2450 distribution. Instead it is available separately from the FTP site (see section
2451 &<<SECTavail>>&).
2452
2453 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2454 source of the documentation is found in the source tree, running &`make
2455 install`& automatically builds the info files and installs them.
2456
2457
2458
2459 .section "Setting up the spool directory" "SECID33"
2460 .cindex "spool directory" "creating"
2461 When it starts up, Exim tries to create its spool directory if it does not
2462 exist. The Exim uid and gid are used for the owner and group of the spool
2463 directory. Sub-directories are automatically created in the spool directory as
2464 necessary.
2465
2466
2467
2468
2469 .section "Testing" "SECID34"
2470 .cindex "testing" "installation"
2471 Having installed Exim, you can check that the runtime configuration file is
2472 syntactically valid by running the following command, which assumes that the
2473 Exim binary directory is within your PATH environment variable:
2474 .code
2475 exim -bV
2476 .endd
2477 If there are any errors in the configuration file, Exim outputs error messages.
2478 Otherwise it outputs the version number and build date,
2479 the DBM library that is being used, and information about which drivers and
2480 other optional code modules are included in the binary.
2481 Some simple routing tests can be done by using the address testing option. For
2482 example,
2483 .display
2484 &`exim -bt`& <&'local username'&>
2485 .endd
2486 should verify that it recognizes a local mailbox, and
2487 .display
2488 &`exim -bt`& <&'remote address'&>
2489 .endd
2490 a remote one. Then try getting it to deliver mail, both locally and remotely.
2491 This can be done by passing messages directly to Exim, without going through a
2492 user agent. For example:
2493 .code
2494 exim -v postmaster@your.domain.example
2495 From: user@your.domain.example
2496 To: postmaster@your.domain.example
2497 Subject: Testing Exim
2498
2499 This is a test message.
2500 ^D
2501 .endd
2502 The &%-v%& option causes Exim to output some verification of what it is doing.
2503 In this case you should see copies of three log lines, one for the message's
2504 arrival, one for its delivery, and one containing &"Completed"&.
2505
2506 .cindex "delivery" "problems with"
2507 If you encounter problems, look at Exim's log files (&'mainlog'& and
2508 &'paniclog'&) to see if there is any relevant information there. Another source
2509 of information is running Exim with debugging turned on, by specifying the
2510 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2511 with debugging turned on by a command of the form
2512 .display
2513 &`exim -d -M`& <&'exim-message-id'&>
2514 .endd
2515 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2516 produces rather a lot of output, but you can cut this down to specific areas.
2517 For example, if you use &%-d-all+route%& only the debugging information
2518 relevant to routing is included. (See the &%-d%& option in chapter
2519 &<<CHAPcommandline>>& for more details.)
2520
2521 .cindex '&"sticky"& bit'
2522 .cindex "lock files"
2523 One specific problem that has shown up on some sites is the inability to do
2524 local deliveries into a shared mailbox directory, because it does not have the
2525 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2526 writing to a mailbox file, and if it cannot create the lock file, the delivery
2527 is deferred. You can get round this either by setting the &"sticky bit"& on the
2528 directory, or by setting a specific group for local deliveries and allowing
2529 that group to create files in the directory (see the comments above the
2530 &(local_delivery)& transport in the default configuration file). Another
2531 approach is to configure Exim not to use lock files, but just to rely on
2532 &[fcntl()]& locking instead. However, you should do this only if all user
2533 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2534 see chapter &<<CHAPappendfile>>&.
2535
2536 One thing that cannot be tested on a system that is already running an MTA is
2537 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2538 &%-oX%& option can be used to run an Exim daemon that listens on some other
2539 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2540 &'exim_checkaccess'& utility can be used to check out policy controls on
2541 incoming SMTP mail.
2542
2543 Testing a new version on a system that is already running Exim can most easily
2544 be done by building a binary with a different CONFIGURE_FILE setting. From
2545 within the runtime configuration, all other file and directory names
2546 that Exim uses can be altered, in order to keep it entirely clear of the
2547 production version.
2548
2549
2550 .section "Replacing another MTA with Exim" "SECID35"
2551 .cindex "replacing another MTA"
2552 Building and installing Exim for the first time does not of itself put it in
2553 general use. The name by which the system's MTA is called by mail user agents
2554 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2555 operating system), and it is necessary to make this name point to the &'exim'&
2556 binary in order to get the user agents to pass messages to Exim. This is
2557 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2558 or &_/usr/lib/sendmail_&
2559 .cindex "symbolic link" "to &'exim'& binary"
2560 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2561 privilege and executable status from the old MTA. It is then necessary to stop
2562 and restart the mailer daemon, if one is running.
2563
2564 .cindex "FreeBSD, MTA indirection"
2565 .cindex "&_/etc/mail/mailer.conf_&"
2566 Some operating systems have introduced alternative ways of switching MTAs. For
2567 example, if you are running FreeBSD, you need to edit the file
2568 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2569 described. A typical example of the contents of this file for running Exim is
2570 as follows:
2571 .code
2572 sendmail            /usr/exim/bin/exim
2573 send-mail           /usr/exim/bin/exim
2574 mailq               /usr/exim/bin/exim -bp
2575 newaliases          /usr/bin/true
2576 .endd
2577 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2578 your Exim installation is &"live"&. Check it by sending a message from your
2579 favourite user agent.
2580
2581 You should consider what to tell your users about the change of MTA. Exim may
2582 have different capabilities to what was previously running, and there are
2583 various operational differences such as the text of messages produced by
2584 command line options and in bounce messages. If you allow your users to make
2585 use of Exim's filtering capabilities, you should make the document entitled
2586 &'Exim's interface to mail filtering'& available to them.
2587
2588
2589
2590 .section "Upgrading Exim" "SECID36"
2591 .cindex "upgrading Exim"
2592 If you are already running Exim on your host, building and installing a new
2593 version automatically makes it available to MUAs, or any other programs that
2594 call the MTA directly. However, if you are running an Exim daemon, you do need
2595 .cindex restart "on HUP signal"
2596 .cindex signal "HUP, to restart"
2597 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2598 new binary. You do not need to stop processing mail in order to install a new
2599 version of Exim. The install script does not modify an existing runtime
2600 configuration file.
2601
2602
2603
2604
2605 .section "Stopping the Exim daemon on Solaris" "SECID37"
2606 .cindex "Solaris" "stopping Exim on"
2607 The standard command for stopping the mailer daemon on Solaris is
2608 .code
2609 /etc/init.d/sendmail stop
2610 .endd
2611 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2612 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2613 for the text &"sendmail"&; this is not present because the actual program name
2614 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2615 solution is to replace the line that finds the process id with something like
2616 .code
2617 pid=`cat /var/spool/exim/exim-daemon.pid`
2618 .endd
2619 to obtain the daemon's pid directly from the file that Exim saves it in.
2620
2621 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2622 still be received from local processes, and if automatic delivery is configured
2623 (the normal case), deliveries will still occur.
2624
2625
2626
2627
2628 . ////////////////////////////////////////////////////////////////////////////
2629 . ////////////////////////////////////////////////////////////////////////////
2630
2631 .chapter "The Exim command line" "CHAPcommandline"
2632 .scindex IIDclo1 "command line" "options"
2633 .scindex IIDclo2 "options" "command line"
2634 Exim's command line takes the standard Unix form of a sequence of options,
2635 each starting with a hyphen character, followed by a number of arguments. The
2636 options are compatible with the main options of Sendmail, and there are also
2637 some additional options, some of which are compatible with Smail 3. Certain
2638 combinations of options do not make sense, and provoke an error if used.
2639 The form of the arguments depends on which options are set.
2640
2641
2642 .section "Setting options by program name" "SECID38"
2643 .cindex "&'mailq'&"
2644 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2645 were present before any other options.
2646 The &%-bp%& option requests a listing of the contents of the mail queue on the
2647 standard output.
2648 This feature is for compatibility with some systems that contain a command of
2649 that name in one of the standard libraries, symbolically linked to
2650 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2651
2652 .cindex "&'rsmtp'&"
2653 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2654 were present before any other options, for compatibility with Smail. The
2655 &%-bS%& option is used for reading in a number of messages in batched SMTP
2656 format.
2657
2658 .cindex "&'rmail'&"
2659 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2660 &%-oee%& options were present before any other options, for compatibility with
2661 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2662
2663 .cindex "&'runq'&"
2664 .cindex "queue runner"
2665 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2666 were present before any other options, for compatibility with Smail. The &%-q%&
2667 option causes a single queue runner process to be started.
2668
2669 .cindex "&'newaliases'&"
2670 .cindex "alias file" "building"
2671 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2672 If Exim is called under the name &'newaliases'& it behaves as if the option
2673 &%-bi%& were present before any other options, for compatibility with Sendmail.
2674 This option is used for rebuilding Sendmail's alias file. Exim does not have
2675 the concept of a single alias file, but can be configured to run a given
2676 command if called with the &%-bi%& option.
2677
2678
2679 .section "Trusted and admin users" "SECTtrustedadmin"
2680 Some Exim options are available only to &'trusted users'& and others are
2681 available only to &'admin users'&. In the description below, the phrases &"Exim
2682 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2683 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2684 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2685
2686 .ilist
2687 .cindex "trusted users" "definition of"
2688 .cindex "user" "trusted definition of"
2689 The trusted users are root, the Exim user, any user listed in the
2690 &%trusted_users%& configuration option, and any user whose current group or any
2691 supplementary group is one of those listed in the &%trusted_groups%&
2692 configuration option. Note that the Exim group is not automatically trusted.
2693
2694 .cindex '&"From"& line'
2695 .cindex "envelope from"
2696 .cindex "envelope sender"
2697 Trusted users are always permitted to use the &%-f%& option or a leading
2698 &"From&~"& line to specify the envelope sender of a message that is passed to
2699 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2700 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2701 users to set envelope senders.
2702
2703 .chindex From:
2704 .chindex Sender:
2705 For a trusted user, there is never any check on the contents of the &'From:'&
2706 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2707 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2708
2709 Trusted users may also specify a host name, host address, interface address,
2710 protocol name, ident value, and authentication data when submitting a message
2711 locally. Thus, they are able to insert messages into Exim's queue locally that
2712 have the characteristics of messages received from a remote host. Untrusted
2713 users may in some circumstances use &%-f%&, but can never set the other values
2714 that are available to trusted users.
2715 .next
2716 .cindex "user" "admin definition of"
2717 .cindex "admin user" "definition of"
2718 The admin users are root, the Exim user, and any user that is a member of the
2719 Exim group or of any group listed in the &%admin_groups%& configuration option.
2720 The current group does not have to be one of these groups.
2721
2722 Admin users are permitted to list the queue, and to carry out certain
2723 operations on messages, for example, to force delivery failures. It is also
2724 necessary to be an admin user in order to see the full information provided by
2725 the Exim monitor, and full debugging output.
2726
2727 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2728 Exim to attempt delivery of messages on its queue is restricted to admin users.
2729 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2730 option false (that is, specifying &%no_prod_requires_admin%&).
2731
2732 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2733 is restricted to admin users unless &%queue_list_requires_admin%& is set
2734 false.
2735 .endlist
2736
2737
2738 &*Warning*&: If you configure your system so that admin users are able to
2739 edit Exim's configuration file, you are giving those users an easy way of
2740 getting root. There is further discussion of this issue at the start of chapter
2741 &<<CHAPconf>>&.
2742
2743
2744
2745
2746 .section "Command line options" "SECID39"
2747 Exim's command line options are described in alphabetical order below. If none
2748 of the options that specifies a specific action (such as starting the daemon or
2749 a queue runner, or testing an address, or receiving a message in a specific
2750 format, or listing the queue) are present, and there is at least one argument
2751 on the command line, &%-bm%& (accept a local message on the standard input,
2752 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2753 outputs a brief message about itself and exits.
2754
2755 . ////////////////////////////////////////////////////////////////////////////
2756 . Insert a stylized XML comment here, to identify the start of the command line
2757 . options. This is for the benefit of the Perl script that automatically
2758 . creates a man page for the options.
2759 . ////////////////////////////////////////////////////////////////////////////
2760
2761 .literal xml
2762 <!-- === Start of command line options === -->
2763 .literal off
2764
2765
2766 .vlist
2767 .vitem &%--%&
2768 .oindex "--"
2769 .cindex "options" "command line; terminating"
2770 This is a pseudo-option whose only purpose is to terminate the options and
2771 therefore to cause subsequent command line items to be treated as arguments
2772 rather than options, even if they begin with hyphens.
2773
2774 .vitem &%--help%&
2775 .oindex "&%--help%&"
2776 This option causes Exim to output a few sentences stating what it is.
2777 The same output is generated if the Exim binary is called with no options and
2778 no arguments.
2779
2780 .vitem &%--version%&
2781 .oindex "&%--version%&"
2782 This option is an alias for &%-bV%& and causes version information to be
2783 displayed.
2784
2785 .vitem &%-Ac%& &&&
2786        &%-Am%&
2787 .oindex "&%-Ac%&"
2788 .oindex "&%-Am%&"
2789 These options are used by Sendmail for selecting configuration files and are
2790 ignored by Exim.
2791
2792 .vitem &%-B%&<&'type'&>
2793 .oindex "&%-B%&"
2794 .cindex "8-bit characters"
2795 .cindex "Sendmail compatibility" "8-bit characters"
2796 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2797 clean; it ignores this option.
2798
2799 .vitem &%-bd%&
2800 .oindex "&%-bd%&"
2801 .cindex "daemon"
2802 .cindex "SMTP" "listener"
2803 .cindex "queue runner"
2804 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2805 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2806 that the daemon should also initiate periodic queue runs.
2807
2808 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2809 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2810 disconnect from the controlling terminal. When running this way, it can be
2811 stopped by pressing ctrl-C.
2812
2813 By default, Exim listens for incoming connections to the standard SMTP port on
2814 all the host's running interfaces. However, it is possible to listen on other
2815 ports, on multiple ports, and only on specific interfaces. Chapter
2816 &<<CHAPinterfaces>>& contains a description of the options that control this.
2817
2818 When a listening daemon
2819 .cindex "daemon" "process id (pid)"
2820 .cindex "pid (process id)" "of daemon"
2821 is started without the use of &%-oX%& (that is, without overriding the normal
2822 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2823 in Exim's spool directory. This location can be overridden by setting
2824 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2825 running as root.
2826
2827 When &%-oX%& is used on the command line to start a listening daemon, the
2828 process id is not written to the normal pid file path. However, &%-oP%& can be
2829 used to specify a path on the command line if a pid file is required.
2830
2831 The SIGHUP signal
2832 .cindex "SIGHUP"
2833 .cindex restart "on HUP signal"
2834 .cindex signal "HUP, to restart"
2835 .cindex "daemon" "restarting"
2836 .cindex signal "to reload configuration"
2837 .cindex daemon "reload configuration"
2838 .cindex reload configuration
2839 can be used to cause the daemon to re-execute itself. This should be done
2840 whenever Exim's configuration file, or any file that is incorporated into it by
2841 means of the &%.include%& facility, is changed, and also whenever a new version
2842 of Exim is installed. It is not necessary to do this when other files that are
2843 referenced from the configuration (for example, alias files) are changed,
2844 because these are reread each time they are used.
2845
2846 .vitem &%-bdf%&
2847 .oindex "&%-bdf%&"
2848 This option has the same effect as &%-bd%& except that it never disconnects
2849 from the controlling terminal, even when no debugging is specified.
2850
2851 .vitem &%-be%&
2852 .oindex "&%-be%&"
2853 .cindex "testing" "string expansion"
2854 .cindex "expansion" "testing"
2855 Run Exim in expansion testing mode. Exim discards its root privilege, to
2856 prevent ordinary users from using this mode to read otherwise inaccessible
2857 files. If no arguments are given, Exim runs interactively, prompting for lines
2858 of data. Otherwise, it processes each argument in turn.
2859
2860 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2861 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2862 used without command line arguments. If successful, it uses the &[readline()]&
2863 function, which provides extensive line-editing facilities, for reading the
2864 test data. A line history is supported.
2865
2866 Long expansion expressions can be split over several lines by using backslash
2867 continuations. As in Exim's runtime configuration, white space at the start of
2868 continuation lines is ignored. Each argument or data line is passed through the
2869 string expansion mechanism, and the result is output. Variable values from the
2870 configuration file (for example, &$qualify_domain$&) are available, but no
2871 message-specific values (such as &$message_exim_id$&) are set, because no message
2872 is being processed (but see &%-bem%& and &%-Mset%&).
2873
2874 &*Note*&: If you use this mechanism to test lookups, and you change the data
2875 files or databases you are using, you must exit and restart Exim before trying
2876 the same lookup again. Otherwise, because each Exim process caches the results
2877 of lookups, you will just get the same result as before.
2878
2879 Macro processing is done on lines before string-expansion: new macros can be
2880 defined and macros will be expanded.
2881 Because macros in the config file are often used for secrets, those are only
2882 available to admin users.
2883
2884 .vitem &%-bem%&&~<&'filename'&>
2885 .oindex "&%-bem%&"
2886 .cindex "testing" "string expansion"
2887 .cindex "expansion" "testing"
2888 This option operates like &%-be%& except that it must be followed by the name
2889 of a file. For example:
2890 .code
2891 exim -bem /tmp/testmessage
2892 .endd
2893 The file is read as a message (as if receiving a locally-submitted non-SMTP
2894 message) before any of the test expansions are done. Thus, message-specific
2895 variables such as &$message_size$& and &$header_from:$& are available. However,
2896 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2897 recipients are read from the headers in the normal way, and are shown in the
2898 &$recipients$& variable. Note that recipients cannot be given on the command
2899 line, because further arguments are taken as strings to expand (just like
2900 &%-be%&).
2901
2902 .vitem &%-bF%&&~<&'filename'&>
2903 .oindex "&%-bF%&"
2904 .cindex "system filter" "testing"
2905 .cindex "testing" "system filter"
2906 This option is the same as &%-bf%& except that it assumes that the filter being
2907 tested is a system filter. The additional commands that are available only in
2908 system filters are recognized.
2909
2910 .vitem &%-bf%&&~<&'filename'&>
2911 .oindex "&%-bf%&"
2912 .cindex "filter" "testing"
2913 .cindex "testing" "filter file"
2914 .cindex "forward file" "testing"
2915 .cindex "testing" "forward file"
2916 .cindex "Sieve filter" "testing"
2917 This option runs Exim in user filter testing mode; the file is the filter file
2918 to be tested, and a test message must be supplied on the standard input. If
2919 there are no message-dependent tests in the filter, an empty file can be
2920 supplied.
2921
2922 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2923 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2924 filter and a user filter in the same run. For example:
2925 .code
2926 exim -bF /system/filter -bf /user/filter </test/message
2927 .endd
2928 This is helpful when the system filter adds header lines or sets filter
2929 variables that are used by the user filter.
2930
2931 If the test filter file does not begin with one of the special lines
2932 .code
2933 # Exim filter
2934 # Sieve filter
2935 .endd
2936 it is taken to be a normal &_.forward_& file, and is tested for validity under
2937 that interpretation. See sections &<<SECTitenonfilred>>& to
2938 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2939 redirection lists.
2940
2941 The result of an Exim command that uses &%-bf%&, provided no errors are
2942 detected, is a list of the actions that Exim would try to take if presented
2943 with the message for real. More details of filter testing are given in the
2944 separate document entitled &'Exim's interfaces to mail filtering'&.
2945
2946 When testing a filter file,
2947 .cindex "&""From""& line"
2948 .cindex "envelope from"
2949 .cindex "envelope sender"
2950 .oindex "&%-f%&" "for filter testing"
2951 the envelope sender can be set by the &%-f%& option,
2952 or by a &"From&~"& line at the start of the test message. Various parameters
2953 that would normally be taken from the envelope recipient address of the message
2954 can be set by means of additional command line options (see the next four
2955 options).
2956
2957 .vitem &%-bfd%&&~<&'domain'&>
2958 .oindex "&%-bfd%&"
2959 .vindex "&$qualify_domain$&"
2960 This sets the domain of the recipient address when a filter file is being
2961 tested by means of the &%-bf%& option. The default is the value of
2962 &$qualify_domain$&.
2963
2964 .vitem &%-bfl%&&~<&'local&~part'&>
2965 .oindex "&%-bfl%&"
2966 This sets the local part of the recipient address when a filter file is being
2967 tested by means of the &%-bf%& option. The default is the username of the
2968 process that calls Exim. A local part should be specified with any prefix or
2969 suffix stripped, because that is how it appears to the filter when a message is
2970 actually being delivered.
2971
2972 .vitem &%-bfp%&&~<&'prefix'&>
2973 .oindex "&%-bfp%&"
2974 .cindex affix "filter testing"
2975 This sets the prefix of the local part of the recipient address when a filter
2976 file is being tested by means of the &%-bf%& option. The default is an empty
2977 prefix.
2978
2979 .vitem &%-bfs%&&~<&'suffix'&>
2980 .oindex "&%-bfs%&"
2981 .cindex affix "filter testing"
2982 This sets the suffix of the local part of the recipient address when a filter
2983 file is being tested by means of the &%-bf%& option. The default is an empty
2984 suffix.
2985
2986 .vitem &%-bh%&&~<&'IP&~address'&>
2987 .oindex "&%-bh%&"
2988 .cindex "testing" "incoming SMTP"
2989 .cindex "SMTP" "testing incoming"
2990 .cindex "testing" "relay control"
2991 .cindex "relaying" "testing configuration"
2992 .cindex "policy control" "testing"
2993 .cindex "debugging" "&%-bh%& option"
2994 This option runs a fake SMTP session as if from the given IP address, using the
2995 standard input and output. The IP address may include a port number at the end,
2996 after a full stop. For example:
2997 .code
2998 exim -bh 10.9.8.7.1234
2999 exim -bh fe80::a00:20ff:fe86:a061.5678
3000 .endd
3001 When an IPv6 address is given, it is converted into canonical form. In the case
3002 of the second example above, the value of &$sender_host_address$& after
3003 conversion to the canonical form is
3004 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
3005
3006 Comments as to what is going on are written to the standard error file. These
3007 include lines beginning with &"LOG"& for anything that would have been logged.
3008 This facility is provided for testing configuration options for incoming
3009 messages, to make sure they implement the required policy. For example, you can
3010 test your relay controls using &%-bh%&.
3011
3012 &*Warning 1*&:
3013 .cindex "RFC 1413"
3014 You can test features of the configuration that rely on ident (RFC 1413)
3015 information by using the &%-oMt%& option. However, Exim cannot actually perform
3016 an ident callout when testing using &%-bh%& because there is no incoming SMTP
3017 connection.
3018
3019 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
3020 are also skipped when testing using &%-bh%&. If you want these callouts to
3021 occur, use &%-bhc%& instead.
3022
3023 Messages supplied during the testing session are discarded, and nothing is
3024 written to any of the real log files. There may be pauses when DNS (and other)
3025 lookups are taking place, and of course these may time out. The &%-oMi%& option
3026 can be used to specify a specific IP interface and port if this is important,
3027 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
3028 session were authenticated.
3029
3030 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
3031 output just states whether a given recipient address from a given host is
3032 acceptable or not. See section &<<SECTcheckaccess>>&.
3033
3034 Features such as authentication and encryption, where the client input is not
3035 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
3036 specialized SMTP test program such as
3037 &url(https://www.jetmore.org/john/code/swaks/,swaks).
3038
3039 .vitem &%-bhc%&&~<&'IP&~address'&>
3040 .oindex "&%-bhc%&"
3041 This option operates in the same way as &%-bh%&, except that address
3042 verification callouts are performed if required. This includes consulting and
3043 updating the callout cache database.
3044
3045 .vitem &%-bi%&
3046 .oindex "&%-bi%&"
3047 .cindex "alias file" "building"
3048 .cindex "building alias file"
3049 .cindex "Sendmail compatibility" "&%-bi%& option"
3050 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
3051 Exim does not have the concept of a single alias file, and so it cannot mimic
3052 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
3053 tend to appear in various scripts such as NIS make files, so the option must be
3054 recognized.
3055
3056 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3057 configuration option is run, under the uid and gid of the caller of Exim. If
3058 the &%-oA%& option is used, its value is passed to the command as an argument.
3059 The command set by &%bi_command%& may not contain arguments. The command can
3060 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3061 if this is required. If the &%bi_command%& option is not set, calling Exim with
3062 &%-bi%& is a no-op.
3063
3064 . // Keep :help first, then the rest in alphabetical order
3065 .vitem &%-bI:help%&
3066 .oindex "&%-bI:help%&"
3067 .cindex "querying exim information"
3068 We shall provide various options starting &`-bI:`& for querying Exim for
3069 information.  The output of many of these will be intended for machine
3070 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3071 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3072 options shall cause Exim to exit after producing the requested output.
3073
3074 .vitem &%-bI:dscp%&
3075 .oindex "&%-bI:dscp%&"
3076 .cindex "DSCP" "values"
3077 This option causes Exim to emit an alphabetically sorted list of all
3078 recognised DSCP names.
3079
3080 .vitem &%-bI:sieve%&
3081 .oindex "&%-bI:sieve%&"
3082 .cindex "Sieve filter" "capabilities"
3083 This option causes Exim to emit an alphabetically sorted list of all supported
3084 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3085 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3086 &`SIEVE`& capability response line.  As the precise list may depend upon
3087 compile-time build options, which this option will adapt to, this is the only
3088 way to guarantee a correct response.
3089
3090 .vitem &%-bm%&
3091 .oindex "&%-bm%&"
3092 .cindex "local message reception"
3093 This option runs an Exim receiving process that accepts an incoming,
3094 locally-generated message on the standard input. The recipients are given as the
3095 command arguments (except when &%-t%& is also present &-- see below). Each
3096 argument can be a comma-separated list of RFC 2822 addresses. This is the
3097 default option for selecting the overall action of an Exim call; it is assumed
3098 if no other conflicting option is present.
3099
3100 If any addresses in the message are unqualified (have no domain), they are
3101 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3102 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3103 suppressing this for special cases.
3104
3105 Policy checks on the contents of local messages can be enforced by means of
3106 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3107
3108 .cindex "return code" "for &%-bm%&"
3109 The return code is zero if the message is successfully accepted. Otherwise, the
3110 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3111
3112 The format
3113 .cindex "message" "format"
3114 .cindex "format" "message"
3115 .cindex "&""From""& line"
3116 .cindex "UUCP" "&""From""& line"
3117 .cindex "Sendmail compatibility" "&""From""& line"
3118 of the message must be as defined in RFC 2822, except that, for
3119 compatibility with Sendmail and Smail, a line in one of the forms
3120 .code
3121 From sender Fri Jan  5 12:55 GMT 1997
3122 From sender Fri, 5 Jan 97 12:55:01
3123 .endd
3124 (with the weekday optional, and possibly with additional text after the date)
3125 is permitted to appear at the start of the message. There appears to be no
3126 authoritative specification of the format of this line. Exim recognizes it by
3127 matching against the regular expression defined by the &%uucp_from_pattern%&
3128 option, which can be changed if necessary.
3129
3130 .oindex "&%-f%&" "overriding &""From""& line"
3131 The specified sender is treated as if it were given as the argument to the
3132 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3133 preference to the address taken from the message. The caller of Exim must be a
3134 trusted user for the sender of a message to be set in this way.
3135
3136 .vitem &%-bmalware%&&~<&'filename'&>
3137 .oindex "&%-bmalware%&"
3138 .cindex "testing", "malware"
3139 .cindex "malware scan test"
3140 This debugging option causes Exim to scan the given file or directory
3141 (depending on the used scanner interface),
3142 using the malware scanning framework.  The option of &%av_scanner%& influences
3143 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3144 the expansion should have defaults which apply to this invocation.  ACLs are
3145 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3146 will never be populated and &%-bmalware%& will fail.
3147
3148 Exim will have changed working directory before resolving the filename, so
3149 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3150 user when it tries to open the file, rather than as the invoking user.
3151 This option requires admin privileges.
3152
3153 The &%-bmalware%& option will not be extended to be more generally useful,
3154 there are better tools for file-scanning.  This option exists to help
3155 administrators verify their Exim and AV scanner configuration.
3156
3157 .vitem &%-bnq%&
3158 .oindex "&%-bnq%&"
3159 .cindex "address qualification, suppressing"
3160 By default, Exim automatically qualifies unqualified addresses (those
3161 without domains) that appear in messages that are submitted locally (that
3162 is, not over TCP/IP). This qualification applies both to addresses in
3163 envelopes, and addresses in header lines. Sender addresses are qualified using
3164 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3165 defaults to the value of &%qualify_domain%&).
3166
3167 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3168 being used to re-submit messages that originally came from remote hosts after
3169 content scanning, you probably do not want to qualify unqualified addresses in
3170 header lines. (Such lines will be present only if you have not enabled a header
3171 syntax check in the appropriate ACL.)
3172
3173 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3174 messages that originate on the local host. When this is used, unqualified
3175 addresses in the envelope provoke errors (causing message rejection) and
3176 unqualified addresses in header lines are left alone.
3177
3178
3179 .vitem &%-bP%&
3180 .oindex "&%-bP%&"
3181 .cindex "configuration options" "extracting"
3182 .cindex "options" "configuration &-- extracting"
3183 If this option is given with no arguments, it causes the values of all Exim's
3184 main configuration options to be written to the standard output. The values
3185 of one or more specific options can be requested by giving their names as
3186 arguments, for example:
3187 .code
3188 exim -bP qualify_domain hold_domains
3189 .endd
3190 .cindex "hiding configuration option values"
3191 .cindex "configuration options" "hiding value of"
3192 .cindex "options" "hiding value of"
3193 However, any option setting that is preceded by the word &"hide"& in the
3194 configuration file is not shown in full, except to an admin user. For other
3195 users, the output is as in this example:
3196 .code
3197 mysql_servers = <value not displayable>
3198 .endd
3199 If &%config%& is given as an argument, the config is
3200 output, as it was parsed, any include file resolved, any comment removed.
3201
3202 If &%config_file%& is given as an argument, the name of the runtime
3203 configuration file is output. (&%configure_file%& works too, for
3204 backward compatibility.)
3205 If a list of configuration files was supplied, the value that is output here
3206 is the name of the file that was actually used.
3207
3208 .cindex "options" "hiding name of"
3209 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3210 name will not be output.
3211
3212 .cindex "daemon" "process id (pid)"
3213 .cindex "pid (process id)" "of daemon"
3214 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3215 directories where log files and daemon pid files are written are output,
3216 respectively. If these values are unset, log files are written in a
3217 sub-directory of the spool directory called &%log%&, and the pid file is
3218 written directly into the spool directory.
3219
3220 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3221 .code
3222 exim -bP +local_domains
3223 .endd
3224 it searches for a matching named list of any type (domain, host, address, or
3225 local part) and outputs what it finds.
3226
3227 .cindex "options" "router &-- extracting"
3228 .cindex "options" "transport &-- extracting"
3229 .cindex "options" "authenticator &-- extracting"
3230 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3231 followed by the name of an appropriate driver instance, the option settings for
3232 that driver are output. For example:
3233 .code
3234 exim -bP transport local_delivery
3235 .endd
3236 The generic driver options are output first, followed by the driver's private
3237 options. A list of the names of drivers of a particular type can be obtained by
3238 using one of the words &%router_list%&, &%transport_list%&, or
3239 &%authenticator_list%&, and a complete list of all drivers with their option
3240 settings can be obtained by using &%routers%&, &%transports%&, or
3241 &%authenticators%&.
3242
3243 .cindex "environment"
3244 If &%environment%& is given as an argument, the set of environment
3245 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3246 variables.
3247
3248 .cindex "options" "macro &-- extracting"
3249 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3250 are available, similarly to the drivers.  Because macros are sometimes used
3251 for storing passwords, this option is restricted.
3252 The output format is one item per line.
3253 For the "-bP macro <name>" form, if no such macro is found
3254 the exit status will be nonzero.
3255
3256 .vitem &%-bp%&
3257 .oindex "&%-bp%&"
3258 .cindex "queue" "listing messages in"
3259 .cindex "listing" "messages in the queue"
3260 This option requests a listing of the contents of the mail queue on the
3261 standard output. If the &%-bp%& option is followed by a list of message ids,
3262 just those messages are listed. By default, this option can be used only by an
3263 admin user. However, the &%queue_list_requires_admin%& option can be set false
3264 to allow any user to see the queue.
3265
3266 Each message in the queue is displayed as in the following example:
3267 .code
3268 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3269           red.king@looking-glass.fict.example
3270           <other addresses>
3271 .endd
3272 .cindex "message" "size in queue listing"
3273 .cindex "size" "of message"
3274 The first line contains the length of time the message has been in the queue
3275 (in this case 25 minutes), the size of the message (2.9K), the unique local
3276 identifier for the message, and the message sender, as contained in the
3277 envelope. For bounce messages, the sender address is empty, and appears as
3278 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3279 the default sender address, the user's login name is shown in parentheses
3280 before the sender address.
3281
3282 .cindex "frozen messages" "in queue listing"
3283 If the message is frozen (attempts to deliver it are suspended) then the text
3284 &"*** frozen ***"& is displayed at the end of this line.
3285
3286 The recipients of the message (taken from the envelope, not the headers) are
3287 displayed on subsequent lines. Those addresses to which the message has already
3288 been delivered are marked with the letter D. If an original address gets
3289 expanded into several addresses via an alias or forward file, the original is
3290 displayed with a D only when deliveries for all of its child addresses are
3291 complete.
3292
3293
3294 .vitem &%-bpa%&
3295 .oindex "&%-bpa%&"
3296 This option operates like &%-bp%&, but in addition it shows delivered addresses
3297 that were generated from the original top level address(es) in each message by
3298 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3299 of just &"D"&.
3300
3301
3302 .vitem &%-bpc%&
3303 .oindex "&%-bpc%&"
3304 .cindex "queue" "count of messages on"
3305 This option counts the number of messages in the queue, and writes the total
3306 to the standard output. It is restricted to admin users, unless
3307 &%queue_list_requires_admin%& is set false.
3308
3309
3310 .vitem &%-bpr%&
3311 .oindex "&%-bpr%&"
3312 This option operates like &%-bp%&, but the output is not sorted into
3313 chronological order of message arrival. This can speed it up when there are
3314 lots of messages in the queue, and is particularly useful if the output is
3315 going to be post-processed in a way that doesn't need the sorting.
3316
3317 .vitem &%-bpra%&
3318 .oindex "&%-bpra%&"
3319 This option is a combination of &%-bpr%& and &%-bpa%&.
3320
3321 .vitem &%-bpru%&
3322 .oindex "&%-bpru%&"
3323 This option is a combination of &%-bpr%& and &%-bpu%&.
3324
3325
3326 .vitem &%-bpu%&
3327 .oindex "&%-bpu%&"
3328 This option operates like &%-bp%& but shows only undelivered top-level
3329 addresses for each message displayed. Addresses generated by aliasing or
3330 forwarding are not shown, unless the message was deferred after processing by a
3331 router with the &%one_time%& option set.
3332
3333
3334 .vitem &%-brt%&
3335 .oindex "&%-brt%&"
3336 .cindex "testing" "retry configuration"
3337 .cindex "retry" "configuration testing"
3338 This option is for testing retry rules, and it must be followed by up to three
3339 arguments. It causes Exim to look for a retry rule that matches the values
3340 and to write it to the standard output. For example:
3341 .code
3342 exim -brt bach.comp.mus.example
3343 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3344 .endd
3345 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3346 argument, which is required, can be a complete address in the form
3347 &'local_part@domain'&, or it can be just a domain name. If the second argument
3348 contains a dot, it is interpreted as an optional second domain name; if no
3349 retry rule is found for the first argument, the second is tried. This ties in
3350 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3351 rule is found that matches the host, one that matches the mail domain is
3352 sought. Finally, an argument that is the name of a specific delivery error, as
3353 used in setting up retry rules, can be given. For example:
3354 .code
3355 exim -brt haydn.comp.mus.example quota_3d
3356 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3357 .endd
3358
3359 .vitem &%-brw%&
3360 .oindex "&%-brw%&"
3361 .cindex "testing" "rewriting"
3362 .cindex "rewriting" "testing"
3363 This option is for testing address rewriting rules, and it must be followed by
3364 a single argument, consisting of either a local part without a domain, or a
3365 complete address with a fully qualified domain. Exim outputs how this address
3366 would be rewritten for each possible place it might appear. See chapter
3367 &<<CHAPrewrite>>& for further details.
3368
3369 .vitem &%-bS%&
3370 .oindex "&%-bS%&"
3371 .cindex "SMTP" "batched incoming"
3372 .cindex "batched SMTP input"
3373 This option is used for batched SMTP input, which is an alternative interface
3374 for non-interactive local message submission. A number of messages can be
3375 submitted in a single run. However, despite its name, this is not really SMTP
3376 input. Exim reads each message's envelope from SMTP commands on the standard
3377 input, but generates no responses. If the caller is trusted, or
3378 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3379 believed; otherwise the sender is always the caller of Exim.
3380
3381 The message itself is read from the standard input, in SMTP format (leading
3382 dots doubled), terminated by a line containing just a single dot. An error is
3383 provoked if the terminating dot is missing. A further message may then follow.
3384
3385 As for other local message submissions, the contents of incoming batch SMTP
3386 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3387 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3388 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3389
3390 Some other SMTP commands are recognized in the input. HELO and EHLO act
3391 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3392 QUIT quits, ignoring the rest of the standard input.
3393
3394 .cindex "return code" "for &%-bS%&"
3395 If any error is encountered, reports are written to the standard output and
3396 error streams, and Exim gives up immediately. The return code is 0 if no error
3397 was detected; it is 1 if one or more messages were accepted before the error
3398 was detected; otherwise it is 2.
3399
3400 More details of input using batched SMTP are given in section
3401 &<<SECTincomingbatchedSMTP>>&.
3402
3403 .vitem &%-bs%&
3404 .oindex "&%-bs%&"
3405 .cindex "SMTP" "local input"
3406 .cindex "local SMTP input"
3407 This option causes Exim to accept one or more messages by reading SMTP commands
3408 on the standard input, and producing SMTP replies on the standard output. SMTP
3409 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3410 Some user agents use this interface as a way of passing locally-generated
3411 messages to the MTA.
3412
3413 In
3414 .cindex "sender" "source of"
3415 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3416 set, the senders of messages are taken from the SMTP MAIL commands.
3417 Otherwise the content of these commands is ignored and the sender is set up as
3418 the calling user. Unqualified addresses are automatically qualified using
3419 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3420 &%-bnq%& option is used.
3421
3422 .cindex "inetd"
3423 The
3424 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3425 using a listening daemon. Exim can distinguish the two cases by checking
3426 whether the standard input is a TCP/IP socket. When Exim is called from
3427 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3428 above concerning senders and qualification do not apply. In this situation,
3429 Exim behaves in exactly the same way as it does when receiving a message via
3430 the listening daemon.
3431
3432 .vitem &%-bt%&
3433 .oindex "&%-bt%&"
3434 .cindex "testing" "addresses"
3435 .cindex "address" "testing"
3436 This option runs Exim in address testing mode, in which each argument is taken
3437 as a recipient address to be tested for deliverability. The results are
3438 written to the standard output. If a test fails, and the caller is not an admin
3439 user, no details of the failure are output, because these might contain
3440 sensitive information such as usernames and passwords for database lookups.
3441
3442 If no arguments are given, Exim runs in an interactive manner, prompting with a
3443 right angle bracket for addresses to be tested.
3444
3445 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3446 &[readline()]& function, because it is running as &'root'& and there are
3447 security issues.
3448
3449 Each address is handled as if it were the recipient address of a message
3450 (compare the &%-bv%& option). It is passed to the routers and the result is
3451 written to the standard output. However, any router that has
3452 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3453 genuine routing tests if your first router passes everything to a scanner
3454 program.
3455
3456 .cindex "return code" "for &%-bt%&"
3457 The return code is 2 if any address failed outright; it is 1 if no address
3458 failed outright but at least one could not be resolved for some reason. Return
3459 code 0 is given only when all addresses succeed.
3460
3461 .cindex "duplicate addresses"
3462 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3463 addresses after routing is complete, so that only one delivery takes place.
3464 This does not happen when testing with &%-bt%&; the full results of routing are
3465 always shown.
3466
3467 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3468 routers in the configuration makes any tests on the sender address of a
3469 message,
3470 .oindex "&%-f%&" "for address testing"
3471 you can use the &%-f%& option to set an appropriate sender when running
3472 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3473 default qualifying domain. However, if you have set up (for example) routers
3474 whose behaviour depends on the contents of an incoming message, you cannot test
3475 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3476 doing such tests.
3477
3478 .vitem &%-bV%&
3479 .oindex "&%-bV%&"
3480 .cindex "version number of Exim"
3481 This option causes Exim to write the current version number, compilation
3482 number, and compilation date of the &'exim'& binary to the standard output.
3483 It also lists the DBM library that is being used, the optional modules (such as
3484 specific lookup types), the drivers that are included in the binary, and the
3485 name of the runtime configuration file that is in use.
3486
3487 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3488 configuration file. However, this is a static check only. It cannot check
3489 values that are to be expanded. For example, although a misspelt ACL verb is
3490 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3491 alone to discover (for example) all the typos in the configuration; some
3492 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3493 dynamic testing facilities.
3494
3495 .vitem &%-bv%&
3496 .oindex "&%-bv%&"
3497 .cindex "verifying address" "using &%-bv%&"
3498 .cindex "address" "verification"
3499 This option runs Exim in address verification mode, in which each argument is
3500 taken as a recipient address to be verified by the routers. (This does
3501 not involve any verification callouts). During normal operation, verification
3502 happens mostly as a consequence processing a &%verify%& condition in an ACL
3503 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3504 including callouts, see the &%-bh%& and &%-bhc%& options.
3505
3506 If verification fails, and the caller is not an admin user, no details of the
3507 failure are output, because these might contain sensitive information such as
3508 usernames and passwords for database lookups.
3509
3510 If no arguments are given, Exim runs in an interactive manner, prompting with a
3511 right angle bracket for addresses to be verified.
3512
3513 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3514 &[readline()]& function, because it is running as &'exim'& and there are
3515 security issues.
3516
3517 Verification differs from address testing (the &%-bt%& option) in that routers
3518 that have &%no_verify%& set are skipped, and if the address is accepted by a
3519 router that has &%fail_verify%& set, verification fails. The address is
3520 verified as a recipient if &%-bv%& is used; to test verification for a sender
3521 address, &%-bvs%& should be used.
3522
3523 If the &%-v%& option is not set, the output consists of a single line for each
3524 address, stating whether it was verified or not, and giving a reason in the
3525 latter case. Without &%-v%&, generating more than one address by redirection
3526 causes verification to end successfully, without considering the generated
3527 addresses. However, if just one address is generated, processing continues,
3528 and the generated address must verify successfully for the overall verification
3529 to succeed.
3530
3531 When &%-v%& is set, more details are given of how the address has been handled,
3532 and in the case of address redirection, all the generated addresses are also
3533 considered. Verification may succeed for some and fail for others.
3534
3535 The
3536 .cindex "return code" "for &%-bv%&"
3537 return code is 2 if any address failed outright; it is 1 if no address
3538 failed outright but at least one could not be resolved for some reason. Return
3539 code 0 is given only when all addresses succeed.
3540
3541 If any of the routers in the configuration makes any tests on the sender
3542 address of a message, you should use the &%-f%& option to set an appropriate
3543 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3544 calling user at the default qualifying domain.
3545
3546 .vitem &%-bvs%&
3547 .oindex "&%-bvs%&"
3548 This option acts like &%-bv%&, but verifies the address as a sender rather
3549 than a recipient address. This affects any rewriting and qualification that
3550 might happen.
3551
3552 .vitem &%-bw%&
3553 .oindex "&%-bw%&"
3554 .cindex "daemon"
3555 .cindex "inetd"
3556 .cindex "inetd" "wait mode"
3557 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3558 similarly to the &%-bd%& option.  All port specifications on the command-line
3559 and in the configuration file are ignored.  Queue-running may not be specified.
3560
3561 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3562 listening for connections.  This permits the system to start up and have
3563 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3564 each port only when the first connection is received.
3565
3566 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3567 which the daemon will exit, which should cause inetd to listen once more.
3568
3569 .vitem &%-C%&&~<&'filelist'&>
3570 .oindex "&%-C%&"
3571 .cindex "configuration file" "alternate"
3572 .cindex "CONFIGURE_FILE"
3573 .cindex "alternate configuration file"
3574 This option causes Exim to find the runtime configuration file from the given
3575 list instead of from the list specified by the CONFIGURE_FILE
3576 compile-time setting. Usually, the list will consist of just a single filename,
3577 but it can be a colon-separated list of names. In this case, the first
3578 file that exists is used. Failure to open an existing file stops Exim from
3579 proceeding any further along the list, and an error is generated.
3580
3581 When this option is used by a caller other than root, and the list is different
3582 from the compiled-in list, Exim gives up its root privilege immediately, and
3583 runs with the real and effective uid and gid set to those of the caller.
3584 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3585 file contains a list of full pathnames, one per line, for configuration files
3586 which are trusted. Root privilege is retained for any configuration file so
3587 listed, as long as the caller is the Exim user (or the user specified in the
3588 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3589 not writeable by inappropriate users or groups.
3590
3591 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3592 configuration using &%-C%& right through message reception and delivery,
3593 even if the caller is root. The reception works, but by that time, Exim is
3594 running as the Exim user, so when it re-executes to regain privilege for the
3595 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3596 test reception and delivery using two separate commands (one to put a message
3597 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3598
3599 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3600 prefix string with which any file named in a &%-C%& command line option
3601 must start. In addition, the filename must not contain the sequence &`/../`&.
3602 However, if the value of the &%-C%& option is identical to the value of
3603 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3604 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3605 unset, any filename can be used with &%-C%&.
3606
3607 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3608 to a directory to which only root has access. This prevents someone who has
3609 broken into the Exim account from running a privileged Exim with an arbitrary
3610 configuration file.
3611
3612 The &%-C%& facility is useful for ensuring that configuration files are
3613 syntactically correct, but cannot be used for test deliveries, unless the
3614 caller is privileged, or unless it is an exotic configuration that does not
3615 require privilege. No check is made on the owner or group of the files
3616 specified by this option.
3617
3618
3619 .vitem &%-D%&<&'macro'&>=<&'value'&>
3620 .oindex "&%-D%&"
3621 .cindex "macro" "setting on command line"
3622 This option can be used to override macro definitions in the configuration file
3623 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3624 unprivileged caller, it causes Exim to give up its root privilege.
3625 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3626 completely disabled, and its use causes an immediate error exit.
3627
3628 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3629 colon-separated list of macros which are considered safe and, if &%-D%& only
3630 supplies macros from this list, and the values are acceptable, then Exim will
3631 not give up root privilege if the caller is root, the Exim run-time user, or
3632 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3633 to be removed in the future.  Acceptable values for the macros satisfy the
3634 regexp: &`^[A-Za-z0-9_/.-]*$`&
3635
3636 The entire option (including equals sign if present) must all be within one
3637 command line item. &%-D%& can be used to set the value of a macro to the empty
3638 string, in which case the equals sign is optional. These two commands are
3639 synonymous:
3640 .code
3641 exim -DABC  ...
3642 exim -DABC= ...
3643 .endd
3644 To include spaces in a macro definition item, quotes must be used. If you use
3645 quotes, spaces are permitted around the macro name and the equals sign. For
3646 example:
3647 .code
3648 exim '-D ABC = something' ...
3649 .endd
3650 &%-D%& may be repeated up to 10 times on a command line.
3651 Only macro names up to 22 letters long can be set.
3652
3653
3654 .vitem &%-d%&<&'debug&~options'&>
3655 .oindex "&%-d%&"
3656 .cindex "debugging" "list of selectors"
3657 .cindex "debugging" "&%-d%& option"
3658 This option causes debugging information to be written to the standard
3659 error stream. It is restricted to admin users because debugging output may show
3660 database queries that contain password information. Also, the details of users'
3661 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3662 writes an error message to the standard error stream and exits with a non-zero
3663 return code.
3664
3665 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3666 standard debugging data is output. This can be reduced, or increased to include
3667 some more rarely needed information, by directly following &%-d%& with a string
3668 made up of names preceded by plus or minus characters. These add or remove sets
3669 of debugging data, respectively. For example, &%-d+filter%& adds filter
3670 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3671 no spaces are allowed in the debug setting. The available debugging categories
3672 are:
3673 .display
3674 &`acl            `& ACL interpretation
3675 &`auth           `& authenticators
3676 &`deliver        `& general delivery logic
3677 &`dns            `& DNS lookups (see also resolver)
3678 &`dnsbl          `& DNS black list (aka RBL) code
3679 &`exec           `& arguments for &[execv()]& calls
3680 &`expand         `& detailed debugging for string expansions
3681 &`filter         `& filter handling
3682 &`hints_lookup   `& hints data lookups
3683 &`host_lookup    `& all types of name-to-IP address handling
3684 &`ident          `& ident lookup
3685 &`interface      `& lists of local interfaces
3686 &`lists          `& matching things in lists
3687 &`load           `& system load checks
3688 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3689                     &<<CHAPlocalscan>>&)
3690 &`lookup         `& general lookup code and all lookups
3691 &`memory         `& memory handling
3692 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3693 &`pid            `& modifier: add pid to debug output lines
3694 &`process_info   `& setting info for the process log
3695 &`queue_run      `& queue runs
3696 &`receive        `& general message reception logic
3697 &`resolver       `& turn on the DNS resolver's debugging output
3698 &`retry          `& retry handling
3699 &`rewrite        `& address rewriting
3700 &`route          `& address routing
3701 &`timestamp      `& modifier: add timestamp to debug output lines
3702 &`tls            `& TLS logic
3703 &`transport      `& transports
3704 &`uid            `& changes of uid/gid and looking up uid/gid
3705 &`verify         `& address verification logic
3706 &`all            `& almost all of the above (see below), and also &%-v%&
3707 .endd
3708 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3709 for &`-all`&. The reason for this is that &`+all`& is something that people
3710 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3711 is included, an awful lot of output that is very rarely of interest is
3712 generated, so it now has to be explicitly requested. However, &`-all`& does
3713 turn everything off.
3714
3715 .cindex "resolver, debugging output"
3716 .cindex "DNS resolver, debugging output"
3717 The &`resolver`& option produces output only if the DNS resolver was compiled
3718 with DEBUG enabled. This is not the case in some operating systems. Also,
3719 unfortunately, debugging output from the DNS resolver is written to stdout
3720 rather than stderr.
3721
3722 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3723 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3724 However, the &`pid`& selector is forced when debugging is turned on for a
3725 daemon, which then passes it on to any re-executed Exims. Exim also
3726 automatically adds the pid to debug lines when several remote deliveries are
3727 run in parallel.
3728
3729 The &`timestamp`& selector causes the current time to be inserted at the start
3730 of all debug output lines. This can be useful when trying to track down delays
3731 in processing.
3732
3733 .cindex debugging "UTF-8 in"
3734 .cindex UTF-8 "in debug output"
3735 The &`noutf8`& selector disables the use of
3736 UTF-8 line-drawing characters to group related information.
3737 When disabled. ascii-art is used instead.
3738 Using the &`+all`& option does not set this modifier,
3739
3740 If the &%debug_print%& option is set in any driver, it produces output whenever
3741 any debugging is selected, or if &%-v%& is used.
3742
3743 .vitem &%-dd%&<&'debug&~options'&>
3744 .oindex "&%-dd%&"
3745 This option behaves exactly like &%-d%& except when used on a command that
3746 starts a daemon process. In that case, debugging is turned off for the
3747 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3748 behaviour of the daemon without creating as much output as full debugging does.
3749
3750 .vitem &%-dropcr%&
3751 .oindex "&%-dropcr%&"
3752 This is an obsolete option that is now a no-op. It used to affect the way Exim
3753 handled CR and LF characters in incoming messages. What happens now is
3754 described in section &<<SECTlineendings>>&.
3755
3756 .vitem &%-E%&
3757 .oindex "&%-E%&"
3758 .cindex "bounce message" "generating"
3759 This option specifies that an incoming message is a locally-generated delivery
3760 failure report. It is used internally by Exim when handling delivery failures
3761 and is not intended for external use. Its only effect is to stop Exim
3762 generating certain messages to the postmaster, as otherwise message cascades
3763 could occur in some situations. As part of the same option, a message id may
3764 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3765 new message contains the id, following &"R="&, as a cross-reference.
3766
3767 .vitem &%-e%&&'x'&
3768 .oindex "&%-e%&&'x'&"
3769 There are a number of Sendmail options starting with &%-oe%& which seem to be
3770 called by various programs without the leading &%o%& in the option. For
3771 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3772 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3773
3774 .vitem &%-F%&&~<&'string'&>
3775 .oindex "&%-F%&"
3776 .cindex "sender" "name"
3777 .cindex "name" "of sender"
3778 This option sets the sender's full name for use when a locally-generated
3779 message is being accepted. In the absence of this option, the user's &'gecos'&
3780 entry from the password data is used. As users are generally permitted to alter
3781 their &'gecos'& entries, no security considerations are involved. White space
3782 between &%-F%& and the <&'string'&> is optional.
3783
3784 .vitem &%-f%&&~<&'address'&>
3785 .oindex "&%-f%&"
3786 .cindex "sender" "address"
3787 .cindex "address" "sender"
3788 .cindex "trusted users"
3789 .cindex "envelope from"
3790 .cindex "envelope sender"
3791 .cindex "user" "trusted"
3792 This option sets the address of the envelope sender of a locally-generated
3793 message (also known as the return path). The option can normally be used only
3794 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3795 users to use it.
3796
3797 Processes running as root or the Exim user are always trusted. Other
3798 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3799 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3800 of a local message is set to the caller's login name at the default qualify
3801 domain.
3802
3803 There is one exception to the restriction on the use of &%-f%&: an empty sender
3804 can be specified by any user, trusted or not, to create a message that can
3805 never provoke a bounce. An empty sender can be specified either as an empty
3806 string, or as a pair of angle brackets with nothing between them, as in these
3807 examples of shell commands:
3808 .code
3809 exim -f '<>' user@domain
3810 exim -f "" user@domain
3811 .endd
3812 In addition, the use of &%-f%& is not restricted when testing a filter file
3813 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3814 &%-bv%& options.
3815
3816 Allowing untrusted users to change the sender address does not of itself make
3817 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3818 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3819 though this can be overridden by setting &%no_local_from_check%&.
3820
3821 White
3822 .cindex "&""From""& line"
3823 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3824 given as two arguments or one combined argument). The sender of a
3825 locally-generated message can also be set (when permitted) by an initial
3826 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3827 if &%-f%& is also present, it overrides &"From&~"&.
3828
3829 .vitem &%-G%&
3830 .oindex "&%-G%&"
3831 .cindex "submission fixups, suppressing (command-line)"
3832 This option is equivalent to an ACL applying:
3833 .code
3834 control = suppress_local_fixups
3835 .endd
3836 for every message received.  Note that Sendmail will complain about such
3837 bad formatting, where Exim silently just does not fix it up.  This may change
3838 in future.
3839
3840 As this affects audit information, the caller must be a trusted user to use
3841 this option.
3842
3843 .vitem &%-h%&&~<&'number'&>
3844 .oindex "&%-h%&"
3845 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3846 This option is accepted for compatibility with Sendmail, but has no effect. (In
3847 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3848 headers.)
3849
3850 .vitem &%-i%&
3851 .oindex "&%-i%&"
3852 .cindex "Solaris" "&'mail'& command"
3853 .cindex "dot" "in incoming non-SMTP message"
3854 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3855 line by itself should not terminate an incoming, non-SMTP message.
3856 Solaris 2.4 (SunOS 5.4) Sendmail has a similar &%-i%& processing option
3857 &url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf),
3858 p. 1M-529), and therefore a &%-oi%& command line option, which both are used
3859 by its &'mailx'& command.
3860
3861 .vitem &%-L%&&~<&'tag'&>
3862 .oindex "&%-L%&"
3863 .cindex "syslog" "process name; set with flag"
3864 This option is equivalent to setting &%syslog_processname%& in the config
3865 file and setting &%log_file_path%& to &`syslog`&.
3866 Its use is restricted to administrators.  The configuration file has to be
3867 read and parsed, to determine access rights, before this is set and takes
3868 effect, so early configuration file errors will not honour this flag.
3869
3870 The tag should not be longer than 32 characters.
3871
3872 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3873 .oindex "&%-M%&"
3874 .cindex "forcing delivery"
3875 .cindex "delivery" "forcing attempt"
3876 .cindex "frozen messages" "forcing delivery"
3877 This option requests Exim to run a delivery attempt on each message in turn. If
3878 any of the messages are frozen, they are automatically thawed before the
3879 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3880 and &%hold_domains%& are ignored.
3881
3882 Retry
3883 .cindex "hints database" "overriding retry hints"
3884 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3885 the normal retry time has not yet been reached. This option requires the caller
3886 to be an admin user. However, there is an option called &%prod_requires_admin%&
3887 which can be set false to relax this restriction (and also the same requirement
3888 for the &%-q%&, &%-R%&, and &%-S%& options).
3889
3890 The deliveries happen synchronously, that is, the original Exim process does
3891 not terminate until all the delivery attempts have finished. No output is
3892 produced unless there is a serious error. If you want to see what is happening,
3893 use the &%-v%& option as well, or inspect Exim's main log.
3894
3895 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3896 .oindex "&%-Mar%&"
3897 .cindex "message" "adding recipients"
3898 .cindex "recipient" "adding"
3899 This option requests Exim to add the addresses to the list of recipients of the
3900 message (&"ar"& for &"add recipients"&). The first argument must be a message
3901 id, and the remaining ones must be email addresses. However, if the message is
3902 active (in the middle of a delivery attempt), it is not altered. This option
3903 can be used only by an admin user.
3904
3905 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&&&
3906         &~<&'host&~IP'&>&&&
3907         &~<&'sequence&~number'&>&&&
3908         &~<&'message&~id'&>"
3909 .oindex "&%-MC%&"
3910 .cindex "SMTP" "passed connection"
3911 .cindex "SMTP" "multiple deliveries"
3912 .cindex "multiple SMTP deliveries"
3913 This option is not intended for use by external callers. It is used internally
3914 by Exim to invoke another instance of itself to deliver a waiting message using
3915 an existing SMTP connection, which is passed as the standard input. Details are
3916 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3917 must be root or the Exim user in order to use it.
3918
3919 .vitem &%-MCA%&
3920 .oindex "&%-MCA%&"
3921 This option is not intended for use by external callers. It is used internally
3922 by Exim in conjunction with the &%-MC%& option. It signifies that the
3923 connection to the remote host has been authenticated.
3924
3925 .vitem &%-MCD%&
3926 .oindex "&%-MCD%&"
3927 This option is not intended for use by external callers. It is used internally
3928 by Exim in conjunction with the &%-MC%& option. It signifies that the
3929 remote host supports the ESMTP &_DSN_& extension.
3930
3931 .vitem &%-MCd%&
3932 .oindex "&%-MCd%&"
3933 This option is not intended for use by external callers. It is used internally
3934 by Exim in conjunction with the &%-d%& option
3935 to pass on an information string on the purpose of the process.
3936
3937 .vitem &%-MCG%&&~<&'queue&~name'&>
3938 .oindex "&%-MCG%&"
3939 This option is not intended for use by external callers. It is used internally
3940 by Exim in conjunction with the &%-MC%& option. It signifies that an
3941 alternate queue is used, named by the following argument.
3942
3943 .vitem &%-MCK%&
3944 .oindex "&%-MCK%&"
3945 This option is not intended for use by external callers. It is used internally
3946 by Exim in conjunction with the &%-MC%& option. It signifies that a
3947 remote host supports the ESMTP &_CHUNKING_& extension.
3948
3949 .vitem &%-MCL%&
3950 .oindex "&%-MCL%&"
3951 This option is not intended for use by external callers. It is used internally
3952 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3953 which Exim is connected advertised limits on numbers of mails, recipients or
3954 recipient domains.
3955 The limits are given by the following three arguments.
3956
3957 .vitem &%-MCP%&
3958 .oindex "&%-MCP%&"
3959 This option is not intended for use by external callers. It is used internally
3960 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3961 which Exim is connected supports pipelining.
3962
3963 .vitem &%-MCp%&
3964 .oindex "&%-MCp%&"
3965 This option is not intended for use by external callers. It is used internally
3966 by Exim in conjunction with the &%-MC%& option. It signifies that the connection
3967 t a remote server is via a SOCKS proxy, using addresses and ports given by
3968 the following four arguments.
3969
3970 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3971 .oindex "&%-MCQ%&"
3972 This option is not intended for use by external callers. It is used internally
3973 by Exim in conjunction with the &%-MC%& option when the original delivery was
3974 started by a queue runner. It passes on the process id of the queue runner,
3975 together with the file descriptor number of an open pipe. Closure of the pipe
3976 signals the final completion of the sequence of processes that are passing
3977 messages through the same SMTP connection.
3978
3979 .vitem &%-MCq%&&~<&'recipient&~address'&>&~<&'size'&>
3980 .oindex "&%-MCq%&"
3981 This option is not intended for use by external callers. It is used internally
3982 by Exim to implement quota checking for local users.
3983
3984 .vitem &%-MCS%&
3985 .oindex "&%-MCS%&"
3986 This option is not intended for use by external callers. It is used internally
3987 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3988 ESMTP SIZE option should be used on messages delivered down the existing
3989 connection.
3990
3991 .vitem &%-MCT%&
3992 .oindex "&%-MCT%&"
3993 This option is not intended for use by external callers. It is used internally
3994 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3995 host to which Exim is connected supports TLS encryption.
3996
3997 .vitem &%-MCr%&&~<&'SNI'&> &&&
3998        &%-MCs%&&~<&'SNI'&>
3999 .oindex "&%-MCs%&"
4000 .oindex "&%-MCr%&"
4001 These options are not intended for use by external callers. It is used internally
4002 by Exim in conjunction with the &%-MCt%& option, and passes on the fact that
4003 a TLS Server Name Indication was sent as part of the channel establishment.
4004 The argument gives the SNI string.
4005 The "r" variant indicates a DANE-verified connection.
4006
4007 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
4008 .oindex "&%-MCt%&"
4009 This option is not intended for use by external callers. It is used internally
4010 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
4011 connection is being proxied by a parent process for handling TLS encryption.
4012 The arguments give the local address and port being proxied, and the TLS cipher.
4013
4014 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4015 .oindex "&%-Mc%&"
4016 .cindex "hints database" "not overridden by &%-Mc%&"
4017 .cindex "delivery" "manually started &-- not forced"
4018 This option requests Exim to run a delivery attempt on each message, in turn,
4019 but unlike the &%-M%& option, it does check for retry hints, and respects any
4020 that are found. This option is not very useful to external callers. It is
4021 provided mainly for internal use by Exim when it needs to re-invoke itself in
4022 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
4023 However, &%-Mc%& can be useful when testing, in order to run a delivery that
4024 respects retry times and other options such as &%hold_domains%& that are
4025 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
4026 If you want to run a specific delivery as if in a queue run, you should use
4027 &%-q%& with a message id argument. A distinction between queue run deliveries
4028 and other deliveries is made in one or two places.
4029
4030 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
4031 .oindex "&%-Mes%&"
4032 .cindex "message" "changing sender"
4033 .cindex "sender" "changing"
4034 This option requests Exim to change the sender address in the message to the
4035 given address, which must be a fully qualified address or &"<>"& (&"es"& for
4036 &"edit sender"&). There must be exactly two arguments. The first argument must
4037 be a message id, and the second one an email address. However, if the message
4038 is active (in the middle of a delivery attempt), its status is not altered.
4039 This option can be used only by an admin user.
4040
4041 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4042 .oindex "&%-Mf%&"
4043 .cindex "freezing messages"
4044 .cindex "message" "manually freezing"
4045 This option requests Exim to mark each listed message as &"frozen"&. This
4046 prevents any delivery attempts taking place until the message is &"thawed"&,
4047 either manually or as a result of the &%auto_thaw%& configuration option.
4048 However, if any of the messages are active (in the middle of a delivery
4049 attempt), their status is not altered. This option can be used only by an admin
4050 user.
4051
4052 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4053 .oindex "&%-Mg%&"
4054 .cindex "giving up on messages"
4055 .cindex "message" "abandoning delivery attempts"
4056 .cindex "delivery" "abandoning further attempts"
4057 This option requests Exim to give up trying to deliver the listed messages,
4058 including any that are frozen. However, if any of the messages are active,
4059 their status is not altered. For non-bounce messages, a delivery error message
4060 is sent to the sender, containing the text &"cancelled by administrator"&.
4061 Bounce messages are just discarded. This option can be used only by an admin
4062 user.
4063
4064 .vitem &%-MG%&&~<&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
4065 .oindex "&%-MG%&"
4066 .cindex queue named
4067 .cindex "named queues" "moving messages"
4068 .cindex "queue" "moving messages"
4069 This option requests that each listed message be moved from its current
4070 queue to the given named queue.
4071 The destination queue name argument is required, but can be an empty
4072 string to define the default queue.
4073 If the messages are not currently located in the default queue,
4074 a &%-qG<name>%& option will be required to define the source queue.
4075
4076 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4077 .oindex "&%-Mmad%&"
4078 .cindex "delivery" "cancelling all"
4079 This option requests Exim to mark all the recipient addresses in the messages
4080 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
4081 message is active (in the middle of a delivery attempt), its status is not
4082 altered. This option can be used only by an admin user.
4083
4084 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
4085 .oindex "&%-Mmd%&"
4086 .cindex "delivery" "cancelling by address"
4087 .cindex "recipient" "removing"
4088 .cindex "removing recipients"
4089 This option requests Exim to mark the given addresses as already delivered
4090 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
4091 the remaining ones must be email addresses. These are matched to recipient
4092 addresses in the message in a case-sensitive manner. If the message is active
4093 (in the middle of a delivery attempt), its status is not altered. This option
4094 can be used only by an admin user.
4095
4096 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4097 .oindex "&%-Mrm%&"
4098 .cindex "removing messages"
4099 .cindex "abandoning mail"
4100 .cindex "message" "manually discarding"
4101 This option requests Exim to remove the given messages from the queue. No
4102 bounce messages are sent; each message is simply forgotten. However, if any of
4103 the messages are active, their status is not altered. This option can be used
4104 only by an admin user or by the user who originally caused the message to be
4105 placed in the queue.
4106
4107 . .new
4108 . .vitem &%-MS%&
4109 . .oindex "&%-MS%&"
4110 . .cindex REQUIRETLS
4111 . This option is used to request REQUIRETLS processing on the message.
4112 . It is used internally by Exim in conjunction with -E when generating
4113 . a bounce message.
4114 . .wen
4115
4116 .vitem &%-Mset%&&~<&'message&~id'&>
4117 .oindex "&%-Mset%&"
4118 .cindex "testing" "string expansion"
4119 .cindex "expansion" "testing"
4120 This option is useful only in conjunction with &%-be%& (that is, when testing
4121 string expansions). Exim loads the given message from its spool before doing
4122 the test expansions, thus setting message-specific variables such as
4123 &$message_size$& and the header variables. The &$recipients$& variable is made
4124 available. This feature is provided to make it easier to test expansions that
4125 make use of these variables. However, this option can be used only by an admin
4126 user. See also &%-bem%&.
4127
4128 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4129 .oindex "&%-Mt%&"
4130 .cindex "thawing messages"
4131 .cindex "unfreezing messages"
4132 .cindex "frozen messages" "thawing"
4133 .cindex "message" "thawing frozen"
4134 This option requests Exim to &"thaw"& any of the listed messages that are
4135 &"frozen"&, so that delivery attempts can resume. However, if any of the
4136 messages are active, their status is not altered. This option can be used only
4137 by an admin user.
4138
4139 .vitem &%-Mvb%&&~<&'message&~id'&>
4140 .oindex "&%-Mvb%&"
4141 .cindex "listing" "message body"
4142 .cindex "message" "listing body of"
4143 This option causes the contents of the message body (-D) spool file to be
4144 written to the standard output. This option can be used only by an admin user.
4145
4146 .vitem &%-Mvc%&&~<&'message&~id'&>
4147 .oindex "&%-Mvc%&"
4148 .cindex "message" "listing in RFC 2822 format"
4149 .cindex "listing" "message in RFC 2822 format"
4150 This option causes a copy of the complete message (header lines plus body) to
4151 be written to the standard output in RFC 2822 format. This option can be used
4152 only by an admin user.
4153
4154 .vitem &%-Mvh%&&~<&'message&~id'&>
4155 .oindex "&%-Mvh%&"
4156 .cindex "listing" "message headers"
4157 .cindex "header lines" "listing"
4158 .cindex "message" "listing header lines"
4159 This option causes the contents of the message headers (-H) spool file to be
4160 written to the standard output. This option can be used only by an admin user.
4161
4162 .vitem &%-Mvl%&&~<&'message&~id'&>
4163 .oindex "&%-Mvl%&"
4164 .cindex "listing" "message log"
4165 .cindex "message" "listing message log"
4166 This option causes the contents of the message log spool file to be written to
4167 the standard output. This option can be used only by an admin user.
4168
4169 .vitem &%-m%&
4170 .oindex "&%-m%&"
4171 This is a synonym for &%-om%& that is accepted by Sendmail
4172 (&url(https://docs.oracle.com/cd/E19457-01/801-6680-1M/801-6680-1M.pdf)
4173 p. 1M-258), so Exim treats it that way too.
4174
4175 .vitem &%-N%&
4176 .oindex "&%-N%&"
4177 .cindex "debugging" "&%-N%& option"
4178 .cindex "debugging" "suppressing delivery"
4179 This is a debugging option that inhibits delivery of a message at the transport
4180 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4181 it just doesn't actually transport the message, but instead behaves as if it
4182 had successfully done so. However, it does not make any updates to the retry
4183 database, and the log entries for deliveries are flagged with &"*>"& rather
4184 than &"=>"&.
4185
4186 Because &%-N%& discards any message to which it applies, only root or the Exim
4187 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4188 words, an ordinary user can use it only when supplying an incoming message to
4189 which it will apply. Although transportation never fails when &%-N%& is set, an
4190 address may be deferred because of a configuration problem on a transport, or a
4191 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4192 the message, and applies to any subsequent delivery attempts that may happen
4193 for that message.
4194
4195 .vitem &%-n%&
4196 .oindex "&%-n%&"
4197 This option is interpreted by Sendmail to mean &"no aliasing"&.
4198 For normal modes of operation, it is ignored by Exim.
4199 When combined with &%-bP%& it makes the output more terse (suppresses
4200 option names, environment values and config pretty printing).
4201
4202 .vitem &%-O%&&~<&'data'&>
4203 .oindex "&%-O%&"
4204 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4205 Exim.
4206
4207 .vitem &%-oA%&&~<&'file&~name'&>
4208 .oindex "&%-oA%&"
4209 .cindex "Sendmail compatibility" "&%-oA%& option"
4210 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4211 alternative alias filename. Exim handles &%-bi%& differently; see the
4212 description above.
4213
4214 .vitem &%-oB%&&~<&'n'&>
4215 .oindex "&%-oB%&"
4216 .cindex "SMTP" "passed connection"
4217 .cindex "SMTP" "multiple deliveries"
4218 .cindex "multiple SMTP deliveries"
4219 This is a debugging option which limits the maximum number of messages that can
4220 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4221 transport. If <&'n'&> is omitted, the limit is set to 1.
4222
4223 .vitem &%-odb%&
4224 .oindex "&%-odb%&"
4225 .cindex "background delivery"
4226 .cindex "delivery" "in the background"
4227 This option applies to all modes in which Exim accepts incoming messages,
4228 including the listening daemon. It requests &"background"& delivery of such
4229 messages, which means that the accepting process automatically starts a
4230 delivery process for each message received, but does not wait for the delivery
4231 processes to finish.
4232
4233 When all the messages have been received, the reception process exits,
4234 leaving the delivery processes to finish in their own time. The standard output
4235 and error streams are closed at the start of each delivery process.
4236 This is the default action if none of the &%-od%& options are present.
4237
4238 If one of the queueing options in the configuration file
4239 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4240 overrides it if &%queue_only_override%& is set true, which is the default
4241 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4242
4243 .vitem &%-odf%&
4244 .oindex "&%-odf%&"
4245 .cindex "foreground delivery"
4246 .cindex "delivery" "in the foreground"
4247 This option requests &"foreground"& (synchronous) delivery when Exim has
4248 accepted a locally-generated message. (For the daemon it is exactly the same as
4249 &%-odb%&.) A delivery process is automatically started to deliver the message,
4250 and Exim waits for it to complete before proceeding.
4251
4252 The original Exim reception process does not finish until the delivery
4253 process for the final message has ended. The standard error stream is left open
4254 during deliveries.
4255
4256 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4257 false and one of the queueing options in the configuration file is in effect.
4258
4259 If there is a temporary delivery error during foreground delivery, the
4260 message is left in the queue for later delivery, and the original reception
4261 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4262 restricted configuration that never queues messages.
4263
4264
4265 .vitem &%-odi%&
4266 .oindex "&%-odi%&"
4267 This option is synonymous with &%-odf%&. It is provided for compatibility with
4268 Sendmail.
4269
4270 .vitem &%-odq%&
4271 .oindex "&%-odq%&"
4272 .cindex "non-immediate delivery"
4273 .cindex "delivery" "suppressing immediate"
4274 .cindex "queueing incoming messages"
4275 This option applies to all modes in which Exim accepts incoming messages,
4276 including the listening daemon. It specifies that the accepting process should
4277 not automatically start a delivery process for each message received. Messages
4278 are placed in the queue, and remain there until a subsequent queue runner
4279 process encounters them. There are several configuration options (such as
4280 &%queue_only%&) that can be used to queue incoming messages under certain
4281 conditions. This option overrides all of them and also &%-odqs%&. It always
4282 forces queueing.
4283
4284 .vitem &%-odqs%&
4285 .oindex "&%-odqs%&"
4286 .cindex "SMTP" "delaying delivery"
4287 .cindex "first pass routing"
4288 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4289 However, like &%-odb%& and &%-odi%&, this option has no effect if
4290 &%queue_only_override%& is false and one of the queueing options in the
4291 configuration file is in effect.
4292
4293 When &%-odqs%& does operate, a delivery process is started for each incoming
4294 message, in the background by default, but in the foreground if &%-odi%& is
4295 also present. The recipient addresses are routed, and local deliveries are done
4296 in the normal way. However, if any SMTP deliveries are required, they are not
4297 done at this time, so the message remains in the queue until a subsequent queue
4298 runner process encounters it. Because routing was done, Exim knows which
4299 messages are waiting for which hosts, and so a number of messages for the same
4300 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4301 configuration option has the same effect for specific domains. See also the
4302 &%-qq%& option.
4303
4304 .vitem &%-oee%&
4305 .oindex "&%-oee%&"
4306 .cindex "error" "reporting"
4307 If an error is detected while a non-SMTP message is being received (for
4308 example, a malformed address), the error is reported to the sender in a mail
4309 message.
4310
4311 .cindex "return code" "for &%-oee%&"
4312 Provided
4313 this error message is successfully sent, the Exim receiving process
4314 exits with a return code of zero. If not, the return code is 2 if the problem
4315 is that the original message has no recipients, or 1 for any other error.
4316 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4317
4318 .vitem &%-oem%&
4319 .oindex "&%-oem%&"
4320 .cindex "error" "reporting"
4321 .cindex "return code" "for &%-oem%&"
4322 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4323 return code, whether or not the error message was successfully sent.
4324 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4325
4326 .vitem &%-oep%&
4327 .oindex "&%-oep%&"
4328 .cindex "error" "reporting"
4329 If an error is detected while a non-SMTP message is being received, the
4330 error is reported by writing a message to the standard error file (stderr).
4331 .cindex "return code" "for &%-oep%&"
4332 The return code is 1 for all errors.
4333
4334 .vitem &%-oeq%&
4335 .oindex "&%-oeq%&"
4336 .cindex "error" "reporting"
4337 This option is supported for compatibility with Sendmail, but has the same
4338 effect as &%-oep%&.
4339
4340 .vitem &%-oew%&
4341 .oindex "&%-oew%&"
4342 .cindex "error" "reporting"
4343 This option is supported for compatibility with Sendmail, but has the same
4344 effect as &%-oem%&.
4345
4346 .vitem &%-oi%&
4347 .oindex "&%-oi%&"
4348 .cindex "dot" "in incoming non-SMTP message"
4349 This option, which has the same effect as &%-i%&, specifies that a dot on a
4350 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4351 single dot does terminate, though Exim does no special processing for other
4352 lines that start with a dot. This option is set by default if Exim is called as
4353 &'rmail'&. See also &%-ti%&.
4354
4355 .vitem &%-oitrue%&
4356 .oindex "&%-oitrue%&"
4357 This option is treated as synonymous with &%-oi%&.
4358
4359 .vitem &%-oMa%&&~<&'host&~address'&>
4360 .oindex "&%-oMa%&"
4361 .cindex "sender" "host address, specifying for local message"
4362 A number of options starting with &%-oM%& can be used to set values associated
4363 with remote hosts on locally-submitted messages (that is, messages not received
4364 over TCP/IP). These options can be used by any caller in conjunction with the
4365 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4366 other circumstances, they are ignored unless the caller is trusted.
4367
4368 The &%-oMa%& option sets the sender host address. This may include a port
4369 number at the end, after a full stop (period). For example:
4370 .code
4371 exim -bs -oMa 10.9.8.7.1234
4372 .endd
4373 An alternative syntax is to enclose the IP address in square brackets,
4374 followed by a colon and the port number:
4375 .code
4376 exim -bs -oMa [10.9.8.7]:1234
4377 .endd
4378 The IP address is placed in the &$sender_host_address$& variable, and the
4379 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4380 are present on the command line, the sender host IP address is taken from
4381 whichever one is last.
4382
4383 .vitem &%-oMaa%&&~<&'name'&>
4384 .oindex "&%-oMaa%&"
4385 .cindex "authentication" "name, specifying for local message"
4386 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4387 option sets the value of &$sender_host_authenticated$& (the authenticator
4388 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4389 This option can be used with &%-bh%& and &%-bs%& to set up an
4390 authenticated SMTP session without actually using the SMTP AUTH command.
4391
4392 .vitem &%-oMai%&&~<&'string'&>
4393 .oindex "&%-oMai%&"
4394 .cindex "authentication" "id, specifying for local message"
4395 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4396 option sets the value of &$authenticated_id$& (the id that was authenticated).
4397 This overrides the default value (the caller's login id, except with &%-bh%&,
4398 where there is no default) for messages from local sources. See chapter
4399 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4400
4401 .vitem &%-oMas%&&~<&'address'&>
4402 .oindex "&%-oMas%&"
4403 .cindex "authentication" "sender, specifying for local message"
4404 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4405 option sets the authenticated sender value in &$authenticated_sender$&. It
4406 overrides the sender address that is created from the caller's login id for
4407 messages from local sources, except when &%-bh%& is used, when there is no
4408 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4409 specified on a MAIL command overrides this value. See chapter
4410 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4411
4412 .vitem &%-oMi%&&~<&'interface&~address'&>
4413 .oindex "&%-oMi%&"
4414 .cindex "interface" "address, specifying for local message"
4415 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4416 option sets the IP interface address value. A port number may be included,
4417 using the same syntax as for &%-oMa%&. The interface address is placed in
4418 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4419
4420 .vitem &%-oMm%&&~<&'message&~reference'&>
4421 .oindex "&%-oMm%&"
4422 .cindex "message reference" "message reference, specifying for local message"
4423 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4424 option sets the message reference, e.g. message-id, and is logged during
4425 delivery. This is useful when some kind of audit trail is required to tie
4426 messages together. The format of the message reference is checked and will
4427 abort if the format is invalid. The option will only be accepted if exim is
4428 running in trusted mode, not as any regular user.
4429
4430 The best example of a message reference is when Exim sends a bounce message.
4431 The message reference is the message-id of the original message for which Exim
4432 is sending the bounce.
4433
4434 .vitem &%-oMr%&&~<&'protocol&~name'&>
4435 .oindex "&%-oMr%&"
4436 .cindex "protocol, specifying for local message"
4437 .vindex "&$received_protocol$&"
4438 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4439 option sets the received protocol value that is stored in
4440 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4441 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4442 SMTP protocol names (see the description of &$received_protocol$& in section
4443 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4444 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4445 be set by &%-oMr%&. Repeated use of this option is not supported.
4446
4447 .vitem &%-oMs%&&~<&'host&~name'&>
4448 .oindex "&%-oMs%&"
4449 .cindex "sender" "host name, specifying for local message"
4450 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4451 option sets the sender host name in &$sender_host_name$&. When this option is
4452 present, Exim does not attempt to look up a host name from an IP address; it
4453 uses the name it is given.
4454
4455 .vitem &%-oMt%&&~<&'ident&~string'&>
4456 .oindex "&%-oMt%&"
4457 .cindex "sender" "ident string, specifying for local message"
4458 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4459 option sets the sender ident value in &$sender_ident$&. The default setting for
4460 local callers is the login id of the calling process, except when &%-bh%& is
4461 used, when there is no default.
4462
4463 .vitem &%-om%&
4464 .oindex "&%-om%&"
4465 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4466 In Sendmail, this option means &"me too"&, indicating that the sender of a
4467 message should receive a copy of the message if the sender appears in an alias
4468 expansion. Exim always does this, so the option does nothing.
4469
4470 .vitem &%-oo%&
4471 .oindex "&%-oo%&"
4472 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4473 This option is ignored. In Sendmail it specifies &"old style headers"&,
4474 whatever that means.
4475
4476 .vitem &%-oP%&&~<&'path'&>
4477 .oindex "&%-oP%&"
4478 .cindex "pid (process id)" "of daemon"
4479 .cindex "daemon" "process id (pid)"
4480 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4481 value. The option specifies the file to which the process id of the daemon is
4482 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4483 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4484 because in those cases, the normal pid file is not used.
4485
4486 .vitem &%-oPX%&
4487 .oindex "&%-oPX%&"
4488 .cindex "pid (process id)" "of daemon"
4489 .cindex "daemon" "process id (pid)"
4490 This option is not intended for general use.
4491 The daemon uses it when terminating due to a SIGTEM, possibly in
4492 combination with &%-oP%&&~<&'path'&>.
4493 It causes the pid file to be removed.
4494
4495 .vitem &%-or%&&~<&'time'&>
4496 .oindex "&%-or%&"
4497 .cindex "timeout" "for non-SMTP input"
4498 This option sets a timeout value for incoming non-SMTP messages. If it is not
4499 set, Exim will wait forever for the standard input. The value can also be set
4500 by the &%receive_timeout%& option. The format used for specifying times is
4501 described in section &<<SECTtimeformat>>&.
4502
4503 .vitem &%-os%&&~<&'time'&>
4504 .oindex "&%-os%&"
4505 .cindex "timeout" "for SMTP input"
4506 .cindex "SMTP" "input timeout"
4507 This option sets a timeout value for incoming SMTP messages. The timeout
4508 applies to each SMTP command and block of data. The value can also be set by
4509 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4510 for specifying times is described in section &<<SECTtimeformat>>&.
4511
4512 .vitem &%-ov%&
4513 .oindex "&%-ov%&"
4514 This option has exactly the same effect as &%-v%&.
4515
4516 .vitem &%-oX%&&~<&'number&~or&~string'&>
4517 .oindex "&%-oX%&"
4518 .cindex "TCP/IP" "setting listening ports"
4519 .cindex "TCP/IP" "setting listening interfaces"
4520 .cindex "port" "receiving TCP/IP"
4521 This option is relevant only when the &%-bd%& (start listening daemon) option
4522 is also given. It controls which ports and interfaces the daemon uses. Details
4523 of the syntax, and how it interacts with configuration file options, are given
4524 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4525 file is written unless &%-oP%& is also present to specify a pid filename.
4526
4527 .vitem &%-oY%&
4528 .oindex &%-oY%&
4529 .cindex "daemon notifier socket"
4530 This option controls the creation of an inter-process communications endpoint
4531 by the Exim daemon.
4532 It is only relevant when the &%-bd%& (start listening daemon) option is also
4533 given.
4534 Normally the daemon creates this socket, unless a &%-oX%& and &*no*& &%-oP%&
4535 option is also present.
4536 If this option is given then the socket will not be created.  This could be
4537 required if the system is running multiple daemons.
4538
4539 The socket is currently used for
4540 .ilist
4541 fast ramp-up of queue runner processes
4542 .next
4543 obtaining a current queue size
4544 .endlist
4545
4546 .vitem &%-pd%&
4547 .oindex "&%-pd%&"
4548 .cindex "Perl" "starting the interpreter"
4549 This option applies when an embedded Perl interpreter is linked with Exim (see
4550 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4551 option, forcing the starting of the interpreter to be delayed until it is
4552 needed.
4553
4554 .vitem &%-ps%&
4555 .oindex "&%-ps%&"
4556 .cindex "Perl" "starting the interpreter"
4557 This option applies when an embedded Perl interpreter is linked with Exim (see
4558 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4559 option, forcing the starting of the interpreter to occur as soon as Exim is
4560 started.
4561
4562 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4563 .oindex "&%-p%&"
4564 For compatibility with Sendmail, this option is equivalent to
4565 .display
4566 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4567 .endd
4568 It sets the incoming protocol and host name (for trusted callers). The
4569 host name and its colon can be omitted when only the protocol is to be set.
4570 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4571 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4572 or &`s`& using this option (but that does not seem a real limitation).
4573 Repeated use of this option is not supported.
4574
4575 .vitem &%-q%&
4576 .oindex "&%-q%&"
4577 .cindex "queue runner" "starting manually"
4578 This option is normally restricted to admin users. However, there is a
4579 configuration option called &%prod_requires_admin%& which can be set false to
4580 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4581 and &%-S%& options).
4582
4583 .cindex "queue runner" "description of operation"
4584 If other commandline options do not specify an action,
4585 the &%-q%& option starts one queue runner process. This scans the queue of
4586 waiting messages, and runs a delivery process for each one in turn. It waits
4587 for each delivery process to finish before starting the next one. A delivery
4588 process may not actually do any deliveries if the retry times for the addresses
4589 have not been reached. Use &%-qf%& (see below) if you want to override this.
4590
4591 If
4592 .cindex "SMTP" "passed connection"
4593 .cindex "SMTP" "multiple deliveries"
4594 .cindex "multiple SMTP deliveries"
4595 the delivery process spawns other processes to deliver other messages down
4596 passed SMTP connections, the queue runner waits for these to finish before
4597 proceeding.
4598
4599 When all the queued messages have been considered, the original queue runner
4600 process terminates. In other words, a single pass is made over the waiting
4601 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4602 this to be repeated periodically.
4603
4604 Exim processes the waiting messages in an unpredictable order. It isn't very
4605 random, but it is likely to be different each time, which is all that matters.
4606 If one particular message screws up a remote MTA, other messages to the same
4607 MTA have a chance of getting through if they get tried first.
4608
4609 It is possible to cause the messages to be processed in lexical message id
4610 order, which is essentially the order in which they arrived, by setting the
4611 &%queue_run_in_order%& option, but this is not recommended for normal use.
4612
4613 .vitem &%-q%&<&'qflags'&>
4614 The &%-q%& option may be followed by one or more flag letters that change its
4615 behaviour. They are all optional, but if more than one is present, they must
4616 appear in the correct order. Each flag is described in a separate item below.
4617
4618 .vitem &%-qq...%&
4619 .oindex "&%-qq%&"
4620 .cindex "queue" "double scanning"
4621 .cindex "queue" "routing"
4622 .cindex "routing" "whole queue before delivery"
4623 .cindex "first pass routing"
4624 .cindex "queue runner" "two phase"
4625 An option starting with &%-qq%& requests a two-stage queue run. In the first
4626 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4627 every domain. Addresses are routed, local deliveries happen, but no remote
4628 transports are run.
4629
4630 Performance will be best if the &%queue_run_in_order%& option is false.
4631 If that is so and the &%queue_fast_ramp%& option is true then
4632 in the first phase of the run,
4633 once a threshold number of messages are routed for a given host,
4634 a delivery process is forked in parallel with the rest of the scan.
4635
4636 .cindex "hints database" "remembering routing"
4637 The hints database that remembers which messages are waiting for specific hosts
4638 is updated, as if delivery to those hosts had been deferred. After this is
4639 complete, a second, normal queue scan happens, with routing and delivery taking
4640 place as normal. Messages that are routed to the same host should mostly be
4641 delivered down a single SMTP
4642 .cindex "SMTP" "passed connection"
4643 .cindex "SMTP" "multiple deliveries"
4644 .cindex "multiple SMTP deliveries"
4645 connection because of the hints that were set up during the first queue scan.
4646 This option may be useful for hosts that are connected to the Internet
4647 intermittently.
4648
4649 .vitem &%-q[q]i...%&
4650 .oindex "&%-qi%&"
4651 .cindex "queue" "initial delivery"
4652 If the &'i'& flag is present, the queue runner runs delivery processes only for
4653 those messages that haven't previously been tried. (&'i'& stands for &"initial
4654 delivery"&.) This can be helpful if you are putting messages in the queue using
4655 &%-odq%& and want a queue runner just to process the new messages.
4656
4657 .vitem &%-q[q][i]f...%&
4658 .oindex "&%-qf%&"
4659 .cindex "queue" "forcing delivery"
4660 .cindex "delivery" "forcing in queue run"
4661 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4662 message, whereas without &'f'& only those non-frozen addresses that have passed
4663 their retry times are tried.
4664
4665 .vitem &%-q[q][i]ff...%&
4666 .oindex "&%-qff%&"
4667 .cindex "frozen messages" "forcing delivery"
4668 If &'ff'& is present, a delivery attempt is forced for every message, whether
4669 frozen or not.
4670
4671 .vitem &%-q[q][i][f[f]]l%&
4672 .oindex "&%-ql%&"
4673 .cindex "queue" "local deliveries only"
4674 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4675 be done. If a message requires any remote deliveries, it remains in the queue
4676 for later delivery.
4677
4678 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4679 .oindex "&%-qG%&"
4680 .cindex queue named
4681 .cindex "named queues"  "deliver from"
4682 .cindex "queue" "delivering specific messages"
4683 If the &'G'& flag and a name is present, the queue runner operates on the
4684 queue with the given name rather than the default queue.
4685 The name should not contain a &'/'& character.
4686 For a periodic queue run (see below)
4687 append to the name a slash and a time value.
4688
4689 If other commandline options specify an action, a &'-qG<name>'& option
4690 will specify a queue to operate on.
4691 For example:
4692 .code
4693 exim -bp -qGquarantine
4694 mailq -qGquarantine
4695 exim -qGoffpeak -Rf @special.domain.example
4696 .endd
4697
4698 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4699 When scanning the queue, Exim can be made to skip over messages whose ids are
4700 lexically less than a given value by following the &%-q%& option with a
4701 starting message id. For example:
4702 .code
4703 exim -q 0t5C6f-0000c8-00
4704 .endd
4705 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4706 second message id is given, messages whose ids are lexically greater than it
4707 are also skipped. If the same id is given twice, for example,
4708 .code
4709 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4710 .endd
4711 just one delivery process is started, for that message. This differs from
4712 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4713 that it counts as a delivery from a queue run. Note that the selection
4714 mechanism does not affect the order in which the messages are scanned. There
4715 are also other ways of selecting specific sets of messages for delivery in a
4716 queue run &-- see &%-R%& and &%-S%&.
4717
4718 .vitem &%-q%&<&'qflags'&><&'time'&>
4719 .cindex "queue runner" "starting periodically"
4720 .cindex "periodic queue running"
4721 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4722 starting a queue runner process at intervals specified by the given time value
4723 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4724 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4725 single daemon process handles both functions. A common way of starting up a
4726 combined daemon at system boot time is to use a command such as
4727 .code
4728 /usr/exim/bin/exim -bd -q30m
4729 .endd
4730 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4731 process every 30 minutes.
4732
4733 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4734 pid file is written unless one is explicitly requested by the &%-oP%& option.
4735
4736 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4737 .oindex "&%-qR%&"
4738 This option is synonymous with &%-R%&. It is provided for Sendmail
4739 compatibility.
4740
4741 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4742 .oindex "&%-qS%&"
4743 This option is synonymous with &%-S%&.
4744
4745 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4746 .oindex "&%-R%&"
4747 .cindex "queue runner" "for specific recipients"
4748 .cindex "delivery" "to given domain"
4749 .cindex "domain" "delivery to"
4750 The <&'rsflags'&> may be empty, in which case the white space before the string
4751 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4752 which are the possible values for <&'rsflags'&>. White space is required if
4753 <&'rsflags'&> is not empty.
4754
4755 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4756 perform a single queue run, except that, when scanning the messages on the
4757 queue, Exim processes only those that have at least one undelivered recipient
4758 address containing the given string, which is checked in a case-independent
4759 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4760 regular expression; otherwise it is a literal string.
4761
4762 If you want to do periodic queue runs for messages with specific recipients,
4763 you can combine &%-R%& with &%-q%& and a time value. For example:
4764 .code
4765 exim -q25m -R @special.domain.example
4766 .endd
4767 This example does a queue run for messages with recipients in the given domain
4768 every 25 minutes. Any additional flags that are specified with &%-q%& are
4769 applied to each queue run.
4770
4771 Once a message is selected for delivery by this mechanism, all its addresses
4772 are processed. For the first selected message, Exim overrides any retry
4773 information and forces a delivery attempt for each undelivered address. This
4774 means that if delivery of any address in the first message is successful, any
4775 existing retry information is deleted, and so delivery attempts for that
4776 address in subsequently selected messages (which are processed without forcing)
4777 will run. However, if delivery of any address does not succeed, the retry
4778 information is updated, and in subsequently selected messages, the failing
4779 address will be skipped.
4780
4781 .cindex "frozen messages" "forcing delivery"
4782 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4783 all selected messages, not just the first; frozen messages are included when
4784 &'ff'& is present.
4785
4786 The &%-R%& option makes it straightforward to initiate delivery of all messages
4787 to a given domain after a host has been down for some time. When the SMTP
4788 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4789 effect is to run Exim with the &%-R%& option, but it can be configured to run
4790 an arbitrary command instead.
4791
4792 .vitem &%-r%&
4793 .oindex "&%-r%&"
4794 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4795
4796 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4797 .oindex "&%-S%&"
4798 .cindex "delivery" "from given sender"
4799 .cindex "queue runner" "for specific senders"
4800 This option acts like &%-R%& except that it checks the string against each
4801 message's sender instead of against the recipients. If &%-R%& is also set, both
4802 conditions must be met for a message to be selected. If either of the options
4803 has &'f'& or &'ff'& in its flags, the associated action is taken.
4804
4805 .vitem &%-Tqt%&&~<&'times'&>
4806 .oindex "&%-Tqt%&"
4807 This is an option that is exclusively for use by the Exim testing suite. It is not
4808 recognized when Exim is run normally. It allows for the setting up of explicit
4809 &"queue times"& so that various warning/retry features can be tested.
4810
4811 .vitem &%-t%&
4812 .oindex "&%-t%&"
4813 .cindex "recipient" "extracting from header lines"
4814 .chindex Bcc:
4815 .chindex Cc:
4816 .chindex To:
4817 When Exim is receiving a locally-generated, non-SMTP message on its standard
4818 input, the &%-t%& option causes the recipients of the message to be obtained
4819 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4820 from the command arguments. The addresses are extracted before any rewriting
4821 takes place and the &'Bcc:'& header line, if present, is then removed.
4822
4823 .cindex "Sendmail compatibility" "&%-t%& option"
4824 If the command has any arguments, they specify addresses to which the message
4825 is &'not'& to be delivered. That is, the argument addresses are removed from
4826 the recipients list obtained from the headers. This is compatible with Smail 3
4827 and in accordance with the documented behaviour of several versions of
4828 Sendmail, as described in man pages on a number of operating systems (e.g.
4829 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4830 argument addresses to those obtained from the headers, and the O'Reilly
4831 Sendmail book documents it that way. Exim can be made to add argument addresses
4832 instead of subtracting them by setting the option
4833 &%extract_addresses_remove_arguments%& false.
4834
4835 .cindex "&%Resent-%& header lines" "with &%-t%&"
4836 If there are any &%Resent-%& header lines in the message, Exim extracts
4837 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4838 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4839 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4840 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4841
4842 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4843 message is resent several times). The RFC also specifies that they should be
4844 added at the front of the message, and separated by &'Received:'& lines. It is
4845 not at all clear how &%-t%& should operate in the present of multiple sets,
4846 nor indeed exactly what constitutes a &"set"&.
4847 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4848 are often added at the end of the header, and if a message is resent more than
4849 once, it is common for the original set of &%Resent-%& headers to be renamed as
4850 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4851
4852 .vitem &%-ti%&
4853 .oindex "&%-ti%&"
4854 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4855 compatibility with Sendmail.
4856
4857 .vitem &%-tls-on-connect%&
4858 .oindex "&%-tls-on-connect%&"
4859 .cindex "TLS" "use without STARTTLS"
4860 .cindex "TLS" "automatic start"
4861 This option is available when Exim is compiled with TLS support. It forces all
4862 incoming SMTP connections to behave as if the incoming port is listed in the
4863 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4864 &<<CHAPTLS>>& for further details.
4865
4866
4867 .vitem &%-U%&
4868 .oindex "&%-U%&"
4869 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4870 Sendmail uses this option for &"initial message submission"&, and its
4871 documentation states that in future releases, it may complain about
4872 syntactically invalid messages rather than fixing them when this flag is not
4873 set. Exim ignores this option.
4874
4875 .vitem &%-v%&
4876 .oindex "&%-v%&"
4877 This option causes Exim to write information to the standard error stream,
4878 describing what it is doing. In particular, it shows the log lines for
4879 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4880 dialogue is shown. Some of the log lines shown may not actually be written to
4881 the log if the setting of &%log_selector%& discards them. Any relevant
4882 selectors are shown with each log line. If none are shown, the logging is
4883 unconditional.
4884
4885 .vitem &%-x%&
4886 .oindex "&%-x%&"
4887 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4888 National Language Support extended characters in the body of the mail item"&).
4889 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4890 this option.
4891
4892 .vitem &%-X%&&~<&'logfile'&>
4893 .oindex "&%-X%&"
4894 This option is interpreted by Sendmail to cause debug information to be sent
4895 to the named file.  It is ignored by Exim.
4896
4897 .vitem &%-z%&&~<&'log-line'&>
4898 .oindex "&%-z%&"
4899 This option writes its argument to Exim's logfile.
4900 Use is restricted to administrators; the intent is for operational notes.
4901 Quotes should be used to maintain a multi-word item as a single argument,
4902 under most shells.
4903 .endlist
4904
4905 .ecindex IIDclo1
4906 .ecindex IIDclo2
4907
4908
4909 . ////////////////////////////////////////////////////////////////////////////
4910 . Insert a stylized DocBook comment here, to identify the end of the command
4911 . line options. This is for the benefit of the Perl script that automatically
4912 . creates a man page for the options.
4913 . ////////////////////////////////////////////////////////////////////////////
4914
4915 .literal xml
4916 <!-- === End of command line options === -->
4917 .literal off
4918
4919
4920
4921
4922
4923 . ////////////////////////////////////////////////////////////////////////////
4924 . ////////////////////////////////////////////////////////////////////////////
4925
4926
4927 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4928          "The runtime configuration file"
4929
4930 .cindex "runtime configuration"
4931 .cindex "configuration file" "general description"
4932 .cindex "CONFIGURE_FILE"
4933 .cindex "configuration file" "errors in"
4934 .cindex "error" "in configuration file"
4935 .cindex "return code" "for bad configuration"
4936 Exim uses a single runtime configuration file that is read whenever an Exim
4937 binary is executed. Note that in normal operation, this happens frequently,
4938 because Exim is designed to operate in a distributed manner, without central
4939 control.
4940
4941 If a syntax error is detected while reading the configuration file, Exim
4942 writes a message on the standard error, and exits with a non-zero return code.
4943 The message is also written to the panic log. &*Note*&: Only simple syntax
4944 errors can be detected at this time. The values of any expanded options are
4945 not checked until the expansion happens, even when the expansion does not
4946 actually alter the string.
4947
4948 The name of the configuration file is compiled into the binary for security
4949 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4950 most configurations, this specifies a single file. However, it is permitted to
4951 give a colon-separated list of filenames, in which case Exim uses the first
4952 existing file in the list.
4953
4954 .cindex "EXIM_USER"
4955 .cindex "EXIM_GROUP"
4956 .cindex "CONFIGURE_OWNER"
4957 .cindex "CONFIGURE_GROUP"
4958 .cindex "configuration file" "ownership"
4959 .cindex "ownership" "configuration file"
4960 The runtime configuration file must be owned by root or by the user that is
4961 specified at compile time by the CONFIGURE_OWNER option (if set). The
4962 configuration file must not be world-writeable, or group-writeable unless its
4963 group is the root group or the one specified at compile time by the
4964 CONFIGURE_GROUP option.
4965
4966 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4967 to root, anybody who is able to edit the runtime configuration file has an
4968 easy way to run commands as root. If you specify a user or group in the
4969 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4970 who are members of that group will trivially be able to obtain root privileges.
4971
4972 Up to Exim version 4.72, the runtime configuration file was also permitted to
4973 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4974 since it offered a simple privilege escalation for any attacker who managed to
4975 compromise the Exim user account.
4976
4977 A default configuration file, which will work correctly in simple situations,
4978 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4979 defines just one filename, the installation process copies the default
4980 configuration to a new file of that name if it did not previously exist. If
4981 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4982 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4983 configuration.
4984
4985
4986
4987 .section "Using a different configuration file" "SECID40"
4988 .cindex "configuration file" "alternate"
4989 A one-off alternate configuration can be specified by the &%-C%& command line
4990 option, which may specify a single file or a list of files. However, when
4991 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4992 unless the argument for &%-C%& is identical to the built-in value from
4993 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4994 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4995 is useful mainly for checking the syntax of configuration files before
4996 installing them. No owner or group checks are done on a configuration file
4997 specified by &%-C%&, if root privilege has been dropped.
4998
4999 Even the Exim user is not trusted to specify an arbitrary configuration file
5000 with the &%-C%& option to be used with root privileges, unless that file is
5001 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
5002 testing a configuration using &%-C%& right through message reception and
5003 delivery, even if the caller is root. The reception works, but by that time,
5004 Exim is running as the Exim user, so when it re-execs to regain privilege for
5005 the delivery, the use of &%-C%& causes privilege to be lost. However, root
5006 can test reception and delivery using two separate commands (one to put a
5007 message in the queue, using &%-odq%&, and another to do the delivery, using
5008 &%-M%&).
5009
5010 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
5011 prefix string with which any file named in a &%-C%& command line option must
5012 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
5013 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
5014 filename can be used with &%-C%&.
5015
5016 One-off changes to a configuration can be specified by the &%-D%& command line
5017 option, which defines and overrides values for macros used inside the
5018 configuration file. However, like &%-C%&, the use of this option by a
5019 non-privileged user causes Exim to discard its root privilege.
5020 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
5021 completely disabled, and its use causes an immediate error exit.
5022
5023 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
5024 to declare certain macro names trusted, such that root privilege will not
5025 necessarily be discarded.
5026 WHITELIST_D_MACROS defines a colon-separated list of macros which are
5027 considered safe and, if &%-D%& only supplies macros from this list, and the
5028 values are acceptable, then Exim will not give up root privilege if the caller
5029 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
5030 transition mechanism and is expected to be removed in the future.  Acceptable
5031 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
5032
5033 Some sites may wish to use the same Exim binary on different machines that
5034 share a file system, but to use different configuration files on each machine.
5035 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
5036 looks for a file whose name is the configuration filename followed by a dot
5037 and the machine's node name, as obtained from the &[uname()]& function. If this
5038 file does not exist, the standard name is tried. This processing occurs for
5039 each filename in the list given by CONFIGURE_FILE or &%-C%&.
5040
5041 In some esoteric situations different versions of Exim may be run under
5042 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
5043 help with this. See the comments in &_src/EDITME_& for details.
5044
5045
5046
5047 .section "Configuration file format" "SECTconffilfor"
5048 .cindex "configuration file" "format of"
5049 .cindex "format" "configuration file"
5050 Exim's configuration file is divided into a number of different parts. General
5051 option settings must always appear at the start of the file. The other parts
5052 are all optional, and may appear in any order. Each part other than the first
5053 is introduced by the word &"begin"& followed by at least one literal
5054 space, and the name of the part. The optional parts are:
5055
5056 .ilist
5057 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
5058 &<<CHAPACL>>&).
5059 .next
5060 .cindex "AUTH" "configuration"
5061 &'authenticators'&: Configuration settings for the authenticator drivers. These
5062 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
5063 .next
5064 &'routers'&: Configuration settings for the router drivers. Routers process
5065 addresses and determine how the message is to be delivered (see chapters
5066 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
5067 .next
5068 &'transports'&: Configuration settings for the transport drivers. Transports
5069 define mechanisms for copying messages to destinations (see chapters
5070 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
5071 .next
5072 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
5073 If there is no retry section, or if it is empty (that is, no retry rules are
5074 defined), Exim will not retry deliveries. In this situation, temporary errors
5075 are treated the same as permanent errors. Retry rules are discussed in chapter
5076 &<<CHAPretry>>&.
5077 .next
5078 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
5079 when new addresses are generated during delivery. Rewriting is discussed in
5080 chapter &<<CHAPrewrite>>&.
5081 .next
5082 &'local_scan'&: Private options for the &[local_scan()]& function. If you
5083 want to use this feature, you must set
5084 .code
5085 LOCAL_SCAN_HAS_OPTIONS=yes
5086 .endd
5087 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
5088 facility are given in chapter &<<CHAPlocalscan>>&.
5089 .endlist
5090
5091 .cindex "configuration file" "leading white space in"
5092 .cindex "configuration file" "trailing white space in"
5093 .cindex "white space" "in configuration file"
5094 Leading and trailing white space in configuration lines is always ignored.
5095
5096 Blank lines in the file, and lines starting with a # character (ignoring
5097 leading white space) are treated as comments and are ignored. &*Note*&: A
5098 # character other than at the beginning of a line is not treated specially,
5099 and does not introduce a comment.
5100
5101 Any non-comment line can be continued by ending it with a backslash. Note that
5102 the general rule for white space means that trailing white space after the
5103 backslash and leading white space at the start of continuation
5104 lines is ignored. Comment lines beginning with # (but not empty lines) may
5105 appear in the middle of a sequence of continuation lines.
5106
5107 A convenient way to create a configuration file is to start from the
5108 default, which is supplied in &_src/configure.default_&, and add, delete, or
5109 change settings as required.
5110
5111 The ACLs, retry rules, and rewriting rules have their own syntax which is
5112 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
5113 respectively. The other parts of the configuration file have some syntactic
5114 items in common, and these are described below, from section &<<SECTcos>>&
5115 onwards. Before that, the inclusion, macro, and conditional facilities are
5116 described.
5117
5118
5119
5120 .section "File inclusions in the configuration file" "SECID41"
5121 .cindex "inclusions in configuration file"
5122 .cindex "configuration file" "including other files"
5123 .cindex "&`.include`& in configuration file"
5124 .cindex "&`.include_if_exists`& in configuration file"
5125 You can include other files inside Exim's runtime configuration file by
5126 using this syntax:
5127 .display
5128 &`.include`& <&'filename'&>
5129 &`.include_if_exists`& <&'filename'&>
5130 .endd
5131 on a line by itself. Double quotes round the filename are optional. If you use
5132 the first form, a configuration error occurs if the file does not exist; the
5133 second form does nothing for non-existent files.
5134 The first form allows a relative name. It is resolved relative to
5135 the directory of the including file. For the second form an absolute filename
5136 is required.
5137
5138 Includes may be nested to any depth, but remember that Exim reads its
5139 configuration file often, so it is a good idea to keep them to a minimum.
5140 If you change the contents of an included file, you must HUP the daemon,
5141 because an included file is read only when the configuration itself is read.
5142
5143 The processing of inclusions happens early, at a physical line level, so, like
5144 comment lines, an inclusion can be used in the middle of an option setting,
5145 for example:
5146 .code
5147 hosts_lookup = a.b.c \
5148                .include /some/file
5149 .endd
5150 Include processing happens after macro processing (see below). Its effect is to
5151 process the lines of the included file as if they occurred inline where the
5152 inclusion appears.
5153
5154
5155
5156 .section "Macros in the configuration file" "SECTmacrodefs"
5157 .cindex "macro" "description of"
5158 .cindex "configuration file" "macros"
5159 If a line in the main part of the configuration (that is, before the first
5160 &"begin"& line) begins with an upper case letter, it is taken as a macro
5161 definition, and must be of the form
5162 .display
5163 <&'name'&> = <&'rest of line'&>
5164 .endd
5165 The name must consist of letters, digits, and underscores, and need not all be
5166 in upper case, though that is recommended. The rest of the line, including any
5167 continuations, is the replacement text, and has leading and trailing white
5168 space removed. Quotes are not removed. The replacement text can never end with
5169 a backslash character, but this doesn't seem to be a serious limitation.
5170
5171 Macros may also be defined between router, transport, authenticator, or ACL
5172 definitions. They may not, however, be defined within an individual driver or
5173 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5174
5175 .section "Macro substitution" "SECID42"
5176 Once a macro is defined, all subsequent lines in the file (and any included
5177 files) are scanned for the macro name; if there are several macros, the line is
5178 scanned for each, in turn, in the order in which the macros are defined. The
5179 replacement text is not re-scanned for the current macro, though it is scanned
5180 for subsequently defined macros. For this reason, a macro name may not contain
5181 the name of a previously defined macro as a substring. You could, for example,
5182 define
5183 .display
5184 &`ABCD_XYZ = `&<&'something'&>
5185 &`ABCD = `&<&'something else'&>
5186 .endd
5187 but putting the definitions in the opposite order would provoke a configuration
5188 error. Macro expansion is applied to individual physical lines from the file,
5189 before checking for line continuation or file inclusion (see above). If a line
5190 consists solely of a macro name, and the expansion of the macro is empty, the
5191 line is ignored. A macro at the start of a line may turn the line into a
5192 comment line or a &`.include`& line.
5193
5194
5195 .section "Redefining macros" "SECID43"
5196 Once defined, the value of a macro can be redefined later in the configuration
5197 (or in an included file). Redefinition is specified by using &'=='& instead of
5198 &'='&. For example:
5199 .code
5200 MAC =  initial value
5201 ...
5202 MAC == updated value
5203 .endd
5204 Redefinition does not alter the order in which the macros are applied to the
5205 subsequent lines of the configuration file. It is still the same order in which
5206 the macros were originally defined. All that changes is the macro's value.
5207 Redefinition makes it possible to accumulate values. For example:
5208 .code
5209 MAC =  initial value
5210 ...
5211 MAC == MAC and something added
5212 .endd
5213 This can be helpful in situations where the configuration file is built
5214 from a number of other files.
5215
5216 .section "Overriding macro values" "SECID44"
5217 The values set for macros in the configuration file can be overridden by the
5218 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5219 used, unless called by root or the Exim user. A definition on the command line
5220 using the &%-D%& option causes all definitions and redefinitions within the
5221 file to be ignored.
5222
5223
5224
5225 .section "Example of macro usage" "SECID45"
5226 As an example of macro usage, consider a configuration where aliases are looked
5227 up in a MySQL database. It helps to keep the file less cluttered if long
5228 strings such as SQL statements are defined separately as macros, for example:
5229 .code
5230 ALIAS_QUERY = select mailbox from user where \
5231               login='${quote_mysql:$local_part}';
5232 .endd
5233 This can then be used in a &(redirect)& router setting like this:
5234 .code
5235 data = ${lookup mysql{ALIAS_QUERY}}
5236 .endd
5237 In earlier versions of Exim macros were sometimes used for domain, host, or
5238 address lists. In Exim 4 these are handled better by named lists &-- see
5239 section &<<SECTnamedlists>>&.
5240
5241
5242 .section "Builtin macros" "SECTbuiltinmacros"
5243 Exim defines some macros depending on facilities available, which may
5244 differ due to build-time definitions and from one release to another.
5245 All of these macros start with an underscore.
5246 They can be used to conditionally include parts of a configuration
5247 (see below).
5248
5249 The following classes of macros are defined:
5250 .display
5251 &` _HAVE_*                    `&  build-time defines
5252 &` _DRIVER_ROUTER_*           `&  router drivers
5253 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5254 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5255 &` _LOG_*                     `&  log_selector values
5256 &` _OPT_MAIN_*                `&  main config options
5257 &` _OPT_ROUTERS_*             `&  generic router options
5258 &` _OPT_TRANSPORTS_*          `&  generic transport options
5259 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5260 &` _OPT_ROUTER_*_*            `&  private router options
5261 &` _OPT_TRANSPORT_*_*         `&  private transport options
5262 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5263 .endd
5264
5265 Use an &"exim -bP macros"& command to get the list of macros.
5266
5267
5268 .section "Conditional skips in the configuration file" "SECID46"
5269 .cindex "configuration file" "conditional skips"
5270 .cindex "&`.ifdef`&"
5271 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5272 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5273 portions of the configuration file. The processing happens whenever the file is
5274 read (that is, when an Exim binary starts to run).
5275
5276 The implementation is very simple. Instances of the first four directives must
5277 be followed by text that includes the names of one or macros. The condition
5278 that is tested is whether or not any macro substitution has taken place in the
5279 line. Thus:
5280 .code
5281 .ifdef AAA
5282 message_size_limit = 50M
5283 .else
5284 message_size_limit = 100M
5285 .endif
5286 .endd
5287 sets a message size limit of 50M if the macro &`AAA`& is defined
5288 (or &`A`& or &`AA`&), and 100M
5289 otherwise. If there is more than one macro named on the line, the condition
5290 is true if any of them are defined. That is, it is an &"or"& condition. To
5291 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5292
5293 Although you can use a macro expansion to generate one of these directives,
5294 it is not very useful, because the condition &"there was a macro substitution
5295 in this line"& will always be true.
5296
5297 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5298 to clarify complicated nestings.
5299
5300
5301
5302 .section "Common option syntax" "SECTcos"
5303 .cindex "common option syntax"
5304 .cindex "syntax of common options"
5305 .cindex "configuration file" "common option syntax"
5306 For the main set of options, driver options, and &[local_scan()]& options,
5307 each setting is on a line by itself, and starts with a name consisting of
5308 lower-case letters and underscores. Many options require a data value, and in
5309 these cases the name must be followed by an equals sign (with optional white
5310 space) and then the value. For example:
5311 .code
5312 qualify_domain = mydomain.example.com
5313 .endd
5314 .cindex "hiding configuration option values"
5315 .cindex "configuration options" "hiding value of"
5316 .cindex "options" "hiding value of"
5317 Some option settings may contain sensitive data, for example, passwords for
5318 accessing databases. To stop non-admin users from using the &%-bP%& command
5319 line option to read these values, you can precede the option settings with the
5320 word &"hide"&. For example:
5321 .code
5322 hide mysql_servers = localhost/users/admin/secret-password
5323 .endd
5324 For non-admin users, such options are displayed like this:
5325 .code
5326 mysql_servers = <value not displayable>
5327 .endd
5328 If &"hide"& is used on a driver option, it hides the value of that option on
5329 all instances of the same driver.
5330
5331 The following sections describe the syntax used for the different data types
5332 that are found in option settings.
5333
5334
5335 .section "Boolean options" "SECID47"
5336 .cindex "format" "boolean"
5337 .cindex "boolean configuration values"
5338 .oindex "&%no_%&&'xxx'&"
5339 .oindex "&%not_%&&'xxx'&"
5340 Options whose type is given as boolean are on/off switches. There are two
5341 different ways of specifying such options: with and without a data value. If
5342 the option name is specified on its own without data, the switch is turned on;
5343 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5344 boolean options may be followed by an equals sign and one of the words
5345 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5346 the following two settings have exactly the same effect:
5347 .code
5348 queue_only
5349 queue_only = true
5350 .endd
5351 The following two lines also have the same (opposite) effect:
5352 .code
5353 no_queue_only
5354 queue_only = false
5355 .endd
5356 You can use whichever syntax you prefer.
5357
5358
5359
5360
5361 .section "Integer values" "SECID48"
5362 .cindex "integer configuration values"
5363 .cindex "format" "integer"
5364 If an option's type is given as &"integer"&, the value can be given in decimal,
5365 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5366 number is assumed. Otherwise, it is treated as an octal number unless it starts
5367 with the characters &"0x"&, in which case the remainder is interpreted as a
5368 hexadecimal number.
5369
5370 If an integer value is followed by the letter K, it is multiplied by 1024; if
5371 it is followed by the letter M, it is multiplied by 1024x1024;
5372 if by the letter G, 1024x1024x1024.
5373 When the values
5374 of integer option settings are output, values which are an exact multiple of
5375 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5376 and M. The printing style is independent of the actual input format that was
5377 used.
5378
5379
5380 .section "Octal integer values" "SECID49"
5381 .cindex "integer format"
5382 .cindex "format" "octal integer"
5383 If an option's type is given as &"octal integer"&, its value is always
5384 interpreted as an octal number, whether or not it starts with the digit zero.
5385 Such options are always output in octal.
5386
5387
5388 .section "Fixed point numbers" "SECID50"
5389 .cindex "fixed point configuration values"
5390 .cindex "format" "fixed point"
5391 If an option's type is given as &"fixed-point"&, its value must be a decimal
5392 integer, optionally followed by a decimal point and up to three further digits.
5393
5394
5395
5396 .section "Time intervals" "SECTtimeformat"
5397 .cindex "time interval" "specifying in configuration"
5398 .cindex "format" "time interval"
5399 A time interval is specified as a sequence of numbers, each followed by one of
5400 the following letters, with no intervening white space:
5401
5402 .table2 30pt
5403 .irow &%s%& seconds
5404 .irow &%m%& minutes
5405 .irow &%h%& hours
5406 .irow &%d%& days
5407 .irow &%w%& weeks
5408 .endtable
5409
5410 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5411 intervals are output in the same format. Exim does not restrict the values; it
5412 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5413
5414
5415
5416 .section "String values" "SECTstrings"
5417 .cindex "string" "format of configuration values"
5418 .cindex "format" "string"
5419 If an option's type is specified as &"string"&, the value can be specified with
5420 or without double-quotes. If it does not start with a double-quote, the value
5421 consists of the remainder of the line plus any continuation lines, starting at
5422 the first character after any leading white space, with trailing white space
5423 removed, and with no interpretation of the characters in the string. Because
5424 Exim removes comment lines (those beginning with #) at an early stage, they can
5425 appear in the middle of a multi-line string. The following two settings are
5426 therefore equivalent:
5427 .code
5428 trusted_users = uucp:mail
5429 trusted_users = uucp:\
5430                 # This comment line is ignored
5431                 mail
5432 .endd
5433 .cindex "string" "quoted"
5434 .cindex "escape characters in quoted strings"
5435 If a string does start with a double-quote, it must end with a closing
5436 double-quote, and any backslash characters other than those used for line
5437 continuation are interpreted as escape characters, as follows:
5438
5439 .table2 100pt
5440 .irow &`\\`&                     "single backslash"
5441 .irow &`\n`&                     "newline"
5442 .irow &`\r`&                     "carriage return"
5443 .irow &`\t`&                     "tab"
5444 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5445 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5446                                    character"
5447 .endtable
5448
5449 If a backslash is followed by some other character, including a double-quote
5450 character, that character replaces the pair.
5451
5452 Quoting is necessary only if you want to make use of the backslash escapes to
5453 insert special characters, or if you need to specify a value with leading or
5454 trailing spaces. These cases are rare, so quoting is almost never needed in
5455 current versions of Exim. In versions of Exim before 3.14, quoting was required
5456 in order to continue lines, so you may come across older configuration files
5457 and examples that apparently quote unnecessarily.
5458
5459
5460 .section "Expanded strings" "SECID51"
5461 .cindex "expansion" "definition of"
5462 Some strings in the configuration file are subjected to &'string expansion'&,
5463 by which means various parts of the string may be changed according to the
5464 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5465 is as just described; in particular, the handling of backslashes in quoted
5466 strings is done as part of the input process, before expansion takes place.
5467 However, backslash is also an escape character for the expander, so any
5468 backslashes that are required for that reason must be doubled if they are
5469 within a quoted configuration string.
5470
5471
5472 .section "User and group names" "SECID52"
5473 .cindex "user name" "format of"
5474 .cindex "format" "user name"
5475 .cindex "groups" "name format"
5476 .cindex "format" "group name"
5477 User and group names are specified as strings, using the syntax described
5478 above, but the strings are interpreted specially. A user or group name must
5479 either consist entirely of digits, or be a name that can be looked up using the
5480 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5481
5482
5483 .section "List construction" "SECTlistconstruct"
5484 .cindex "list" "syntax of in configuration"
5485 .cindex "format" "list item in configuration"
5486 .cindex "string" "list, definition of"
5487 The data for some configuration options is a list of items, with colon as the
5488 default separator. Many of these options are shown with type &"string list"& in
5489 the descriptions later in this document. Others are listed as &"domain list"&,
5490 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5491 are all the same; however, those other than &"string list"& are subject to
5492 particular kinds of interpretation, as described in chapter
5493 &<<CHAPdomhosaddlists>>&.
5494
5495 In all these cases, the entire list is treated as a single string as far as the
5496 input syntax is concerned. The &%trusted_users%& setting in section
5497 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5498 in a list, it must be entered as two colons. Leading and trailing white space
5499 on each item in a list is ignored. This makes it possible to include items that
5500 start with a colon, and in particular, certain forms of IPv6 address. For
5501 example, the list
5502 .code
5503 local_interfaces = 127.0.0.1 : ::::1
5504 .endd
5505 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5506
5507 &*Note*&: Although leading and trailing white space is ignored in individual
5508 list items, it is not ignored when parsing the list. The spaces around the first
5509 colon in the example above are necessary. If they were not there, the list would
5510 be interpreted as the two items 127.0.0.1:: and 1.
5511
5512 .section "Changing list separators" "SECTlistsepchange"
5513 .cindex "list separator" "changing"
5514 .cindex "IPv6" "addresses in lists"
5515 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5516 introduced to allow the separator character to be changed. If a list begins
5517 with a left angle bracket, followed by any punctuation character, that
5518 character is used instead of colon as the list separator. For example, the list
5519 above can be rewritten to use a semicolon separator like this:
5520 .code
5521 local_interfaces = <; 127.0.0.1 ; ::1
5522 .endd
5523 This facility applies to all lists, with the exception of the list in
5524 &%log_file_path%&. It is recommended that the use of non-colon separators be
5525 confined to circumstances where they really are needed.
5526
5527 .cindex "list separator" "newline as"
5528 .cindex "newline" "as list separator"
5529 It is also possible to use newline and other control characters (those with
5530 code values less than 32, plus DEL) as separators in lists. Such separators
5531 must be provided literally at the time the list is processed. For options that
5532 are string-expanded, you can write the separator using a normal escape
5533 sequence. This will be processed by the expander before the string is
5534 interpreted as a list. For example, if a newline-separated list of domains is
5535 generated by a lookup, you can process it directly by a line such as this:
5536 .code
5537 domains = <\n ${lookup mysql{.....}}
5538 .endd
5539 This avoids having to change the list separator in such data. You are unlikely
5540 to want to use a control character as a separator in an option that is not
5541 expanded, because the value is literal text. However, it can be done by giving
5542 the value in quotes. For example:
5543 .code
5544 local_interfaces = "<\n 127.0.0.1 \n ::1"
5545 .endd
5546 Unlike printing character separators, which can be included in list items by
5547 doubling, it is not possible to include a control character as data when it is
5548 set as the separator. Two such characters in succession are interpreted as
5549 enclosing an empty list item.
5550
5551
5552
5553 .section "Empty items in lists" "SECTempitelis"
5554 .cindex "list" "empty item in"
5555 An empty item at the end of a list is always ignored. In other words, trailing
5556 separator characters are ignored. Thus, the list in
5557 .code
5558 senders = user@domain :
5559 .endd
5560 contains only a single item. If you want to include an empty string as one item
5561 in a list, it must not be the last item. For example, this list contains three
5562 items, the second of which is empty:
5563 .code
5564 senders = user1@domain : : user2@domain
5565 .endd
5566 &*Note*&: There must be white space between the two colons, as otherwise they
5567 are interpreted as representing a single colon data character (and the list
5568 would then contain just one item). If you want to specify a list that contains
5569 just one, empty item, you can do it as in this example:
5570 .code
5571 senders = :
5572 .endd
5573 In this case, the first item is empty, and the second is discarded because it
5574 is at the end of the list.
5575
5576
5577
5578
5579 .section "Format of driver configurations" "SECTfordricon"
5580 .cindex "drivers" "configuration format"
5581 There are separate parts in the configuration for defining routers, transports,
5582 and authenticators. In each part, you are defining a number of driver
5583 instances, each with its own set of options. Each driver instance is defined by
5584 a sequence of lines like this:
5585 .display
5586 <&'instance name'&>:
5587   <&'option'&>
5588   ...
5589   <&'option'&>
5590 .endd
5591 In the following example, the instance name is &(localuser)&, and it is
5592 followed by three options settings:
5593 .code
5594 localuser:
5595   driver = accept
5596   check_local_user
5597   transport = local_delivery
5598 .endd
5599 For each driver instance, you specify which Exim code module it uses &-- by the
5600 setting of the &%driver%& option &-- and (optionally) some configuration
5601 settings. For example, in the case of transports, if you want a transport to
5602 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5603 a local file you would use the &(appendfile)& driver. Each of the drivers is
5604 described in detail in its own separate chapter later in this manual.
5605
5606 You can have several routers, transports, or authenticators that are based on
5607 the same underlying driver (each must have a different instance name).
5608
5609 The order in which routers are defined is important, because addresses are
5610 passed to individual routers one by one, in order. The order in which
5611 transports are defined does not matter at all. The order in which
5612 authenticators are defined is used only when Exim, as a client, is searching
5613 them to find one that matches an authentication mechanism offered by the
5614 server.
5615
5616 .cindex "generic options"
5617 .cindex "options" "generic &-- definition of"
5618 Within a driver instance definition, there are two kinds of option: &'generic'&
5619 and &'private'&. The generic options are those that apply to all drivers of the
5620 same type (that is, all routers, all transports or all authenticators). The
5621 &%driver%& option is a generic option that must appear in every definition.
5622 .cindex "private options"
5623 The private options are special for each driver, and none need appear, because
5624 they all have default values.
5625
5626 The options may appear in any order, except that the &%driver%& option must
5627 precede any private options, since these depend on the particular driver. For
5628 this reason, it is recommended that &%driver%& always be the first option.
5629
5630 Driver instance names, which are used for reference in log entries and
5631 elsewhere, can be any sequence of letters, digits, and underscores (starting
5632 with a letter) and must be unique among drivers of the same type. A router and
5633 a transport (for example) can each have the same name, but no two router
5634 instances can have the same name. The name of a driver instance should not be
5635 confused with the name of the underlying driver module. For example, the
5636 configuration lines:
5637 .code
5638 remote_smtp:
5639   driver = smtp
5640 .endd
5641 create an instance of the &(smtp)& transport driver whose name is
5642 &(remote_smtp)&. The same driver code can be used more than once, with
5643 different instance names and different option settings each time. A second
5644 instance of the &(smtp)& transport, with different options, might be defined
5645 thus:
5646 .code
5647 special_smtp:
5648   driver = smtp
5649   port = 1234
5650   command_timeout = 10s
5651 .endd
5652 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5653 these transport instances from routers, and these names would appear in log
5654 lines.
5655
5656 Comment lines may be present in the middle of driver specifications. The full
5657 list of option settings for any particular driver instance, including all the
5658 defaulted values, can be extracted by making use of the &%-bP%& command line
5659 option.
5660
5661
5662
5663
5664
5665
5666 . ////////////////////////////////////////////////////////////////////////////
5667 . ////////////////////////////////////////////////////////////////////////////
5668
5669 .chapter "The default configuration file" "CHAPdefconfil"
5670 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5671 .cindex "default" "configuration file &""walk through""&"
5672 The default configuration file supplied with Exim as &_src/configure.default_&
5673 is sufficient for a host with simple mail requirements. As an introduction to
5674 the way Exim is configured, this chapter &"walks through"& the default
5675 configuration, giving brief explanations of the settings. Detailed descriptions
5676 of the options are given in subsequent chapters. The default configuration file
5677 itself contains extensive comments about ways you might want to modify the
5678 initial settings. However, note that there are many options that are not
5679 mentioned at all in the default configuration.
5680
5681
5682
5683 .section "Macros" "SECTdefconfmacros"
5684 All macros should be defined before any options.
5685
5686 One macro is specified, but commented out, in the default configuration:
5687 .code
5688 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5689 .endd
5690 If all off-site mail is expected to be delivered to a "smarthost", then set the
5691 hostname here and uncomment the macro.  This will affect which router is used
5692 later on.  If this is left commented out, then Exim will perform direct-to-MX
5693 deliveries using a &(dnslookup)& router.
5694
5695 In addition to macros defined here, Exim includes a number of built-in macros
5696 to enable configuration to be guarded by a binary built with support for a
5697 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5698
5699
5700 .section "Main configuration settings" "SECTdefconfmain"
5701 The main (global) configuration option settings section must always come first
5702 in the file, after the macros.
5703 The first thing you'll see in the file, after some initial comments, is the line
5704 .code
5705 # primary_hostname =
5706 .endd
5707 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5708 to know the official, fully qualified name of your host, and this is where you
5709 can specify it. However, in most cases you do not need to set this option. When
5710 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5711
5712 The first three non-comment configuration lines are as follows:
5713 .code
5714 domainlist local_domains    = @
5715 domainlist relay_to_domains =
5716 hostlist   relay_from_hosts = 127.0.0.1
5717 .endd
5718 These are not, in fact, option settings. They are definitions of two named
5719 domain lists and one named host list. Exim allows you to give names to lists of
5720 domains, hosts, and email addresses, in order to make it easier to manage the
5721 configuration file (see section &<<SECTnamedlists>>&).
5722
5723 The first line defines a domain list called &'local_domains'&; this is used
5724 later in the configuration to identify domains that are to be delivered
5725 on the local host.
5726
5727 .cindex "@ in a domain list"
5728 There is just one item in this list, the string &"@"&. This is a special form
5729 of entry which means &"the name of the local host"&. Thus, if the local host is
5730 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5731 be delivered locally. Because the local host's name is referenced indirectly,
5732 the same configuration file can be used on different hosts.
5733
5734 The second line defines a domain list called &'relay_to_domains'&, but the
5735 list itself is empty. Later in the configuration we will come to the part that
5736 controls mail relaying through the local host; it allows relaying to any
5737 domains in this list. By default, therefore, no relaying on the basis of a mail
5738 domain is permitted.
5739
5740 The third line defines a host list called &'relay_from_hosts'&. This list is
5741 used later in the configuration to permit relaying from any host or IP address
5742 that matches the list. The default contains just the IP address of the IPv4
5743 loopback interface, which means that processes on the local host are able to
5744 submit mail for relaying by sending it over TCP/IP to that interface. No other
5745 hosts are permitted to submit messages for relaying.
5746
5747 Just to be sure there's no misunderstanding: at this point in the configuration
5748 we aren't actually setting up any controls. We are just defining some domains
5749 and hosts that will be used in the controls that are specified later.
5750
5751 The next two configuration lines are genuine option settings:
5752 .code
5753 acl_smtp_rcpt = acl_check_rcpt
5754 acl_smtp_data = acl_check_data
5755 .endd
5756 These options specify &'Access Control Lists'& (ACLs) that are to be used
5757 during an incoming SMTP session for every recipient of a message (every RCPT
5758 command), and after the contents of the message have been received,
5759 respectively. The names of the lists are &'acl_check_rcpt'& and
5760 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5761 section of the configuration. The RCPT ACL controls which recipients are
5762 accepted for an incoming message &-- if a configuration does not provide an ACL
5763 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5764 contents of a message to be checked.
5765
5766 Two commented-out option settings are next:
5767 .code
5768 # av_scanner = clamd:/tmp/clamd
5769 # spamd_address = 127.0.0.1 783
5770 .endd
5771 These are example settings that can be used when Exim is compiled with the
5772 content-scanning extension. The first specifies the interface to the virus
5773 scanner, and the second specifies the interface to SpamAssassin. Further
5774 details are given in chapter &<<CHAPexiscan>>&.
5775
5776 Three more commented-out option settings follow:
5777 .code
5778 # tls_advertise_hosts = *
5779 # tls_certificate = /etc/ssl/exim.crt
5780 # tls_privatekey = /etc/ssl/exim.pem
5781 .endd
5782 These are example settings that can be used when Exim is compiled with
5783 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5784 first one specifies the list of clients that are allowed to use TLS when
5785 connecting to this server; in this case, the wildcard means all clients. The
5786 other options specify where Exim should find its TLS certificate and private
5787 key, which together prove the server's identity to any clients that connect.
5788 More details are given in chapter &<<CHAPTLS>>&.
5789
5790 Another two commented-out option settings follow:
5791 .code
5792 # daemon_smtp_ports = 25 : 465 : 587
5793 # tls_on_connect_ports = 465
5794 .endd
5795 .cindex "port" "465 and 587"
5796 .cindex "port" "for message submission"
5797 .cindex "message" "submission, ports for"
5798 .cindex "submissions protocol"
5799 .cindex "smtps protocol"
5800 .cindex "ssmtp protocol"
5801 .cindex "SMTP" "submissions protocol"
5802 .cindex "SMTP" "ssmtp protocol"
5803 .cindex "SMTP" "smtps protocol"
5804 These options provide better support for roaming users who wish to use this
5805 server for message submission. They are not much use unless you have turned on
5806 TLS (as described in the previous paragraph) and authentication (about which
5807 more in section &<<SECTdefconfauth>>&).
5808 Mail submission from mail clients (MUAs) should be separate from inbound mail
5809 to your domain (MX delivery) for various good reasons (eg, ability to impose
5810 much saner TLS protocol and ciphersuite requirements without unintended
5811 consequences).
5812 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5813 which uses STARTTLS, so this is the &"submission"& port.
5814 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5815 which should be used in preference to 587.
5816 You should also consider deploying SRV records to help clients find
5817 these ports.
5818 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5819
5820 Two more commented-out options settings follow:
5821 .code
5822 # qualify_domain =
5823 # qualify_recipient =
5824 .endd
5825 The first of these specifies a domain that Exim uses when it constructs a
5826 complete email address from a local login name. This is often needed when Exim
5827 receives a message from a local process. If you do not set &%qualify_domain%&,
5828 the value of &%primary_hostname%& is used. If you set both of these options,
5829 you can have different qualification domains for sender and recipient
5830 addresses. If you set only the first one, its value is used in both cases.
5831
5832 .cindex "domain literal" "recognizing format"
5833 The following line must be uncommented if you want Exim to recognize
5834 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5835 (an IP address within square brackets) instead of a named domain.
5836 .code
5837 # allow_domain_literals
5838 .endd
5839 The RFCs still require this form, but many people think that in the modern
5840 Internet it makes little sense to permit mail to be sent to specific hosts by
5841 quoting their IP addresses. This ancient format has been used by people who
5842 try to abuse hosts by using them for unwanted relaying. However, some
5843 people believe there are circumstances (for example, messages addressed to
5844 &'postmaster'&) where domain literals are still useful.
5845
5846 The next configuration line is a kind of trigger guard:
5847 .code
5848 never_users = root
5849 .endd
5850 It specifies that no delivery must ever be run as the root user. The normal
5851 convention is to set up &'root'& as an alias for the system administrator. This
5852 setting is a guard against slips in the configuration.
5853 The list of users specified by &%never_users%& is not, however, the complete
5854 list; the build-time configuration in &_Local/Makefile_& has an option called
5855 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5856 contents of &%never_users%& are added to this list. By default
5857 FIXED_NEVER_USERS also specifies root.
5858
5859 When a remote host connects to Exim in order to send mail, the only information
5860 Exim has about the host's identity is its IP address. The next configuration
5861 line,
5862 .code
5863 host_lookup = *
5864 .endd
5865 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5866 in order to get a host name. This improves the quality of the logging
5867 information, but if you feel it is too expensive, you can remove it entirely,
5868 or restrict the lookup to hosts on &"nearby"& networks.
5869 Note that it is not always possible to find a host name from an IP address,
5870 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5871 unreachable.
5872
5873 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5874 1413 (hence their names):
5875 .code
5876 rfc1413_hosts = *
5877 rfc1413_query_timeout = 0s
5878 .endd
5879 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5880 Few hosts offer RFC1413 service these days; calls have to be
5881 terminated by a timeout and this needlessly delays the startup
5882 of an incoming SMTP connection.
5883 If you have hosts for which you trust RFC1413 and need this
5884 information, you can change this.
5885
5886 This line enables an efficiency SMTP option.  It is negotiated by clients
5887 and not expected to cause problems but can be disabled if needed.
5888 .code
5889 prdr_enable = true
5890 .endd
5891
5892 When Exim receives messages over SMTP connections, it expects all addresses to
5893 be fully qualified with a domain, as required by the SMTP definition. However,
5894 if you are running a server to which simple clients submit messages, you may
5895 find that they send unqualified addresses. The two commented-out options:
5896 .code
5897 # sender_unqualified_hosts =
5898 # recipient_unqualified_hosts =
5899 .endd
5900 show how you can specify hosts that are permitted to send unqualified sender
5901 and recipient addresses, respectively.
5902
5903 The &%log_selector%& option is used to increase the detail of logging
5904 over the default:
5905 .code
5906 log_selector = +smtp_protocol_error +smtp_syntax_error \
5907                +tls_certificate_verified
5908 .endd
5909
5910 The &%percent_hack_domains%& option is also commented out:
5911 .code
5912 # percent_hack_domains =
5913 .endd
5914 It provides a list of domains for which the &"percent hack"& is to operate.
5915 This is an almost obsolete form of explicit email routing. If you do not know
5916 anything about it, you can safely ignore this topic.
5917
5918 The next two settings in the main part of the default configuration are
5919 concerned with messages that have been &"frozen"& on Exim's queue. When a
5920 message is frozen, Exim no longer continues to try to deliver it. Freezing
5921 occurs when a bounce message encounters a permanent failure because the sender
5922 address of the original message that caused the bounce is invalid, so the
5923 bounce cannot be delivered. This is probably the most common case, but there
5924 are also other conditions that cause freezing, and frozen messages are not
5925 always bounce messages.
5926 .code
5927 ignore_bounce_errors_after = 2d
5928 timeout_frozen_after = 7d
5929 .endd
5930 The first of these options specifies that failing bounce messages are to be
5931 discarded after 2 days in the queue. The second specifies that any frozen
5932 message (whether a bounce message or not) is to be timed out (and discarded)
5933 after a week. In this configuration, the first setting ensures that no failing
5934 bounce message ever lasts a week.
5935
5936 Exim queues it's messages in a spool directory. If you expect to have
5937 large queues, you may consider using this option. It splits the spool
5938 directory into subdirectories to avoid file system degradation from
5939 many files in a single directory, resulting in better performance.
5940 Manual manipulation of queued messages becomes more complex (though fortunately
5941 not often needed).
5942 .code
5943 # split_spool_directory = true
5944 .endd
5945
5946 In an ideal world everybody follows the standards. For non-ASCII
5947 messages RFC 2047 is a standard, allowing a maximum line length of 76
5948 characters. Exim adheres that standard and won't process messages which
5949 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5950 In particular, the Exim maintainers have had multiple reports of
5951 problems from Russian administrators of issues until they disable this
5952 check, because of some popular, yet buggy, mail composition software.
5953 .code
5954 # check_rfc2047_length = false
5955 .endd
5956
5957 If you need to be strictly RFC compliant you may wish to disable the
5958 8BITMIME advertisement. Use this, if you exchange mails with systems
5959 that are not 8-bit clean.
5960 .code
5961 # accept_8bitmime = false
5962 .endd
5963
5964 Libraries you use may depend on specific environment settings.  This
5965 imposes a security risk (e.g. PATH). There are two lists:
5966 &%keep_environment%& for the variables to import as they are, and
5967 &%add_environment%& for variables we want to set to a fixed value.
5968 Note that TZ is handled separately, by the &%timezone%& runtime
5969 option and by the TIMEZONE_DEFAULT buildtime option.
5970 .code
5971 # keep_environment = ^LDAP
5972 # add_environment = PATH=/usr/bin::/bin
5973 .endd
5974
5975
5976 .section "ACL configuration" "SECID54"
5977 .cindex "default" "ACLs"
5978 .cindex "&ACL;" "default configuration"
5979 In the default configuration, the ACL section follows the main configuration.
5980 It starts with the line
5981 .code
5982 begin acl
5983 .endd
5984 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5985 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5986 and &%acl_smtp_data%& above.
5987
5988 .cindex "RCPT" "ACL for"
5989 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5990 RCPT command specifies one of the message's recipients. The ACL statements
5991 are considered in order, until the recipient address is either accepted or
5992 rejected. The RCPT command is then accepted or rejected, according to the
5993 result of the ACL processing.
5994 .code
5995 acl_check_rcpt:
5996 .endd
5997 This line, consisting of a name terminated by a colon, marks the start of the
5998 ACL, and names it.
5999 .code
6000 accept  hosts = :
6001 .endd
6002 This ACL statement accepts the recipient if the sending host matches the list.
6003 But what does that strange list mean? It doesn't actually contain any host
6004 names or IP addresses. The presence of the colon puts an empty item in the
6005 list; Exim matches this only if the incoming message did not come from a remote
6006 host, because in that case, the remote hostname is empty. The colon is
6007 important. Without it, the list itself is empty, and can never match anything.
6008
6009 What this statement is doing is to accept unconditionally all recipients in
6010 messages that are submitted by SMTP from local processes using the standard
6011 input and output (that is, not using TCP/IP). A number of MUAs operate in this
6012 manner.
6013 .code
6014 deny    domains       = +local_domains
6015         local_parts   = ^[.] : ^.*[@%!/|]
6016         message       = Restricted characters in address
6017
6018 deny    domains       = !+local_domains
6019         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
6020         message       = Restricted characters in address
6021 .endd
6022 These statements are concerned with local parts that contain any of the
6023 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
6024 Although these characters are entirely legal in local parts (in the case of
6025 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
6026 in Internet mail addresses.
6027
6028 The first three have in the past been associated with explicitly routed
6029 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
6030 option). Addresses containing these characters are regularly tried by spammers
6031 in an attempt to bypass relaying restrictions, and also by open relay testing
6032 programs. Unless you really need them it is safest to reject these characters
6033 at this early stage. This configuration is heavy-handed in rejecting these
6034 characters for all messages it accepts from remote hosts. This is a deliberate
6035 policy of being as safe as possible.
6036
6037 The first rule above is stricter, and is applied to messages that are addressed
6038 to one of the local domains handled by this host. This is implemented by the
6039 first condition, which restricts it to domains that are listed in the
6040 &'local_domains'& domain list. The &"+"& character is used to indicate a
6041 reference to a named list. In this configuration, there is just one domain in
6042 &'local_domains'&, but in general there may be many.
6043
6044 The second condition on the first statement uses two regular expressions to
6045 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
6046 or &"|"&. If you have local accounts that include these characters, you will
6047 have to modify this rule.
6048
6049 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
6050 allows them because they have been encountered in practice. (Consider the
6051 common convention of local parts constructed as
6052 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
6053 the author of Exim, who has no second initial.) However, a local part starting
6054 with a dot or containing &"/../"& can cause trouble if it is used as part of a
6055 filename (for example, for a mailing list). This is also true for local parts
6056 that contain slashes. A pipe symbol can also be troublesome if the local part
6057 is incorporated unthinkingly into a shell command line.
6058
6059 The second rule above applies to all other domains, and is less strict. This
6060 allows your own users to send outgoing messages to sites that use slashes
6061 and vertical bars in their local parts. It blocks local parts that begin
6062 with a dot, slash, or vertical bar, but allows these characters within the
6063 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
6064 and &"!"& is blocked, as before. The motivation here is to prevent your users
6065 (or your users' viruses) from mounting certain kinds of attack on remote sites.
6066 .code
6067 accept  local_parts   = postmaster
6068         domains       = +local_domains
6069 .endd
6070 This statement, which has two conditions, accepts an incoming address if the
6071 local part is &'postmaster'& and the domain is one of those listed in the
6072 &'local_domains'& domain list. The &"+"& character is used to indicate a
6073 reference to a named list. In this configuration, there is just one domain in
6074 &'local_domains'&, but in general there may be many.
6075
6076 The presence of this statement means that mail to postmaster is never blocked
6077 by any of the subsequent tests. This can be helpful while sorting out problems
6078 in cases where the subsequent tests are incorrectly denying access.
6079 .code
6080 require verify        = sender
6081 .endd
6082 This statement requires the sender address to be verified before any subsequent
6083 ACL statement can be used. If verification fails, the incoming recipient
6084 address is refused. Verification consists of trying to route the address, to
6085 see if a bounce message could be delivered to it. In the case of remote
6086 addresses, basic verification checks only the domain, but &'callouts'& can be
6087 used for more verification if required. Section &<<SECTaddressverification>>&
6088 discusses the details of address verification.
6089 .code
6090 accept  hosts         = +relay_from_hosts
6091         control       = submission
6092 .endd
6093 This statement accepts the address if the message is coming from one of the
6094 hosts that are defined as being allowed to relay through this host. Recipient
6095 verification is omitted here, because in many cases the clients are dumb MUAs
6096 that do not cope well with SMTP error responses. For the same reason, the
6097 second line specifies &"submission mode"& for messages that are accepted. This
6098 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
6099 messages that are deficient in some way, for example, because they lack a
6100 &'Date:'& header line. If you are actually relaying out from MTAs, you should
6101 probably add recipient verification here, and disable submission mode.
6102 .code
6103 accept  authenticated = *
6104         control       = submission
6105 .endd
6106 This statement accepts the address if the client host has authenticated itself.
6107 Submission mode is again specified, on the grounds that such messages are most
6108 likely to come from MUAs. The default configuration does not define any
6109 authenticators, though it does include some nearly complete commented-out
6110 examples described in &<<SECTdefconfauth>>&. This means that no client can in
6111 fact authenticate until you complete the authenticator definitions.
6112 .code
6113 require message = relay not permitted
6114         domains = +local_domains : +relay_to_domains
6115 .endd
6116 This statement rejects the address if its domain is neither a local domain nor
6117 one of the domains for which this host is a relay.
6118 .code
6119 require verify = recipient
6120 .endd
6121 This statement requires the recipient address to be verified; if verification
6122 fails, the address is rejected.
6123 .code
6124 # deny    dnslists    = black.list.example
6125 #         message     = rejected because $sender_host_address \
6126 #                       is in a black list at $dnslist_domain\n\
6127 #                       $dnslist_text
6128 #
6129 # warn    dnslists    = black.list.example
6130 #         add_header  = X-Warning: $sender_host_address is in \
6131 #                       a black list at $dnslist_domain
6132 #         log_message = found in $dnslist_domain
6133 .endd
6134 These commented-out lines are examples of how you could configure Exim to check
6135 sending hosts against a DNS black list. The first statement rejects messages
6136 from blacklisted hosts, whereas the second just inserts a warning header
6137 line.
6138 .code
6139 # require verify = csa
6140 .endd
6141 This commented-out line is an example of how you could turn on client SMTP
6142 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6143 records.
6144 .code
6145 accept
6146 .endd
6147 The final statement in the first ACL unconditionally accepts any recipient
6148 address that has successfully passed all the previous tests.
6149 .code
6150 acl_check_data:
6151 .endd
6152 This line marks the start of the second ACL, and names it. Most of the contents
6153 of this ACL are commented out:
6154 .code
6155 # deny    malware   = *
6156 #         message   = This message contains a virus \
6157 #                     ($malware_name).
6158 .endd
6159 These lines are examples of how to arrange for messages to be scanned for
6160 viruses when Exim has been compiled with the content-scanning extension, and a
6161 suitable virus scanner is installed. If the message is found to contain a
6162 virus, it is rejected with the given custom error message.
6163 .code
6164 # warn    spam      = nobody
6165 #         message   = X-Spam_score: $spam_score\n\
6166 #                     X-Spam_score_int: $spam_score_int\n\
6167 #                     X-Spam_bar: $spam_bar\n\
6168 #                     X-Spam_report: $spam_report
6169 .endd
6170 These lines are an example of how to arrange for messages to be scanned by
6171 SpamAssassin when Exim has been compiled with the content-scanning extension,
6172 and SpamAssassin has been installed. The SpamAssassin check is run with
6173 &`nobody`& as its user parameter, and the results are added to the message as a
6174 series of extra header line. In this case, the message is not rejected,
6175 whatever the spam score.
6176 .code
6177 accept
6178 .endd
6179 This final line in the DATA ACL accepts the message unconditionally.
6180
6181
6182 .section "Router configuration" "SECID55"
6183 .cindex "default" "routers"
6184 .cindex "routers" "default"
6185 The router configuration comes next in the default configuration, introduced
6186 by the line
6187 .code
6188 begin routers
6189 .endd
6190 Routers are the modules in Exim that make decisions about where to send
6191 messages. An address is passed to each router, in turn, until it is either
6192 accepted, or failed. This means that the order in which you define the routers
6193 matters. Each router is fully described in its own chapter later in this
6194 manual. Here we give only brief overviews.
6195 .code
6196 # domain_literal:
6197 #   driver = ipliteral
6198 #   domains = !+local_domains
6199 #   transport = remote_smtp
6200 .endd
6201 .cindex "domain literal" "default router"
6202 This router is commented out because the majority of sites do not want to
6203 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6204 you uncomment this router, you also need to uncomment the setting of
6205 &%allow_domain_literals%& in the main part of the configuration.
6206
6207 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6208 macro has been defined, per
6209 .code
6210 .ifdef ROUTER_SMARTHOST
6211 smarthost:
6212 #...
6213 .else
6214 dnslookup:
6215 #...
6216 .endif
6217 .endd
6218
6219 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6220 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6221 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6222 skip these routers because of the &%domains%& option.
6223
6224 .code
6225 smarthost:
6226   driver = manualroute
6227   domains = ! +local_domains
6228   transport = smarthost_smtp
6229   route_data = ROUTER_SMARTHOST
6230   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6231   no_more
6232 .endd
6233 This router only handles mail which is not to any local domains; this is
6234 specified by the line
6235 .code
6236 domains = ! +local_domains
6237 .endd
6238 The &%domains%& option lists the domains to which this router applies, but the
6239 exclamation mark is a negation sign, so the router is used only for domains
6240 that are not in the domain list called &'local_domains'& (which was defined at
6241 the start of the configuration). The plus sign before &'local_domains'&
6242 indicates that it is referring to a named list. Addresses in other domains are
6243 passed on to the following routers.
6244
6245 The name of the router driver is &(manualroute)& because we are manually
6246 specifying how mail should be routed onwards, instead of using DNS MX.
6247 While the name of this router instance is arbitrary, the &%driver%& option must
6248 be one of the driver modules that is in the Exim binary.
6249
6250 With no pre-conditions other than &%domains%&, all mail for non-local domains
6251 will be handled by this router, and the &%no_more%& setting will ensure that no
6252 other routers will be used for messages matching the pre-conditions.  See
6253 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6254 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6255 and the macro supplies the value; the address is then queued for the
6256 &(smarthost_smtp)& transport.
6257
6258 .code
6259 dnslookup:
6260   driver = dnslookup
6261   domains = ! +local_domains
6262   transport = remote_smtp
6263   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6264   no_more
6265 .endd
6266 The &%domains%& option behaves as per smarthost, above.
6267
6268 The name of the router driver is &(dnslookup)&,
6269 and is specified by the &%driver%& option. Do not be confused by the fact that
6270 the name of this router instance is the same as the name of the driver. The
6271 instance name is arbitrary, but the name set in the &%driver%& option must be
6272 one of the driver modules that is in the Exim binary.
6273
6274 The &(dnslookup)& router routes addresses by looking up their domains in the
6275 DNS in order to obtain a list of hosts to which the address is routed. If the
6276 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6277 specified by the &%transport%& option. If the router does not find the domain
6278 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6279 the address fails and is bounced.
6280
6281 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6282 be entirely ignored. This option is present because a number of cases have been
6283 encountered where MX records in the DNS point to host names
6284 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6285 Completely ignoring these IP addresses causes Exim to fail to route the
6286 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6287 continue to try to deliver the message periodically until the address timed
6288 out.
6289 .code
6290 system_aliases:
6291   driver = redirect
6292   allow_fail
6293   allow_defer
6294   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6295 # user = exim
6296   file_transport = address_file
6297   pipe_transport = address_pipe
6298 .endd
6299 Control reaches this and subsequent routers only for addresses in the local
6300 domains. This router checks to see whether the local part is defined as an
6301 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6302 data that it looks up from that file. If no data is found for the local part,
6303 the value of the &%data%& option is empty, causing the address to be passed to
6304 the next router.
6305
6306 &_/etc/aliases_& is a conventional name for the system aliases file that is
6307 often used. That is why it is referenced by from the default configuration
6308 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6309 &_Local/Makefile_& before building Exim.
6310 .code
6311 userforward:
6312   driver = redirect
6313   check_local_user
6314 # local_part_suffix = +* : -*
6315 # local_part_suffix_optional
6316   file = $home/.forward
6317 # allow_filter
6318   no_verify
6319   no_expn
6320   check_ancestor
6321   file_transport = address_file
6322   pipe_transport = address_pipe
6323   reply_transport = address_reply
6324 .endd
6325 This is the most complicated router in the default configuration. It is another
6326 redirection router, but this time it is looking for forwarding data set up by
6327 individual users. The &%check_local_user%& setting specifies a check that the
6328 local part of the address is the login name of a local user. If it is not, the
6329 router is skipped. The two commented options that follow &%check_local_user%&,
6330 namely:
6331 .code
6332 # local_part_suffix = +* : -*
6333 # local_part_suffix_optional
6334 .endd
6335 .vindex "&$local_part_suffix$&"
6336 show how you can specify the recognition of local part suffixes. If the first
6337 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6338 by any sequence of characters, is removed from the local part and placed in the
6339 variable &$local_part_suffix$&. The second suffix option specifies that the
6340 presence of a suffix in the local part is optional. When a suffix is present,
6341 the check for a local login uses the local part with the suffix removed.
6342
6343 When a local user account is found, the file called &_.forward_& in the user's
6344 home directory is consulted. If it does not exist, or is empty, the router
6345 declines. Otherwise, the contents of &_.forward_& are interpreted as
6346 redirection data (see chapter &<<CHAPredirect>>& for more details).
6347
6348 .cindex "Sieve filter" "enabling in default router"
6349 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6350 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6351 is commented out by default), the contents of the file are interpreted as a set
6352 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6353 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6354 separate document entitled &'Exim's interfaces to mail filtering'&.
6355
6356 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6357 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6358 There are two reasons for doing this:
6359
6360 .olist
6361 Whether or not a local user has a &_.forward_& file is not really relevant when
6362 checking an address for validity; it makes sense not to waste resources doing
6363 unnecessary work.
6364 .next
6365 More importantly, when Exim is verifying addresses or handling an EXPN
6366 command during an SMTP session, it is running as the Exim user, not as root.
6367 The group is the Exim group, and no additional groups are set up.
6368 It may therefore not be possible for Exim to read users' &_.forward_& files at
6369 this time.
6370 .endlist
6371
6372 The setting of &%check_ancestor%& prevents the router from generating a new
6373 address that is the same as any previous address that was redirected. (This
6374 works round a problem concerning a bad interaction between aliasing and
6375 forwarding &-- see section &<<SECTredlocmai>>&).
6376
6377 The final three option settings specify the transports that are to be used when
6378 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6379 auto-reply, respectively. For example, if a &_.forward_& file contains
6380 .code
6381 a.nother@elsewhere.example, /home/spqr/archive
6382 .endd
6383 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6384 transport.
6385 .code
6386 localuser:
6387   driver = accept
6388   check_local_user
6389 # local_part_suffix = +* : -*
6390 # local_part_suffix_optional
6391   transport = local_delivery
6392 .endd
6393 The final router sets up delivery into local mailboxes, provided that the local
6394 part is the name of a local login, by accepting the address and assigning it to
6395 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6396 routers, so the address is bounced. The commented suffix settings fulfil the
6397 same purpose as they do for the &(userforward)& router.
6398
6399
6400 .section "Transport configuration" "SECID56"
6401 .cindex "default" "transports"
6402 .cindex "transports" "default"
6403 Transports define mechanisms for actually delivering messages. They operate
6404 only when referenced from routers, so the order in which they are defined does
6405 not matter. The transports section of the configuration starts with
6406 .code
6407 begin transports
6408 .endd
6409 Two remote transports and four local transports are defined.
6410 .code
6411 remote_smtp:
6412   driver = smtp
6413   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6414 .ifdef _HAVE_PRDR
6415   hosts_try_prdr = *
6416 .endif
6417 .endd
6418 This transport is used for delivering messages over SMTP connections.
6419 The list of remote hosts comes from the router.
6420 The &%message_size_limit%& usage is a hack to avoid sending on messages
6421 with over-long lines.
6422
6423 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6424 negotiated between client and server and not expected to cause problems
6425 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6426 use of the &%hosts_try_prdr%& configuration option.
6427
6428 The other remote transport is used when delivering to a specific smarthost
6429 with whom there must be some kind of existing relationship, instead of the
6430 usual federated system.
6431
6432 .code
6433 smarthost_smtp:
6434   driver = smtp
6435   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6436   multi_domain
6437   #
6438 .ifdef _HAVE_TLS
6439   # Comment out any of these which you have to, then file a Support
6440   # request with your smarthost provider to get things fixed:
6441   hosts_require_tls = *
6442   tls_verify_hosts = *
6443   # As long as tls_verify_hosts is enabled, this this will have no effect,
6444   # but if you have to comment it out then this will at least log whether
6445   # you succeed or not:
6446   tls_try_verify_hosts = *
6447   #
6448   # The SNI name should match the name which we'll expect to verify;
6449   # many mail systems don't use SNI and this doesn't matter, but if it does,
6450   # we need to send a name which the remote site will recognize.
6451   # This _should_ be the name which the smarthost operators specified as
6452   # the hostname for sending your mail to.
6453   tls_sni = ROUTER_SMARTHOST
6454   #
6455 .ifdef _HAVE_OPENSSL
6456   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6457 .endif
6458 .ifdef _HAVE_GNUTLS
6459   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6460 .endif
6461 .endif
6462 .ifdef _HAVE_PRDR
6463   hosts_try_prdr = *
6464 .endif
6465 .endd
6466 After the same &%message_size_limit%& hack, we then specify that this Transport
6467 can handle messages to multiple domains in one run.  The assumption here is
6468 that you're routing all non-local mail to the same place and that place is
6469 happy to take all messages from you as quickly as possible.
6470 All other options depend upon built-in macros; if Exim was built without TLS support
6471 then no other options are defined.
6472 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6473 and versions using the &%tls_require_ciphers%& option, where the value to be
6474 used depends upon the library providing TLS.
6475 Beyond that, the options adopt the stance that you should have TLS support available
6476 from your smarthost on today's Internet, so we turn on requiring TLS for the
6477 mail to be delivered, and requiring that the certificate be valid, and match
6478 the expected hostname.  The &%tls_sni%& option can be used by service providers
6479 to select an appropriate certificate to present to you and here we re-use the
6480 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6481 You want to specify the hostname which you'll expect to validate for, and that
6482 should not be subject to insecure tampering via DNS results.
6483
6484 For the &%hosts_try_prdr%& option see the previous transport.
6485
6486 All other options are defaulted.
6487 .code
6488 local_delivery:
6489   driver = appendfile
6490   file = /var/mail/$local_part_data
6491   delivery_date_add
6492   envelope_to_add
6493   return_path_add
6494 # group = mail
6495 # mode = 0660
6496 .endd
6497 This &(appendfile)& transport is used for local delivery to user mailboxes in
6498 traditional BSD mailbox format.
6499
6500 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6501 as it is provided by a potential bad actor.
6502 Instead we use &$local_part_data$&,
6503 the result of looking up &$local_part$& in the user database
6504 (done by using &%check_local_user%& in the the router).
6505
6506 By default &(appendfile)& runs under the uid and gid of the
6507 local user, which requires the sticky bit to be set on the &_/var/mail_&
6508 directory. Some systems use the alternative approach of running mail deliveries
6509 under a particular group instead of using the sticky bit. The commented options
6510 show how this can be done.
6511
6512 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6513 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6514 similarly-named options above.
6515 .code
6516 address_pipe:
6517   driver = pipe
6518   return_output
6519 .endd
6520 This transport is used for handling deliveries to pipes that are generated by
6521 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6522 option specifies that any output on stdout or stderr generated by the pipe is to
6523 be returned to the sender.
6524 .code
6525 address_file:
6526   driver = appendfile
6527   delivery_date_add
6528   envelope_to_add
6529   return_path_add
6530 .endd
6531 This transport is used for handling deliveries to files that are generated by
6532 redirection. The name of the file is not specified in this instance of
6533 &(appendfile)&, because it comes from the &(redirect)& router.
6534 .code
6535 address_reply:
6536   driver = autoreply
6537 .endd
6538 This transport is used for handling automatic replies generated by users'
6539 filter files.
6540
6541
6542
6543 .section "Default retry rule" "SECID57"
6544 .cindex "retry" "default rule"
6545 .cindex "default" "retry rule"
6546 The retry section of the configuration file contains rules which affect the way
6547 Exim retries deliveries that cannot be completed at the first attempt. It is
6548 introduced by the line
6549 .code
6550 begin retry
6551 .endd
6552 In the default configuration, there is just one rule, which applies to all
6553 errors:
6554 .code
6555 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6556 .endd
6557 This causes any temporarily failing address to be retried every 15 minutes for
6558 2 hours, then at intervals starting at one hour and increasing by a factor of
6559 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6560 is not delivered after 4 days of temporary failure, it is bounced. The time is
6561 measured from first failure, not from the time the message was received.
6562
6563 If the retry section is removed from the configuration, or is empty (that is,
6564 if no retry rules are defined), Exim will not retry deliveries. This turns
6565 temporary errors into permanent errors.
6566
6567
6568 .section "Rewriting configuration" "SECID58"
6569 The rewriting section of the configuration, introduced by
6570 .code
6571 begin rewrite
6572 .endd
6573 contains rules for rewriting addresses in messages as they arrive. There are no
6574 rewriting rules in the default configuration file.
6575
6576
6577
6578 .section "Authenticators configuration" "SECTdefconfauth"
6579 .cindex "AUTH" "configuration"
6580 The authenticators section of the configuration, introduced by
6581 .code
6582 begin authenticators
6583 .endd
6584 defines mechanisms for the use of the SMTP AUTH command. The default
6585 configuration file contains two commented-out example authenticators
6586 which support plaintext username/password authentication using the
6587 standard PLAIN mechanism and the traditional but non-standard LOGIN
6588 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6589 to support most MUA software.
6590
6591 The example PLAIN authenticator looks like this:
6592 .code
6593 #PLAIN:
6594 #  driver                  = plaintext
6595 #  server_set_id           = $auth2
6596 #  server_prompts          = :
6597 #  server_condition        = Authentication is not yet configured
6598 #  server_advertise_condition = ${if def:tls_in_cipher }
6599 .endd
6600 And the example LOGIN authenticator looks like this:
6601 .code
6602 #LOGIN:
6603 #  driver                  = plaintext
6604 #  server_set_id           = $auth1
6605 #  server_prompts          = <| Username: | Password:
6606 #  server_condition        = Authentication is not yet configured
6607 #  server_advertise_condition = ${if def:tls_in_cipher }
6608 .endd
6609
6610 The &%server_set_id%& option makes Exim remember the authenticated username
6611 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6612 &%server_prompts%& option configures the &(plaintext)& authenticator so
6613 that it implements the details of the specific authentication mechanism,
6614 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6615 when Exim offers authentication to clients; in the examples, this is only
6616 when TLS or SSL has been started, so to enable the authenticators you also
6617 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6618
6619 The &%server_condition%& setting defines how to verify that the username and
6620 password are correct. In the examples it just produces an error message.
6621 To make the authenticators work, you can use a string expansion
6622 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6623
6624 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6625 usercode and password are in different positions.
6626 Chapter &<<CHAPplaintext>>& covers both.
6627
6628 .ecindex IIDconfiwal
6629
6630
6631
6632 . ////////////////////////////////////////////////////////////////////////////
6633 . ////////////////////////////////////////////////////////////////////////////
6634
6635 .chapter "Regular expressions" "CHAPregexp"
6636
6637 .cindex "regular expressions" "library"
6638 .cindex "PCRE"
6639 Exim supports the use of regular expressions in many of its options. It
6640 uses the PCRE regular expression library; this provides regular expression
6641 matching that is compatible with Perl 5. The syntax and semantics of
6642 regular expressions is discussed in
6643 online Perl manpages, in
6644 many Perl reference books, and also in
6645 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6646 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6647 . --- the http: URL here redirects to another page with the ISBN in the URL
6648 . --- where trying to use https: just redirects back to http:, so sticking
6649 . --- to the old URL for now.  2018-09-07.
6650
6651 The documentation for the syntax and semantics of the regular expressions that
6652 are supported by PCRE is included in the PCRE distribution, and no further
6653 description is included here. The PCRE functions are called from Exim using
6654 the default option settings (that is, with no PCRE options set), except that
6655 the PCRE_CASELESS option is set when the matching is required to be
6656 case-insensitive.
6657
6658 In most cases, when a regular expression is required in an Exim configuration,
6659 it has to start with a circumflex, in order to distinguish it from plain text
6660 or an &"ends with"& wildcard. In this example of a configuration setting, the
6661 second item in the colon-separated list is a regular expression.
6662 .code
6663 domains = a.b.c : ^\\d{3} : *.y.z : ...
6664 .endd
6665 The doubling of the backslash is required because of string expansion that
6666 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6667 of this issue, and a way of avoiding the need for doubling backslashes. The
6668 regular expression that is eventually used in this example contains just one
6669 backslash. The circumflex is included in the regular expression, and has the
6670 normal effect of &"anchoring"& it to the start of the string that is being
6671 matched.
6672
6673 There are, however, two cases where a circumflex is not required for the
6674 recognition of a regular expression: these are the &%match%& condition in a
6675 string expansion, and the &%matches%& condition in an Exim filter file. In
6676 these cases, the relevant string is always treated as a regular expression; if
6677 it does not start with a circumflex, the expression is not anchored, and can
6678 match anywhere in the subject string.
6679
6680 In all cases, if you want a regular expression to match at the end of a string,
6681 you must code the $ metacharacter to indicate this. For example:
6682 .code
6683 domains = ^\\d{3}\\.example
6684 .endd
6685 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6686 You need to use:
6687 .code
6688 domains = ^\\d{3}\\.example\$
6689 .endd
6690 if you want &'example'& to be the top-level domain. The backslash before the
6691 $ is needed because string expansion also interprets dollar characters.
6692
6693
6694
6695 . ////////////////////////////////////////////////////////////////////////////
6696 . ////////////////////////////////////////////////////////////////////////////
6697
6698 .chapter "File and database lookups" "CHAPfdlookup"
6699 .scindex IIDfidalo1 "file" "lookups"
6700 .scindex IIDfidalo2 "database" "lookups"
6701 .cindex "lookup" "description of"
6702 Exim can be configured to look up data in files or databases as it processes
6703 messages. Two different kinds of syntax are used:
6704
6705 .olist
6706 A string that is to be expanded may contain explicit lookup requests. These
6707 cause parts of the string to be replaced by data that is obtained from the
6708 lookup. Lookups of this type are conditional expansion items. Different results
6709 can be defined for the cases of lookup success and failure. See chapter
6710 &<<CHAPexpand>>&, where string expansions are described in detail.
6711 The key for the lookup is &*specified*& as part of the string expansion.
6712 .next
6713 Lists of domains, hosts, and email addresses can contain lookup requests as a
6714 way of avoiding excessively long linear lists. In this case, the data that is
6715 returned by the lookup is often (but not always) discarded; whether the lookup
6716 succeeds or fails is what really counts. These kinds of list are described in
6717 chapter &<<CHAPdomhosaddlists>>&.
6718 The key for the lookup is &*implicit*&,
6719 given by the context in which the list is expanded.
6720 .endlist
6721
6722 String expansions, lists, and lookups interact with each other in such a way
6723 that there is no order in which to describe any one of them that does not
6724 involve references to the others. Each of these three chapters makes more sense
6725 if you have read the other two first. If you are reading this for the first
6726 time, be aware that some of it will make a lot more sense after you have read
6727 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6728
6729 .section "Examples of different lookup syntax" "SECID60"
6730 It is easy to confuse the two different kinds of lookup, especially as the
6731 lists that may contain the second kind are always expanded before being
6732 processed as lists. Therefore, they may also contain lookups of the first kind.
6733 Be careful to distinguish between the following two examples:
6734 .code
6735 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6736 domains = lsearch;/some/file
6737 .endd
6738 The first uses a string expansion, the result of which must be a domain list.
6739 No strings have been specified for a successful or a failing lookup; the
6740 defaults in this case are the looked-up data and an empty string, respectively.
6741 The expansion takes place before the string is processed as a list, and the
6742 file that is searched could contain lines like this:
6743 .code
6744 192.168.3.4: domain1:domain2:...
6745 192.168.1.9: domain3:domain4:...
6746 .endd
6747 When the lookup succeeds, the result of the expansion is a list of domains (and
6748 possibly other types of item that are allowed in domain lists).
6749 .cindex "tainted data" "de-tainting"
6750 The result of the expansion is not tainted.
6751
6752 In the second example, the lookup is a single item in a domain list. It causes
6753 Exim to use a lookup to see if the domain that is being processed can be found
6754 in the file.
6755 The file could contains lines like this:
6756 .code
6757 domain1:
6758 domain2:
6759 .endd
6760 Any data that follows the keys is not relevant when checking that the domain
6761 matches the list item.
6762
6763 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6764 Consider a file containing lines like this:
6765 .code
6766 192.168.5.6: lsearch;/another/file
6767 .endd
6768 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6769 first &%domains%& setting above generates the second setting, which therefore
6770 causes a second lookup to occur.
6771
6772 The lookup type may optionally be followed by a comma
6773 and a comma-separated list of options.
6774 Each option is a &"name=value"& pair.
6775 Whether an option is meaningful depends on the lookup type.
6776
6777 All lookups support the option &"cache=no_rd"&.
6778 If this is given then the cache that Exim manages for lookup results
6779 is not checked before doing the lookup.
6780 The result of the lookup is still written to the cache.
6781
6782 The rest of this chapter describes the different lookup types that are
6783 available. Any of them can be used in any part of the configuration where a
6784 lookup is permitted.
6785
6786
6787 .section "Lookup types" "SECID61"
6788 .cindex "lookup" "types of"
6789 .cindex "single-key lookup" "definition of"
6790 Two different types of data lookup are implemented:
6791
6792 .ilist
6793 The &'single-key'& type requires the specification of a file in which to look,
6794 and a single key to search for. The key must be a non-empty string for the
6795 lookup to succeed. The lookup type determines how the file is searched.
6796 .cindex "tainted data" "single-key lookups"
6797 The file string may not be tainted
6798
6799 .cindex "tainted data" "de-tainting"
6800 All single-key lookups support the option &"ret=key"&.
6801 If this is given and the lookup
6802 (either underlying implementation or cached value)
6803 returns data, the result is replaced with a non-tainted
6804 version of the lookup key.
6805 .cindex "tainted data" "de-tainting"
6806 .next
6807 .cindex "query-style lookup" "definition of"
6808 The &'query-style'& type accepts a generalized database query. No particular
6809 key value is assumed by Exim for query-style lookups. You can use whichever
6810 Exim variables you need to construct the database query.
6811 .endlist
6812
6813 The code for each lookup type is in a separate source file that is included in
6814 the binary of Exim only if the corresponding compile-time option is set. The
6815 default settings in &_src/EDITME_& are:
6816 .code
6817 LOOKUP_DBM=yes
6818 LOOKUP_LSEARCH=yes
6819 .endd
6820 which means that only linear searching and DBM lookups are included by default.
6821 For some types of lookup (e.g. SQL databases), you need to install appropriate
6822 libraries and header files before building Exim.
6823
6824
6825
6826
6827 .section "Single-key lookup types" "SECTsinglekeylookups"
6828 .cindex "lookup" "single-key types"
6829 .cindex "single-key lookup" "list of types"
6830 The following single-key lookup types are implemented:
6831
6832 .ilist
6833 .cindex "cdb" "description of"
6834 .cindex "lookup" "cdb"
6835 .cindex "binary zero" "in lookup key"
6836 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6837 string without a terminating binary zero. The cdb format is designed for
6838 indexed files that are read frequently and never updated, except by total
6839 re-creation. As such, it is particularly suitable for large files containing
6840 aliases or other indexed data referenced by an MTA. Information about cdb and
6841 tools for building the files can be found in several places:
6842 .display
6843 &url(https://cr.yp.to/cdb.html)
6844 &url(https://www.corpit.ru/mjt/tinycdb.html)
6845 &url(https://packages.debian.org/stable/utils/freecdb)
6846 &url(https://github.com/philpennock/cdbtools) (in Go)
6847 .endd
6848 A cdb distribution is not needed in order to build Exim with cdb support,
6849 because the code for reading cdb files is included directly in Exim itself.
6850 However, no means of building or testing cdb files is provided with Exim, so
6851 you need to obtain a cdb distribution in order to do this.
6852 .next
6853 .cindex "DBM" "lookup type"
6854 .cindex "lookup" "dbm"
6855 .cindex "binary zero" "in lookup key"
6856 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6857 DBM file by looking up the record with the given key. A terminating binary
6858 zero is included in the key that is passed to the DBM library. See section
6859 &<<SECTdb>>& for a discussion of DBM libraries.
6860
6861 .cindex "Berkeley DB library" "file format"
6862 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6863 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6864 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6865 the DB_UNKNOWN option. This enables it to handle any of the types of database
6866 that the library supports, and can be useful for accessing DBM files created by
6867 other applications. (For earlier DB versions, DB_HASH is always used.)
6868 .next
6869 .cindex "lookup" "dbmjz"
6870 .cindex "lookup" "dbm &-- embedded NULs"
6871 .cindex "sasldb2"
6872 .cindex "dbmjz lookup type"
6873 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6874 interpreted as an Exim list; the elements of the list are joined together with
6875 ASCII NUL characters to form the lookup key.  An example usage would be to
6876 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6877 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6878 &(cram_md5)& authenticator.
6879 .next
6880 .cindex "lookup" "dbmnz"
6881 .cindex "lookup" "dbm &-- terminating zero"
6882 .cindex "binary zero" "in lookup key"
6883 .cindex "Courier"
6884 .cindex "&_/etc/userdbshadow.dat_&"
6885 .cindex "dbmnz lookup type"
6886 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6887 is not included in the key that is passed to the DBM library. You may need this
6888 if you want to look up data in files that are created by or shared with some
6889 other application that does not use terminating zeros. For example, you need to
6890 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6891 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6892 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6893 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6894 .next
6895 .cindex "lookup" "dsearch"
6896 .cindex "dsearch lookup type"
6897 &(dsearch)&: The given file must be an
6898 absolute
6899 directory path; this is searched for an entry
6900 whose name is the key by calling the &[lstat()]& function.
6901 The key may not
6902 contain any forward slash characters.
6903 If &[lstat()]& succeeds then so does the lookup.
6904 .cindex "tainted data" "dsearch result"
6905 The result is regarded as untainted.
6906
6907 Options for the lookup can be given by appending them after the word "dsearch",
6908 separated by a comma.  Options, if present, are a comma-separated list having
6909 each element starting with a tag name and an equals.
6910
6911 Two options are supported, for the return value and for filtering match
6912 candidates.
6913 The "ret" option requests an alternate result value of
6914 the entire path for the entry. Example:
6915 .code
6916 ${lookup {passwd} dsearch,ret=full {/etc}}
6917 .endd
6918 The default result is just the requested entry.
6919 The "filter" option requests that only directory entries of a given type
6920 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6921 not matching "." or ".."). Example:
6922 .code
6923 ${lookup {passwd} dsearch,filter=file {/etc}}
6924 .endd
6925 The default matching is for any entry type, including directories
6926 and symlinks.
6927
6928 An example of how this
6929 lookup can be used to support virtual domains is given in section
6930 &<<SECTvirtualdomains>>&.
6931 .next
6932 .cindex "lookup" "iplsearch"
6933 .cindex "iplsearch lookup type"
6934 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6935 terminated by a colon or white space or the end of the line. The keys in the
6936 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6937 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6938 being interpreted as a key terminator. For example:
6939 .code
6940 1.2.3.4:           data for 1.2.3.4
6941 192.168.0.0/16:    data for 192.168.0.0/16
6942 "abcd::cdab":      data for abcd::cdab
6943 "abcd:abcd::/32"   data for abcd:abcd::/32
6944 .endd
6945 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6946 file is searched linearly, using the CIDR masks where present, until a matching
6947 key is found. The first key that matches is used; there is no attempt to find a
6948 &"best"& match. Apart from the way the keys are matched, the processing for
6949 &(iplsearch)& is the same as for &(lsearch)&.
6950
6951 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6952 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6953 lookup types support only literal keys.
6954
6955 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6956 the implicit key is the host's IP address rather than its name (see section
6957 &<<SECThoslispatsikey>>&).
6958
6959 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6960 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6961 notation before executing the lookup.)
6962
6963 One option is supported, "ret=full", to request the return of the entire line
6964 rather than omitting the key porttion.
6965 Note however that the key portion will have been de-quoted.
6966
6967 .next
6968 .cindex lookup json
6969 .cindex json "lookup type"
6970 .cindex JSON expansions
6971 &(json)&: The given file is a text file with a JSON structure.
6972 An element of the structure is extracted, defined by the search key.
6973 The key is a list of subelement selectors
6974 (colon-separated by default but changeable in the usual way)
6975 which are applied in turn to select smaller and smaller portions
6976 of the JSON structure.
6977 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6978 nunbered array element is selected.
6979 Otherwise it must apply to a JSON object; the named element is selected.
6980 The final resulting element can be a simple JSON type or a JSON object
6981 or array; for the latter two a string-representation of the JSON
6982 is returned.
6983 For elements of type string, the returned value is de-quoted.
6984
6985
6986 .next
6987 .cindex LMDB
6988 .cindex lookup lmdb
6989 .cindex database lmdb
6990 &(lmdb)&: The given file is an LMDB database.
6991 LMDB is a memory-mapped key-value store,
6992 with API modeled loosely on that of BerkeleyDB.
6993 See &url(https://symas.com/products/lightning-memory-mapped-database/)
6994 for the feature set and operation modes.
6995
6996 Exim provides read-only access via the LMDB C library.
6997 The library can be obtained from &url(https://github.com/LMDB/lmdb)
6998 or your operating system package repository.
6999 To enable LMDB support in Exim set LOOKUP_LMDB=yes in &_Local/Makefile_&.
7000
7001 You will need to separately create the LMDB database file,
7002 possibly using the &"mdb_load"& utility.
7003
7004
7005 .next
7006 .cindex "linear search"
7007 .cindex "lookup" "lsearch"
7008 .cindex "lsearch lookup type"
7009 .cindex "case sensitivity" "in lsearch lookup"
7010 &(lsearch)&: The given file is a text file that is searched linearly for a
7011 line beginning with the search key, terminated by a colon or white space or the
7012 end of the line. The search is case-insensitive; that is, upper and lower case
7013 letters are treated as the same. The first occurrence of the key that is found
7014 in the file is used.
7015
7016 White space between the key and the colon is permitted. The remainder of the
7017 line, with leading and trailing white space removed, is the data. This can be
7018 continued onto subsequent lines by starting them with any amount of white
7019 space, but only a single space character is included in the data at such a
7020 junction. If the data begins with a colon, the key must be terminated by a
7021 colon, for example:
7022 .code
7023 baduser:  :fail:
7024 .endd
7025 Empty lines and lines beginning with # are ignored, even if they occur in the
7026 middle of an item. This is the traditional textual format of alias files. Note
7027 that the keys in an &(lsearch)& file are literal strings. There is no
7028 wildcarding of any kind.
7029
7030 .cindex "lookup" "lsearch &-- colons in keys"
7031 .cindex "white space" "in lsearch key"
7032 In most &(lsearch)& files, keys are not required to contain colons or #
7033 characters, or white space. However, if you need this feature, it is available.
7034 If a key begins with a doublequote character, it is terminated only by a
7035 matching quote (or end of line), and the normal escaping rules apply to its
7036 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
7037 quoted keys (exactly as for unquoted keys). There is no special handling of
7038 quotes for the data part of an &(lsearch)& line.
7039
7040 .next
7041 .cindex "NIS lookup type"
7042 .cindex "lookup" "NIS"
7043 .cindex "binary zero" "in lookup key"
7044 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
7045 the given key, without a terminating binary zero. There is a variant called
7046 &(nis0)& which does include the terminating binary zero in the key. This is
7047 reportedly needed for Sun-style alias files. Exim does not recognize NIS
7048 aliases; the full map names must be used.
7049
7050 .next
7051 .cindex "wildlsearch lookup type"
7052 .cindex "lookup" "wildlsearch"
7053 .cindex "nwildlsearch lookup type"
7054 .cindex "lookup" "nwildlsearch"
7055 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
7056 &(lsearch)&, but instead of being interpreted as a literal string, each key in
7057 the file may be wildcarded. The difference between these two lookup types is
7058 that for &(wildlsearch)&, each key in the file is string-expanded before being
7059 used, whereas for &(nwildlsearch)&, no expansion takes place.
7060
7061 .cindex "case sensitivity" "in (n)wildlsearch lookup"
7062 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
7063 file that are regular expressions can be made case-sensitive by the use of
7064 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
7065
7066 . ==== As this is a nested list, any displays it contains must be indented
7067 . ==== as otherwise they are too far to the left.
7068
7069 .olist
7070 The string may begin with an asterisk to mean &"ends with"&. For example:
7071 .code
7072     *.a.b.c       data for anything.a.b.c
7073     *fish         data for anythingfish
7074 .endd
7075 .next
7076 The string may begin with a circumflex to indicate a regular expression. For
7077 example, for &(wildlsearch)&:
7078 .code
7079     ^\N\d+\.a\.b\N    data for <digits>.a.b
7080 .endd
7081 Note the use of &`\N`& to disable expansion of the contents of the regular
7082 expression. If you are using &(nwildlsearch)&, where the keys are not
7083 string-expanded, the equivalent entry is:
7084 .code
7085     ^\d+\.a\.b        data for <digits>.a.b
7086 .endd
7087 The case-insensitive flag is set at the start of compiling the regular
7088 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
7089 For example, to make the entire pattern case-sensitive:
7090 .code
7091     ^(?-i)\d+\.a\.b        data for <digits>.a.b
7092 .endd
7093
7094 If the regular expression contains white space or colon characters, you must
7095 either quote it (see &(lsearch)& above), or represent these characters in other
7096 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
7097 colon. This may be easier than quoting, because if you quote, you have to
7098 escape all the backslashes inside the quotes.
7099
7100 &*Note*&: It is not possible to capture substrings in a regular expression
7101 match for later use, because the results of all lookups are cached. If a lookup
7102 is repeated, the result is taken from the cache, and no actual pattern matching
7103 takes place. The values of all the numeric variables are unset after a
7104 &((n)wildlsearch)& match.
7105
7106 .next
7107 Although I cannot see it being of much use, the general matching function that
7108 is used to implement &((n)wildlsearch)& means that the string may begin with a
7109 lookup name terminated by a semicolon, and followed by lookup data. For
7110 example:
7111 .code
7112     cdb;/some/file  data for keys that match the file
7113 .endd
7114 The data that is obtained from the nested lookup is discarded.
7115 .endlist olist
7116
7117 Keys that do not match any of these patterns are interpreted literally. The
7118 continuation rules for the data are the same as for &(lsearch)&, and keys may
7119 be followed by optional colons.
7120
7121 &*Warning*&: Unlike most other single-key lookup types, a file of data for
7122 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
7123 lookup types support only literal keys.
7124
7125 .next
7126 .cindex "spf lookup type"
7127 .cindex "lookup" "spf"
7128 &(spf)&: If Exim is built with SPF support, manual lookups can be done
7129 (as opposed to the standard ACL condition method).
7130 For details see section &<<SECSPF>>&.
7131 .endlist ilist
7132
7133
7134 .section "Query-style lookup types" "SECTquerystylelookups"
7135 .cindex "lookup" "query-style types"
7136 .cindex "query-style lookup" "list of types"
7137 The supported query-style lookup types are listed below. Further details about
7138 many of them are given in later sections.
7139
7140 .ilist
7141 .cindex "DNS" "as a lookup type"
7142 .cindex "lookup" "DNS"
7143 &(dnsdb)&: This does a DNS search for one or more records whose domain names
7144 are given in the supplied query. The resulting data is the contents of the
7145 records. See section &<<SECTdnsdb>>&.
7146 .next
7147 .cindex "InterBase lookup type"
7148 .cindex "lookup" "InterBase"
7149 &(ibase)&: This does a lookup in an InterBase database.
7150 .next
7151 .cindex "LDAP" "lookup type"
7152 .cindex "lookup" "LDAP"
7153 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
7154 returns attributes from a single entry. There is a variant called &(ldapm)&
7155 that permits values from multiple entries to be returned. A third variant
7156 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7157 any attribute values. See section &<<SECTldap>>&.
7158 .next
7159 .cindex "MySQL" "lookup type"
7160 .cindex "lookup" "MySQL"
7161 &(mysql)&: The format of the query is an SQL statement that is passed to a
7162 MySQL database. See section &<<SECTsql>>&.
7163 .next
7164 .cindex "NIS+ lookup type"
7165 .cindex "lookup" "NIS+"
7166 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
7167 the field to be returned. See section &<<SECTnisplus>>&.
7168 .next
7169 .cindex "Oracle" "lookup type"
7170 .cindex "lookup" "Oracle"
7171 &(oracle)&: The format of the query is an SQL statement that is passed to an
7172 Oracle database. See section &<<SECTsql>>&.
7173 .next
7174 .cindex "lookup" "passwd"
7175 .cindex "passwd lookup type"
7176 .cindex "&_/etc/passwd_&"
7177 &(passwd)& is a query-style lookup with queries that are just user names. The
7178 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7179 success, the result string is the same as you would get from an &(lsearch)&
7180 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7181 password value. For example:
7182 .code
7183 *:42:42:King Rat:/home/kr:/bin/bash
7184 .endd
7185 .next
7186 .cindex "PostgreSQL lookup type"
7187 .cindex "lookup" "PostgreSQL"
7188 &(pgsql)&: The format of the query is an SQL statement that is passed to a
7189 PostgreSQL database. See section &<<SECTsql>>&.
7190
7191 .next
7192 .cindex "Redis lookup type"
7193 .cindex lookup Redis
7194 &(redis)&: The format of the query is either a simple get or simple set,
7195 passed to a Redis database. See section &<<SECTsql>>&.
7196
7197 .next
7198 .cindex "sqlite lookup type"
7199 .cindex "lookup" "sqlite"
7200 &(sqlite)&: The format of the query is
7201 an SQL statement that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7202
7203 .next
7204 &(testdb)&: This is a lookup type that is used for testing Exim. It is
7205 not likely to be useful in normal operation.
7206 .next
7207 .cindex "whoson lookup type"
7208 .cindex "lookup" "whoson"
7209 . --- still http:-only, 2018-09-07
7210 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7211 allows a server to check whether a particular (dynamically allocated) IP
7212 address is currently allocated to a known (trusted) user and, optionally, to
7213 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7214 at one time for &"POP before SMTP"& authentication, but that approach has been
7215 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7216 &"POP before SMTP"& checking using ACL statements such as
7217 .code
7218 require condition = \
7219   ${lookup whoson {$sender_host_address}{yes}{no}}
7220 .endd
7221 The query consists of a single IP address. The value returned is the name of
7222 the authenticated user, which is stored in the variable &$value$&. However, in
7223 this example, the data in &$value$& is not used; the result of the lookup is
7224 one of the fixed strings &"yes"& or &"no"&.
7225 .endlist
7226
7227
7228
7229 .section "Temporary errors in lookups" "SECID63"
7230 .cindex "lookup" "temporary error in"
7231 Lookup functions can return temporary error codes if the lookup cannot be
7232 completed. For example, an SQL or LDAP database might be unavailable. For this
7233 reason, it is not advisable to use a lookup that might do this for critical
7234 options such as a list of local domains.
7235
7236 When a lookup cannot be completed in a router or transport, delivery
7237 of the message (to the relevant address) is deferred, as for any other
7238 temporary error. In other circumstances Exim may assume the lookup has failed,
7239 or may give up altogether.
7240
7241
7242
7243 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7244 .cindex "wildcard lookups"
7245 .cindex "lookup" "default values"
7246 .cindex "lookup" "wildcard"
7247 .cindex "lookup" "* added to type"
7248 .cindex "default" "in single-key lookups"
7249 In this context, a &"default value"& is a value specified by the administrator
7250 that is to be used if a lookup fails.
7251
7252 &*Note:*& This section applies only to single-key lookups. For query-style
7253 lookups, the facilities of the query language must be used. An attempt to
7254 specify a default for a query-style lookup provokes an error.
7255
7256 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7257 and the initial lookup fails, the key &"*"& is looked up in the file to
7258 provide a default value. See also the section on partial matching below.
7259
7260 .cindex "*@ with single-key lookup"
7261 .cindex "lookup" "*@ added to type"
7262 .cindex "alias file" "per-domain default"
7263 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7264 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7265 character, a second lookup is done with everything before the last @ replaced
7266 by *. This makes it possible to provide per-domain defaults in alias files
7267 that include the domains in the keys. If the second lookup fails (or doesn't
7268 take place because there is no @ in the key), &"*"& is looked up.
7269 For example, a &(redirect)& router might contain:
7270 .code
7271 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7272 .endd
7273 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7274 looks up these keys, in this order:
7275 .code
7276 jane@eyre.example
7277 *@eyre.example
7278 *
7279 .endd
7280 The data is taken from whichever key it finds first. &*Note*&: In an
7281 &(lsearch)& file, this does not mean the first of these keys in the file. A
7282 complete scan is done for each key, and only if it is not found at all does
7283 Exim move on to try the next key.
7284
7285
7286
7287 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7288 .cindex "partial matching"
7289 .cindex "wildcard lookups"
7290 .cindex "lookup" "partial matching"
7291 .cindex "lookup" "wildcard"
7292 .cindex "asterisk" "in search type"
7293 The normal operation of a single-key lookup is to search the file for an exact
7294 match with the given key. However, in a number of situations where domains are
7295 being looked up, it is useful to be able to do partial matching. In this case,
7296 information in the file that has a key starting with &"*."& is matched by any
7297 domain that ends with the components that follow the full stop. For example, if
7298 a key in a DBM file is
7299 .code
7300 *.dates.fict.example
7301 .endd
7302 then when partial matching is enabled this is matched by (amongst others)
7303 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7304 by &'dates.fict.example'&, if that does not appear as a separate key in the
7305 file.
7306
7307 &*Note*&: Partial matching is not available for query-style lookups. It is
7308 also not available for any lookup items in address lists (see section
7309 &<<SECTaddresslist>>&).
7310
7311 Partial matching is implemented by doing a series of separate lookups using
7312 keys constructed by modifying the original subject key. This means that it can
7313 be used with any of the single-key lookup types, provided that
7314 partial matching keys
7315 beginning with a special prefix (default &"*."&) are included in the data file.
7316 Keys in the file that do not begin with the prefix are matched only by
7317 unmodified subject keys when partial matching is in use.
7318
7319 Partial matching is requested by adding the string &"partial-"& to the front of
7320 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7321 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7322 is added at the start of the subject key, and it is looked up again. If that
7323 fails, further lookups are tried with dot-separated components removed from the
7324 start of the subject key, one-by-one, and &"*."& added on the front of what
7325 remains.
7326
7327 A minimum number of two non-* components are required. This can be adjusted
7328 by including a number before the hyphen in the search type. For example,
7329 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7330 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7331 subject key is &'2250.dates.fict.example'& then the following keys are looked
7332 up when the minimum number of non-* components is two:
7333 .code
7334 2250.dates.fict.example
7335 *.2250.dates.fict.example
7336 *.dates.fict.example
7337 *.fict.example
7338 .endd
7339 As soon as one key in the sequence is successfully looked up, the lookup
7340 finishes.
7341
7342 .cindex "lookup" "partial matching &-- changing prefix"
7343 .cindex "prefix" "for partial matching"
7344 The use of &"*."& as the partial matching prefix is a default that can be
7345 changed. The motivation for this feature is to allow Exim to operate with file
7346 formats that are used by other MTAs. A different prefix can be supplied in
7347 parentheses instead of the hyphen after &"partial"&. For example:
7348 .code
7349 domains = partial(.)lsearch;/some/file
7350 .endd
7351 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7352 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7353 components is unchanged). The prefix may consist of any punctuation characters
7354 other than a closing parenthesis. It may be empty, for example:
7355 .code
7356 domains = partial1()cdb;/some/file
7357 .endd
7358 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7359 &`a.b.c`&, &`b.c`&, and &`c`&.
7360
7361 If &"partial0"& is specified, what happens at the end (when the lookup with
7362 just one non-wild component has failed, and the original key is shortened right
7363 down to the null string) depends on the prefix:
7364
7365 .ilist
7366 If the prefix has zero length, the whole lookup fails.
7367 .next
7368 If the prefix has length 1, a lookup for just the prefix is done. For
7369 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7370 .next
7371 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7372 remainder is looked up. With the default prefix, therefore, the final lookup is
7373 for &"*"& on its own.
7374 .next
7375 Otherwise, the whole prefix is looked up.
7376 .endlist
7377
7378
7379 If the search type ends in &"*"& or &"*@"& (see section
7380 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7381 this implies happens after all partial lookups have failed. If &"partial0"& is
7382 specified, adding &"*"& to the search type has no effect with the default
7383 prefix, because the &"*"& key is already included in the sequence of partial
7384 lookups. However, there might be a use for lookup types such as
7385 &"partial0(.)lsearch*"&.
7386
7387 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7388 in domain lists and the like. Partial matching works only in terms of
7389 dot-separated components; a key such as &`*fict.example`&
7390 in a database file is useless, because the asterisk in a partial matching
7391 subject key is always followed by a dot.
7392
7393
7394
7395
7396 .section "Lookup caching" "SECID64"
7397 .cindex "lookup" "caching"
7398 .cindex "caching" "lookup data"
7399 Exim caches all lookup results in order to avoid needless repetition of
7400 lookups. However, because (apart from the daemon) Exim operates as a collection
7401 of independent, short-lived processes, this caching applies only within a
7402 single Exim process. There is no inter-process lookup caching facility.
7403
7404 If an option &"cache=no_rd"& is used on the lookup then
7405 the cache is only written to, cached data is not used for the operation
7406 and a real lookup is done.
7407
7408 For single-key lookups, Exim keeps the relevant files open in case there is
7409 another lookup that needs them. In some types of configuration this can lead to
7410 many files being kept open for messages with many recipients. To avoid hitting
7411 the operating system limit on the number of simultaneously open files, Exim
7412 closes the least recently used file when it needs to open more files than its
7413 own internal limit, which can be changed via the &%lookup_open_max%& option.
7414
7415 The single-key lookup files are closed and the lookup caches are flushed at
7416 strategic points during delivery &-- for example, after all routing is
7417 complete.
7418
7419
7420
7421
7422 .section "Quoting lookup data" "SECID65"
7423 .cindex "lookup" "quoting"
7424 .cindex "quoting" "in lookups"
7425 When data from an incoming message is included in a query-style lookup, there
7426 is the possibility of special characters in the data messing up the syntax of
7427 the query. For example, a NIS+ query that contains
7428 .code
7429 [name=$local_part]
7430 .endd
7431 will be broken if the local part happens to contain a closing square bracket.
7432 For NIS+, data can be enclosed in double quotes like this:
7433 .code
7434 [name="$local_part"]
7435 .endd
7436 but this still leaves the problem of a double quote in the data. The rule for
7437 NIS+ is that double quotes must be doubled. Other lookup types have different
7438 rules, and to cope with the differing requirements, an expansion operator
7439 of the following form is provided:
7440 .code
7441 ${quote_<lookup-type>:<string>}
7442 .endd
7443 For example, the safest way to write the NIS+ query is
7444 .code
7445 [name="${quote_nisplus:$local_part}"]
7446 .endd
7447 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7448 operator can be used for all lookup types, but has no effect for single-key
7449 lookups, since no quoting is ever needed in their key strings.
7450
7451
7452
7453
7454 .section "More about dnsdb" "SECTdnsdb"
7455 .cindex "dnsdb lookup"
7456 .cindex "lookup" "dnsdb"
7457 .cindex "DNS" "as a lookup type"
7458 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7459 of a record type and a domain name, separated by an equals sign. For example,
7460 an expansion string could contain:
7461 .code
7462 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7463 .endd
7464 If the lookup succeeds, the result is placed in &$value$&, which in this case
7465 is used on its own as the result. If the lookup does not succeed, the
7466 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7467 &<<SECTforexpfai>>& for an explanation of what this means.
7468
7469 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7470 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7471 If no type is given, TXT is assumed.
7472
7473 For any record type, if multiple records are found, the data is returned as a
7474 concatenation, with newline as the default separator. The order, of course,
7475 depends on the DNS resolver. You can specify a different separator character
7476 between multiple records by putting a right angle-bracket followed immediately
7477 by the new separator at the start of the query. For example:
7478 .code
7479 ${lookup dnsdb{>: a=host1.example}}
7480 .endd
7481 It is permitted to specify a space as the separator character. Further
7482 white space is ignored.
7483 For lookup types that return multiple fields per record,
7484 an alternate field separator can be specified using a comma after the main
7485 separator character, followed immediately by the field separator.
7486
7487 .cindex "PTR record" "in &(dnsdb)& lookup"
7488 When the type is PTR,
7489 the data can be an IP address, written as normal; inversion and the addition of
7490 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7491 .code
7492 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7493 .endd
7494 If the data for a PTR record is not a syntactically valid IP address, it is not
7495 altered and nothing is added.
7496
7497 .cindex "MX record" "in &(dnsdb)& lookup"
7498 .cindex "SRV record" "in &(dnsdb)& lookup"
7499 For an MX lookup, both the preference value and the host name are returned for
7500 each record, separated by a space. For an SRV lookup, the priority, weight,
7501 port, and host name are returned for each record, separated by spaces.
7502 The field separator can be modified as above.
7503
7504 .cindex "TXT record" "in &(dnsdb)& lookup"
7505 .cindex "SPF record" "in &(dnsdb)& lookup"
7506 For TXT records with multiple items of data, only the first item is returned,
7507 unless a field separator is specified.
7508 To concatenate items without a separator, use a semicolon instead.
7509 For SPF records the
7510 default behaviour is to concatenate multiple items without using a separator.
7511 .code
7512 ${lookup dnsdb{>\n,: txt=a.b.example}}
7513 ${lookup dnsdb{>\n; txt=a.b.example}}
7514 ${lookup dnsdb{spf=example.org}}
7515 .endd
7516 It is permitted to specify a space as the separator character. Further
7517 white space is ignored.
7518
7519 .cindex "SOA record" "in &(dnsdb)& lookup"
7520 For an SOA lookup, while no result is obtained the lookup is redone with
7521 successively more leading components dropped from the given domain.
7522 Only the primary-nameserver field is returned unless a field separator is
7523 specified.
7524 .code
7525 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7526 .endd
7527
7528 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7529 .cindex "dnsdb modifiers"
7530 .cindex "modifiers" "dnsdb"
7531 .cindex "options" "dnsdb"
7532 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7533 each followed by a comma,
7534 that may appear before the record type.
7535
7536 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7537 temporary DNS error for any of them, the behaviour is controlled by
7538 a defer-option modifier.
7539 The possible keywords are
7540 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7541 With &"strict"& behaviour, any temporary DNS error causes the
7542 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7543 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7544 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7545 error causes the whole lookup to defer only if none of the other lookups
7546 succeed. The default is &"lax"&, so the following lookups are equivalent:
7547 .code
7548 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7549 ${lookup dnsdb{a=one.host.com:two.host.com}}
7550 .endd
7551 Thus, in the default case, as long as at least one of the DNS lookups
7552 yields some data, the lookup succeeds.
7553
7554 .cindex "DNSSEC" "dns lookup"
7555 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7556 The possible keywords are
7557 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7558 With &"strict"& or &"lax"& DNSSEC information is requested
7559 with the lookup.
7560 With &"strict"& a response from the DNS resolver that
7561 is not labelled as authenticated data
7562 is treated as equivalent to a temporary DNS error.
7563 The default is &"lax"&.
7564
7565 See also the &$lookup_dnssec_authenticated$& variable.
7566
7567 .cindex timeout "dns lookup"
7568 .cindex "DNS" timeout
7569 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7570 The form is &"retrans_VAL"& where VAL is an Exim time specification
7571 (e.g. &"5s"&).
7572 The default value is set by the main configuration option &%dns_retrans%&.
7573
7574 Retries for the dnsdb lookup can be controlled by a retry modifier.
7575 The form if &"retry_VAL"& where VAL is an integer.
7576 The default count is set by the main configuration option &%dns_retry%&.
7577
7578 .cindex caching "of dns lookup"
7579 .cindex TTL "of dns lookup"
7580 .cindex DNS TTL
7581 Dnsdb lookup results are cached within a single process (and its children).
7582 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7583 value of the set of returned DNS records.
7584
7585
7586 .section "Pseudo dnsdb record types" "SECID66"
7587 .cindex "MX record" "in &(dnsdb)& lookup"
7588 By default, both the preference value and the host name are returned for
7589 each MX record, separated by a space. If you want only host names, you can use
7590 the pseudo-type MXH:
7591 .code
7592 ${lookup dnsdb{mxh=a.b.example}}
7593 .endd
7594 In this case, the preference values are omitted, and just the host names are
7595 returned.
7596
7597 .cindex "name server for enclosing domain"
7598 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7599 records on the given domain, but if none are found, it removes the first
7600 component of the domain name, and tries again. This process continues until NS
7601 records are found or there are no more components left (or there is a DNS
7602 error). In other words, it may return the name servers for a top-level domain,
7603 but it never returns the root name servers. If there are no NS records for the
7604 top-level domain, the lookup fails. Consider these examples:
7605 .code
7606 ${lookup dnsdb{zns=xxx.quercite.com}}
7607 ${lookup dnsdb{zns=xxx.edu}}
7608 .endd
7609 Assuming that in each case there are no NS records for the full domain name,
7610 the first returns the name servers for &%quercite.com%&, and the second returns
7611 the name servers for &%edu%&.
7612
7613 You should be careful about how you use this lookup because, unless the
7614 top-level domain does not exist, the lookup always returns some host names. The
7615 sort of use to which this might be put is for seeing if the name servers for a
7616 given domain are on a blacklist. You can probably assume that the name servers
7617 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7618 such a list.
7619
7620 .cindex "CSA" "in &(dnsdb)& lookup"
7621 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7622 records according to the CSA rules, which are described in section
7623 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7624 not sufficient because of the extra parent domain search behaviour of CSA. The
7625 result of a successful lookup such as:
7626 .code
7627 ${lookup dnsdb {csa=$sender_helo_name}}
7628 .endd
7629 has two space-separated fields: an authorization code and a target host name.
7630 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7631 authorization required but absent, or &"?"& for unknown.
7632
7633 .cindex "A+" "in &(dnsdb)& lookup"
7634 The pseudo-type A+ performs an AAAA
7635 and then an A lookup.  All results are returned; defer processing
7636 (see below) is handled separately for each lookup.  Example:
7637 .code
7638 ${lookup dnsdb {>; a+=$sender_helo_name}}
7639 .endd
7640
7641
7642 .section "Multiple dnsdb lookups" "SECID67"
7643 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7644 However, you can specify a list of domains or IP addresses in a single
7645 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7646 the default separator, but with the ability to change this. For example:
7647 .code
7648 ${lookup dnsdb{one.domain.com:two.domain.com}}
7649 ${lookup dnsdb{a=one.host.com:two.host.com}}
7650 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7651 .endd
7652 In order to retain backwards compatibility, there is one special case: if
7653 the lookup type is PTR and no change of separator is specified, Exim looks
7654 to see if the rest of the string is precisely one IPv6 address. In this
7655 case, it does not treat it as a list.
7656
7657 The data from each lookup is concatenated, with newline separators by default,
7658 in the same way that multiple DNS records for a single item are handled. A
7659 different separator can be specified, as described above.
7660
7661
7662
7663
7664 .section "More about LDAP" "SECTldap"
7665 .cindex "LDAP" "lookup, more about"
7666 .cindex "lookup" "LDAP"
7667 .cindex "Solaris" "LDAP"
7668 The original LDAP implementation came from the University of Michigan; this has
7669 become &"Open LDAP"&, and there are now two different releases. Another
7670 implementation comes from Netscape, and Solaris 7 and subsequent releases
7671 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7672 the lookup function level, their error handling is different. For this reason
7673 it is necessary to set a compile-time variable when building Exim with LDAP, to
7674 indicate which LDAP library is in use. One of the following should appear in
7675 your &_Local/Makefile_&:
7676 .code
7677 LDAP_LIB_TYPE=UMICHIGAN
7678 LDAP_LIB_TYPE=OPENLDAP1
7679 LDAP_LIB_TYPE=OPENLDAP2
7680 LDAP_LIB_TYPE=NETSCAPE
7681 LDAP_LIB_TYPE=SOLARIS
7682 .endd
7683 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7684 same interface as the University of Michigan version.
7685
7686 There are three LDAP lookup types in Exim. These behave slightly differently in
7687 the way they handle the results of a query:
7688
7689 .ilist
7690 &(ldap)& requires the result to contain just one entry; if there are more, it
7691 gives an error.
7692 .next
7693 &(ldapdn)& also requires the result to contain just one entry, but it is the
7694 Distinguished Name that is returned rather than any attribute values.
7695 .next
7696 &(ldapm)& permits the result to contain more than one entry; the attributes
7697 from all of them are returned.
7698 .endlist
7699
7700
7701 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7702 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7703 the data returned by a successful lookup is described in the next section.
7704 First we explain how LDAP queries are coded.
7705
7706
7707 .section "Format of LDAP queries" "SECTforldaque"
7708 .cindex "LDAP" "query format"
7709 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7710 the configuration of a &(redirect)& router one might have this setting:
7711 .code
7712 data = ${lookup ldap \
7713   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7714   c=UK?mailbox?base?}}
7715 .endd
7716 .cindex "LDAP" "with TLS"
7717 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7718 secure (encrypted) LDAP connections. The second of these ensures that an
7719 encrypted TLS connection is used.
7720
7721 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7722 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7723 See the &%ldap_start_tls%& option.
7724
7725 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7726 controlled. Every part of the TLS configuration can be configured by settings in
7727 &_exim.conf_&. Depending on the version of the client libraries installed on
7728 your system, some of the initialization may have required setting options in
7729 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7730 certificates. This revealed a nuance where the current UID that exim was
7731 running as could affect which config files it read. With Exim 4.83, these
7732 methods become optional, only taking effect if not specifically set in
7733 &_exim.conf_&.
7734
7735
7736 .section "LDAP quoting" "SECID68"
7737 .cindex "LDAP" "quoting"
7738 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7739 and the second because the LDAP query is represented as a URL. Furthermore,
7740 within an LDAP query, two different kinds of quoting are required. For this
7741 reason, there are two different LDAP-specific quoting operators.
7742
7743 The &%quote_ldap%& operator is designed for use on strings that are part of
7744 filter specifications. Conceptually, it first does the following conversions on
7745 the string:
7746 .code
7747 *   =>   \2A
7748 (   =>   \28
7749 )   =>   \29
7750 \   =>   \5C
7751 .endd
7752 in accordance with RFC 2254. The resulting string is then quoted according
7753 to the rules for URLs, that is, all non-alphanumeric characters except
7754 .code
7755 ! $ ' - . _ ( ) * +
7756 .endd
7757 are converted to their hex values, preceded by a percent sign. For example:
7758 .code
7759 ${quote_ldap: a(bc)*, a<yz>; }
7760 .endd
7761 yields
7762 .code
7763 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7764 .endd
7765 Removing the URL quoting, this is (with a leading and a trailing space):
7766 .code
7767 a\28bc\29\2A, a<yz>;
7768 .endd
7769 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7770 base DN specifications in queries. Conceptually, it first converts the string
7771 by inserting a backslash in front of any of the following characters:
7772 .code
7773 , + " \ < > ;
7774 .endd
7775 It also inserts a backslash before any leading spaces or # characters, and
7776 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7777 is then quoted according to the rules for URLs. For example:
7778 .code
7779 ${quote_ldap_dn: a(bc)*, a<yz>; }
7780 .endd
7781 yields
7782 .code
7783 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7784 .endd
7785 Removing the URL quoting, this is (with a trailing space):
7786 .code
7787 \ a(bc)*\, a\<yz\>\;\
7788 .endd
7789 There are some further comments about quoting in the section on LDAP
7790 authentication below.
7791
7792
7793 .section "LDAP connections" "SECID69"
7794 .cindex "LDAP" "connections"
7795 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7796 is in use, via a Unix domain socket. The example given above does not specify
7797 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7798 by starting it with
7799 .code
7800 ldap://<hostname>:<port>/...
7801 .endd
7802 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7803 used. When no server is specified in a query, a list of default servers is
7804 taken from the &%ldap_default_servers%& configuration option. This supplies a
7805 colon-separated list of servers which are tried in turn until one successfully
7806 handles a query, or there is a serious error. Successful handling either
7807 returns the requested data, or indicates that it does not exist. Serious errors
7808 are syntactical, or multiple values when only a single value is expected.
7809 Errors which cause the next server to be tried are connection failures, bind
7810 failures, and timeouts.
7811
7812 For each server name in the list, a port number can be given. The standard way
7813 of specifying a host and port is to use a colon separator (RFC 1738). Because
7814 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7815 doubled. For example
7816 .code
7817 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7818 .endd
7819 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7820 to the LDAP library with no server name, and the library's default (normally
7821 the local host) is used.
7822
7823 If you are using the OpenLDAP library, you can connect to an LDAP server using
7824 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7825 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7826 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7827 not available.
7828
7829 For this type of connection, instead of a host name for the server, a pathname
7830 for the socket is required, and the port number is not relevant. The pathname
7831 can be specified either as an item in &%ldap_default_servers%&, or inline in
7832 the query. In the former case, you can have settings such as
7833 .code
7834 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7835 .endd
7836 When the pathname is given in the query, you have to escape the slashes as
7837 &`%2F`& to fit in with the LDAP URL syntax. For example:
7838 .code
7839 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7840 .endd
7841 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7842 a pathname, it uses the Unix domain socket code, even if the query actually
7843 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7844 socket connection. This behaviour means that you can use a setting of
7845 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7846 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7847 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7848 backup host.
7849
7850 If an explicit &`ldapi`& type is given in a query when a host name is
7851 specified, an error is diagnosed. However, if there are more items in
7852 &%ldap_default_servers%&, they are tried. In other words:
7853
7854 .ilist
7855 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7856 interface.
7857 .next
7858 Using &`ldapi`& with a host name causes an error.
7859 .endlist
7860
7861
7862 Using &`ldapi`& with no host or path in the query, and no setting of
7863 &%ldap_default_servers%&, does whatever the library does by default.
7864
7865
7866
7867 .section "LDAP authentication and control information" "SECID70"
7868 .cindex "LDAP" "authentication"
7869 The LDAP URL syntax provides no way of passing authentication and other control
7870 information to the server. To make this possible, the URL in an LDAP query may
7871 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7872 spaces. If a value contains spaces it must be enclosed in double quotes, and
7873 when double quotes are used, backslash is interpreted in the usual way inside
7874 them. The following names are recognized:
7875 .display
7876 &`DEREFERENCE`&  set the dereferencing parameter
7877 &`NETTIME    `&  set a timeout for a network operation
7878 &`USER       `&  set the DN, for authenticating the LDAP bind
7879 &`PASS       `&  set the password, likewise
7880 &`REFERRALS  `&  set the referrals parameter
7881 &`SERVERS    `&  set alternate server list for this query only
7882 &`SIZE       `&  set the limit for the number of entries returned
7883 &`TIME       `&  set the maximum waiting time for a query
7884 .endd
7885 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7886 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7887 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7888 library from trying to follow referrals issued by the LDAP server.
7889
7890 .cindex LDAP timeout
7891 .cindex timeout "LDAP lookup"
7892 The name CONNECT is an obsolete name for NETTIME, retained for
7893 backwards compatibility. This timeout (specified as a number of seconds) is
7894 enforced from the client end for operations that can be carried out over a
7895 network. Specifically, it applies to network connections and calls to the
7896 &'ldap_result()'& function. If the value is greater than zero, it is used if
7897 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7898 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7899 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7900 Netscape SDK; for OpenLDAP no action is taken.
7901
7902 The TIME parameter (also a number of seconds) is passed to the server to
7903 set a server-side limit on the time taken to complete a search.
7904
7905 The SERVERS parameter allows you to specify an alternate list of ldap servers
7906 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7907 default list of ldap servers, and a single lookup can specify a single ldap
7908 server to use.  But when you need to do a lookup with a list of servers that is
7909 different than the default list (maybe different order, maybe a completely
7910 different set of servers), the SERVERS parameter allows you to specify this
7911 alternate list (colon-separated).
7912
7913 Here is an example of an LDAP query in an Exim lookup that uses some of these
7914 values. This is a single line, folded to fit on the page:
7915 .code
7916 ${lookup ldap
7917   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7918   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7919   {$value}fail}
7920 .endd
7921 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7922 any of the auxiliary data. Exim configuration settings that include lookups
7923 which contain password information should be preceded by &"hide"& to prevent
7924 non-admin users from using the &%-bP%& option to see their values.
7925
7926 The auxiliary data items may be given in any order. The default is no
7927 connection timeout (the system timeout is used), no user or password, no limit
7928 on the number of entries returned, and no time limit on queries.
7929
7930 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7931 removes any URL quoting that it may contain before passing it LDAP. Apparently
7932 some libraries do this for themselves, but some do not. Removing the URL
7933 quoting has two advantages:
7934
7935 .ilist
7936 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7937 DNs as with DNs inside actual queries.
7938 .next
7939 It permits spaces inside USER= DNs.
7940 .endlist
7941
7942 For example, a setting such as
7943 .code
7944 USER=cn=${quote_ldap_dn:$1}
7945 .endd
7946 should work even if &$1$& contains spaces.
7947
7948 Expanded data for the PASS= value should be quoted using the &%quote%&
7949 expansion operator, rather than the LDAP quote operators. The only reason this
7950 field needs quoting is to ensure that it conforms to the Exim syntax, which
7951 does not allow unquoted spaces. For example:
7952 .code
7953 PASS=${quote:$3}
7954 .endd
7955 The LDAP authentication mechanism can be used to check passwords as part of
7956 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7957 &<<CHAPexpand>>&.
7958
7959
7960
7961 .section "Format of data returned by LDAP" "SECID71"
7962 .cindex "LDAP" "returned data formats"
7963 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7964 as a sequence of values, for example
7965 .code
7966 cn=manager,o=University of Cambridge,c=UK
7967 .endd
7968 The &(ldap)& lookup type generates an error if more than one entry matches the
7969 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7970 the result between the data from different entries. It is possible for multiple
7971 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7972 you know that whatever values are returned all came from a single entry in the
7973 directory.
7974
7975 In the common case where you specify a single attribute in your LDAP query, the
7976 result is not quoted, and does not contain the attribute name. If the attribute
7977 has multiple values, they are separated by commas. Any comma that is
7978 part of an attribute's value is doubled.
7979
7980 If you specify multiple attributes, the result contains space-separated, quoted
7981 strings, each preceded by the attribute name and an equals sign. Within the
7982 quotes, the quote character, backslash, and newline are escaped with
7983 backslashes, and commas are used to separate multiple values for the attribute.
7984 Any commas in attribute values are doubled
7985 (permitting treatment of the values as a comma-separated list).
7986 Apart from the escaping, the string within quotes takes the same form as the
7987 output when a single attribute is requested. Specifying no attributes is the
7988 same as specifying all of an entry's attributes.
7989
7990 Here are some examples of the output format. The first line of each pair is an
7991 LDAP query, and the second is the data that is returned. The attribute called
7992 &%attr1%& has two values, one of them with an embedded comma, whereas
7993 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7994 (they have SUP &%attr%& in their schema definitions).
7995
7996 .code
7997 ldap:///o=base?attr1?sub?(uid=fred)
7998 value1.1,value1,,2
7999
8000 ldap:///o=base?attr2?sub?(uid=fred)
8001 value two
8002
8003 ldap:///o=base?attr?sub?(uid=fred)
8004 value1.1,value1,,2,value two
8005
8006 ldap:///o=base?attr1,attr2?sub?(uid=fred)
8007 attr1="value1.1,value1,,2" attr2="value two"
8008
8009 ldap:///o=base??sub?(uid=fred)
8010 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
8011 .endd
8012 You can
8013 make use of Exim's &%-be%& option to run expansion tests and thereby check the
8014 results of LDAP lookups.
8015 The &%extract%& operator in string expansions can be used to pick out
8016 individual fields from data that consists of &'key'&=&'value'& pairs.
8017 The &%listextract%& operator should be used to pick out individual values
8018 of attributes, even when only a single value is expected.
8019 The doubling of embedded commas allows you to use the returned data as a
8020 comma separated list (using the "<," syntax for changing the input list separator).
8021
8022
8023
8024
8025 .section "More about NIS+" "SECTnisplus"
8026 .cindex "NIS+ lookup type"
8027 .cindex "lookup" "NIS+"
8028 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
8029 and field name. If this is given, the result of a successful query is the
8030 contents of the named field; otherwise the result consists of a concatenation
8031 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
8032 values containing spaces are quoted. For example, the query
8033 .code
8034 [name=mg1456],passwd.org_dir
8035 .endd
8036 might return the string
8037 .code
8038 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
8039 home=/home/mg1456 shell=/bin/bash shadow=""
8040 .endd
8041 (split over two lines here to fit on the page), whereas
8042 .code
8043 [name=mg1456],passwd.org_dir:gcos
8044 .endd
8045 would just return
8046 .code
8047 Martin Guerre
8048 .endd
8049 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
8050 for the given indexed key. The effect of the &%quote_nisplus%& expansion
8051 operator is to double any quote characters within the text.
8052
8053
8054
8055 .section "SQL lookups" "SECTsql"
8056 .cindex "SQL lookup types"
8057 .cindex "MySQL" "lookup type"
8058 .cindex "PostgreSQL lookup type"
8059 .cindex "lookup" "MySQL"
8060 .cindex "lookup" "PostgreSQL"
8061 .cindex "Oracle" "lookup type"
8062 .cindex "lookup" "Oracle"
8063 .cindex "InterBase lookup type"
8064 .cindex "lookup" "InterBase"
8065 .cindex "Redis lookup type"
8066 .cindex lookup Redis
8067 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
8068 and SQLite
8069 databases. Queries for these databases contain SQL statements, so an example
8070 might be
8071 .code
8072 ${lookup mysql{select mailbox from users where id='userx'}\
8073   {$value}fail}
8074 .endd
8075 If the result of the query contains more than one field, the data for each
8076 field in the row is returned, preceded by its name, so the result of
8077 .code
8078 ${lookup pgsql{select home,name from users where id='userx'}\
8079   {$value}}
8080 .endd
8081 might be
8082 .code
8083 home=/home/userx name="Mister X"
8084 .endd
8085 Empty values and values containing spaces are double quoted, with embedded
8086 quotes escaped by a backslash. If the result of the query contains just one
8087 field, the value is passed back verbatim, without a field name, for example:
8088 .code
8089 Mister X
8090 .endd
8091 If the result of the query yields more than one row, it is all concatenated,
8092 with a newline between the data for each row.
8093
8094
8095 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
8096 .cindex "MySQL" "lookup type"
8097 .cindex "PostgreSQL lookup type"
8098 .cindex "lookup" "MySQL"
8099 .cindex "lookup" "PostgreSQL"
8100 .cindex "Oracle" "lookup type"
8101 .cindex "lookup" "Oracle"
8102 .cindex "InterBase lookup type"
8103 .cindex "lookup" "InterBase"
8104 .cindex "Redis lookup type"
8105 .cindex lookup Redis
8106 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
8107 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
8108 or &%redis_servers%&
8109 option (as appropriate) must be set to a colon-separated list of server
8110 information.
8111 .oindex &%mysql_servers%&
8112 .oindex &%pgsql_servers%&
8113 .oindex &%oracle_servers%&
8114 .oindex &%ibase_servers%&
8115 .oindex &%redis_servers%&
8116 (For MySQL and PostgreSQL, the global option need not be set if all
8117 queries contain their own server information &-- see section
8118 &<<SECTspeserque>>&.)
8119 For all but Redis
8120 each item in the list is a slash-separated list of four
8121 items: host name, database name, user name, and password. In the case of
8122 Oracle, the host name field is used for the &"service name"&, and the database
8123 name field is not used and should be empty. For example:
8124 .code
8125 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
8126 .endd
8127 Because password data is sensitive, you should always precede the setting with
8128 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
8129 option. Here is an example where two MySQL servers are listed:
8130 .code
8131 hide mysql_servers = localhost/users/root/secret:\
8132                      otherhost/users/root/othersecret
8133 .endd
8134 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
8135 because this is a colon-separated list, the colon has to be doubled. For each
8136 query, these parameter groups are tried in order until a connection is made and
8137 a query is successfully processed. The result of a query may be that no data is
8138 found, but that is still a successful query. In other words, the list of
8139 servers provides a backup facility, not a list of different places to look.
8140
8141 For Redis the global option need not be specified if all queries contain their
8142 own server information &-- see section &<<SECTspeserque>>&.
8143 If specified, the option must be set to a colon-separated list of server
8144 information.
8145 Each item in the list is a slash-separated list of three items:
8146 host, database number, and password.
8147 .olist
8148 The host is required and may be either an IPv4 address and optional
8149 port number (separated by a colon, which needs doubling due to the
8150 higher-level list), or a Unix socket pathname enclosed in parentheses
8151 .next
8152 The database number is optional; if present that number is selected in the backend
8153 .next
8154 The password is optional; if present it is used to authenticate to the backend
8155 .endlist
8156
8157 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8158 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8159 respectively, and the characters single-quote, double-quote, and backslash
8160 itself are escaped with backslashes.
8161
8162 The &%quote_redis%& expansion operator
8163 escapes whitespace and backslash characters with a backslash.
8164
8165 .section "Specifying the server in the query" "SECTspeserque"
8166 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8167 it is possible to specify a list of servers with an individual query. This is
8168 done by appending a comma-separated option to the query type:
8169 .display
8170 &`,servers=`&&'server1:server2:server3:...'&
8171 .endd
8172 Each item in the list may take one of two forms:
8173 .olist
8174 If it contains no slashes it is assumed to be just a host name. The appropriate
8175 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8176 of the same name, and the remaining parameters (database, user, password) are
8177 taken from there.
8178 .next
8179 If it contains any slashes, it is taken as a complete parameter set.
8180 .endlist
8181 The list of servers is used in exactly the same way as the global list.
8182 Once a connection to a server has happened and a query has been
8183 successfully executed, processing of the lookup ceases.
8184
8185 This feature is intended for use in master/slave situations where updates
8186 are occurring and you want to update the master rather than a slave. If the
8187 master is in the list as a backup for reading, you might have a global setting
8188 like this:
8189 .code
8190 mysql_servers = slave1/db/name/pw:\
8191                 slave2/db/name/pw:\
8192                 master/db/name/pw
8193 .endd
8194 In an updating lookup, you could then write:
8195 .code
8196 ${lookup mysql,servers=master {UPDATE ...} }
8197 .endd
8198 That query would then be sent only to the master server. If, on the other hand,
8199 the master is not to be used for reading, and so is not present in the global
8200 option, you can still update it by a query of this form:
8201 .code
8202 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8203 .endd
8204
8205 An older syntax places the servers specification before the query,
8206 semicolon separated:
8207 .code
8208 ${lookup mysql{servers=master; UPDATE ...} }
8209 .endd
8210 The new version avoids potential issues with tainted
8211 arguments in the query, for explicit expansion.
8212 &*Note*&: server specifications in list-style lookups are still problematic.
8213
8214
8215 .section "Special MySQL features" "SECID73"
8216 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8217 causes a connection to the server on the local host by means of a Unix domain
8218 socket. An alternate socket can be specified in parentheses.
8219 An option group name for MySQL option files can be specified in square brackets;
8220 the default value is &"exim"&.
8221 The full syntax of each item in &%mysql_servers%& is:
8222 .display
8223 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8224   <&'database'&>/<&'user'&>/<&'password'&>
8225 .endd
8226 Any of the four sub-parts of the first field can be omitted. For normal use on
8227 the local host it can be left blank or set to just &"localhost"&.
8228
8229 No database need be supplied &-- but if it is absent here, it must be given in
8230 the queries.
8231
8232 If a MySQL query is issued that does not request any data (an insert, update,
8233 or delete command), the result of the lookup is the number of rows affected.
8234
8235 &*Warning*&: This can be misleading. If an update does not actually change
8236 anything (for example, setting a field to the value it already has), the result
8237 is zero because no rows are affected.
8238
8239
8240 .section "Special PostgreSQL features" "SECID74"
8241 PostgreSQL lookups can also use Unix domain socket connections to the database.
8242 This is usually faster and costs less CPU time than a TCP/IP connection.
8243 However it can be used only if the mail server runs on the same machine as the
8244 database server. A configuration line for PostgreSQL via Unix domain sockets
8245 looks like this:
8246 .code
8247 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8248 .endd
8249 In other words, instead of supplying a host name, a path to the socket is
8250 given. The path name is enclosed in parentheses so that its slashes aren't
8251 visually confused with the delimiters for the other server parameters.
8252
8253 If a PostgreSQL query is issued that does not request any data (an insert,
8254 update, or delete command), the result of the lookup is the number of rows
8255 affected.
8256
8257 .section "More about SQLite" "SECTsqlite"
8258 .cindex "lookup" "SQLite"
8259 .cindex "sqlite lookup type"
8260 SQLite is different to the other SQL lookups because a filename is required in
8261 addition to the SQL query. An SQLite database is a single file, and there is no
8262 daemon as in the other SQL databases.
8263
8264 .oindex &%sqlite_dbfile%&
8265 There are two ways of
8266 specifying the file.
8267 The first is is by using the &%sqlite_dbfile%& main option.
8268 The second, which allows separate files for each query,
8269 is to use an option appended, comma-separated, to the &"sqlite"&
8270 lookup type word.  The option is the word &"file"&, then an equals,
8271 then the filename.
8272 The filename in this case cannot contain whitespace or open-brace charachters.
8273
8274 A deprecated method is available, prefixing the query with the filename
8275 separated by white space.
8276 This means that
8277 .cindex "tainted data" "sqlite file"
8278 the query cannot use any tainted values, as that taints
8279 the entire query including the filename - resulting in a refusal to open
8280 the file.
8281
8282 In all the above cases the filename must be an absolute path.
8283
8284 Here is a lookup expansion example:
8285 .code
8286 sqlite_dbfile = /some/thing/sqlitedb
8287 ...
8288 ${lookup sqlite {select name from aliases where id='userx';}}
8289 .endd
8290 In a list, the syntax is similar. For example:
8291 .code
8292 domainlist relay_to_domains = sqlite;\
8293    select * from relays where ip='$sender_host_address';
8294 .endd
8295 The only character affected by the &%quote_sqlite%& operator is a single
8296 quote, which it doubles.
8297
8298 .cindex timeout SQLite
8299 .cindex sqlite "lookup timeout"
8300 The SQLite library handles multiple simultaneous accesses to the database
8301 internally. Multiple readers are permitted, but only one process can
8302 update at once. Attempts to access the database while it is being updated
8303 are rejected after a timeout period, during which the SQLite library
8304 waits for the lock to be released. In Exim, the default timeout is set
8305 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8306 option.
8307
8308 .section "More about Redis" "SECTredis"
8309 .cindex "lookup" "Redis"
8310 .cindex "redis lookup type"
8311 Redis is a non-SQL database. Commands are simple get and set.
8312 Examples:
8313 .code
8314 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8315 ${lookup redis{get keyname}}
8316 .endd
8317
8318 As of release 4.91, "lightweight" support for Redis Cluster is available.
8319 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8320 of which must be reachable from the running exim instance. If the cluster has
8321 master/slave replication, the list must contain all the master and slave
8322 servers.
8323
8324 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8325 immediately follow the redirection but treats the response as a DEFER, moving on
8326 to the next server in the &%redis_servers%& list until the correct server is
8327 reached.
8328
8329 .ecindex IIDfidalo1
8330 .ecindex IIDfidalo2
8331
8332
8333 . ////////////////////////////////////////////////////////////////////////////
8334 . ////////////////////////////////////////////////////////////////////////////
8335
8336 .chapter "Domain, host, address, and local part lists" &&&
8337          "CHAPdomhosaddlists" &&&
8338          "Domain, host, and address lists"
8339 .scindex IIDdohoadli "lists of domains; hosts; etc."
8340 A number of Exim configuration options contain lists of domains, hosts,
8341 email addresses, or local parts. For example, the &%hold_domains%& option
8342 contains a list of domains whose delivery is currently suspended. These lists
8343 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8344 arguments to expansion conditions such as &%match_domain%&.
8345
8346 Each item in one of these lists is a pattern to be matched against a domain,
8347 host, email address, or local part, respectively. In the sections below, the
8348 different types of pattern for each case are described, but first we cover some
8349 general facilities that apply to all four kinds of list.
8350
8351 Note that other parts of Exim use a &'string list'& which does not
8352 support all the complexity available in
8353 domain, host, address and local part lists.
8354
8355
8356
8357 .section "Expansion of lists" "SECTlistexpand"
8358 .cindex "expansion" "of lists"
8359 Each list is expanded as a single string before it is used.
8360
8361 &'Exception: the router headers_remove option, where list-item
8362 splitting is done before string-expansion.'&
8363
8364 The result of
8365 expansion must be a list, possibly containing empty items, which is split up
8366 into separate items for matching. By default, colon is the separator character,
8367 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8368 &<<SECTempitelis>>& for details of the list syntax; the second of these
8369 discusses the way to specify empty list items.
8370
8371
8372 If the string expansion is forced to fail, Exim behaves as if the item it is
8373 testing (domain, host, address, or local part) is not in the list. Other
8374 expansion failures cause temporary errors.
8375
8376 If an item in a list is a regular expression, backslashes, dollars and possibly
8377 other special characters in the expression must be protected against
8378 misinterpretation by the string expander. The easiest way to do this is to use
8379 the &`\N`& expansion feature to indicate that the contents of the regular
8380 expression should not be expanded. For example, in an ACL you might have:
8381 .code
8382 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8383                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8384 .endd
8385 The first item is a regular expression that is protected from expansion by
8386 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8387 senders based on the receiving domain.
8388
8389
8390
8391
8392 .section "Negated items in lists" "SECID76"
8393 .cindex "list" "negation"
8394 .cindex "negation" "in lists"
8395 Items in a list may be positive or negative. Negative items are indicated by a
8396 leading exclamation mark, which may be followed by optional white space. A list
8397 defines a set of items (domains, etc). When Exim processes one of these lists,
8398 it is trying to find out whether a domain, host, address, or local part
8399 (respectively) is in the set that is defined by the list. It works like this:
8400
8401 The list is scanned from left to right. If a positive item is matched, the
8402 subject that is being checked is in the set; if a negative item is matched, the
8403 subject is not in the set. If the end of the list is reached without the
8404 subject having matched any of the patterns, it is in the set if the last item
8405 was a negative one, but not if it was a positive one. For example, the list in
8406 .code
8407 domainlist relay_to_domains = !a.b.c : *.b.c
8408 .endd
8409 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8410 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8411 list is positive. However, if the setting were
8412 .code
8413 domainlist relay_to_domains = !a.b.c
8414 .endd
8415 then all domains other than &'a.b.c'& would match because the last item in the
8416 list is negative. In other words, a list that ends with a negative item behaves
8417 as if it had an extra item &`:*`& on the end.
8418
8419 Another way of thinking about positive and negative items in lists is to read
8420 the connector as &"or"& after a positive item and as &"and"& after a negative
8421 item.
8422
8423
8424
8425 .section "File names in lists" "SECTfilnamlis"
8426 .cindex "list" "filename in"
8427 If an item in a domain, host, address, or local part list is an absolute
8428 filename (beginning with a slash character), each line of the file is read and
8429 processed as if it were an independent item in the list, except that further
8430 filenames are not allowed,
8431 and no expansion of the data from the file takes place.
8432 Empty lines in the file are ignored, and the file may also contain comment
8433 lines:
8434
8435 .ilist
8436 For domain and host lists, if a # character appears anywhere in a line of the
8437 file, it and all following characters are ignored.
8438 .next
8439 Because local parts may legitimately contain # characters, a comment in an
8440 address list or local part list file is recognized only if # is preceded by
8441 white space or the start of the line. For example:
8442 .code
8443 not#comment@x.y.z   # but this is a comment
8444 .endd
8445 .endlist
8446
8447 Putting a filename in a list has the same effect as inserting each line of the
8448 file as an item in the list (blank lines and comments excepted). However, there
8449 is one important difference: the file is read each time the list is processed,
8450 so if its contents vary over time, Exim's behaviour changes.
8451
8452 If a filename is preceded by an exclamation mark, the sense of any match
8453 within the file is inverted. For example, if
8454 .code
8455 hold_domains = !/etc/nohold-domains
8456 .endd
8457 and the file contains the lines
8458 .code
8459 !a.b.c
8460 *.b.c
8461 .endd
8462 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8463 any domain matching &`*.b.c`& is not.
8464
8465
8466
8467 .section "An lsearch file is not an out-of-line list" "SECID77"
8468 As will be described in the sections that follow, lookups can be used in lists
8469 to provide indexed methods of checking list membership. There has been some
8470 confusion about the way &(lsearch)& lookups work in lists. Because
8471 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8472 sometimes thought that it is allowed to contain wild cards and other kinds of
8473 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8474 always fixed strings, just as for any other single-key lookup type.
8475
8476 If you want to use a file to contain wild-card patterns that form part of a
8477 list, just give the filename on its own, without a search type, as described
8478 in the previous section. You could also use the &(wildlsearch)& or
8479 &(nwildlsearch)&, but there is no advantage in doing this.
8480
8481
8482
8483
8484 .section "Results of list checking" SECTlistresults
8485 The primary result of doing a list check is a truth value.
8486 In some contexts additional information is stored
8487 about the list element that matched:
8488 .vlist
8489 .vitem hosts
8490 A &%hosts%& ACL condition
8491 will store a result in the &$host_data$& variable.
8492 .vitem local_parts
8493 A &%local_parts%& router option or &%local_parts%& ACL condition
8494 will store a result in the &$local_part_data$& variable.
8495 .vitem domains
8496 A &%domains%& router option or &%domains%& ACL condition
8497 will store a result in the &$domain_data$& variable.
8498 .vitem senders
8499 A &%senders%& router option or &%senders%& ACL condition
8500 will store a result in the &$sender_data$& variable.
8501 .vitem recipients
8502 A &%recipients%& ACL condition
8503 will store a result in the &$recipient_data$& variable.
8504 .endlist
8505
8506 The detail of the additional information depends on the
8507 type of match and is given below as the &*value*& information.
8508
8509
8510
8511
8512 .section "Named lists" "SECTnamedlists"
8513 .cindex "named lists"
8514 .cindex "list" "named"
8515 A list of domains, hosts, email addresses, or local parts can be given a name
8516 which is then used to refer to the list elsewhere in the configuration. This is
8517 particularly convenient if the same list is required in several different
8518 places. It also allows lists to be given meaningful names, which can improve
8519 the readability of the configuration. For example, it is conventional to define
8520 a domain list called &'local_domains'& for all the domains that are handled
8521 locally on a host, using a configuration line such as
8522 .code
8523 domainlist local_domains = localhost:my.dom.example
8524 .endd
8525 Named lists are referenced by giving their name preceded by a plus sign, so,
8526 for example, a router that is intended to handle local domains would be
8527 configured with the line
8528 .code
8529 domains = +local_domains
8530 .endd
8531 The first router in a configuration is often one that handles all domains
8532 except the local ones, using a configuration with a negated item like this:
8533 .code
8534 dnslookup:
8535   driver = dnslookup
8536   domains = ! +local_domains
8537   transport = remote_smtp
8538   no_more
8539 .endd
8540 The four kinds of named list are created by configuration lines starting with
8541 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8542 respectively. Then there follows the name that you are defining, followed by an
8543 equals sign and the list itself. For example:
8544 .code
8545 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8546 addresslist bad_senders = cdb;/etc/badsenders
8547 .endd
8548 A named list may refer to other named lists:
8549 .code
8550 domainlist  dom1 = first.example : second.example
8551 domainlist  dom2 = +dom1 : third.example
8552 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8553 .endd
8554 &*Warning*&: If the last item in a referenced list is a negative one, the
8555 effect may not be what you intended, because the negation does not propagate
8556 out to the higher level. For example, consider:
8557 .code
8558 domainlist  dom1 = !a.b
8559 domainlist  dom2 = +dom1 : *.b
8560 .endd
8561 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8562 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8563 means it matches the second list as well. The effect is not the same as
8564 .code
8565 domainlist  dom2 = !a.b : *.b
8566 .endd
8567 where &'x.y'& does not match. It's best to avoid negation altogether in
8568 referenced lists if you can.
8569
8570 .cindex "hiding named list values"
8571 .cindex "named lists" "hiding value of"
8572 Some named list definitions may contain sensitive data, for example, passwords for
8573 accessing databases. To stop non-admin users from using the &%-bP%& command
8574 line option to read these values, you can precede the definition with the
8575 word &"hide"&. For example:
8576 .code
8577 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8578 .endd
8579
8580
8581 Named lists may have a performance advantage. When Exim is routing an
8582 address or checking an incoming message, it caches the result of tests on named
8583 lists. So, if you have a setting such as
8584 .code
8585 domains = +local_domains
8586 .endd
8587 on several of your routers
8588 or in several ACL statements,
8589 the actual test is done only for the first one. However, the caching works only
8590 if there are no expansions within the list itself or any sublists that it
8591 references. In other words, caching happens only for lists that are known to be
8592 the same each time they are referenced.
8593
8594 By default, there may be up to 16 named lists of each type. This limit can be
8595 extended by changing a compile-time variable. The use of domain and host lists
8596 is recommended for concepts such as local domains, relay domains, and relay
8597 hosts. The default configuration is set up like this.
8598
8599
8600
8601 .section "Named lists compared with macros" "SECID78"
8602 .cindex "list" "named compared with macro"
8603 .cindex "macro" "compared with named list"
8604 At first sight, named lists might seem to be no different from macros in the
8605 configuration file. However, macros are just textual substitutions. If you
8606 write
8607 .code
8608 ALIST = host1 : host2
8609 auth_advertise_hosts = !ALIST
8610 .endd
8611 it probably won't do what you want, because that is exactly the same as
8612 .code
8613 auth_advertise_hosts = !host1 : host2
8614 .endd
8615 Notice that the second host name is not negated. However, if you use a host
8616 list, and write
8617 .code
8618 hostlist alist = host1 : host2
8619 auth_advertise_hosts = ! +alist
8620 .endd
8621 the negation applies to the whole list, and so that is equivalent to
8622 .code
8623 auth_advertise_hosts = !host1 : !host2
8624 .endd
8625
8626
8627 .section "Named list caching" "SECID79"
8628 .cindex "list" "caching of named"
8629 .cindex "caching" "named lists"
8630 While processing a message, Exim caches the result of checking a named list if
8631 it is sure that the list is the same each time. In practice, this means that
8632 the cache operates only if the list contains no $ characters, which guarantees
8633 that it will not change when it is expanded. Sometimes, however, you may have
8634 an expanded list that you know will be the same each time within a given
8635 message. For example:
8636 .code
8637 domainlist special_domains = \
8638            ${lookup{$sender_host_address}cdb{/some/file}}
8639 .endd
8640 This provides a list of domains that depends only on the sending host's IP
8641 address. If this domain list is referenced a number of times (for example,
8642 in several ACL lines, or in several routers) the result of the check is not
8643 cached by default, because Exim does not know that it is going to be the
8644 same list each time.
8645
8646 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8647 cache the result anyway. For example:
8648 .code
8649 domainlist_cache special_domains = ${lookup{...
8650 .endd
8651 If you do this, you should be absolutely sure that caching is going to do
8652 the right thing in all cases. When in doubt, leave it out.
8653
8654
8655
8656 .section "Domain lists" "SECTdomainlist"
8657 .cindex "domain list" "patterns for"
8658 .cindex "list" "domain list"
8659 Domain lists contain patterns that are to be matched against a mail domain.
8660 The following types of item may appear in domain lists:
8661
8662 .ilist
8663 .cindex "primary host name"
8664 .cindex "host name" "matched in domain list"
8665 .oindex "&%primary_hostname%&"
8666 .cindex "domain list" "matching primary host name"
8667 .cindex "@ in a domain list"
8668 If a pattern consists of a single @ character, it matches the local host name,
8669 as set by the &%primary_hostname%& option (or defaulted). This makes it
8670 possible to use the same configuration file on several different hosts that
8671 differ only in their names.
8672
8673 The value for a match will be the primary host name.
8674
8675
8676 .next
8677 .cindex "@[] in a domain list"
8678 .cindex "domain list" "matching local IP interfaces"
8679 .cindex "domain literal"
8680 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8681 in square brackets (as in an email address that contains a domain literal), but
8682 only if that IP address is recognized as local for email routing purposes. The
8683 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8684 control which of a host's several IP addresses are treated as local.
8685 In today's Internet, the use of domain literals is controversial;
8686 see the &%allow_domain_literals%& main option.
8687
8688 The value for a match will be the string &`@[]`&.
8689
8690
8691 .next
8692 .cindex "@mx_any"
8693 .cindex "@mx_primary"
8694 .cindex "@mx_secondary"
8695 .cindex "domain list" "matching MX pointers to local host"
8696 If a pattern consists of the string &`@mx_any`& it matches any domain that
8697 has an MX record pointing to the local host or to any host that is listed in
8698 .oindex "&%hosts_treat_as_local%&"
8699 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8700 are similar, except that the first matches only when a primary MX target is the
8701 local host, and the second only when no primary MX target is the local host,
8702 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8703 preference value &-- there may of course be more than one of them.
8704
8705 The MX lookup that takes place when matching a pattern of this type is
8706 performed with the resolver options for widening names turned off. Thus, for
8707 example, a single-component domain will &'not'& be expanded by adding the
8708 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8709 options of the &(dnslookup)& router for a discussion of domain widening.
8710
8711 Sometimes you may want to ignore certain IP addresses when using one of these
8712 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8713 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8714 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8715 on a router). For example:
8716 .code
8717 domains = @mx_any/ignore=127.0.0.1
8718 .endd
8719 This example matches any domain that has an MX record pointing to one of
8720 the local host's IP addresses other than 127.0.0.1.
8721
8722 The list of IP addresses is in fact processed by the same code that processes
8723 host lists, so it may contain CIDR-coded network specifications and it may also
8724 contain negative items.
8725
8726 Because the list of IP addresses is a sublist within a domain list, you have to
8727 be careful about delimiters if there is more than one address. Like any other
8728 list, the default delimiter can be changed. Thus, you might have:
8729 .code
8730 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8731           an.other.domain : ...
8732 .endd
8733 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8734 involved, it is easiest to change the delimiter for the main list as well:
8735 .code
8736 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8737           an.other.domain ? ...
8738 .endd
8739 The value for a match will be the list element string (starting &`@mx_`&).
8740
8741
8742 .next
8743 .cindex "asterisk" "in domain list"
8744 .cindex "domain list" "asterisk in"
8745 .cindex "domain list" "matching &""ends with""&"
8746 If a pattern starts with an asterisk, the remaining characters of the pattern
8747 are compared with the terminating characters of the domain. The use of &"*"& in
8748 domain lists differs from its use in partial matching lookups. In a domain
8749 list, the character following the asterisk need not be a dot, whereas partial
8750 matching works only in terms of dot-separated components. For example, a domain
8751 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8752 &'cipher.key.ex'&.
8753
8754 The value for a match will be the list element string (starting with the asterisk).
8755 Additionally, &$0$& will be set to the matched string
8756 and &$1$& to the variable portion which the asterisk matched.
8757
8758 .next
8759 .cindex "regular expressions" "in domain list"
8760 .cindex "domain list" "matching regular expression"
8761 If a pattern starts with a circumflex character, it is treated as a regular
8762 expression, and matched against the domain using a regular expression matching
8763 function. The circumflex is treated as part of the regular expression.
8764 Email domains are case-independent, so this regular expression match is by
8765 default case-independent, but you can make it case-dependent by starting it
8766 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8767 are given in chapter &<<CHAPregexp>>&.
8768
8769 &*Warning*&: Because domain lists are expanded before being processed, you
8770 must escape any backslash and dollar characters in the regular expression, or
8771 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8772 it is not to be expanded (unless you really do want to build a regular
8773 expression by expansion, of course).
8774
8775 The value for a match will be the list element string (starting with the circumflex).
8776 Additionally, &$0$& will be set to the string matching the regular expression,
8777 and &$1$& (onwards) to any submatches identified by parentheses.
8778
8779
8780
8781 .next
8782 .cindex "lookup" "in domain list"
8783 .cindex "domain list" "matching by lookup"
8784 If a pattern starts with the name of a single-key lookup type followed by a
8785 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8786 must be a filename in a suitable format for the lookup type. For example, for
8787 &"cdb;"& it must be an absolute path:
8788 .code
8789 domains = cdb;/etc/mail/local_domains.cdb
8790 .endd
8791 The appropriate type of lookup is done on the file using the domain name as the
8792 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8793 only in whether or not the key is present in the file. However, when a lookup
8794 is used for the &%domains%& option on a router
8795 or a &%domains%& condition in an ACL statement, the value is preserved in the
8796 &$domain_data$& variable and can be referred to in other router options or
8797 other statements in the same ACL.
8798 .cindex "tainted data" "de-tainting"
8799 The value will be untainted.
8800
8801 &*Note*&: If the data result of the lookup (as opposed to the key)
8802 is empty, then this empty value is stored in &$domain_data$&.
8803 The option to return the key for the lookup, as the value,
8804 may be what is wanted.
8805
8806
8807 .next
8808 Any of the single-key lookup type names may be preceded by
8809 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8810 .code
8811 domains = partial-dbm;/partial/domains
8812 .endd
8813 This causes partial matching logic to be invoked; a description of how this
8814 works is given in section &<<SECTpartiallookup>>&.
8815
8816 .next
8817 .cindex "asterisk" "in lookup type"
8818 Any of the single-key lookup types may be followed by an asterisk. This causes
8819 a default lookup for a key consisting of a single asterisk to be done if the
8820 original lookup fails. This is not a useful feature when using a domain list to
8821 select particular domains (because any domain would match), but it might have
8822 value if the result of the lookup is being used via the &$domain_data$&
8823 expansion variable.
8824
8825 .next
8826 If the pattern starts with the name of a query-style lookup type followed by a
8827 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8828 pattern must be an appropriate query for the lookup type, as described in
8829 chapter &<<CHAPfdlookup>>&. For example:
8830 .code
8831 hold_domains = mysql;select domain from holdlist \
8832   where domain = '${quote_mysql:$domain}';
8833 .endd
8834 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8835 example, it doesn't matter what field you select). Exim is interested only in
8836 whether or not the query succeeds. However, when a lookup is used for the
8837 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8838 variable and can be referred to in other options.
8839 .cindex "tainted data" "de-tainting"
8840 The value will be untainted.
8841
8842 .next
8843 If the pattern starts with the name of a lookup type
8844 of either kind (single-key or query-style) it may be
8845 followed by a comma and options,
8846 The options are lookup-type specific and consist of a comma-separated list.
8847 Each item starts with a tag and and equals "=" sign.
8848
8849 .next
8850 .cindex "domain list" "matching literal domain name"
8851 If none of the above cases apply, a caseless textual comparison is made
8852 between the pattern and the domain.
8853
8854 The value for a match will be the list element string.
8855 .cindex "tainted data" "de-tainting"
8856 Note that this is commonly untainted
8857 (depending on the way the list was created).
8858 Specifically, explicit text in the configuration file in not tainted.
8859 This is a useful way of obtaining an untainted equivalent to
8860 the domain, for later operations.
8861
8862 However if the list (including one-element lists)
8863 is created by expanding a variable containing tainted data,
8864 it is tainted and so will the match value be.
8865 .endlist
8866
8867
8868 Here is an example that uses several different kinds of pattern:
8869 .code
8870 domainlist funny_domains = \
8871   @ : \
8872   lib.unseen.edu : \
8873   *.foundation.fict.example : \
8874   \N^[1-2]\d{3}\.fict\.example$\N : \
8875   partial-dbm;/opt/data/penguin/book : \
8876   nis;domains.byname : \
8877   nisplus;[name=$domain,status=local],domains.org_dir
8878 .endd
8879 There are obvious processing trade-offs among the various matching modes. Using
8880 an asterisk is faster than a regular expression, and listing a few names
8881 explicitly probably is too. The use of a file or database lookup is expensive,
8882 but may be the only option if hundreds of names are required. Because the
8883 patterns are tested in order, it makes sense to put the most commonly matched
8884 patterns earlier.
8885
8886
8887
8888 .section "Host lists" "SECThostlist"
8889 .cindex "host list" "patterns in"
8890 .cindex "list" "host list"
8891 Host lists are used to control what remote hosts are allowed to do. For
8892 example, some hosts may be allowed to use the local host as a relay, and some
8893 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8894 two different ways, by name or by IP address. In a host list, some types of
8895 pattern are matched to a host name, and some are matched to an IP address.
8896 You need to be particularly careful with this when single-key lookups are
8897 involved, to ensure that the right value is being used as the key.
8898
8899
8900 .section "Special host list patterns" "SECID80"
8901 .cindex "empty item in hosts list"
8902 .cindex "host list" "empty string in"
8903 If a host list item is the empty string, it matches only when no remote host is
8904 involved. This is the case when a message is being received from a local
8905 process using SMTP on the standard input, that is, when a TCP/IP connection is
8906 not used.
8907
8908 .cindex "asterisk" "in host list"
8909 The special pattern &"*"& in a host list matches any host or no host. Neither
8910 the IP address nor the name is actually inspected.
8911
8912
8913
8914 .section "Host list patterns that match by IP address" "SECThoslispatip"
8915 .cindex "host list" "matching IP addresses"
8916 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8917 the incoming address actually appears in the IPv6 host as
8918 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8919 list, it is converted into a traditional IPv4 address first. (Not all operating
8920 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8921 concerns.)
8922
8923 The following types of pattern in a host list check the remote host by
8924 inspecting its IP address:
8925
8926 .ilist
8927 If the pattern is a plain domain name (not a regular expression, not starting
8928 with *, not a lookup of any kind), Exim calls the operating system function
8929 to find the associated IP address(es). Exim uses the newer
8930 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8931 This typically causes a forward DNS lookup of the name. The result is compared
8932 with the IP address of the subject host.
8933
8934 If there is a temporary problem (such as a DNS timeout) with the host name
8935 lookup, a temporary error occurs. For example, if the list is being used in an
8936 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8937 temporary SMTP error code. If no IP address can be found for the host name,
8938 what happens is described in section &<<SECTbehipnot>>& below.
8939
8940 .next
8941 .cindex "@ in a host list"
8942 If the pattern is &"@"&, the primary host name is substituted and used as a
8943 domain name, as just described.
8944
8945 .next
8946 If the pattern is an IP address, it is matched against the IP address of the
8947 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8948 IPv6 addresses can be given in colon-separated format, but the colons have to
8949 be doubled so as not to be taken as item separators when the default list
8950 separator is used. IPv6 addresses are recognized even when Exim is compiled
8951 without IPv6 support. This means that if they appear in a host list on an
8952 IPv4-only host, Exim will not treat them as host names. They are just addresses
8953 that can never match a client host.
8954
8955 .next
8956 .cindex "@[] in a host list"
8957 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8958 the local host. For example, if the local host is an IPv4 host with one
8959 interface address 10.45.23.56, these two ACL statements have the same effect:
8960 .code
8961 accept hosts = 127.0.0.1 : 10.45.23.56
8962 accept hosts = @[]
8963 .endd
8964 .next
8965 .cindex "CIDR notation"
8966 If the pattern is an IP address followed by a slash and a mask length, for
8967 example
8968 .code
8969 10.11.42.0/24
8970 .endd
8971 , it is matched against the IP address of the subject
8972 host under the given mask. This allows an entire network of hosts to be
8973 included (or excluded) by a single item. The mask uses CIDR notation; it
8974 specifies the number of address bits that must match, starting from the most
8975 significant end of the address.
8976
8977 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8978 of a range of addresses. It is the number of bits in the network portion of the
8979 address. The above example specifies a 24-bit netmask, so it matches all 256
8980 addresses in the 10.11.42.0 network. An item such as
8981 .code
8982 192.168.23.236/31
8983 .endd
8984 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8985 32 for an IPv4 address is the same as no mask at all; just a single address
8986 matches.
8987
8988 Here is another example which shows an IPv4 and an IPv6 network:
8989 .code
8990 recipient_unqualified_hosts = 192.168.0.0/16: \
8991                               3ffe::ffff::836f::::/48
8992 .endd
8993 The doubling of list separator characters applies only when these items
8994 appear inline in a host list. It is not required when indirecting via a file.
8995 For example:
8996 .code
8997 recipient_unqualified_hosts = /opt/exim/unqualnets
8998 .endd
8999 could make use of a file containing
9000 .code
9001 172.16.0.0/12
9002 3ffe:ffff:836f::/48
9003 .endd
9004 to have exactly the same effect as the previous example. When listing IPv6
9005 addresses inline, it is usually more convenient to use the facility for
9006 changing separator characters. This list contains the same two networks:
9007 .code
9008 recipient_unqualified_hosts = <; 172.16.0.0/12; \
9009                                  3ffe:ffff:836f::/48
9010 .endd
9011 The separator is changed to semicolon by the leading &"<;"& at the start of the
9012 list.
9013 .endlist
9014
9015
9016
9017 .section "Host list patterns for single-key lookups by host address" &&&
9018          "SECThoslispatsikey"
9019 .cindex "host list" "lookup of IP address"
9020 When a host is to be identified by a single-key lookup of its complete IP
9021 address, the pattern takes this form:
9022 .display
9023 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
9024 .endd
9025 For example:
9026 .code
9027 hosts_lookup = net-cdb;/hosts-by-ip.db
9028 .endd
9029 The text form of the IP address of the subject host is used as the lookup key.
9030 IPv6 addresses are converted to an unabbreviated form, using lower case
9031 letters, with dots as separators because colon is the key terminator in
9032 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
9033 quoting the keys, but this is a facility that was added later.] The data
9034 returned by the lookup is not used.
9035
9036 .cindex "IP address" "masking"
9037 .cindex "host list" "masked IP address"
9038 Single-key lookups can also be performed using masked IP addresses, using
9039 patterns of this form:
9040 .display
9041 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
9042 .endd
9043 For example:
9044 .code
9045 net24-dbm;/networks.db
9046 .endd
9047 The IP address of the subject host is masked using <&'number'&> as the mask
9048 length. A textual string is constructed from the masked value, followed by the
9049 mask, and this is used as the lookup key. For example, if the host's IP address
9050 is 192.168.34.6, the key that is looked up for the above example is
9051 &"192.168.34.0/24"&.
9052
9053 When an IPv6 address is converted to a string, dots are normally used instead
9054 of colons, so that keys in &(lsearch)& files need not contain colons (which
9055 terminate &(lsearch)& keys). This was implemented some time before the ability
9056 to quote keys was made available in &(lsearch)& files. However, the more
9057 recently implemented &(iplsearch)& files do require colons in IPv6 keys
9058 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
9059 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
9060 converted using colons and not dots.
9061 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
9062 addresses are always used.
9063 The latter are converted to IPv4 addresses, in dotted-quad form.
9064
9065 Ideally, it would be nice to tidy up this anomalous situation by changing to
9066 colons in all cases, given that quoting is now available for &(lsearch)&.
9067 However, this would be an incompatible change that might break some existing
9068 configurations.
9069
9070 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
9071 IPv6 address) is not the same as specifying just &%net-%& without a number. In
9072 the former case the key strings include the mask value, whereas in the latter
9073 case the IP address is used on its own.
9074
9075
9076
9077 .section "Host list patterns that match by host name" "SECThoslispatnam"
9078 .cindex "host" "lookup failures"
9079 .cindex "unknown host name"
9080 .cindex "host list" "matching host name"
9081 There are several types of pattern that require Exim to know the name of the
9082 remote host. These are either wildcard patterns or lookups by name. (If a
9083 complete hostname is given without any wildcarding, it is used to find an IP
9084 address to match against, as described in section &<<SECThoslispatip>>&
9085 above.)
9086
9087 If the remote host name is not already known when Exim encounters one of these
9088 patterns, it has to be found from the IP address.
9089 Although many sites on the Internet are conscientious about maintaining reverse
9090 DNS data for their hosts, there are also many that do not do this.
9091 Consequently, a name cannot always be found, and this may lead to unwanted
9092 effects. Take care when configuring host lists with wildcarded name patterns.
9093 Consider what will happen if a name cannot be found.
9094
9095 Because of the problems of determining host names from IP addresses, matching
9096 against host names is not as common as matching against IP addresses.
9097
9098 By default, in order to find a host name, Exim first does a reverse DNS lookup;
9099 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
9100 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
9101 are done can be changed by setting the &%host_lookup_order%& option. For
9102 security, once Exim has found one or more names, it looks up the IP addresses
9103 for these names and compares them with the IP address that it started with.
9104 Only those names whose IP addresses match are accepted. Any other names are
9105 discarded. If no names are left, Exim behaves as if the host name cannot be
9106 found. In the most common case there is only one name and one IP address.
9107
9108 There are some options that control what happens if a host name cannot be
9109 found. These are described in section &<<SECTbehipnot>>& below.
9110
9111 .cindex "host" "alias for"
9112 .cindex "alias for host"
9113 As a result of aliasing, hosts may have more than one name. When processing any
9114 of the following types of pattern, all the host's names are checked:
9115
9116 .ilist
9117 .cindex "asterisk" "in host list"
9118 If a pattern starts with &"*"& the remainder of the item must match the end of
9119 the host name. For example, &`*.b.c`& matches all hosts whose names end in
9120 &'.b.c'&. This special simple form is provided because this is a very common
9121 requirement. Other kinds of wildcarding require the use of a regular
9122 expression.
9123 .next
9124 .cindex "regular expressions" "in host list"
9125 .cindex "host list" "regular expression in"
9126 If the item starts with &"^"& it is taken to be a regular expression which is
9127 matched against the host name. Host names are case-independent, so this regular
9128 expression match is by default case-independent, but you can make it
9129 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9130 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9131 example,
9132 .code
9133 ^(a|b)\.c\.d$
9134 .endd
9135 is a regular expression that matches either of the two hosts &'a.c.d'& or
9136 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9137 that backslash and dollar characters are not misinterpreted as part of the
9138 string expansion. The simplest way to do this is to use &`\N`& to mark that
9139 part of the string as non-expandable. For example:
9140 .code
9141 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9142 .endd
9143 &*Warning*&: If you want to match a complete host name, you must include the
9144 &`$`& terminating metacharacter in the regular expression, as in the above
9145 example. Without it, a match at the start of the host name is all that is
9146 required.
9147 .endlist
9148
9149
9150
9151
9152 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
9153 .cindex "host" "lookup failures, permanent"
9154 While processing a host list, Exim may need to look up an IP address from a
9155 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9156 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9157 behaviour when it fails to find the information it is seeking is the same.
9158
9159 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9160 apply to temporary DNS errors, whose handling is described in the next section.
9161
9162 .cindex "&`+include_unknown`&"
9163 .cindex "&`+ignore_unknown`&"
9164 Exim parses a host list from left to right. If it encounters a permanent
9165 lookup failure in any item in the host list before it has found a match,
9166 Exim treats it as a failure and the default behavior is as if the host
9167 does not match the list. This may not always be what you want to happen.
9168 To change Exim's behaviour, the special items &`+include_unknown`& or
9169 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9170 not recognized in an indirected file).
9171
9172 .ilist
9173 If any item that follows &`+include_unknown`& requires information that
9174 cannot found, Exim behaves as if the host does match the list. For example,
9175 .code
9176 host_reject_connection = +include_unknown:*.enemy.ex
9177 .endd
9178 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9179 any hosts whose name it cannot find.
9180
9181 .next
9182 If any item that follows &`+ignore_unknown`& requires information that cannot
9183 be found, Exim ignores that item and proceeds to the rest of the list. For
9184 example:
9185 .code
9186 accept hosts = +ignore_unknown : friend.example : \
9187                192.168.4.5
9188 .endd
9189 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9190 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9191 name can be found for 192.168.4.5, it is rejected.
9192 .endlist
9193
9194 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9195 list. The effect of each one lasts until the next, or until the end of the
9196 list.
9197
9198 .section "Mixing wildcarded host names and addresses in host lists" &&&
9199          "SECTmixwilhos"
9200 .cindex "host list" "mixing names and addresses in"
9201
9202 This section explains the host/ip processing logic with the same concepts
9203 as the previous section, but specifically addresses what happens when a
9204 wildcarded hostname is one of the items in the hostlist.
9205
9206 .ilist
9207 If you have name lookups or wildcarded host names and
9208 IP addresses in the same host list, you should normally put the IP
9209 addresses first. For example, in an ACL you could have:
9210 .code
9211 accept hosts = 10.9.8.7 : *.friend.example
9212 .endd
9213 The reason you normally would order it this way lies in the
9214 left-to-right way that Exim processes lists.  It can test IP addresses
9215 without doing any DNS lookups, but when it reaches an item that requires
9216 a host name, it fails if it cannot find a host name to compare with the
9217 pattern. If the above list is given in the opposite order, the
9218 &%accept%& statement fails for a host whose name cannot be found, even
9219 if its IP address is 10.9.8.7.
9220
9221 .next
9222 If you really do want to do the name check first, and still recognize the IP
9223 address, you can rewrite the ACL like this:
9224 .code
9225 accept hosts = *.friend.example
9226 accept hosts = 10.9.8.7
9227 .endd
9228 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9229 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9230 &`+ignore_unknown`&, which was discussed in depth in the first example in
9231 this section.
9232 .endlist
9233
9234
9235 .section "Temporary DNS errors when looking up host information" &&&
9236          "SECTtemdnserr"
9237 .cindex "host" "lookup failures, temporary"
9238 .cindex "&`+include_defer`&"
9239 .cindex "&`+ignore_defer`&"
9240 A temporary DNS lookup failure normally causes a defer action (except when
9241 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9242 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9243 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9244 section. These options should be used with care, probably only in non-critical
9245 host lists such as whitelists.
9246
9247
9248
9249 .section "Host list patterns for single-key lookups by host name" &&&
9250          "SECThoslispatnamsk"
9251 .cindex "unknown host name"
9252 .cindex "host list" "matching host name"
9253 If a pattern is of the form
9254 .display
9255 <&'single-key-search-type'&>;<&'search-data'&>
9256 .endd
9257 for example
9258 .code
9259 dbm;/host/accept/list
9260 .endd
9261 a single-key lookup is performed, using the host name as its key. If the
9262 lookup succeeds, the host matches the item. The actual data that is looked up
9263 is not used.
9264
9265 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9266 keys in the file, not IP addresses. If you want to do lookups based on IP
9267 addresses, you must precede the search type with &"net-"& (see section
9268 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9269 two items in the same list, one doing an address lookup and one doing a name
9270 lookup, both using the same file.
9271
9272
9273
9274 .section "Host list patterns for query-style lookups" "SECID81"
9275 If a pattern is of the form
9276 .display
9277 <&'query-style-search-type'&>;<&'query'&>
9278 .endd
9279 the query is obeyed, and if it succeeds, the host matches the item. The actual
9280 data that is looked up is not used. The variables &$sender_host_address$& and
9281 &$sender_host_name$& can be used in the query. For example:
9282 .code
9283 hosts_lookup = pgsql;\
9284   select ip from hostlist where ip='$sender_host_address'
9285 .endd
9286 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9287 can use the &%sg%& expansion item to change this if you need to. If you want to
9288 use masked IP addresses in database queries, you can use the &%mask%& expansion
9289 operator.
9290
9291 If the query contains a reference to &$sender_host_name$&, Exim automatically
9292 looks up the host name if it has not already done so. (See section
9293 &<<SECThoslispatnam>>& for comments on finding host names.)
9294
9295 Historical note: prior to release 4.30, Exim would always attempt to find a
9296 host name before running the query, unless the search type was preceded by
9297 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9298 still recognized for query-style lookups, but its presence or absence has no
9299 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9300 See section &<<SECThoslispatsikey>>&.)
9301
9302
9303
9304
9305
9306 .section "Address lists" "SECTaddresslist"
9307 .cindex "list" "address list"
9308 .cindex "address list" "empty item"
9309 .cindex "address list" "patterns"
9310 Address lists contain patterns that are matched against mail addresses. There
9311 is one special case to be considered: the sender address of a bounce message is
9312 always empty. You can test for this by providing an empty item in an address
9313 list. For example, you can set up a router to process bounce messages by
9314 using this option setting:
9315 .code
9316 senders = :
9317 .endd
9318 The presence of the colon creates an empty item. If you do not provide any
9319 data, the list is empty and matches nothing. The empty sender can also be
9320 detected by a regular expression that matches an empty string,
9321 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9322
9323 Non-empty items in an address list can be straightforward email addresses. For
9324 example:
9325 .code
9326 senders = jbc@askone.example : hs@anacreon.example
9327 .endd
9328 A certain amount of wildcarding is permitted. If a pattern contains an @
9329 character, but is not a regular expression and does not begin with a
9330 semicolon-terminated lookup type (described below), the local part of the
9331 subject address is compared with the local part of the pattern, which may start
9332 with an asterisk. If the local parts match, the domain is checked in exactly
9333 the same way as for a pattern in a domain list. For example, the domain can be
9334 wildcarded, refer to a named list, or be a lookup:
9335 .code
9336 deny senders = *@*.spamming.site:\
9337                *@+hostile_domains:\
9338                bozo@partial-lsearch;/list/of/dodgy/sites:\
9339                *@dbm;/bad/domains.db
9340 .endd
9341 .cindex "local part" "starting with !"
9342 .cindex "address list" "local part starting with !"
9343 If a local part that begins with an exclamation mark is required, it has to be
9344 specified using a regular expression, because otherwise the exclamation mark is
9345 treated as a sign of negation, as is standard in lists.
9346
9347 If a non-empty pattern that is not a regular expression or a lookup does not
9348 contain an @ character, it is matched against the domain part of the subject
9349 address. The only two formats that are recognized this way are a literal
9350 domain, or a domain pattern that starts with *. In both these cases, the effect
9351 is the same as if &`*@`& preceded the pattern. For example:
9352 .code
9353 deny senders = enemy.domain : *.enemy.domain
9354 .endd
9355
9356 The following kinds of more complicated address list pattern can match any
9357 address, including the empty address that is characteristic of bounce message
9358 senders:
9359
9360 .ilist
9361 .cindex "regular expressions" "in address list"
9362 .cindex "address list" "regular expression in"
9363 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9364 done against the complete address, with the pattern as the regular expression.
9365 You must take care that backslash and dollar characters are not misinterpreted
9366 as part of the string expansion. The simplest way to do this is to use &`\N`&
9367 to mark that part of the string as non-expandable. For example:
9368 .code
9369 deny senders = \N^.*this.*@example\.com$\N : \
9370                \N^\d{8}.+@spamhaus.example$\N : ...
9371 .endd
9372 The &`\N`& sequences are removed by the expansion, so these items do indeed
9373 start with &"^"& by the time they are being interpreted as address patterns.
9374
9375 .next
9376 .cindex "address list" "lookup for complete address"
9377 Complete addresses can be looked up by using a pattern that starts with a
9378 lookup type terminated by a semicolon, followed by the data for the lookup. For
9379 example:
9380 .code
9381 deny senders = cdb;/etc/blocked.senders : \
9382   mysql;select address from blocked where \
9383   address='${quote_mysql:$sender_address}'
9384 .endd
9385 Both query-style and single-key lookup types can be used. For a single-key
9386 lookup type, Exim uses the complete address as the key. However, empty keys are
9387 not supported for single-key lookups, so a match against the empty address
9388 always fails. This restriction does not apply to query-style lookups.
9389
9390 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9391 cannot be used, and is ignored if specified, with an entry being written to the
9392 panic log.
9393 .cindex "*@ with single-key lookup"
9394 However, you can configure lookup defaults, as described in section
9395 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9396 default. For example, with this lookup:
9397 .code
9398 accept senders = lsearch*@;/some/file
9399 .endd
9400 the file could contains lines like this:
9401 .code
9402 user1@domain1.example
9403 *@domain2.example
9404 .endd
9405 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9406 that are tried is:
9407 .code
9408 nimrod@jaeger.example
9409 *@jaeger.example
9410 *
9411 .endd
9412 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9413 would mean that every address matches, thus rendering the test useless.
9414
9415 &*Warning 2*&: Do not confuse these two kinds of item:
9416 .code
9417 deny recipients = dbm*@;/some/file
9418 deny recipients = *@dbm;/some/file
9419 .endd
9420 The first does a whole address lookup, with defaulting, as just described,
9421 because it starts with a lookup type. The second matches the local part and
9422 domain independently, as described in a bullet point below.
9423 .endlist
9424
9425
9426 The following kinds of address list pattern can match only non-empty addresses.
9427 If the subject address is empty, a match against any of these pattern types
9428 always fails.
9429
9430
9431 .ilist
9432 .cindex "@@ with single-key lookup"
9433 .cindex "address list" "@@ lookup type"
9434 .cindex "address list" "split local part and domain"
9435 If a pattern starts with &"@@"& followed by a single-key lookup item
9436 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9437 split into a local part and a domain. The domain is looked up in the file. If
9438 it is not found, there is no match. If it is found, the data that is looked up
9439 from the file is treated as a colon-separated list of local part patterns, each
9440 of which is matched against the subject local part in turn.
9441
9442 .cindex "asterisk" "in address list"
9443 The lookup may be a partial one, and/or one involving a search for a default
9444 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9445 patterns that are looked up can be regular expressions or begin with &"*"&, or
9446 even be further lookups. They may also be independently negated. For example,
9447 with
9448 .code
9449 deny senders = @@dbm;/etc/reject-by-domain
9450 .endd
9451 the data from which the DBM file is built could contain lines like
9452 .code
9453 baddomain.com:  !postmaster : *
9454 .endd
9455 to reject all senders except &%postmaster%& from that domain.
9456
9457 .cindex "local part" "starting with !"
9458 If a local part that actually begins with an exclamation mark is required, it
9459 has to be specified using a regular expression. In &(lsearch)& files, an entry
9460 may be split over several lines by indenting the second and subsequent lines,
9461 but the separating colon must still be included at line breaks. White space
9462 surrounding the colons is ignored. For example:
9463 .code
9464 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9465   spammer3 : spammer4
9466 .endd
9467 As in all colon-separated lists in Exim, a colon can be included in an item by
9468 doubling.
9469
9470 If the last item in the list starts with a right angle-bracket, the remainder
9471 of the item is taken as a new key to look up in order to obtain a continuation
9472 list of local parts. The new key can be any sequence of characters. Thus one
9473 might have entries like
9474 .code
9475 aol.com: spammer1 : spammer 2 : >*
9476 xyz.com: spammer3 : >*
9477 *:       ^\d{8}$
9478 .endd
9479 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9480 local parts for all domains, in addition to the specific local parts listed for
9481 each domain. Of course, using this feature costs another lookup each time a
9482 chain is followed, but the effort needed to maintain the data is reduced.
9483
9484 .cindex "loop" "in lookups"
9485 It is possible to construct loops using this facility, and in order to catch
9486 them, the chains may be no more than fifty items long.
9487
9488 .next
9489 The @@<&'lookup'&> style of item can also be used with a query-style
9490 lookup, but in this case, the chaining facility is not available. The lookup
9491 can only return a single list of local parts.
9492 .endlist
9493
9494 &*Warning*&: There is an important difference between the address list items
9495 in these two examples:
9496 .code
9497 senders = +my_list
9498 senders = *@+my_list
9499 .endd
9500 In the first one, &`my_list`& is a named address list, whereas in the second
9501 example it is a named domain list.
9502
9503
9504
9505
9506 .section "Case of letters in address lists" "SECTcasletadd"
9507 .cindex "case of local parts"
9508 .cindex "address list" "case forcing"
9509 .cindex "case forcing in address lists"
9510 Domains in email addresses are always handled caselessly, but for local parts
9511 case may be significant on some systems (see &%caseful_local_part%& for how
9512 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9513 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9514 blocking lists should be done in a case-independent manner. Since most address
9515 lists in Exim are used for this kind of control, Exim attempts to do this by
9516 default.
9517
9518 The domain portion of an address is always lowercased before matching it to an
9519 address list. The local part is lowercased by default, and any string
9520 comparisons that take place are done caselessly. This means that the data in
9521 the address list itself, in files included as plain filenames, and in any file
9522 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9523 keys in files that are looked up by a search type other than &(lsearch)& (which
9524 works caselessly) must be in lower case, because these lookups are not
9525 case-independent.
9526
9527 .cindex "&`+caseful`&"
9528 To allow for the possibility of caseful address list matching, if an item in
9529 an address list is the string &"+caseful"&, the original case of the local
9530 part is restored for any comparisons that follow, and string comparisons are no
9531 longer case-independent. This does not affect the domain, which remains in
9532 lower case. However, although independent matches on the domain alone are still
9533 performed caselessly, regular expressions that match against an entire address
9534 become case-sensitive after &"+caseful"& has been seen.
9535
9536
9537
9538 .section "Local part lists" "SECTlocparlis"
9539 .cindex "list" "local part list"
9540 .cindex "local part" "list"
9541 These behave in the same way as domain and host lists, with the following
9542 changes:
9543
9544 Case-sensitivity in local part lists is handled in the same way as for address
9545 lists, as just described. The &"+caseful"& item can be used if required. In a
9546 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9547 set false, the subject is lowercased and the matching is initially
9548 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9549 matching in the local part list, but not elsewhere in the router. If
9550 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9551 option is case-sensitive from the start.
9552
9553 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9554 comments are handled in the same way as address lists &-- they are recognized
9555 only if the # is preceded by white space or the start of the line.
9556 Otherwise, local part lists are matched in the same way as domain lists, except
9557 that the special items that refer to the local host (&`@`&, &`@[]`&,
9558 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9559 Refer to section &<<SECTdomainlist>>& for details of the other available item
9560 types.
9561 .ecindex IIDdohoadli
9562
9563
9564
9565
9566 . ////////////////////////////////////////////////////////////////////////////
9567 . ////////////////////////////////////////////////////////////////////////////
9568
9569 .chapter "String expansions" "CHAPexpand"
9570 .scindex IIDstrexp "expansion" "of strings"
9571 Many strings in Exim's runtime configuration are expanded before use. Some of
9572 them are expanded every time they are used; others are expanded only once.
9573
9574 When a string is being expanded it is copied verbatim from left to right except
9575 .cindex expansion "string concatenation"
9576 when a dollar or backslash character is encountered. A dollar specifies the
9577 start of a portion of the string that is interpreted and replaced as described
9578 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9579 escape character, as described in the following section.
9580
9581 Whether a string is expanded depends upon the context.  Usually this is solely
9582 dependent upon the option for which a value is sought; in this documentation,
9583 options for which string expansion is performed are marked with &dagger; after
9584 the data type.  ACL rules always expand strings.  A couple of expansion
9585 conditions do not expand some of the brace-delimited branches, for security
9586 reasons,
9587 .cindex "tainted data" expansion
9588 .cindex "tainted data" definition
9589 .cindex expansion "tainted data"
9590 and expansion of data deriving from the sender (&"tainted data"&)
9591 is not permitted (including acessing a file using a tainted name).
9592 The main config option &%allow_insecure_tainted_data%& can be used as
9593 mitigation during uprades to more secure configurations.
9594
9595 Common ways of obtaining untainted equivalents of variables with
9596 tainted values
9597 .cindex "tainted data" "de-tainting"
9598 come down to using the tainted value as a lookup key in a trusted database.
9599 This database could be the filesystem structure,
9600 or the password file,
9601 or accessed via a DBMS.
9602 Specific methods are indexed under &"de-tainting"&.
9603
9604
9605
9606 .section "Literal text in expanded strings" "SECTlittext"
9607 .cindex "expansion" "including literal text"
9608 An uninterpreted dollar can be included in an expanded string by putting a
9609 backslash in front of it. A backslash can be used to prevent any special
9610 character being treated specially in an expansion, including backslash itself.
9611 If the string appears in quotes in the configuration file, two backslashes are
9612 required because the quotes themselves cause interpretation of backslashes when
9613 the string is read in (see section &<<SECTstrings>>&).
9614
9615 .cindex "expansion" "non-expandable substrings"
9616 A portion of the string can specified as non-expandable by placing it between
9617 two occurrences of &`\N`&. This is particularly useful for protecting regular
9618 expressions, which often contain backslashes and dollar signs. For example:
9619 .code
9620 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9621 .endd
9622 On encountering the first &`\N`&, the expander copies subsequent characters
9623 without interpretation until it reaches the next &`\N`& or the end of the
9624 string.
9625
9626
9627
9628 .section "Character escape sequences in expanded strings" "SECID82"
9629 .cindex "expansion" "escape sequences"
9630 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9631 expanded string is recognized as an escape sequence for the character newline,
9632 carriage return, or tab, respectively. A backslash followed by up to three
9633 octal digits is recognized as an octal encoding for a single character, and a
9634 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9635 encoding.
9636
9637 These escape sequences are also recognized in quoted strings when they are read
9638 in. Their interpretation in expansions as well is useful for unquoted strings,
9639 and for other cases such as looked-up strings that are then expanded.
9640
9641
9642 .section "Testing string expansions" "SECID83"
9643 .cindex "expansion" "testing"
9644 .cindex "testing" "string expansion"
9645 .oindex "&%-be%&"
9646 Many expansions can be tested by calling Exim with the &%-be%& option. This
9647 takes the command arguments, or lines from the standard input if there are no
9648 arguments, runs them through the string expansion code, and writes the results
9649 to the standard output. Variables based on configuration values are set up, but
9650 since no message is being processed, variables such as &$local_part$& have no
9651 value. Nevertheless the &%-be%& option can be useful for checking out file and
9652 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9653 and &%nhash%&.
9654
9655 Exim gives up its root privilege when it is called with the &%-be%& option, and
9656 instead runs under the uid and gid it was called with, to prevent users from
9657 using &%-be%& for reading files to which they do not have access.
9658
9659 .oindex "&%-bem%&"
9660 If you want to test expansions that include variables whose values are taken
9661 from a message, there are two other options that can be used. The &%-bem%&
9662 option is like &%-be%& except that it is followed by a filename. The file is
9663 read as a message before doing the test expansions. For example:
9664 .code
9665 exim -bem /tmp/test.message '$h_subject:'
9666 .endd
9667 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9668 Exim message identifier. For example:
9669 .code
9670 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9671 .endd
9672 This loads the message from Exim's spool before doing the test expansions, and
9673 is therefore restricted to admin users.
9674
9675
9676 .section "Forced expansion failure" "SECTforexpfai"
9677 .cindex "expansion" "forced failure"
9678 A number of expansions that are described in the following section have
9679 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9680 (which are sometimes called &"curly brackets"&). Which of the two strings is
9681 used depends on some condition that is evaluated as part of the expansion. If,
9682 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9683 the entire string expansion fails in a way that can be detected by the code
9684 that requested the expansion. This is called &"forced expansion failure"&, and
9685 its consequences depend on the circumstances. In some cases it is no different
9686 from any other expansion failure, but in others a different action may be
9687 taken. Such variations are mentioned in the documentation of the option that is
9688 being expanded.
9689
9690
9691
9692
9693 .section "Expansion items" "SECTexpansionitems"
9694 The following items are recognized in expanded strings. White space may be used
9695 between sub-items that are keywords or substrings enclosed in braces inside an
9696 outer set of braces, to improve readability. &*Warning*&: Within braces,
9697 white space is significant.
9698
9699 .vlist
9700 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9701 .cindex "expansion" "variables"
9702 Substitute the contents of the named variable, for example:
9703 .code
9704 $local_part
9705 ${domain}
9706 .endd
9707 The second form can be used to separate the name from subsequent alphanumeric
9708 characters. This form (using braces) is available only for variables; it does
9709 &'not'& apply to message headers. The names of the variables are given in
9710 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9711 given, the expansion fails.
9712
9713 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9714 .cindex "expansion" "operators"
9715 The string is first itself expanded, and then the operation specified by
9716 <&'op'&> is applied to it. For example:
9717 .code
9718 ${lc:$local_part}
9719 .endd
9720 The string starts with the first character after the colon, which may be
9721 leading white space. A list of operators is given in section &<<SECTexpop>>&
9722 below. The operator notation is used for simple expansion items that have just
9723 one argument, because it reduces the number of braces and therefore makes the
9724 string easier to understand.
9725
9726 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9727 This item inserts &"basic"& header lines. It is described with the &%header%&
9728 expansion item below.
9729
9730
9731 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9732 .cindex "expansion" "calling an acl"
9733 .cindex "&%acl%&" "call from expansion"
9734 The name and zero to nine argument strings are first expanded separately.  The expanded
9735 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9736 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9737 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9738 and may use the variables; if another acl expansion is used the values
9739 are restored after it returns.  If the ACL sets
9740 a value using a "message =" modifier and returns accept or deny, the value becomes
9741 the result of the expansion.
9742 If no message is set and the ACL returns accept or deny
9743 the expansion result is an empty string.
9744 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9745
9746
9747 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9748 .cindex authentication "results header"
9749 .chindex Authentication-Results:
9750 .cindex authentication "expansion item"
9751 This item returns a string suitable for insertion as an
9752 &'Authentication-Results:'&
9753 header line.
9754 The given <&'authserv-id'&> is included in the result; typically this
9755 will be a domain name identifying the system performing the authentications.
9756 Methods that might be present in the result include:
9757 .code
9758 none
9759 iprev
9760 auth
9761 spf
9762 dkim
9763 .endd
9764
9765 Example use (as an ACL modifier):
9766 .code
9767       add_header = :at_start:${authresults {$primary_hostname}}
9768 .endd
9769 This is safe even if no authentication results are available.
9770
9771
9772 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9773        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9774 .cindex "expansion" "extracting certificate fields"
9775 .cindex "&%certextract%&" "certificate fields"
9776 .cindex "certificate" "extracting fields"
9777 The <&'certificate'&> must be a variable of type certificate.
9778 The field name is expanded and used to retrieve the relevant field from
9779 the certificate.  Supported fields are:
9780 .display
9781 &`version        `&
9782 &`serial_number  `&
9783 &`subject        `& RFC4514 DN
9784 &`issuer         `& RFC4514 DN
9785 &`notbefore      `& time
9786 &`notafter       `& time
9787 &`sig_algorithm  `&
9788 &`signature      `&
9789 &`subj_altname   `& tagged list
9790 &`ocsp_uri       `& list
9791 &`crl_uri        `& list
9792 .endd
9793 If the field is found,
9794 <&'string2'&> is expanded, and replaces the whole item;
9795 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9796 variable &$value$& contains the value that has been extracted. Afterwards, it
9797 is restored to any previous value it might have had.
9798
9799 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9800 key is not found. If {<&'string2'&>} is also omitted, the value that was
9801 extracted is used.
9802
9803 Some field names take optional modifiers, appended and separated by commas.
9804
9805 The field selectors marked as "RFC4514" above
9806 output a Distinguished Name string which is
9807 not quite
9808 parseable by Exim as a comma-separated tagged list
9809 (the exceptions being elements containing commas).
9810 RDN elements of a single type may be selected by
9811 a modifier of the type label; if so the expansion
9812 result is a list (newline-separated by default).
9813 The separator may be changed by another modifier of
9814 a right angle-bracket followed immediately by the new separator.
9815 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9816
9817 The field selectors marked as "time" above
9818 take an optional modifier of "int"
9819 for which the result is the number of seconds since epoch.
9820 Otherwise the result is a human-readable string
9821 in the timezone selected by the main "timezone" option.
9822
9823 The field selectors marked as "list" above return a list,
9824 newline-separated by default,
9825 (embedded separator characters in elements are doubled).
9826 The separator may be changed by a modifier of
9827 a right angle-bracket followed immediately by the new separator.
9828
9829 The field selectors marked as "tagged" above
9830 prefix each list element with a type string and an equals sign.
9831 Elements of only one type may be selected by a modifier
9832 which is one of "dns", "uri" or "mail";
9833 if so the element tags are omitted.
9834
9835 If not otherwise noted field values are presented in human-readable form.
9836
9837 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9838        {*&<&'arg'&>&*}...}*&"
9839 .cindex &%dlfunc%&
9840 This expansion dynamically loads and then calls a locally-written C function.
9841 This functionality is available only if Exim is compiled with
9842 .code
9843 EXPAND_DLFUNC=yes
9844 .endd
9845 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9846 object so that it doesn't reload the same object file in the same Exim process
9847 (but of course Exim does start new processes frequently).
9848
9849 There may be from zero to eight arguments to the function.
9850
9851 When compiling
9852 a local function that is to be called in this way,
9853 first &_DLFUNC_IMPL_& should be defined,
9854 and second &_local_scan.h_& should be included.
9855 The Exim variables and functions that are defined by that API
9856 are also available for dynamically loaded functions. The function itself
9857 must have the following type:
9858 .code
9859 int dlfunction(uschar **yield, int argc, uschar *argv[])
9860 .endd
9861 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9862 function should return one of the following values:
9863
9864 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9865 into the expanded string that is being built.
9866
9867 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9868 from &'yield'&, if it is set.
9869
9870 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9871 taken from &'yield'& if it is set.
9872
9873 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9874
9875 When compiling a function that is to be used in this way with gcc,
9876 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9877 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9878
9879
9880 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9881 .cindex "expansion" "extracting value from environment"
9882 .cindex "environment" "values from"
9883 The key is first expanded separately, and leading and trailing white space
9884 removed.
9885 This is then searched for as a name in the environment.
9886 If a variable is found then its value is placed in &$value$&
9887 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9888
9889 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9890 appear, for example:
9891 .code
9892 ${env{USER}{$value} fail }
9893 .endd
9894 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9895 {<&'string1'&>} must be present for &"fail"& to be recognized.
9896
9897 If {<&'string2'&>} is omitted an empty string is substituted on
9898 search failure.
9899 If {<&'string1'&>} is omitted the search result is substituted on
9900 search success.
9901
9902 The environment is adjusted by the &%keep_environment%& and
9903 &%add_environment%& main section options.
9904
9905
9906 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9907        {*&<&'string3'&>&*}}*&"
9908 .cindex "expansion" "extracting substrings by key"
9909 .cindex "&%extract%&" "substrings by key"
9910 The key and <&'string1'&> are first expanded separately. Leading and trailing
9911 white space is removed from the key (but not from any of the strings). The key
9912 must not be empty and must not consist entirely of digits.
9913 The expanded <&'string1'&> must be of the form:
9914 .display
9915 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9916 .endd
9917 .vindex "&$value$&"
9918 where the equals signs and spaces (but not both) are optional. If any of the
9919 values contain white space, they must be enclosed in double quotes, and any
9920 values that are enclosed in double quotes are subject to escape processing as
9921 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9922 for the value that corresponds to the key. The search is case-insensitive. If
9923 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9924 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9925 variable &$value$& contains the value that has been extracted. Afterwards, it
9926 is restored to any previous value it might have had.
9927
9928 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9929 key is not found. If {<&'string2'&>} is also omitted, the value that was
9930 extracted is used. Thus, for example, these two expansions are identical, and
9931 yield &"2001"&:
9932 .code
9933 ${extract{gid}{uid=1984 gid=2001}}
9934 ${extract{gid}{uid=1984 gid=2001}{$value}}
9935 .endd
9936 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9937 appear, for example:
9938 .code
9939 ${extract{Z}{A=... B=...}{$value} fail }
9940 .endd
9941 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9942 {<&'string2'&>} must be present for &"fail"& to be recognized.
9943
9944 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9945        {*&<&'string3'&>&*}}*&" &&&
9946        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9947        {*&<&'string3'&>&*}}*&"
9948 .cindex "expansion" "extracting from JSON object"
9949 .cindex JSON expansions
9950 The key and <&'string1'&> are first expanded separately. Leading and trailing
9951 white space is removed from the key (but not from any of the strings). The key
9952 must not be empty and must not consist entirely of digits.
9953 The expanded <&'string1'&> must be of the form:
9954 .display
9955 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9956 .endd
9957 .vindex "&$value$&"
9958 The braces, commas and colons, and the quoting of the member name are required;
9959 the spaces are optional.
9960 Matching of the key against the member names is done case-sensitively.
9961 For the &"json"& variant,
9962 if a returned value is a JSON string, it retains its leading and
9963 trailing quotes.
9964 For the &"jsons"& variant, which is intended for use with JSON strings, the
9965 leading and trailing quotes are removed from the returned value.
9966 . XXX should be a UTF-8 compare
9967
9968 The results of matching are handled as above.
9969
9970
9971 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9972         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9973 .cindex "expansion" "extracting substrings by number"
9974 .cindex "&%extract%&" "substrings by number"
9975 The <&'number'&> argument must consist entirely of decimal digits,
9976 apart from leading and trailing white space, which is ignored.
9977 This is what distinguishes this form of &%extract%& from the previous kind. It
9978 behaves in the same way, except that, instead of extracting a named field, it
9979 extracts from <&'string1'&> the field whose number is given as the first
9980 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9981 <&'string3'&> as before.
9982
9983 The fields in the string are separated by any one of the characters in the
9984 separator string. These may include space or tab characters.
9985 The first field is numbered one. If the number is negative, the fields are
9986 counted from the end of the string, with the rightmost one numbered -1. If the
9987 number given is zero, the entire string is returned. If the modulus of the
9988 number is greater than the number of fields in the string, the result is the
9989 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9990 provided. For example:
9991 .code
9992 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9993 .endd
9994 yields &"42"&, and
9995 .code
9996 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9997 .endd
9998 yields &"99"&. Two successive separators mean that the field between them is
9999 empty (for example, the fifth field above).
10000
10001
10002 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
10003         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
10004        "&*${extract jsons{*&<&'number'&>&*}}&&&
10005         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10006 .cindex "expansion" "extracting from JSON array"
10007 .cindex JSON expansions
10008 The <&'number'&> argument must consist entirely of decimal digits,
10009 apart from leading and trailing white space, which is ignored.
10010
10011 Field selection and result handling is as above;
10012 there is no choice of field separator.
10013 For the &"json"& variant,
10014 if a returned value is a JSON string, it retains its leading and
10015 trailing quotes.
10016 For the &"jsons"& variant, which is intended for use with JSON strings, the
10017 leading and trailing quotes are removed from the returned value.
10018
10019
10020 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
10021 .cindex "list" "selecting by condition"
10022 .cindex "expansion" "selecting from list by condition"
10023 .vindex "&$item$&"
10024 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10025 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10026 For each item
10027 in this list, its value is place in &$item$&, and then the condition is
10028 evaluated. If the condition is true, &$item$& is added to the output as an
10029 item in a new list; if the condition is false, the item is discarded. The
10030 separator used for the output list is the same as the one used for the
10031 input, but a separator setting is not included in the output. For example:
10032 .code
10033 ${filter{a:b:c}{!eq{$item}{b}}}
10034 .endd
10035 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
10036 to what it was before. See also the &%map%& and &%reduce%& expansion items.
10037
10038
10039 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10040 .cindex "hash function" "textual"
10041 .cindex "expansion" "textual hash"
10042 This is a textual hashing function, and was the first to be implemented in
10043 early versions of Exim. In current releases, there are other hashing functions
10044 (numeric, MD5, and SHA-1), which are described below.
10045
10046 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
10047 <&'n'&>. If you are using fixed values for these numbers, that is, if
10048 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
10049 use the simpler operator notation that avoids some of the braces:
10050 .code
10051 ${hash_<n>_<m>:<string>}
10052 .endd
10053 The second number is optional (in both notations). If <&'n'&> is greater than
10054 or equal to the length of the string, the expansion item returns the string.
10055 Otherwise it computes a new string of length <&'n'&> by applying a hashing
10056 function to the string. The new string consists of characters taken from the
10057 first <&'m'&> characters of the string
10058 .code
10059 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
10060 .endd
10061 If <&'m'&> is not present the value 26 is used, so that only lower case
10062 letters appear. For example:
10063 .display
10064 &`$hash{3}{monty}}           `&   yields  &`jmg`&
10065 &`$hash{5}{monty}}           `&   yields  &`monty`&
10066 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
10067 .endd
10068
10069 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
10070         &*$h_*&<&'header&~name'&>&*:*&" &&&
10071        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10072         &*$bh_*&<&'header&~name'&>&*:*&" &&&
10073        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10074         &*$lh_*&<&'header&~name'&>&*:*&" &&&
10075        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10076         &*$rh_*&<&'header&~name'&>&*:*&"
10077 .cindex "expansion" "header insertion"
10078 .vindex "&$header_$&"
10079 .vindex "&$bheader_$&"
10080 .vindex "&$lheader_$&"
10081 .vindex "&$rheader_$&"
10082 .cindex "header lines" "in expansion strings"
10083 .cindex "header lines" "character sets"
10084 .cindex "header lines" "decoding"
10085 Substitute the contents of the named message header line, for example
10086 .code
10087 $header_reply-to:
10088 .endd
10089 The newline that terminates a header line is not included in the expansion, but
10090 internal newlines (caused by splitting the header line over several physical
10091 lines) may be present.
10092
10093 The difference between the four pairs of expansions is in the way
10094 the data in the header line is interpreted.
10095
10096 .ilist
10097 .cindex "white space" "in header lines"
10098 &%rheader%& gives the original &"raw"& content of the header line, with no
10099 processing at all, and without the removal of leading and trailing white space.
10100
10101 .next
10102 .cindex "list" "of header lines"
10103 &%lheader%& gives a colon-separated list, one element per header when there
10104 are multiple headers with a given name.
10105 Any embedded colon characters within an element are doubled, so normal Exim
10106 list-processing facilities can be used.
10107 The terminating newline of each element is removed; in other respects
10108 the content is &"raw"&.
10109
10110 .next
10111 .cindex "base64 encoding" "in header lines"
10112 &%bheader%& removes leading and trailing white space, and then decodes base64
10113 or quoted-printable MIME &"words"& within the header text, but does no
10114 character set translation. If decoding of what looks superficially like a MIME
10115 &"word"& fails, the raw string is returned. If decoding
10116 .cindex "binary zero" "in header line"
10117 produces a binary zero character, it is replaced by a question mark &-- this is
10118 what Exim does for binary zeros that are actually received in header lines.
10119
10120 .next
10121 &%header%& tries to translate the string as decoded by &%bheader%& to a
10122 standard character set. This is an attempt to produce the same string as would
10123 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
10124 returned. Translation is attempted only on operating systems that support the
10125 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
10126 a system Makefile or in &_Local/Makefile_&.
10127 .endlist ilist
10128
10129 In a filter file, the target character set for &%header%& can be specified by a
10130 command of the following form:
10131 .code
10132 headers charset "UTF-8"
10133 .endd
10134 This command affects all references to &$h_$& (or &$header_$&) expansions in
10135 subsequently obeyed filter commands. In the absence of this command, the target
10136 character set in a filter is taken from the setting of the &%headers_charset%&
10137 option in the runtime configuration. The value of this option defaults to the
10138 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10139 ISO-8859-1.
10140
10141 Header names follow the syntax of RFC 2822, which states that they may contain
10142 any printing characters except space and colon. Consequently, curly brackets
10143 &'do not'& terminate header names, and should not be used to enclose them as
10144 if they were variables. Attempting to do so causes a syntax error.
10145
10146 Only header lines that are common to all copies of a message are visible to
10147 this mechanism. These are the original header lines that are received with the
10148 message, and any that are added by an ACL statement or by a system
10149 filter. Header lines that are added to a particular copy of a message by a
10150 router or transport are not accessible.
10151
10152 For incoming SMTP messages, no header lines are visible in
10153 ACLs that are obeyed before the data phase completes,
10154 because the header structure is not set up until the message is received.
10155 They are visible in DKIM, PRDR and DATA ACLs.
10156 Header lines that are added in a RCPT ACL (for example)
10157 are saved until the message's incoming header lines are available, at which
10158 point they are added.
10159 When any of the above ACLs are
10160 running, however, header lines added by earlier ACLs are visible.
10161
10162 Upper case and lower case letters are synonymous in header names. If the
10163 following character is white space, the terminating colon may be omitted, but
10164 this is not recommended, because you may then forget it when it is needed. When
10165 white space terminates the header name, this white space is included in the
10166 expanded string.  If the message does not contain the given header, the
10167 expansion item is replaced by an empty string. (See the &%def%& condition in
10168 section &<<SECTexpcond>>& for a means of testing for the existence of a
10169 header.)
10170
10171 If there is more than one header with the same name, they are all concatenated
10172 to form the substitution string, up to a maximum length of 64K. Unless
10173 &%rheader%& is being used, leading and trailing white space is removed from
10174 each header before concatenation, and a completely empty header is ignored. A
10175 newline character is then inserted between non-empty headers, but there is no
10176 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10177 those headers that contain lists of addresses, a comma is also inserted at the
10178 junctions between headers. This does not happen for the &%rheader%& expansion.
10179
10180 .cindex "tainted data" "message headers"
10181 When the headers are from an incoming message,
10182 the result of expanding any of these variables is tainted.
10183
10184
10185 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10186 .cindex "expansion" "hmac hashing"
10187 .cindex &%hmac%&
10188 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10189 shared secret and some text into a message authentication code, as specified in
10190 RFC 2104. This differs from &`${md5:secret_text...}`& or
10191 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10192 cryptographic hash, allowing for authentication that is not possible with MD5
10193 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10194 present. For example:
10195 .code
10196 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10197 .endd
10198 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10199 produces:
10200 .code
10201 dd97e3ba5d1a61b5006108f8c8252953
10202 .endd
10203 As an example of how this might be used, you might put in the main part of
10204 an Exim configuration:
10205 .code
10206 SPAMSCAN_SECRET=cohgheeLei2thahw
10207 .endd
10208 In a router or a transport you could then have:
10209 .code
10210 headers_add = \
10211   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10212   ${hmac{md5}{SPAMSCAN_SECRET}\
10213   {${primary_hostname},${message_exim_id},$h_message-id:}}
10214 .endd
10215 Then given a message, you can check where it was scanned by looking at the
10216 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10217 this header line is authentic by recomputing the authentication code from the
10218 host name, message ID and the &'Message-id:'& header line. This can be done
10219 using Exim's &%-be%& option, or by other means, for example, by using the
10220 &'hmac_md5_hex()'& function in Perl.
10221
10222
10223 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10224 .cindex "expansion" "conditional"
10225 .cindex "&%if%&, expansion item"
10226 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10227 item; otherwise <&'string2'&> is used. The available conditions are described
10228 in section &<<SECTexpcond>>& below. For example:
10229 .code
10230 ${if eq {$local_part}{postmaster} {yes}{no} }
10231 .endd
10232 The second string need not be present; if it is not and the condition is not
10233 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10234 be present instead of the second string (without any curly brackets). In this
10235 case, the expansion is forced to fail if the condition is not true (see section
10236 &<<SECTforexpfai>>&).
10237
10238 If both strings are omitted, the result is the string &`true`& if the condition
10239 is true, and the empty string if the condition is false. This makes it less
10240 cumbersome to write custom ACL and router conditions. For example, instead of
10241 .code
10242 condition = ${if >{$acl_m4}{3}{true}{false}}
10243 .endd
10244 you can use
10245 .code
10246 condition = ${if >{$acl_m4}{3}}
10247 .endd
10248
10249
10250
10251 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10252 .cindex expansion "imap folder"
10253 .cindex "&%imapfolder%& expansion item"
10254 This item converts a (possibly multilevel, or with non-ASCII characters)
10255 folder specification to a Maildir name for filesystem use.
10256 For information on internationalisation support see &<<SECTi18nMDA>>&.
10257
10258
10259
10260 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10261 .cindex "expansion" "string truncation"
10262 .cindex "&%length%& expansion item"
10263 The &%length%& item is used to extract the initial portion of a string. Both
10264 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10265 you are using a fixed value for the number, that is, if <&'string1'&> does not
10266 change when expanded, you can use the simpler operator notation that avoids
10267 some of the braces:
10268 .code
10269 ${length_<n>:<string>}
10270 .endd
10271 The result of this item is either the first <&'n'&> bytes or the whole
10272 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10273 &%strlen%&, which gives the length of a string.
10274 All measurement is done in bytes and is not UTF-8 aware.
10275
10276
10277 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10278         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10279 .cindex "expansion" "extracting list elements by number"
10280 .cindex "&%listextract%&" "extract list elements by number"
10281 .cindex "list" "extracting elements by number"
10282 The <&'number'&> argument must consist entirely of decimal digits,
10283 apart from an optional leading minus,
10284 and leading and trailing white space (which is ignored).
10285
10286 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10287 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10288
10289 The first field of the list is numbered one.
10290 If the number is negative, the fields are
10291 counted from the end of the list, with the rightmost one numbered -1.
10292 The numbered element of the list is extracted and placed in &$value$&,
10293 then <&'string2'&> is expanded as the result.
10294
10295 If the modulus of the
10296 number is zero or greater than the number of fields in the string,
10297 the result is the expansion of <&'string3'&>.
10298
10299 For example:
10300 .code
10301 ${listextract{2}{x:42:99}}
10302 .endd
10303 yields &"42"&, and
10304 .code
10305 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10306 .endd
10307 yields &"result: 42"&.
10308
10309 If {<&'string3'&>} is omitted, an empty string is used for string3.
10310 If {<&'string2'&>} is also omitted, the value that was
10311 extracted is used.
10312 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10313
10314
10315 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10316 .cindex quoting "for list"
10317 .cindex list quoting
10318 This item doubles any occurrence of the separator character
10319 in the given string.
10320 An empty string is replaced with a single space.
10321 This converts the string into a safe form for use as a list element,
10322 in a list using the given separator.
10323
10324
10325 .vitem "&*${lookup&~{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10326         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" &&&
10327        "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10328         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10329 .cindex "expansion" "lookup in"
10330 .cindex "file" "lookups"
10331 .cindex "lookup" "in expanded string"
10332 The two forms of lookup item specify data lookups in files and databases, as
10333 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10334 lookups, and the second is used for query-style lookups. The <&'key'&>,
10335 <&'file'&>, and <&'query'&> strings are expanded before use.
10336
10337 If there is any white space in a lookup item which is part of a filter command,
10338 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10339 other place where white space is significant, the lookup item must be enclosed
10340 in double quotes. The use of data lookups in users' filter files may be locked
10341 out by the system administrator.
10342
10343 .vindex "&$value$&"
10344 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10345 During its expansion, the variable &$value$& contains the data returned by the
10346 lookup. Afterwards it reverts to the value it had previously (at the outer
10347 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10348 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10349 string on failure. If <&'string2'&> is provided, it can itself be a nested
10350 lookup, thus providing a mechanism for looking up a default value when the
10351 original lookup fails.
10352
10353 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10354 data for the outer lookup while the parameters of the second lookup are
10355 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10356 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10357 appear, and in this case, if the lookup fails, the entire expansion is forced
10358 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10359 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10360 successful lookup, and nothing in the case of failure.
10361
10362 For single-key lookups, the string &"partial"& is permitted to precede the
10363 search type in order to do partial matching, and * or *@ may follow a search
10364 type to request default lookups if the key does not match (see sections
10365 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10366
10367 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10368 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10369 and non-wild parts of the key during the expansion of the replacement text.
10370 They return to their previous values at the end of the lookup item.
10371
10372 This example looks up the postmaster alias in the conventional alias file:
10373 .code
10374 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10375 .endd
10376 This example uses NIS+ to look up the full name of the user corresponding to
10377 the local part of an address, forcing the expansion to fail if it is not found:
10378 .code
10379 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10380   {$value}fail}
10381 .endd
10382
10383
10384 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10385 .cindex "expansion" "list creation"
10386 .vindex "&$item$&"
10387 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10388 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10389 For each item
10390 in this list, its value is place in &$item$&, and then <&'string2'&> is
10391 expanded and added to the output as an item in a new list. The separator used
10392 for the output list is the same as the one used for the input, but a separator
10393 setting is not included in the output. For example:
10394 .code
10395 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10396 .endd
10397 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10398 value of &$item$& is restored to what it was before. See also the &%filter%&
10399 and &%reduce%& expansion items.
10400
10401 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10402 .cindex "expansion" "numeric hash"
10403 .cindex "hash function" "numeric"
10404 The three strings are expanded; the first two must yield numbers. Call them
10405 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10406 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10407 can use the simpler operator notation that avoids some of the braces:
10408 .code
10409 ${nhash_<n>_<m>:<string>}
10410 .endd
10411 The second number is optional (in both notations). If there is only one number,
10412 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10413 processed by a div/mod hash function that returns two numbers, separated by a
10414 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10415 example,
10416 .code
10417 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10418 .endd
10419 returns the string &"6/33"&.
10420
10421
10422
10423 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10424 .cindex "Perl" "use in expanded string"
10425 .cindex "expansion" "calling Perl from"
10426 This item is available only if Exim has been built to include an embedded Perl
10427 interpreter. The subroutine name and the arguments are first separately
10428 expanded, and then the Perl subroutine is called with those arguments. No
10429 additional arguments need be given; the maximum number permitted, including the
10430 name of the subroutine, is nine.
10431
10432 The return value of the subroutine is inserted into the expanded string, unless
10433 the return value is &%undef%&. In that case, the entire expansion is
10434 forced to fail, in the same way as an explicit &"fail"& on a lookup item
10435 does (see section &<<SECTforexpfai>>&).  Whatever you return is evaluated
10436 in a scalar context, thus the return value is a scalar.  For example, if you
10437 return a Perl vector, the return value is the size of the vector,
10438 not its contents.
10439
10440 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10441 with the error message that was passed to &%die%&. More details of the embedded
10442 Perl facility are given in chapter &<<CHAPperl>>&.
10443
10444 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10445 out the use of this expansion item in filter files.
10446
10447
10448 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10449 .cindex "&%prvs%& expansion item"
10450 The first argument is a complete email address and the second is secret
10451 keystring. The third argument, specifying a key number, is optional. If absent,
10452 it defaults to 0. The result of the expansion is a prvs-signed email address,
10453 to be typically used with the &%return_path%& option on an &(smtp)& transport
10454 as part of a bounce address tag validation (BATV) scheme. For more discussion
10455 and an example, see section &<<SECTverifyPRVS>>&.
10456
10457 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10458         {*&<&'string'&>&*}}*&"
10459 .cindex "&%prvscheck%& expansion item"
10460 This expansion item is the complement of the &%prvs%& item. It is used for
10461 checking prvs-signed addresses. If the expansion of the first argument does not
10462 yield a syntactically valid prvs-signed address, the whole item expands to the
10463 empty string. When the first argument does expand to a syntactically valid
10464 prvs-signed address, the second argument is expanded, with the prvs-decoded
10465 version of the address and the key number extracted from the address in the
10466 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10467
10468 These two variables can be used in the expansion of the second argument to
10469 retrieve the secret. The validity of the prvs-signed address is then checked
10470 against the secret. The result is stored in the variable &$prvscheck_result$&,
10471 which is empty for failure or &"1"& for success.
10472
10473 The third argument is optional; if it is missing, it defaults to an empty
10474 string. This argument is now expanded. If the result is an empty string, the
10475 result of the expansion is the decoded version of the address. This is the case
10476 whether or not the signature was valid. Otherwise, the result of the expansion
10477 is the expansion of the third argument.
10478
10479 All three variables can be used in the expansion of the third argument.
10480 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10481 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10482
10483 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10484 .cindex "expansion" "inserting an entire file"
10485 .cindex "file" "inserting into expansion"
10486 .cindex "&%readfile%& expansion item"
10487 The filename and end-of-line (eol) string are first expanded separately. The file is
10488 then read, and its contents replace the entire item. All newline characters in
10489 the file are replaced by the end-of-line string if it is present. Otherwise,
10490 newlines are left in the string.
10491 String expansion is not applied to the contents of the file. If you want this,
10492 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10493 the string expansion fails.
10494
10495 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10496 locks out the use of this expansion item in filter files.
10497
10498
10499
10500 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10501         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10502 .cindex "expansion" "inserting from a socket"
10503 .cindex "socket, use of in expansion"
10504 .cindex "&%readsocket%& expansion item"
10505 This item inserts data from a Unix domain or TCP socket into the expanded
10506 string. The minimal way of using it uses just two arguments, as in these
10507 examples:
10508 .code
10509 ${readsocket{/socket/name}{request string}}
10510 ${readsocket{inet:some.host:1234}{request string}}
10511 .endd
10512 For a Unix domain socket, the first substring must be the path to the socket.
10513 For an Internet socket, the first substring must contain &`inet:`& followed by
10514 a host name or IP address, followed by a colon and a port, which can be a
10515 number or the name of a TCP port in &_/etc/services_&. An IP address may
10516 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10517 example:
10518 .code
10519 ${readsocket{inet:[::1]:1234}{request string}}
10520 .endd
10521 Only a single host name may be given, but if looking it up yields more than
10522 one IP address, they are each tried in turn until a connection is made. For
10523 both kinds of socket, Exim makes a connection, writes the request string
10524 (unless it is an empty string; no terminating NUL is ever sent)
10525 and reads from the socket until an end-of-file
10526 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10527 extend what can be done. Firstly, you can vary the timeout. For example:
10528 .code
10529 ${readsocket{/socket/name}{request string}{3s}}
10530 .endd
10531
10532 The third argument is a list of options, of which the first element is the timeout
10533 and must be present if any options are given.
10534 Further elements are options of form &'name=value'&.
10535 Example:
10536 .code
10537 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10538 .endd
10539
10540 The following option names are recognised:
10541 .ilist
10542 &*cache*&
10543 Defines if the result data can be cached for use by a later identical
10544 request in the same process.
10545 Values are &"yes"& or &"no"& (the default).
10546 If not, all cached results for this connection specification
10547 will be invalidated.
10548
10549 .next
10550 &*shutdown*&
10551 Defines whether or not a write-shutdown is done on the connection after
10552 sending the request. Values are &"yes"& (the default) or &"no"&
10553 (preferred, eg. by some webservers).
10554
10555 .next
10556 &*tls*&
10557 Controls the use of TLS on the connection.
10558 Values are &"yes"& or &"no"& (the default).
10559 If it is enabled, a shutdown as descripbed above is never done.
10560 .endlist
10561
10562
10563 A fourth argument allows you to change any newlines that are in the data
10564 that is read, in the same way as for &%readfile%& (see above). This example
10565 turns them into spaces:
10566 .code
10567 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10568 .endd
10569 As with all expansions, the substrings are expanded before the processing
10570 happens. Errors in these sub-expansions cause the expansion to fail. In
10571 addition, the following errors can occur:
10572
10573 .ilist
10574 Failure to create a socket file descriptor;
10575 .next
10576 Failure to connect the socket;
10577 .next
10578 Failure to write the request string;
10579 .next
10580 Timeout on reading from the socket.
10581 .endlist
10582
10583 By default, any of these errors causes the expansion to fail. However, if
10584 you supply a fifth substring, it is expanded and used when any of the above
10585 errors occurs. For example:
10586 .code
10587 ${readsocket{/socket/name}{request string}{3s}{\n}\
10588   {socket failure}}
10589 .endd
10590 You can test for the existence of a Unix domain socket by wrapping this
10591 expansion in &`${if exists`&, but there is a race condition between that test
10592 and the actual opening of the socket, so it is safer to use the fifth argument
10593 if you want to be absolutely sure of avoiding an expansion error for a
10594 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10595
10596 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10597 locks out the use of this expansion item in filter files.
10598
10599
10600 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10601 .cindex "expansion" "reducing a list to a scalar"
10602 .cindex "list" "reducing to a scalar"
10603 .vindex "&$value$&"
10604 .vindex "&$item$&"
10605 This operation reduces a list to a single, scalar string. After expansion,
10606 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10607 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10608 Then <&'string2'&> is expanded and
10609 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10610 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10611 them. The result of that expansion is assigned to &$value$& before the next
10612 iteration. When the end of the list is reached, the final value of &$value$& is
10613 added to the expansion output. The &%reduce%& expansion item can be used in a
10614 number of ways. For example, to add up a list of numbers:
10615 .code
10616 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10617 .endd
10618 The result of that expansion would be &`6`&. The maximum of a list of numbers
10619 can be found:
10620 .code
10621 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10622 .endd
10623 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10624 restored to what they were before. See also the &%filter%& and &%map%&
10625 expansion items.
10626
10627 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10628 This item inserts &"raw"& header lines. It is described with the &%header%&
10629 expansion item in section &<<SECTexpansionitems>>& above.
10630
10631 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10632         {*&<&'string2'&>&*}}*&"
10633 .cindex "expansion" "running a command"
10634 .cindex "&%run%& expansion item"
10635 The command and its arguments are first expanded as one string. The string is
10636 split apart into individual arguments by spaces, and then the command is run
10637 in a separate process, but under the same uid and gid.  As in other command
10638 executions from Exim, a shell is not used by default. If the command requires
10639 a shell, you must explicitly code it.
10640
10641 Since the arguments are split by spaces, when there is a variable expansion
10642 which has an empty result, it will cause the situation that the argument will
10643 simply be omitted when the program is actually executed by Exim. If the
10644 script/program requires a specific number of arguments and the expanded
10645 variable could possibly result in this empty expansion, the variable must be
10646 quoted. This is more difficult if the expanded variable itself could result
10647 in a string containing quotes, because it would interfere with the quotes
10648 around the command arguments. A possible guard against this is to wrap the
10649 variable in the &%sg%& operator to change any quote marks to some other
10650 character.
10651
10652 The standard input for the command exists, but is empty. The standard output
10653 and standard error are set to the same file descriptor.
10654 .cindex "return code" "from &%run%& expansion"
10655 .vindex "&$value$&"
10656 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10657 and replaces the entire item; during this expansion, the standard output/error
10658 from the command is in the variable &$value$&. If the command fails,
10659 <&'string2'&>, if present, is expanded and used. Once again, during the
10660 expansion, the standard output/error from the command is in the variable
10661 &$value$&.
10662
10663 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10664 can be the word &"fail"& (not in braces) to force expansion failure if the
10665 command does not succeed. If both strings are omitted, the result is contents
10666 of the standard output/error on success, and nothing on failure.
10667
10668 .vindex "&$run_in_acl$&"
10669 The standard output/error of the command is put in the variable &$value$&.
10670 In this ACL example, the output of a command is logged for the admin to
10671 troubleshoot:
10672 .code
10673 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10674       log_message  = Output of id: $value
10675 .endd
10676 If the command requires shell idioms, such as the > redirect operator, the
10677 shell must be invoked directly, such as with:
10678 .code
10679 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10680 .endd
10681
10682 .vindex "&$runrc$&"
10683 The return code from the command is put in the variable &$runrc$&, and this
10684 remains set afterwards, so in a filter file you can do things like this:
10685 .code
10686 if "${run{x y z}{}}$runrc" is 1 then ...
10687   elif $runrc is 2 then ...
10688   ...
10689 endif
10690 .endd
10691 If execution of the command fails (for example, the command does not exist),
10692 the return code is 127 &-- the same code that shells use for non-existent
10693 commands.
10694
10695 &*Warning*&: In a router or transport, you cannot assume the order in which
10696 option values are expanded, except for those preconditions whose order of
10697 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10698 by the expansion of one option, and use it in another.
10699
10700 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10701 out the use of this expansion item in filter files.
10702
10703
10704 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10705 .cindex "expansion" "string substitution"
10706 .cindex "&%sg%& expansion item"
10707 This item works like Perl's substitution operator (s) with the global (/g)
10708 option; hence its name. However, unlike the Perl equivalent, Exim does not
10709 modify the subject string; instead it returns the modified string for insertion
10710 into the overall expansion. The item takes three arguments: the subject string,
10711 a regular expression, and a substitution string. For example:
10712 .code
10713 ${sg{abcdefabcdef}{abc}{xyz}}
10714 .endd
10715 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10716 if any $, } or \ characters are required in the regular expression or in the
10717 substitution string, they have to be escaped. For example:
10718 .code
10719 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10720 .endd
10721 yields &"defabc"&, and
10722 .code
10723 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10724 .endd
10725 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10726 the regular expression from string expansion.
10727
10728 The regular expression is compiled in 8-bit mode, working against bytes
10729 rather than any Unicode-aware character handling.
10730
10731
10732 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10733 .cindex sorting "a list"
10734 .cindex list sorting
10735 .cindex expansion "list sorting"
10736 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10737 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10738 The <&'comparator'&> argument is interpreted as the operator
10739 of a two-argument expansion condition.
10740 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10741 The comparison should return true when applied to two values
10742 if the first value should sort before the second value.
10743 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10744 the element being placed in &$item$&,
10745 to give values for comparison.
10746
10747 The item result is a sorted list,
10748 with the original list separator,
10749 of the list elements (in full) of the original.
10750
10751 Examples:
10752 .code
10753 ${sort{3:2:1:4}{<}{$item}}
10754 .endd
10755 sorts a list of numbers, and
10756 .code
10757 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10758 .endd
10759 will sort an MX lookup into priority order.
10760
10761
10762
10763 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10764 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10765
10766
10767
10768 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10769 .cindex "&%substr%& expansion item"
10770 .cindex "substring extraction"
10771 .cindex "expansion" "substring extraction"
10772 The three strings are expanded; the first two must yield numbers. Call them
10773 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10774 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10775 can use the simpler operator notation that avoids some of the braces:
10776 .code
10777 ${substr_<n>_<m>:<string>}
10778 .endd
10779 The second number is optional (in both notations).
10780 If it is absent in the simpler format, the preceding underscore must also be
10781 omitted.
10782
10783 The &%substr%& item can be used to extract more general substrings than
10784 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10785 length required. For example
10786 .code
10787 ${substr{3}{2}{$local_part}}
10788 .endd
10789 If the starting offset is greater than the string length the result is the
10790 null string; if the length plus starting offset is greater than the string
10791 length, the result is the right-hand part of the string, starting from the
10792 given offset. The first byte (character) in the string has offset zero.
10793
10794 The &%substr%& expansion item can take negative offset values to count
10795 from the right-hand end of its operand. The last byte (character) is offset -1,
10796 the second-last is offset -2, and so on. Thus, for example,
10797 .code
10798 ${substr{-5}{2}{1234567}}
10799 .endd
10800 yields &"34"&. If the absolute value of a negative offset is greater than the
10801 length of the string, the substring starts at the beginning of the string, and
10802 the length is reduced by the amount of overshoot. Thus, for example,
10803 .code
10804 ${substr{-5}{2}{12}}
10805 .endd
10806 yields an empty string, but
10807 .code
10808 ${substr{-3}{2}{12}}
10809 .endd
10810 yields &"1"&.
10811
10812 When the second number is omitted from &%substr%&, the remainder of the string
10813 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10814 string preceding the offset point are taken. For example, an offset of -1 and
10815 no length, as in these semantically identical examples:
10816 .code
10817 ${substr_-1:abcde}
10818 ${substr{-1}{abcde}}
10819 .endd
10820 yields all but the last character of the string, that is, &"abcd"&.
10821
10822 All measurement is done in bytes and is not UTF-8 aware.
10823
10824
10825
10826 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10827         {*&<&'replacements'&>&*}}*&"
10828 .cindex "expansion" "character translation"
10829 .cindex "&%tr%& expansion item"
10830 This item does single-character (in bytes) translation on its subject string. The second
10831 argument is a list of characters to be translated in the subject string. Each
10832 matching character is replaced by the corresponding character from the
10833 replacement list. For example
10834 .code
10835 ${tr{abcdea}{ac}{13}}
10836 .endd
10837 yields &`1b3de1`&. If there are duplicates in the second character string, the
10838 last occurrence is used. If the third string is shorter than the second, its
10839 last character is replicated. However, if it is empty, no translation takes
10840 place.
10841
10842 All character handling is done in bytes and is not UTF-8 aware.
10843
10844 .endlist
10845
10846
10847
10848 .section "Expansion operators" "SECTexpop"
10849 .cindex "expansion" "operators"
10850 For expansion items that perform transformations on a single argument string,
10851 the &"operator"& notation is used because it is simpler and uses fewer braces.
10852 The substring is first expanded before the operation is applied to it. The
10853 following operations can be performed:
10854
10855 .vlist
10856 .vitem &*${address:*&<&'string'&>&*}*&
10857 .cindex "expansion" "RFC 2822 address handling"
10858 .cindex "&%address%& expansion item"
10859 The string is interpreted as an RFC 2822 address, as it might appear in a
10860 header line, and the effective address is extracted from it. If the string does
10861 not parse successfully, the result is empty.
10862
10863 The parsing correctly handles SMTPUTF8 Unicode in the string.
10864
10865
10866 .vitem &*${addresses:*&<&'string'&>&*}*&
10867 .cindex "expansion" "RFC 2822 address handling"
10868 .cindex "&%addresses%& expansion item"
10869 The string (after expansion) is interpreted as a list of addresses in RFC
10870 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10871 operative address (&'local-part@domain'&) is extracted from each item, and the
10872 result of the expansion is a colon-separated list, with appropriate
10873 doubling of colons should any happen to be present in the email addresses.
10874 Syntactically invalid RFC2822 address items are omitted from the output.
10875
10876 It is possible to specify a character other than colon for the output
10877 separator by starting the string with > followed by the new separator
10878 character. For example:
10879 .code
10880 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10881 .endd
10882 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10883 first, so if the expanded string starts with >, it may change the output
10884 separator unintentionally. This can be avoided by setting the output
10885 separator explicitly:
10886 .code
10887 ${addresses:>:$h_from:}
10888 .endd
10889
10890 Compare the &%address%& (singular)
10891 expansion item, which extracts the working address from a single RFC2822
10892 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10893 processing lists.
10894
10895 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10896 a strict interpretation of header line formatting.  Exim parses the bare,
10897 unquoted portion of an email address and if it finds a comma, treats it as an
10898 email address separator. For the example header line:
10899 .code
10900 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10901 .endd
10902 The first example below demonstrates that Q-encoded email addresses are parsed
10903 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10904 It does not see the comma because it's still encoded as "=2C".  The second
10905 example below is passed the contents of &`$header_from:`&, meaning it gets
10906 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10907 The third example shows that the presence of a comma is skipped when it is
10908 quoted.  The fourth example shows SMTPUTF8 handling.
10909 .code
10910 # exim -be '${addresses:From: \
10911 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10912 user@example.com
10913 # exim -be '${addresses:From: Last, First <user@example.com>}'
10914 Last:user@example.com
10915 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10916 user@example.com
10917 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10918 フィリップ@example.jp
10919 .endd
10920
10921 .vitem &*${base32:*&<&'digits'&>&*}*&
10922 .cindex "&%base32%& expansion item"
10923 .cindex "expansion" "conversion to base 32"
10924 The string must consist entirely of decimal digits. The number is converted to
10925 base 32 and output as a (empty, for zero) string of characters.
10926 Only lowercase letters are used.
10927
10928 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10929 .cindex "&%base32d%& expansion item"
10930 .cindex "expansion" "conversion to base 32"
10931 The string must consist entirely of base-32 digits.
10932 The number is converted to decimal and output as a string.
10933
10934 .vitem &*${base62:*&<&'digits'&>&*}*&
10935 .cindex "&%base62%& expansion item"
10936 .cindex "expansion" "conversion to base 62"
10937 The string must consist entirely of decimal digits. The number is converted to
10938 base 62 and output as a string of six characters, including leading zeros. In
10939 the few operating environments where Exim uses base 36 instead of base 62 for
10940 its message identifiers (because those systems do not have case-sensitive
10941 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10942 to be absolutely clear: this is &'not'& base64 encoding.
10943
10944 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10945 .cindex "&%base62d%& expansion item"
10946 .cindex "expansion" "conversion to base 62"
10947 The string must consist entirely of base-62 digits, or, in operating
10948 environments where Exim uses base 36 instead of base 62 for its message
10949 identifiers, base-36 digits. The number is converted to decimal and output as a
10950 string.
10951
10952 .vitem &*${base64:*&<&'string'&>&*}*&
10953 .cindex "expansion" "base64 encoding"
10954 .cindex "base64 encoding" "in string expansion"
10955 .cindex "&%base64%& expansion item"
10956 .cindex certificate "base64 of DER"
10957 This operator converts a string into one that is base64 encoded.
10958
10959 If the string is a single variable of type certificate,
10960 returns the base64 encoding of the DER form of the certificate.
10961
10962
10963 .vitem &*${base64d:*&<&'string'&>&*}*&
10964 .cindex "expansion" "base64 decoding"
10965 .cindex "base64 decoding" "in string expansion"
10966 .cindex "&%base64d%& expansion item"
10967 This operator converts a base64-encoded string into the un-coded form.
10968
10969
10970 .vitem &*${domain:*&<&'string'&>&*}*&
10971 .cindex "domain" "extraction"
10972 .cindex "expansion" "domain extraction"
10973 The string is interpreted as an RFC 2822 address and the domain is extracted
10974 from it. If the string does not parse successfully, the result is empty.
10975
10976
10977 .vitem &*${escape:*&<&'string'&>&*}*&
10978 .cindex "expansion" "escaping non-printing characters"
10979 .cindex "&%escape%& expansion item"
10980 If the string contains any non-printing characters, they are converted to
10981 escape sequences starting with a backslash. Whether characters with the most
10982 significant bit set (so-called &"8-bit characters"&) count as printing or not
10983 is controlled by the &%print_topbitchars%& option.
10984
10985 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10986 .cindex "expansion" "escaping 8-bit characters"
10987 .cindex "&%escape8bit%& expansion item"
10988 If the string contains any characters with the most significant bit set,
10989 they are converted to escape sequences starting with a backslash.
10990 Backslashes and DEL characters are also converted.
10991
10992
10993 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10994 .cindex "expansion" "expression evaluation"
10995 .cindex "expansion" "arithmetic expression"
10996 .cindex "&%eval%& expansion item"
10997 These items supports simple arithmetic and bitwise logical operations in
10998 expansion strings. The string (after expansion) must be a conventional
10999 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
11000 logical operators, and parentheses. All operations are carried out using
11001 integer arithmetic. The operator priorities are as follows (the same as in the
11002 C programming language):
11003 .table2 70pt 300pt
11004 .irow &'highest:'& "not (~), negate (-)"
11005 .irow ""   "multiply (*), divide (/), remainder (%)"
11006 .irow ""   "plus (+), minus (-)"
11007 .irow ""   "shift-left (<<), shift-right (>>)"
11008 .irow ""   "and (&&)"
11009 .irow ""   "xor (^)"
11010 .irow &'lowest:'&  "or (|)"
11011 .endtable
11012 Binary operators with the same priority are evaluated from left to right. White
11013 space is permitted before or after operators.
11014
11015 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
11016 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
11017 decimal, even if they start with a leading zero; hexadecimal numbers are not
11018 permitted. This can be useful when processing numbers extracted from dates or
11019 times, which often do have leading zeros.
11020
11021 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
11022 or 1024*1024*1024,
11023 respectively. Negative numbers are supported. The result of the computation is
11024 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
11025
11026 .display
11027 &`${eval:1+1}            `&  yields 2
11028 &`${eval:1+2*3}          `&  yields 7
11029 &`${eval:(1+2)*3}        `&  yields 9
11030 &`${eval:2+42%5}         `&  yields 4
11031 &`${eval:0xc&amp;5}          `&  yields 4
11032 &`${eval:0xc|5}          `&  yields 13
11033 &`${eval:0xc^5}          `&  yields 9
11034 &`${eval:0xc>>1}         `&  yields 6
11035 &`${eval:0xc<<1}         `&  yields 24
11036 &`${eval:~255&amp;0x1234}    `&  yields 4608
11037 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
11038 .endd
11039
11040 As a more realistic example, in an ACL you might have
11041 .code
11042 deny   condition =                    \
11043          ${if and {                   \
11044            {>{$rcpt_count}{10}}       \
11045            {                          \
11046            <                          \
11047              {$recipients_count}      \
11048              {${eval:$rcpt_count/2}}  \
11049            }                          \
11050          }{yes}{no}}
11051        message = Too many bad recipients
11052 .endd
11053 The condition is true if there have been more than 10 RCPT commands and
11054 fewer than half of them have resulted in a valid recipient.
11055
11056
11057 .vitem &*${expand:*&<&'string'&>&*}*&
11058 .cindex "expansion" "re-expansion of substring"
11059 The &%expand%& operator causes a string to be expanded for a second time. For
11060 example,
11061 .code
11062 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
11063 .endd
11064 first looks up a string in a file while expanding the operand for &%expand%&,
11065 and then re-expands what it has found.
11066
11067
11068 .vitem &*${from_utf8:*&<&'string'&>&*}*&
11069 .cindex "Unicode"
11070 .cindex "UTF-8" "conversion from"
11071 .cindex "expansion" "UTF-8 conversion"
11072 .cindex "&%from_utf8%& expansion item"
11073 The world is slowly moving towards Unicode, although there are no standards for
11074 email yet. However, other applications (including some databases) are starting
11075 to store data in Unicode, using UTF-8 encoding. This operator converts from a
11076 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
11077 converted to underscores. The input must be a valid UTF-8 string. If it is not,
11078 the result is an undefined sequence of bytes.
11079
11080 Unicode code points with values less than 256 are compatible with ASCII and
11081 ISO-8859-1 (also known as Latin-1).
11082 For example, character 169 is the copyright symbol in both cases, though the
11083 way it is encoded is different. In UTF-8, more than one byte is needed for
11084 characters with code values greater than 127, whereas ISO-8859-1 is a
11085 single-byte encoding (but thereby limited to 256 characters). This makes
11086 translation from UTF-8 to ISO-8859-1 straightforward.
11087
11088
11089 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11090 .cindex "hash function" "textual"
11091 .cindex "expansion" "textual hash"
11092 The &%hash%& operator is a simpler interface to the hashing function that can
11093 be used when the two parameters are fixed numbers (as opposed to strings that
11094 change when expanded). The effect is the same as
11095 .code
11096 ${hash{<n>}{<m>}{<string>}}
11097 .endd
11098 See the description of the general &%hash%& item above for details. The
11099 abbreviation &%h%& can be used when &%hash%& is used as an operator.
11100
11101
11102
11103 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
11104 .cindex "base64 encoding" "conversion from hex"
11105 .cindex "expansion" "hex to base64"
11106 .cindex "&%hex2b64%& expansion item"
11107 This operator converts a hex string into one that is base64 encoded. This can
11108 be useful for processing the output of the various hashing functions.
11109
11110
11111
11112 .vitem &*${hexquote:*&<&'string'&>&*}*&
11113 .cindex "quoting" "hex-encoded unprintable characters"
11114 .cindex "&%hexquote%& expansion item"
11115 This operator converts non-printable characters in a string into a hex
11116 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
11117 as is, and other byte values are converted to &`\xNN`&, for example, a
11118 byte value 127 is converted to &`\x7f`&.
11119
11120
11121 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
11122 .cindex "&%ipv6denorm%& expansion item"
11123 .cindex "IP address" normalisation
11124 This expands an IPv6 address to a full eight-element colon-separated set
11125 of hex digits including leading zeroes.
11126 A trailing ipv4-style dotted-decimal set is converted to hex.
11127 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11128
11129 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
11130 .cindex "&%ipv6norm%& expansion item"
11131 .cindex "IP address" normalisation
11132 .cindex "IP address" "canonical form"
11133 This converts an IPv6 address to canonical form.
11134 Leading zeroes of groups are omitted, and the longest
11135 set of zero-valued groups is replaced with a double colon.
11136 A trailing ipv4-style dotted-decimal set is converted to hex.
11137 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11138
11139
11140 .vitem &*${lc:*&<&'string'&>&*}*&
11141 .cindex "case forcing in strings"
11142 .cindex "string" "case forcing"
11143 .cindex "lower casing"
11144 .cindex "expansion" "case forcing"
11145 .cindex "&%lc%& expansion item"
11146 This forces the letters in the string into lower-case, for example:
11147 .code
11148 ${lc:$local_part}
11149 .endd
11150 Case is defined per the system C locale.
11151
11152 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11153 .cindex "expansion" "string truncation"
11154 .cindex "&%length%& expansion item"
11155 The &%length%& operator is a simpler interface to the &%length%& function that
11156 can be used when the parameter is a fixed number (as opposed to a string that
11157 changes when expanded). The effect is the same as
11158 .code
11159 ${length{<number>}{<string>}}
11160 .endd
11161 See the description of the general &%length%& item above for details. Note that
11162 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11163 when &%length%& is used as an operator.
11164 All measurement is done in bytes and is not UTF-8 aware.
11165
11166
11167 .vitem &*${listcount:*&<&'string'&>&*}*&
11168 .cindex "expansion" "list item count"
11169 .cindex "list" "item count"
11170 .cindex "list" "count of items"
11171 .cindex "&%listcount%& expansion item"
11172 The string is interpreted as a list and the number of items is returned.
11173
11174
11175 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11176 .cindex "expansion" "named list"
11177 .cindex "&%listnamed%& expansion item"
11178 The name is interpreted as a named list and the content of the list is returned,
11179 expanding any referenced lists, re-quoting as needed for colon-separation.
11180 If the optional type is given it must be one of "a", "d", "h" or "l"
11181 and selects address-, domain-, host- or localpart- lists to search among respectively.
11182 Otherwise all types are searched in an undefined order and the first
11183 matching list is returned.
11184 &*Note*&: Neither string-expansion of lists referenced by named-list syntax elements,
11185 nor expansion of lookup elements, is done by the &%listnamed%& operator.
11186
11187
11188 .vitem &*${local_part:*&<&'string'&>&*}*&
11189 .cindex "expansion" "local part extraction"
11190 .cindex "&%local_part%& expansion item"
11191 The string is interpreted as an RFC 2822 address and the local part is
11192 extracted from it. If the string does not parse successfully, the result is
11193 empty.
11194 The parsing correctly handles SMTPUTF8 Unicode in the string.
11195
11196
11197 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11198 .cindex "masked IP address"
11199 .cindex "IP address" "masking"
11200 .cindex "CIDR notation"
11201 .cindex "expansion" "IP address masking"
11202 .cindex "&%mask%& expansion item"
11203 If the form of the string to be operated on is not an IP address followed by a
11204 slash and an integer (that is, a network address in CIDR notation), the
11205 expansion fails. Otherwise, this operator converts the IP address to binary,
11206 masks off the least significant bits according to the bit count, and converts
11207 the result back to text, with mask appended. For example,
11208 .code
11209 ${mask:10.111.131.206/28}
11210 .endd
11211 returns the string &"10.111.131.192/28"&. Since this operation is expected to
11212 be mostly used for looking up masked addresses in files, the result for an IPv6
11213 address uses dots to separate components instead of colons, because colon
11214 terminates a key string in lsearch files. So, for example,
11215 .code
11216 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11217 .endd
11218 returns the string
11219 .code
11220 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11221 .endd
11222 Letters in IPv6 addresses are always output in lower case.
11223
11224
11225 .vitem &*${md5:*&<&'string'&>&*}*&
11226 .cindex "MD5 hash"
11227 .cindex "expansion" "MD5 hash"
11228 .cindex certificate fingerprint
11229 .cindex "&%md5%& expansion item"
11230 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11231 as a 32-digit hexadecimal number, in which any letters are in lower case.
11232
11233 If the string is a single variable of type certificate,
11234 returns the MD5 hash fingerprint of the certificate.
11235
11236
11237 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11238 .cindex "expansion" "numeric hash"
11239 .cindex "hash function" "numeric"
11240 The &%nhash%& operator is a simpler interface to the numeric hashing function
11241 that can be used when the two parameters are fixed numbers (as opposed to
11242 strings that change when expanded). The effect is the same as
11243 .code
11244 ${nhash{<n>}{<m>}{<string>}}
11245 .endd
11246 See the description of the general &%nhash%& item above for details.
11247
11248
11249 .vitem &*${quote:*&<&'string'&>&*}*&
11250 .cindex "quoting" "in string expansions"
11251 .cindex "expansion" "quoting"
11252 .cindex "&%quote%& expansion item"
11253 The &%quote%& operator puts its argument into double quotes if it
11254 is an empty string or
11255 contains anything other than letters, digits, underscores, dots, and hyphens.
11256 Any occurrences of double quotes and backslashes are escaped with a backslash.
11257 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11258 respectively For example,
11259 .code
11260 ${quote:ab"*"cd}
11261 .endd
11262 becomes
11263 .code
11264 "ab\"*\"cd"
11265 .endd
11266 The place where this is useful is when the argument is a substitution from a
11267 variable or a message header.
11268
11269 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11270 .cindex "&%quote_local_part%& expansion item"
11271 This operator is like &%quote%&, except that it quotes the string only if
11272 required to do so by the rules of RFC 2822 for quoting local parts. For
11273 example, a plus sign would not cause quoting (but it would for &%quote%&).
11274 If you are creating a new email address from the contents of &$local_part$&
11275 (or any other unknown data), you should always use this operator.
11276
11277 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11278 will likely use the quoting form.
11279 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11280
11281
11282 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11283 .cindex "quoting" "lookup-specific"
11284 This operator applies lookup-specific quoting rules to the string. Each
11285 query-style lookup type has its own quoting rules which are described with
11286 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11287 .code
11288 ${quote_ldap:two * two}
11289 .endd
11290 returns
11291 .code
11292 two%20%5C2A%20two
11293 .endd
11294 For single-key lookup types, no quoting is ever necessary and this operator
11295 yields an unchanged string.
11296
11297
11298 .vitem &*${randint:*&<&'n'&>&*}*&
11299 .cindex "random number"
11300 This operator returns a somewhat random number which is less than the
11301 supplied number and is at least 0.  The quality of this randomness depends
11302 on how Exim was built; the values are not suitable for keying material.
11303 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11304 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11305 for versions of GnuTLS with that function.
11306 Otherwise, the implementation may be arc4random(), random() seeded by
11307 srandomdev() or srandom(), or a custom implementation even weaker than
11308 random().
11309
11310
11311 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11312 .cindex "expansion" "IP address"
11313 This operator reverses an IP address; for IPv4 addresses, the result is in
11314 dotted-quad decimal form, while for IPv6 addresses the result is in
11315 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11316 for DNS.  For example,
11317 .code
11318 ${reverse_ip:192.0.2.4}
11319 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11320 .endd
11321 returns
11322 .code
11323 4.2.0.192
11324 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
11325 .endd
11326
11327
11328 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11329 .cindex "expansion" "RFC 2047"
11330 .cindex "RFC 2047" "expansion operator"
11331 .cindex "&%rfc2047%& expansion item"
11332 This operator encodes text according to the rules of RFC 2047. This is an
11333 encoding that is used in header lines to encode non-ASCII characters. It is
11334 assumed that the input string is in the encoding specified by the
11335 &%headers_charset%& option, which gets its default at build time. If the string
11336 contains only characters in the range 33&--126, and no instances of the
11337 characters
11338 .code
11339 ? = ( ) < > @ , ; : \ " . [ ] _
11340 .endd
11341 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11342 string, using as many &"encoded words"& as necessary to encode all the
11343 characters.
11344
11345
11346 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11347 .cindex "expansion" "RFC 2047"
11348 .cindex "RFC 2047" "decoding"
11349 .cindex "&%rfc2047d%& expansion item"
11350 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11351 bytes are replaced by question marks. Characters are converted into the
11352 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11353 not recognized unless &%check_rfc2047_length%& is set false.
11354
11355 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11356 access a header line, RFC 2047 decoding is done automatically. You do not need
11357 to use this operator as well.
11358
11359
11360
11361 .vitem &*${rxquote:*&<&'string'&>&*}*&
11362 .cindex "quoting" "in regular expressions"
11363 .cindex "regular expressions" "quoting"
11364 .cindex "&%rxquote%& expansion item"
11365 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11366 characters in its argument. This is useful when substituting the values of
11367 variables or headers inside regular expressions.
11368
11369
11370 .vitem &*${sha1:*&<&'string'&>&*}*&
11371 .cindex "SHA-1 hash"
11372 .cindex "expansion" "SHA-1 hashing"
11373 .cindex certificate fingerprint
11374 .cindex "&%sha1%& expansion item"
11375 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11376 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11377
11378 If the string is a single variable of type certificate,
11379 returns the SHA-1 hash fingerprint of the certificate.
11380
11381
11382 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11383        &*${sha2:*&<&'string'&>&*}*& &&&
11384        &*${sha2_<n>:*&<&'string'&>&*}*&
11385 .cindex "SHA-256 hash"
11386 .cindex "SHA-2 hash"
11387 .cindex certificate fingerprint
11388 .cindex "expansion" "SHA-256 hashing"
11389 .cindex "&%sha256%& expansion item"
11390 .cindex "&%sha2%& expansion item"
11391 The &%sha256%& operator computes the SHA-256 hash value of the string
11392 and returns
11393 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11394
11395 If the string is a single variable of type certificate,
11396 returns the SHA-256 hash fingerprint of the certificate.
11397
11398 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11399 (except for certificates, which are not supported).
11400 Finally, if an underbar
11401 and a number is appended it specifies the output length, selecting a
11402 member of the SHA-2 family of hash functions.
11403 Values of 256, 384 and 512 are accepted, with 256 being the default.
11404
11405
11406 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11407        &*${sha3_<n>:*&<&'string'&>&*}*&
11408 .cindex "SHA3 hash"
11409 .cindex "expansion" "SHA3 hashing"
11410 .cindex "&%sha3%& expansion item"
11411 The &%sha3%& operator computes the SHA3-256 hash value of the string
11412 and returns
11413 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11414
11415 If a number is appended, separated by an underbar, it specifies
11416 the output length.  Values of 224, 256, 384 and 512 are accepted;
11417 with 256 being the default.
11418
11419 The &%sha3%& expansion item is only supported if Exim has been
11420 compiled with GnuTLS 3.5.0 or later,
11421 or OpenSSL 1.1.1 or later.
11422 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11423
11424
11425 .vitem &*${stat:*&<&'string'&>&*}*&
11426 .cindex "expansion" "statting a file"
11427 .cindex "file" "extracting characteristics"
11428 .cindex "&%stat%& expansion item"
11429 The string, after expansion, must be a file path. A call to the &[stat()]&
11430 function is made for this path. If &[stat()]& fails, an error occurs and the
11431 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11432 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11433 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11434 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11435 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11436 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11437 can extract individual fields using the &%extract%& expansion item.
11438
11439 The use of the &%stat%& expansion in users' filter files can be locked out by
11440 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11441 systems for files larger than 2GB.
11442
11443 .vitem &*${str2b64:*&<&'string'&>&*}*&
11444 .cindex "&%str2b64%& expansion item"
11445 Now deprecated, a synonym for the &%base64%& expansion operator.
11446
11447
11448
11449 .vitem &*${strlen:*&<&'string'&>&*}*&
11450 .cindex "expansion" "string length"
11451 .cindex "string" "length in expansion"
11452 .cindex "&%strlen%& expansion item"
11453 The item is replaced by the length of the expanded string, expressed as a
11454 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11455 All measurement is done in bytes and is not UTF-8 aware.
11456
11457
11458 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11459 .cindex "&%substr%& expansion item"
11460 .cindex "substring extraction"
11461 .cindex "expansion" "substring expansion"
11462 The &%substr%& operator is a simpler interface to the &%substr%& function that
11463 can be used when the two parameters are fixed numbers (as opposed to strings
11464 that change when expanded). The effect is the same as
11465 .code
11466 ${substr{<start>}{<length>}{<string>}}
11467 .endd
11468 See the description of the general &%substr%& item above for details. The
11469 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11470 All measurement is done in bytes and is not UTF-8 aware.
11471
11472 .vitem &*${time_eval:*&<&'string'&>&*}*&
11473 .cindex "&%time_eval%& expansion item"
11474 .cindex "time interval" "decoding"
11475 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11476 seconds.
11477
11478 .vitem &*${time_interval:*&<&'string'&>&*}*&
11479 .cindex "&%time_interval%& expansion item"
11480 .cindex "time interval" "formatting"
11481 The argument (after sub-expansion) must be a sequence of decimal digits that
11482 represents an interval of time as a number of seconds. It is converted into a
11483 number of larger units and output in Exim's normal time format, for example,
11484 &`1w3d4h2m6s`&.
11485
11486 .vitem &*${uc:*&<&'string'&>&*}*&
11487 .cindex "case forcing in strings"
11488 .cindex "string" "case forcing"
11489 .cindex "upper casing"
11490 .cindex "expansion" "case forcing"
11491 .cindex "&%uc%& expansion item"
11492 This forces the letters in the string into upper-case.
11493 Case is defined per the system C locale.
11494
11495 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11496 .cindex "correction of invalid utf-8 sequences in strings"
11497 .cindex "utf-8" "utf-8 sequences"
11498 .cindex "incorrect utf-8"
11499 .cindex "expansion" "utf-8 forcing"
11500 .cindex "&%utf8clean%& expansion item"
11501 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11502 In versions of Exim before 4.92, this did not correctly do so for a truncated
11503 final codepoint's encoding, and the character would be silently dropped.
11504 If you must handle detection of this scenario across both sets of Exim behavior,
11505 the complexity will depend upon the task.
11506 For instance, to detect if the first character is multibyte and a 1-byte
11507 extraction can be successfully used as a path component (as is common for
11508 dividing up delivery folders), you might use:
11509 .code
11510 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11511 .endd
11512 (which will false-positive if the first character of the local part is a
11513 literal question mark).
11514
11515 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11516        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11517        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11518        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11519 .cindex expansion UTF-8
11520 .cindex UTF-8 expansion
11521 .cindex EAI
11522 .cindex internationalisation
11523 .cindex "&%utf8_domain_to_alabel%& expansion item"
11524 .cindex "&%utf8_domain_from_alabel%& expansion item"
11525 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11526 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11527 These convert EAI mail name components between UTF-8 and a-label forms.
11528 For information on internationalisation support see &<<SECTi18nMTA>>&.
11529 .endlist
11530
11531
11532
11533
11534
11535
11536 .section "Expansion conditions" "SECTexpcond"
11537 .scindex IIDexpcond "expansion" "conditions"
11538 The following conditions are available for testing by the &%${if%& construct
11539 while expanding strings:
11540
11541 .vlist
11542 .vitem &*!*&<&'condition'&>
11543 .cindex "expansion" "negating a condition"
11544 .cindex "negation" "in expansion condition"
11545 Preceding any condition with an exclamation mark negates the result of the
11546 condition.
11547
11548 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11549 .cindex "numeric comparison"
11550 .cindex "expansion" "numeric comparison"
11551 There are a number of symbolic operators for doing numeric comparisons. They
11552 are:
11553 .display
11554 &`=   `&   equal
11555 &`==  `&   equal
11556 &`>   `&   greater
11557 &`>=  `&   greater or equal
11558 &`<   `&   less
11559 &`<=  `&   less or equal
11560 .endd
11561 For example:
11562 .code
11563 ${if >{$message_size}{10M} ...
11564 .endd
11565 Note that the general negation operator provides for inequality testing. The
11566 two strings must take the form of optionally signed decimal integers,
11567 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11568 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11569 As a special case, the numerical value of an empty string is taken as
11570 zero.
11571
11572 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11573 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11574 10M, not if 10M is larger than &$message_size$&.
11575
11576
11577 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11578         {*&<&'arg2'&>&*}...}*&
11579 .cindex "expansion" "calling an acl"
11580 .cindex "&%acl%&" "expansion condition"
11581 The name and zero to nine argument strings are first expanded separately.  The expanded
11582 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11583 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11584 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11585 and may use the variables; if another acl expansion is used the values
11586 are restored after it returns.  If the ACL sets
11587 a value using a "message =" modifier the variable $value becomes
11588 the result of the expansion, otherwise it is empty.
11589 If the ACL returns accept the condition is true; if deny, false.
11590 If the ACL returns defer the result is a forced-fail.
11591
11592 .vitem &*bool&~{*&<&'string'&>&*}*&
11593 .cindex "expansion" "boolean parsing"
11594 .cindex "&%bool%& expansion condition"
11595 This condition turns a string holding a true or false representation into
11596 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11597 (case-insensitively); also integer numbers map to true if non-zero,
11598 false if zero.
11599 An empty string is treated as false.
11600 Leading and trailing whitespace is ignored;
11601 thus a string consisting only of whitespace is false.
11602 All other string values will result in expansion failure.
11603
11604 When combined with ACL variables, this expansion condition will let you
11605 make decisions in one place and act on those decisions in another place.
11606 For example:
11607 .code
11608 ${if bool{$acl_m_privileged_sender} ...
11609 .endd
11610
11611
11612 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11613 .cindex "expansion" "boolean parsing"
11614 .cindex "&%bool_lax%& expansion condition"
11615 Like &%bool%&, this condition turns a string into a boolean state.  But
11616 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11617 loose definition that the Router &%condition%& option uses.  The empty string
11618 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11619 true.  Leading and trailing whitespace is ignored.
11620
11621 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11622
11623 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11624 .cindex "expansion" "encrypted comparison"
11625 .cindex "encrypted strings, comparing"
11626 .cindex "&%crypteq%& expansion condition"
11627 This condition is included in the Exim binary if it is built to support any
11628 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11629 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11630 included in the binary.
11631
11632 The &%crypteq%& condition has two arguments. The first is encrypted and
11633 compared against the second, which is already encrypted. The second string may
11634 be in the LDAP form for storing encrypted strings, which starts with the
11635 encryption type in curly brackets, followed by the data. If the second string
11636 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11637 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11638 Typically this will be a field from a password file. An example of an encrypted
11639 string in LDAP form is:
11640 .code
11641 {md5}CY9rzUYh03PK3k6DJie09g==
11642 .endd
11643 If such a string appears directly in an expansion, the curly brackets have to
11644 be quoted, because they are part of the expansion syntax. For example:
11645 .code
11646 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11647 .endd
11648 The following encryption types (whose names are matched case-independently) are
11649 supported:
11650
11651 .ilist
11652 .cindex "MD5 hash"
11653 .cindex "base64 encoding" "in encrypted password"
11654 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11655 printable characters to compare with the remainder of the second string. If the
11656 length of the comparison string is 24, Exim assumes that it is base64 encoded
11657 (as in the above example). If the length is 32, Exim assumes that it is a
11658 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11659 comparison fails.
11660
11661 .next
11662 .cindex "SHA-1 hash"
11663 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11664 printable characters to compare with the remainder of the second string. If the
11665 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11666 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11667 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11668
11669 .next
11670 .cindex "&[crypt()]&"
11671 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11672 only the first eight characters of the password. However, in modern operating
11673 systems this is no longer true, and in many cases the entire password is used,
11674 whatever its length.
11675
11676 .next
11677 .cindex "&[crypt16()]&"
11678 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11679 use up to 16 characters of the password in some operating systems. Again, in
11680 modern operating systems, more characters may be used.
11681 .endlist
11682 Exim has its own version of &[crypt16()]&, which is just a double call to
11683 &[crypt()]&. For operating systems that have their own version, setting
11684 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11685 operating system version instead of its own. This option is set by default in
11686 the OS-dependent &_Makefile_& for those operating systems that are known to
11687 support &[crypt16()]&.
11688
11689 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11690 it was not using the same algorithm as some operating systems' versions. It
11691 turns out that as well as &[crypt16()]& there is a function called
11692 &[bigcrypt()]& in some operating systems. This may or may not use the same
11693 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11694
11695 However, since there is now a move away from the traditional &[crypt()]&
11696 functions towards using SHA1 and other algorithms, tidying up this area of
11697 Exim is seen as very low priority.
11698
11699 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11700 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11701 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11702 default is &`{crypt}`&. Whatever the default, you can always use either
11703 function by specifying it explicitly in curly brackets.
11704
11705 .vitem &*def:*&<&'variable&~name'&>
11706 .cindex "expansion" "checking for empty variable"
11707 .cindex "&%def%& expansion condition"
11708 The &%def%& condition must be followed by the name of one of the expansion
11709 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11710 variable does not contain the empty string. For example:
11711 .code
11712 ${if def:sender_ident {from $sender_ident}}
11713 .endd
11714 Note that the variable name is given without a leading &%$%& character. If the
11715 variable does not exist, the expansion fails.
11716
11717 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11718         &~&*def:h_*&<&'header&~name'&>&*:*&"
11719 .cindex "expansion" "checking header line existence"
11720 This condition is true if a message is being processed and the named header
11721 exists in the message. For example,
11722 .code
11723 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11724 .endd
11725 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11726 the header name must be terminated by a colon if white space does not follow.
11727
11728 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11729        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11730 .cindex "string" "comparison"
11731 .cindex "expansion" "string comparison"
11732 .cindex "&%eq%& expansion condition"
11733 .cindex "&%eqi%& expansion condition"
11734 The two substrings are first expanded. The condition is true if the two
11735 resulting strings are identical. For &%eq%& the comparison includes the case of
11736 letters, whereas for &%eqi%& the comparison is case-independent, where
11737 case is defined per the system C locale.
11738
11739 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11740 .cindex "expansion" "file existence test"
11741 .cindex "file" "existence test"
11742 .cindex "&%exists%&, expansion condition"
11743 The substring is first expanded and then interpreted as an absolute path. The
11744 condition is true if the named file (or directory) exists. The existence test
11745 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11746 users' filter files may be locked out by the system administrator.
11747
11748 &*Note:*& Testing a path using this condition is not a sufficient way of
11749 de-tainting it.
11750 Consider using a dsearch lookup.
11751
11752 .vitem &*first_delivery*&
11753 .cindex "delivery" "first"
11754 .cindex "first delivery"
11755 .cindex "expansion" "first delivery test"
11756 .cindex "&%first_delivery%& expansion condition"
11757 This condition, which has no data, is true during a message's first delivery
11758 attempt. It is false during any subsequent delivery attempts.
11759
11760
11761 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11762        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11763 .cindex "list" "iterative conditions"
11764 .cindex "expansion" "&*forall*& condition"
11765 .cindex "expansion" "&*forany*& condition"
11766 .vindex "&$item$&"
11767 These conditions iterate over a list. The first argument is expanded to form
11768 the list. By default, the list separator is a colon, but it can be changed by
11769 the normal method (&<<SECTlistsepchange>>&).
11770 The second argument is interpreted as a condition that is to
11771 be applied to each item in the list in turn. During the interpretation of the
11772 condition, the current list item is placed in a variable called &$item$&.
11773 .ilist
11774 For &*forany*&, interpretation stops if the condition is true for any item, and
11775 the result of the whole condition is true. If the condition is false for all
11776 items in the list, the overall condition is false.
11777 .next
11778 For &*forall*&, interpretation stops if the condition is false for any item,
11779 and the result of the whole condition is false. If the condition is true for
11780 all items in the list, the overall condition is true.
11781 .endlist
11782 Note that negation of &*forany*& means that the condition must be false for all
11783 items for the overall condition to succeed, and negation of &*forall*& means
11784 that the condition must be false for at least one item. In this example, the
11785 list separator is changed to a comma:
11786 .code
11787 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11788 .endd
11789 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11790 being processed, to enable these expansion items to be nested.
11791
11792 To scan a named list, expand it with the &*listnamed*& operator.
11793
11794 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11795        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11796        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11797        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11798 .cindex JSON "iterative conditions"
11799 .cindex JSON expansions
11800 .cindex expansion "&*forall_json*& condition"
11801 .cindex expansion "&*forany_json*& condition"
11802 .cindex expansion "&*forall_jsons*& condition"
11803 .cindex expansion "&*forany_jsons*& condition"
11804 As for the above, except that the first argument must, after expansion,
11805 be a JSON array.
11806 The array separator is not changeable.
11807 For the &"jsons"& variants the elements are expected to be JSON strings
11808 and have their quotes removed before the evaluation of the condition.
11809
11810
11811
11812 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11813        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11814 .cindex "string" "comparison"
11815 .cindex "expansion" "string comparison"
11816 .cindex "&%ge%& expansion condition"
11817 .cindex "&%gei%& expansion condition"
11818 The two substrings are first expanded. The condition is true if the first
11819 string is lexically greater than or equal to the second string. For &%ge%& the
11820 comparison includes the case of letters, whereas for &%gei%& the comparison is
11821 case-independent.
11822 Case and collation order are defined per the system C locale.
11823
11824 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11825        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11826 .cindex "string" "comparison"
11827 .cindex "expansion" "string comparison"
11828 .cindex "&%gt%& expansion condition"
11829 .cindex "&%gti%& expansion condition"
11830 The two substrings are first expanded. The condition is true if the first
11831 string is lexically greater than the second string. For &%gt%& the comparison
11832 includes the case of letters, whereas for &%gti%& the comparison is
11833 case-independent.
11834 Case and collation order are defined per the system C locale.
11835
11836
11837 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11838 SRS decode.  See SECT &<<SECTSRS>>& for details.
11839
11840
11841 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11842        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11843 .cindex "string" "comparison"
11844 .cindex "list" "iterative conditions"
11845 Both strings are expanded; the second string is treated as a list of simple
11846 strings; if the first string is a member of the second, then the condition
11847 is true.
11848 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11849
11850 These are simpler to use versions of the more powerful &*forany*& condition.
11851 Examples, and the &*forany*& equivalents:
11852 .code
11853 ${if inlist{needle}{foo:needle:bar}}
11854   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11855 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11856   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11857 .endd
11858
11859 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11860        &*isip4&~{*&<&'string'&>&*}*& &&&
11861        &*isip6&~{*&<&'string'&>&*}*&
11862 .cindex "IP address" "testing string format"
11863 .cindex "string" "testing for IP address"
11864 .cindex "&%isip%& expansion condition"
11865 .cindex "&%isip4%& expansion condition"
11866 .cindex "&%isip6%& expansion condition"
11867 The substring is first expanded, and then tested to see if it has the form of
11868 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11869 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11870
11871 For an IPv4 address, the test is for four dot-separated components, each of
11872 which consists of from one to three digits. For an IPv6 address, up to eight
11873 colon-separated components are permitted, each containing from one to four
11874 hexadecimal digits. There may be fewer than eight components if an empty
11875 component (adjacent colons) is present. Only one empty component is permitted.
11876
11877 &*Note*&: The checks used to be just on the form of the address; actual numerical
11878 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11879 check.
11880 This is no longer the case.
11881
11882 The main use of these tests is to distinguish between IP addresses and
11883 host names, or between IPv4 and IPv6 addresses. For example, you could use
11884 .code
11885 ${if isip4{$sender_host_address}...
11886 .endd
11887 to test which IP version an incoming SMTP connection is using.
11888
11889 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11890 .cindex "LDAP" "use for authentication"
11891 .cindex "expansion" "LDAP authentication test"
11892 .cindex "&%ldapauth%& expansion condition"
11893 This condition supports user authentication using LDAP. See section
11894 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11895 queries. For this use, the query must contain a user name and password. The
11896 query itself is not used, and can be empty. The condition is true if the
11897 password is not empty, and the user name and password are accepted by the LDAP
11898 server. An empty password is rejected without calling LDAP because LDAP binds
11899 with an empty password are considered anonymous regardless of the username, and
11900 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11901 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11902 this can be used.
11903
11904
11905 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11906        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11907 .cindex "string" "comparison"
11908 .cindex "expansion" "string comparison"
11909 .cindex "&%le%& expansion condition"
11910 .cindex "&%lei%& expansion condition"
11911 The two substrings are first expanded. The condition is true if the first
11912 string is lexically less than or equal to the second string. For &%le%& the
11913 comparison includes the case of letters, whereas for &%lei%& the comparison is
11914 case-independent.
11915 Case and collation order are defined per the system C locale.
11916
11917 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11918        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11919 .cindex "string" "comparison"
11920 .cindex "expansion" "string comparison"
11921 .cindex "&%lt%& expansion condition"
11922 .cindex "&%lti%& expansion condition"
11923 The two substrings are first expanded. The condition is true if the first
11924 string is lexically less than the second string. For &%lt%& the comparison
11925 includes the case of letters, whereas for &%lti%& the comparison is
11926 case-independent.
11927 Case and collation order are defined per the system C locale.
11928
11929
11930 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11931 .cindex "expansion" "regular expression comparison"
11932 .cindex "regular expressions" "match in expanded string"
11933 .cindex "&%match%& expansion condition"
11934 The two substrings are first expanded. The second is then treated as a regular
11935 expression and applied to the first. Because of the pre-expansion, if the
11936 regular expression contains dollar, or backslash characters, they must be
11937 escaped. Care must also be taken if the regular expression contains braces
11938 (curly brackets). A closing brace must be escaped so that it is not taken as a
11939 premature termination of <&'string2'&>. The easiest approach is to use the
11940 &`\N`& feature to disable expansion of the regular expression.
11941 For example,
11942 .code
11943 ${if match {$local_part}{\N^\d{3}\N} ...
11944 .endd
11945 If the whole expansion string is in double quotes, further escaping of
11946 backslashes is also required.
11947
11948 The condition is true if the regular expression match succeeds.
11949 The regular expression is not required to begin with a circumflex
11950 metacharacter, but if there is no circumflex, the expression is not anchored,
11951 and it may match anywhere in the subject, not just at the start. If you want
11952 the pattern to match at the end of the subject, you must include the &`$`&
11953 metacharacter at an appropriate point.
11954 All character handling is done in bytes and is not UTF-8 aware,
11955 but we might change this in a future Exim release.
11956
11957 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11958 At the start of an &%if%& expansion the values of the numeric variable
11959 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11960 succeeds causes them to be reset to the substrings of that condition and they
11961 will have these values during the expansion of the success string. At the end
11962 of the &%if%& expansion, the previous values are restored. After testing a
11963 combination of conditions using &%or%&, the subsequent values of the numeric
11964 variables are those of the condition that succeeded.
11965
11966 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11967 .cindex "&%match_address%& expansion condition"
11968 See &*match_local_part*&.
11969
11970 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11971 .cindex "&%match_domain%& expansion condition"
11972 See &*match_local_part*&.
11973
11974 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11975 .cindex "&%match_ip%& expansion condition"
11976 This condition matches an IP address to a list of IP address patterns. It must
11977 be followed by two argument strings. The first (after expansion) must be an IP
11978 address or an empty string. The second (not expanded) is a restricted host
11979 list that can match only an IP address, not a host name. For example:
11980 .code
11981 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11982 .endd
11983 The specific types of host list item that are permitted in the list are:
11984
11985 .ilist
11986 An IP address, optionally with a CIDR mask.
11987 .next
11988 A single asterisk, which matches any IP address.
11989 .next
11990 An empty item, which matches only if the IP address is empty. This could be
11991 useful for testing for a locally submitted message or one from specific hosts
11992 in a single test such as
11993 . ==== As this is a nested list, any displays it contains must be indented
11994 . ==== as otherwise they are too far to the left. This comment applies to
11995 . ==== the use of xmlto plus fop. There's no problem when formatting with
11996 . ==== sdop, with or without the extra indent.
11997 .code
11998   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11999 .endd
12000 where the first item in the list is the empty string.
12001 .next
12002 The item @[] matches any of the local host's interface addresses.
12003 .next
12004 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
12005 even if &`net-`& is not specified. There is never any attempt to turn the IP
12006 address into a host name. The most common type of linear search for
12007 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
12008 masks. For example:
12009 .code
12010   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
12011 .endd
12012 It is of course possible to use other kinds of lookup, and in such a case, you
12013 do need to specify the &`net-`& prefix if you want to specify a specific
12014 address mask, for example:
12015 .code
12016   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
12017 .endd
12018 However, unless you are combining a &%match_ip%& condition with others, it is
12019 just as easy to use the fact that a lookup is itself a condition, and write:
12020 .code
12021   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
12022 .endd
12023 .endlist ilist
12024
12025 Note that <&'string2'&> is not itself subject to string expansion, unless
12026 Exim was built with the EXPAND_LISTMATCH_RHS option.
12027
12028 Consult section &<<SECThoslispatip>>& for further details of these patterns.
12029
12030 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12031 .cindex "domain list" "in expansion condition"
12032 .cindex "address list" "in expansion condition"
12033 .cindex "local part" "list, in expansion condition"
12034 .cindex "&%match_local_part%& expansion condition"
12035 This condition, together with &%match_address%& and &%match_domain%&, make it
12036 possible to test domain, address, and local part lists within expansions. Each
12037 condition requires two arguments: an item and a list to match. A trivial
12038 example is:
12039 .code
12040 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
12041 .endd
12042 In each case, the second argument may contain any of the allowable items for a
12043 list of the appropriate type. Also, because the second argument
12044 is a standard form of list, it is possible to refer to a named list.
12045 Thus, you can use conditions like this:
12046 .code
12047 ${if match_domain{$domain}{+local_domains}{...
12048 .endd
12049 .cindex "&`+caseful`&"
12050 For address lists, the matching starts off caselessly, but the &`+caseful`&
12051 item can be used, as in all address lists, to cause subsequent items to
12052 have their local parts matched casefully. Domains are always matched
12053 caselessly.
12054
12055 Note that <&'string2'&> is not itself subject to string expansion, unless
12056 Exim was built with the EXPAND_LISTMATCH_RHS option.
12057
12058 &*Note*&: Host lists are &'not'& supported in this way. This is because
12059 hosts have two identities: a name and an IP address, and it is not clear
12060 how to specify cleanly how such a test would work. However, IP addresses can be
12061 matched using &%match_ip%&.
12062
12063 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
12064 .cindex "PAM authentication"
12065 .cindex "AUTH" "with PAM"
12066 .cindex "Solaris" "PAM support"
12067 .cindex "expansion" "PAM authentication test"
12068 .cindex "&%pam%& expansion condition"
12069 &'Pluggable Authentication Modules'&
12070 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
12071 available in the latest releases of Solaris and in some GNU/Linux
12072 distributions. The Exim support, which is intended for use in conjunction with
12073 the SMTP AUTH command, is available only if Exim is compiled with
12074 .code
12075 SUPPORT_PAM=yes
12076 .endd
12077 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
12078 in some releases of GNU/Linux &%-ldl%& is also needed.
12079
12080 The argument string is first expanded, and the result must be a
12081 colon-separated list of strings. Leading and trailing white space is ignored.
12082 The PAM module is initialized with the service name &"exim"& and the user name
12083 taken from the first item in the colon-separated data string (<&'string1'&>).
12084 The remaining items in the data string are passed over in response to requests
12085 from the authentication function. In the simple case there will only be one
12086 request, for a password, so the data consists of just two strings.
12087
12088 There can be problems if any of the strings are permitted to contain colon
12089 characters. In the usual way, these have to be doubled to avoid being taken as
12090 separators.
12091 The &%listquote%& expansion item can be used for this.
12092 For example, the configuration
12093 of a LOGIN authenticator might contain this setting:
12094 .code
12095 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
12096 .endd
12097 In some operating systems, PAM authentication can be done only from a process
12098 running as root. Since Exim is running as the Exim user when receiving
12099 messages, this means that PAM cannot be used directly in those systems.
12100 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
12101
12102
12103 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
12104 .cindex "&'pwcheck'& daemon"
12105 .cindex "Cyrus"
12106 .cindex "expansion" "&'pwcheck'& authentication test"
12107 .cindex "&%pwcheck%& expansion condition"
12108 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
12109 This is one way of making it possible for passwords to be checked by a process
12110 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
12111 deprecated. Its replacement is &'saslauthd'& (see below).
12112
12113 The pwcheck support is not included in Exim by default. You need to specify
12114 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
12115 building Exim. For example:
12116 .code
12117 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
12118 .endd
12119 You do not need to install the full Cyrus software suite in order to use
12120 the pwcheck daemon. You can compile and install just the daemon alone
12121 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
12122 access to the &_/var/pwcheck_& directory.
12123
12124 The &%pwcheck%& condition takes one argument, which must be the user name and
12125 password, separated by a colon. For example, in a LOGIN authenticator
12126 configuration, you might have this:
12127 .code
12128 server_condition = ${if pwcheck{$auth1:$auth2}}
12129 .endd
12130 Again, for a PLAIN authenticator configuration, this would be:
12131 .code
12132 server_condition = ${if pwcheck{$auth2:$auth3}}
12133 .endd
12134 .vitem &*queue_running*&
12135 .cindex "queue runner" "detecting when delivering from"
12136 .cindex "expansion" "queue runner test"
12137 .cindex "&%queue_running%& expansion condition"
12138 This condition, which has no data, is true during delivery attempts that are
12139 initiated by queue runner processes, and false otherwise.
12140
12141
12142 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12143 .cindex "Radius"
12144 .cindex "expansion" "Radius authentication"
12145 .cindex "&%radius%& expansion condition"
12146 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12147 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12148 the Radius client configuration file in order to build Exim with Radius
12149 support.
12150
12151 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12152 library, using the original API. If you are using release 0.4.0 or later of
12153 this library, you need to set
12154 .code
12155 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12156 .endd
12157 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12158 &%libradius%& library that comes with FreeBSD. To do this, set
12159 .code
12160 RADIUS_LIB_TYPE=RADLIB
12161 .endd
12162 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12163 You may also have to supply a suitable setting in EXTRALIBS so that the
12164 Radius library can be found when Exim is linked.
12165
12166 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12167 Radius client library, which calls the Radius server. The condition is true if
12168 the authentication is successful. For example:
12169 .code
12170 server_condition = ${if radius{<arguments>}}
12171 .endd
12172
12173
12174 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12175         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12176 .cindex "&'saslauthd'& daemon"
12177 .cindex "Cyrus"
12178 .cindex "expansion" "&'saslauthd'& authentication test"
12179 .cindex "&%saslauthd%& expansion condition"
12180 This condition supports user authentication using the Cyrus &'saslauthd'&
12181 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12182 Using this daemon is one way of making it possible for passwords to be checked
12183 by a process that is not running as root.
12184
12185 The saslauthd support is not included in Exim by default. You need to specify
12186 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12187 building Exim. For example:
12188 .code
12189 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12190 .endd
12191 You do not need to install the full Cyrus software suite in order to use
12192 the saslauthd daemon. You can compile and install just the daemon alone
12193 from the Cyrus SASL library.
12194
12195 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12196 two are mandatory. For example:
12197 .code
12198 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12199 .endd
12200 The service and the realm are optional (which is why the arguments are enclosed
12201 in their own set of braces). For details of the meaning of the service and
12202 realm, and how to run the daemon, consult the Cyrus documentation.
12203 .endlist vlist
12204
12205
12206
12207 .section "Combining expansion conditions" "SECID84"
12208 .cindex "expansion" "combining conditions"
12209 Several conditions can be tested at once by combining them using the &%and%&
12210 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12211 conditions on their own, and precede their lists of sub-conditions. Each
12212 sub-condition must be enclosed in braces within the overall braces that contain
12213 the list. No repetition of &%if%& is used.
12214
12215
12216 .vlist
12217 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12218 .cindex "&""or""& expansion condition"
12219 .cindex "expansion" "&""or""& of conditions"
12220 The sub-conditions are evaluated from left to right. The condition is true if
12221 any one of the sub-conditions is true.
12222 For example,
12223 .code
12224 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12225 .endd
12226 When a true sub-condition is found, the following ones are parsed but not
12227 evaluated. If there are several &"match"& sub-conditions the values of the
12228 numeric variables afterwards are taken from the first one that succeeds.
12229
12230 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12231 .cindex "&""and""& expansion condition"
12232 .cindex "expansion" "&""and""& of conditions"
12233 The sub-conditions are evaluated from left to right. The condition is true if
12234 all of the sub-conditions are true. If there are several &"match"&
12235 sub-conditions, the values of the numeric variables afterwards are taken from
12236 the last one. When a false sub-condition is found, the following ones are
12237 parsed but not evaluated.
12238 .endlist
12239 .ecindex IIDexpcond
12240
12241
12242
12243
12244 .section "Expansion variables" "SECTexpvar"
12245 .cindex "expansion" "variables, list of"
12246 This section contains an alphabetical list of all the expansion variables. Some
12247 of them are available only when Exim is compiled with specific options such as
12248 support for TLS or the content scanning extension.
12249
12250 .vlist
12251 .vitem "&$0$&, &$1$&, etc"
12252 .cindex "numerical variables (&$1$& &$2$& etc)"
12253 When a &%match%& expansion condition succeeds, these variables contain the
12254 captured substrings identified by the regular expression during subsequent
12255 processing of the success string of the containing &%if%& expansion item.
12256 In the expansion condition case
12257 they do not retain their values afterwards; in fact, their previous
12258 values are restored at the end of processing an &%if%& item. The numerical
12259 variables may also be set externally by some other matching process which
12260 precedes the expansion of the string. For example, the commands available in
12261 Exim filter files include an &%if%& command with its own regular expression
12262 matching condition.
12263
12264 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12265 Within an acl condition, expansion condition or expansion item
12266 any arguments are copied to these variables,
12267 any unused variables being made empty.
12268
12269 .vitem "&$acl_c...$&"
12270 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12271 can be given any name that starts with &$acl_c$& and is at least six characters
12272 long, but the sixth character must be either a digit or an underscore. For
12273 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12274 variables persist throughout the lifetime of an SMTP connection. They can be
12275 used to pass information between ACLs and between different invocations of the
12276 same ACL. When a message is received, the values of these variables are saved
12277 with the message, and can be accessed by filters, routers, and transports
12278 during subsequent delivery.
12279
12280 .vitem "&$acl_m...$&"
12281 These variables are like the &$acl_c...$& variables, except that their values
12282 are reset after a message has been received. Thus, if several messages are
12283 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12284 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12285 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12286 message is received, the values of these variables are saved with the message,
12287 and can be accessed by filters, routers, and transports during subsequent
12288 delivery.
12289
12290 .vitem &$acl_narg$&
12291 Within an acl condition, expansion condition or expansion item
12292 this variable has the number of arguments.
12293
12294 .vitem &$acl_verify_message$&
12295 .vindex "&$acl_verify_message$&"
12296 After an address verification has failed, this variable contains the failure
12297 message. It retains its value for use in subsequent modifiers of the verb.
12298 The message can be preserved by coding like this:
12299 .code
12300 warn !verify = sender
12301      set acl_m0 = $acl_verify_message
12302 .endd
12303 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12304 &%log_message%& modifiers, to include information about the verification
12305 failure.
12306 &*Note*&: The variable is cleared at the end of processing the ACL verb.
12307
12308 .vitem &$address_data$&
12309 .vindex "&$address_data$&"
12310 This variable is set by means of the &%address_data%& option in routers. The
12311 value then remains with the address while it is processed by subsequent routers
12312 and eventually a transport. If the transport is handling multiple addresses,
12313 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12314 for more details. &*Note*&: The contents of &$address_data$& are visible in
12315 user filter files.
12316
12317 If &$address_data$& is set when the routers are called from an ACL to verify
12318 a recipient address, the final value is still in the variable for subsequent
12319 conditions and modifiers of the ACL statement. If routing the address caused it
12320 to be redirected to just one address, the child address is also routed as part
12321 of the verification, and in this case the final value of &$address_data$& is
12322 from the child's routing.
12323
12324 If &$address_data$& is set when the routers are called from an ACL to verify a
12325 sender address, the final value is also preserved, but this time in
12326 &$sender_address_data$&, to distinguish it from data from a recipient
12327 address.
12328
12329 In both cases (recipient and sender verification), the value does not persist
12330 after the end of the current ACL statement. If you want to preserve
12331 these values for longer, you can save them in ACL variables.
12332
12333 .vitem &$address_file$&
12334 .vindex "&$address_file$&"
12335 When, as a result of aliasing, forwarding, or filtering, a message is directed
12336 to a specific file, this variable holds the name of the file when the transport
12337 is running. At other times, the variable is empty. For example, using the
12338 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12339 .code
12340 /home/r2d2/savemail
12341 .endd
12342 then when the &(address_file)& transport is running, &$address_file$&
12343 contains the text string &`/home/r2d2/savemail`&.
12344 .cindex "Sieve filter" "value of &$address_file$&"
12345 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12346 then up to the transport configuration to generate an appropriate absolute path
12347 to the relevant file.
12348
12349 .vitem &$address_pipe$&
12350 .vindex "&$address_pipe$&"
12351 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12352 this variable holds the pipe command when the transport is running.
12353
12354 .vitem "&$auth1$& &-- &$auth4$&"
12355 .vindex "&$auth1$&, &$auth2$&, etc"
12356 These variables are used in SMTP authenticators (see chapters
12357 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12358
12359 .vitem &$authenticated_id$&
12360 .cindex "authentication" "id"
12361 .vindex "&$authenticated_id$&"
12362 When a server successfully authenticates a client it may be configured to
12363 preserve some of the authentication information in the variable
12364 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12365 user/password authenticator configuration might preserve the user name for use
12366 in the routers. Note that this is not the same information that is saved in
12367 &$sender_host_authenticated$&.
12368
12369 When a message is submitted locally (that is, not over a TCP connection)
12370 the value of &$authenticated_id$& is normally the login name of the calling
12371 process. However, a trusted user can override this by means of the &%-oMai%&
12372 command line option.
12373 This second case also sets up information used by the
12374 &$authresults$& expansion item.
12375
12376 .vitem &$authenticated_fail_id$&
12377 .cindex "authentication" "fail" "id"
12378 .vindex "&$authenticated_fail_id$&"
12379 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12380 will contain the failed authentication id. If more than one authentication
12381 id is attempted, it will contain only the last one. The variable is
12382 available for processing in the ACL's, generally the quit or notquit ACL.
12383 A message to a local recipient could still be accepted without requiring
12384 authentication, which means this variable could also be visible in all of
12385 the ACL's as well.
12386
12387
12388 .vitem &$authenticated_sender$&
12389 .cindex "sender" "authenticated"
12390 .cindex "authentication" "sender"
12391 .cindex "AUTH" "on MAIL command"
12392 .vindex "&$authenticated_sender$&"
12393 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12394 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12395 described in section &<<SECTauthparamail>>&. Unless the data is the string
12396 &"<>"&, it is set as the authenticated sender of the message, and the value is
12397 available during delivery in the &$authenticated_sender$& variable. If the
12398 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12399
12400 .vindex "&$qualify_domain$&"
12401 When a message is submitted locally (that is, not over a TCP connection), the
12402 value of &$authenticated_sender$& is an address constructed from the login
12403 name of the calling process and &$qualify_domain$&, except that a trusted user
12404 can override this by means of the &%-oMas%& command line option.
12405
12406
12407 .vitem &$authentication_failed$&
12408 .cindex "authentication" "failure"
12409 .vindex "&$authentication_failed$&"
12410 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12411 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12412 possible to distinguish between &"did not try to authenticate"&
12413 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12414 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12415 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12416 negative response to an AUTH command, including (for example) an attempt to use
12417 an undefined mechanism.
12418
12419 .vitem &$av_failed$&
12420 .cindex "content scanning" "AV scanner failure"
12421 This variable is available when Exim is compiled with the content-scanning
12422 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12423 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12424 the ACL malware condition.
12425
12426 .vitem &$body_linecount$&
12427 .cindex "message body" "line count"
12428 .cindex "body of message" "line count"
12429 .vindex "&$body_linecount$&"
12430 When a message is being received or delivered, this variable contains the
12431 number of lines in the message's body. See also &$message_linecount$&.
12432
12433 .vitem &$body_zerocount$&
12434 .cindex "message body" "binary zero count"
12435 .cindex "body of message" "binary zero count"
12436 .cindex "binary zero" "in message body"
12437 .vindex "&$body_zerocount$&"
12438 When a message is being received or delivered, this variable contains the
12439 number of binary zero bytes (ASCII NULs) in the message's body.
12440
12441 .vitem &$bounce_recipient$&
12442 .vindex "&$bounce_recipient$&"
12443 This is set to the recipient address of a bounce message while Exim is creating
12444 it. It is useful if a customized bounce message text file is in use (see
12445 chapter &<<CHAPemsgcust>>&).
12446
12447 .vitem &$bounce_return_size_limit$&
12448 .vindex "&$bounce_return_size_limit$&"
12449 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12450 up to a multiple of 1000. It is useful when a customized error message text
12451 file is in use (see chapter &<<CHAPemsgcust>>&).
12452
12453 .vitem &$caller_gid$&
12454 .cindex "gid (group id)" "caller"
12455 .vindex "&$caller_gid$&"
12456 The real group id under which the process that called Exim was running. This is
12457 not the same as the group id of the originator of a message (see
12458 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12459 incarnation normally contains the Exim gid.
12460
12461 .vitem &$caller_uid$&
12462 .cindex "uid (user id)" "caller"
12463 .vindex "&$caller_uid$&"
12464 The real user id under which the process that called Exim was running. This is
12465 not the same as the user id of the originator of a message (see
12466 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12467 incarnation normally contains the Exim uid.
12468
12469 .vitem &$callout_address$&
12470 .vindex "&$callout_address$&"
12471 After a callout for verification, spamd or malware daemon service, the
12472 address that was connected to.
12473
12474 .vitem &$compile_number$&
12475 .vindex "&$compile_number$&"
12476 The building process for Exim keeps a count of the number
12477 of times it has been compiled. This serves to distinguish different
12478 compilations of the same version of Exim.
12479
12480 .vitem &$config_dir$&
12481 .vindex "&$config_dir$&"
12482 The directory name of the main configuration file. That is, the content of
12483 &$config_file$& with the last component stripped. The value does not
12484 contain the trailing slash. If &$config_file$& does not contain a slash,
12485 &$config_dir$& is ".".
12486
12487 .vitem &$config_file$&
12488 .vindex "&$config_file$&"
12489 The name of the main configuration file Exim is using.
12490
12491 .vitem &$dkim_verify_status$&
12492 Results of DKIM verification.
12493 For details see section &<<SECDKIMVFY>>&.
12494
12495 .vitem &$dkim_cur_signer$& &&&
12496        &$dkim_verify_reason$& &&&
12497        &$dkim_domain$& &&&
12498        &$dkim_identity$& &&&
12499        &$dkim_selector$& &&&
12500        &$dkim_algo$& &&&
12501        &$dkim_canon_body$& &&&
12502        &$dkim_canon_headers$& &&&
12503        &$dkim_copiedheaders$& &&&
12504        &$dkim_bodylength$& &&&
12505        &$dkim_created$& &&&
12506        &$dkim_expires$& &&&
12507        &$dkim_headernames$& &&&
12508        &$dkim_key_testing$& &&&
12509        &$dkim_key_nosubdomains$& &&&
12510        &$dkim_key_srvtype$& &&&
12511        &$dkim_key_granularity$& &&&
12512        &$dkim_key_notes$& &&&
12513        &$dkim_key_length$&
12514 These variables are only available within the DKIM ACL.
12515 For details see section &<<SECDKIMVFY>>&.
12516
12517 .vitem &$dkim_signers$&
12518 .vindex &$dkim_signers$&
12519 When a message has been received this variable contains
12520 a colon-separated list of signer domains and identities for the message.
12521 For details see section &<<SECDKIMVFY>>&.
12522
12523 .vitem &$dmarc_domain_policy$& &&&
12524        &$dmarc_status$& &&&
12525        &$dmarc_status_text$& &&&
12526        &$dmarc_used_domains$&
12527 Results of DMARC verification.
12528 For details see section &<<SECDMARC>>&.
12529
12530 .vitem &$dnslist_domain$& &&&
12531        &$dnslist_matched$& &&&
12532        &$dnslist_text$& &&&
12533        &$dnslist_value$&
12534 .vindex "&$dnslist_domain$&"
12535 .vindex "&$dnslist_matched$&"
12536 .vindex "&$dnslist_text$&"
12537 .vindex "&$dnslist_value$&"
12538 .cindex "black list (DNS)"
12539 When a DNS (black) list lookup succeeds, these variables are set to contain
12540 the following data from the lookup: the list's domain name, the key that was
12541 looked up, the contents of any associated TXT record, and the value from the
12542 main A record. See section &<<SECID204>>& for more details.
12543
12544 .vitem &$domain$&
12545 .vindex "&$domain$&"
12546 When an address is being routed, or delivered on its own, this variable
12547 contains the domain. Uppercase letters in the domain are converted into lower
12548 case for &$domain$&.
12549
12550 Global address rewriting happens when a message is received, so the value of
12551 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12552 is set during user filtering, but not during system filtering, because a
12553 message may have many recipients and the system filter is called just once.
12554
12555 When more than one address is being delivered at once (for example, several
12556 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12557 have the same domain. Transports can be restricted to handling only one domain
12558 at a time if the value of &$domain$& is required at transport time &-- this is
12559 the default for local transports. For further details of the environment in
12560 which local transports are run, see chapter &<<CHAPenvironment>>&.
12561
12562 .oindex "&%delay_warning_condition%&"
12563 At the end of a delivery, if all deferred addresses have the same domain, it is
12564 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12565
12566 The &$domain$& variable is also used in some other circumstances:
12567
12568 .ilist
12569 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12570 the recipient address. The domain of the &'sender'& address is in
12571 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12572 normally set during the running of the MAIL ACL. However, if the sender address
12573 is verified with a callout during the MAIL ACL, the sender domain is placed in
12574 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12575 the &(smtp)& transport.
12576
12577 .next
12578 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12579 &$domain$& contains the domain portion of the address that is being rewritten;
12580 it can be used in the expansion of the replacement address, for example, to
12581 rewrite domains by file lookup.
12582
12583 .next
12584 With one important exception, whenever a domain list is being scanned,
12585 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12586 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12587 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12588 that, in a RCPT ACL, the sender domain list can be dependent on the
12589 recipient domain (which is what is in &$domain$& at this time).
12590
12591 .next
12592 .cindex "ETRN" "value of &$domain$&"
12593 .oindex "&%smtp_etrn_command%&"
12594 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12595 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12596 .endlist
12597
12598 .cindex "tainted data"
12599 If the origin of the data is an incoming message,
12600 the result of expanding this variable is tainted and may not
12601 be further expanded or used as a filename.
12602 When an untainted version is needed, one should be obtained from
12603 looking up the value in a local (therefore trusted) database.
12604 Often &$domain_data$& is usable in this role.
12605
12606
12607 .vitem &$domain_data$&
12608 .vindex "&$domain_data$&"
12609 When the &%domains%& condition on a router
12610 or an ACL
12611 matches a domain
12612 against a list, the match value is copied to &$domain_data$&.
12613 This is an enhancement over previous versions of Exim, when it only
12614 applied to the data read by a lookup.
12615 For details on match values see section &<<SECTlistresults>>& et. al.
12616
12617 If the router routes the
12618 address to a transport, the value is available in that transport. If the
12619 transport is handling multiple addresses, the value from the first address is
12620 used.
12621
12622 &$domain_data$& set in an ACL is available during
12623 the rest of the ACL statement.
12624
12625 .vitem &$exim_gid$&
12626 .vindex "&$exim_gid$&"
12627 This variable contains the numerical value of the Exim group id.
12628
12629 .vitem &$exim_path$&
12630 .vindex "&$exim_path$&"
12631 This variable contains the path to the Exim binary.
12632
12633 .vitem &$exim_uid$&
12634 .vindex "&$exim_uid$&"
12635 This variable contains the numerical value of the Exim user id.
12636
12637 .vitem &$exim_version$&
12638 .vindex "&$exim_version$&"
12639 This variable contains the version string of the Exim build.
12640 The first character is a major version number, currently 4.
12641 Then after a dot, the next group of digits is a minor version number.
12642 There may be other characters following the minor version.
12643 This value may be overridden by the &%exim_version%& main config option.
12644
12645 .vitem &$header_$&<&'name'&>
12646 This is not strictly an expansion variable. It is expansion syntax for
12647 inserting the message header line with the given name. Note that the name must
12648 be terminated by colon or white space, because it may contain a wide variety of
12649 characters. Note also that braces must &'not'& be used.
12650 See the full description in section &<<SECTexpansionitems>>& above.
12651
12652 .vitem &$headers_added$&
12653 .vindex "&$headers_added$&"
12654 Within an ACL this variable contains the headers added so far by
12655 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12656 The headers are a newline-separated list.
12657
12658 .vitem &$home$&
12659 .vindex "&$home$&"
12660 When the &%check_local_user%& option is set for a router, the user's home
12661 directory is placed in &$home$& when the check succeeds. In particular, this
12662 means it is set during the running of users' filter files. A router may also
12663 explicitly set a home directory for use by a transport; this can be overridden
12664 by a setting on the transport itself.
12665
12666 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12667 of the environment variable HOME, which is subject to the
12668 &%keep_environment%& and &%add_environment%& main config options.
12669
12670 .vitem &$host$&
12671 .vindex "&$host$&"
12672 If a router assigns an address to a transport (any transport), and passes a
12673 list of hosts with the address, the value of &$host$& when the transport starts
12674 to run is the name of the first host on the list. Note that this applies both
12675 to local and remote transports.
12676
12677 .cindex "transport" "filter"
12678 .cindex "filter" "transport filter"
12679 For the &(smtp)& transport, if there is more than one host, the value of
12680 &$host$& changes as the transport works its way through the list. In
12681 particular, when the &(smtp)& transport is expanding its options for encryption
12682 using TLS, or for specifying a transport filter (see chapter
12683 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12684 is connected.
12685
12686 When used in the client part of an authenticator configuration (see chapter
12687 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12688 client is connected.
12689
12690
12691 .vitem &$host_address$&
12692 .vindex "&$host_address$&"
12693 This variable is set to the remote host's IP address whenever &$host$& is set
12694 for a remote connection. It is also set to the IP address that is being checked
12695 when the &%ignore_target_hosts%& option is being processed.
12696
12697 .vitem &$host_data$&
12698 .vindex "&$host_data$&"
12699 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12700 result of the lookup is made available in the &$host_data$& variable. This
12701 allows you, for example, to do things like this:
12702 .code
12703 deny  hosts = net-lsearch;/some/file
12704       message = $host_data
12705 .endd
12706 .vitem &$host_lookup_deferred$&
12707 .cindex "host name" "lookup, failure of"
12708 .vindex "&$host_lookup_deferred$&"
12709 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12710 message comes from a remote host and there is an attempt to look up the host's
12711 name from its IP address, and the attempt is not successful, one of these
12712 variables is set to &"1"&.
12713
12714 .ilist
12715 If the lookup receives a definite negative response (for example, a DNS lookup
12716 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12717
12718 .next
12719 If there is any kind of problem during the lookup, such that Exim cannot
12720 tell whether or not the host name is defined (for example, a timeout for a DNS
12721 lookup), &$host_lookup_deferred$& is set to &"1"&.
12722 .endlist ilist
12723
12724 Looking up a host's name from its IP address consists of more than just a
12725 single reverse lookup. Exim checks that a forward lookup of at least one of the
12726 names it receives from a reverse lookup yields the original IP address. If this
12727 is not the case, Exim does not accept the looked up name(s), and
12728 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12729 IP address (for example, the existence of a PTR record in the DNS) is not
12730 sufficient on its own for the success of a host name lookup. If the reverse
12731 lookup succeeds, but there is a lookup problem such as a timeout when checking
12732 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12733 &"1"&. See also &$sender_host_name$&.
12734
12735 .cindex authentication "expansion item"
12736 Performing these checks sets up information used by the
12737 &%authresults%& expansion item.
12738
12739
12740 .vitem &$host_lookup_failed$&
12741 .vindex "&$host_lookup_failed$&"
12742 See &$host_lookup_deferred$&.
12743
12744 .vitem &$host_port$&
12745 .vindex "&$host_port$&"
12746 This variable is set to the remote host's TCP port whenever &$host$& is set
12747 for an outbound connection.
12748
12749 .vitem &$initial_cwd$&
12750 .vindex "&$initial_cwd$&
12751 This variable contains the full path name of the initial working
12752 directory of the current Exim process. This may differ from the current
12753 working directory, as Exim changes this to "/" during early startup, and
12754 to &$spool_directory$& later.
12755
12756 .vitem &$inode$&
12757 .vindex "&$inode$&"
12758 The only time this variable is set is while expanding the &%directory_file%&
12759 option in the &(appendfile)& transport. The variable contains the inode number
12760 of the temporary file which is about to be renamed. It can be used to construct
12761 a unique name for the file.
12762
12763 .vitem &$interface_address$& &&&
12764        &$interface_port$&
12765 .vindex "&$interface_address$&"
12766 .vindex "&$interface_port$&"
12767 These are obsolete names for &$received_ip_address$& and &$received_port$&.
12768
12769 .vitem &$item$&
12770 .vindex "&$item$&"
12771 This variable is used during the expansion of &*forall*& and &*forany*&
12772 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12773 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12774 empty.
12775
12776 .vitem &$ldap_dn$&
12777 .vindex "&$ldap_dn$&"
12778 This variable, which is available only when Exim is compiled with LDAP support,
12779 contains the DN from the last entry in the most recently successful LDAP
12780 lookup.
12781
12782 .vitem &$load_average$&
12783 .vindex "&$load_average$&"
12784 This variable contains the system load average, multiplied by 1000 so that it
12785 is an integer. For example, if the load average is 0.21, the value of the
12786 variable is 210. The value is recomputed every time the variable is referenced.
12787
12788 .vitem &$local_part$&
12789 .vindex "&$local_part$&"
12790 When an address is being routed, or delivered on its own, this
12791 variable contains the local part. When a number of addresses are being
12792 delivered together (for example, multiple RCPT commands in an SMTP
12793 session), &$local_part$& is not set.
12794
12795 Global address rewriting happens when a message is received, so the value of
12796 &$local_part$& during routing and delivery is the value after rewriting.
12797 &$local_part$& is set during user filtering, but not during system filtering,
12798 because a message may have many recipients and the system filter is called just
12799 once.
12800
12801 .cindex "tainted data"
12802 If the origin of the data is an incoming message,
12803 the result of expanding this variable is tainted and
12804 may not be further expanded or used as a filename.
12805
12806 &*Warning*&: the content of this variable is usually provided by a potential
12807 attacker.
12808 Consider carefully the implications of using it unvalidated as a name
12809 for file access.
12810 This presents issues for users' &_.forward_& and filter files.
12811 For traditional full user accounts, use &%check_local_users%& and the
12812 &$local_part_data$& variable rather than this one.
12813 For virtual users, store a suitable pathname component in the database
12814 which is used for account name validation, and use that retrieved value
12815 rather than this variable.
12816 Often &$local_part_data$& is usable in this role.
12817 If needed, use a router &%address_data%& or &%set%& option for
12818 the retrieved data.
12819
12820 When a message is being delivered to a file, pipe, or autoreply transport as a
12821 result of aliasing or forwarding, &$local_part$& is set to the local part of
12822 the parent address, not to the filename or command (see &$address_file$& and
12823 &$address_pipe$&).
12824
12825 When an ACL is running for a RCPT command, &$local_part$& contains the
12826 local part of the recipient address.
12827
12828 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12829 &$local_part$& contains the local part of the address that is being rewritten;
12830 it can be used in the expansion of the replacement address, for example.
12831
12832 In all cases, all quoting is removed from the local part. For example, for both
12833 the addresses
12834 .code
12835 "abc:xyz"@test.example
12836 abc\:xyz@test.example
12837 .endd
12838 the value of &$local_part$& is
12839 .code
12840 abc:xyz
12841 .endd
12842 If you use &$local_part$& to create another address, you should always wrap it
12843 inside a quoting operator. For example, in a &(redirect)& router you could
12844 have:
12845 .code
12846 data = ${quote_local_part:$local_part}@new.domain.example
12847 .endd
12848 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12849 to process local parts in a case-dependent manner in a router, you can set the
12850 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12851
12852 .vitem &$local_part_data$&
12853 .vindex "&$local_part_data$&"
12854 When the &%local_parts%& condition on a router or ACL
12855 matches a local part list
12856 the match value is copied to &$local_part_data$&.
12857 This is an enhancement over previous versions of Exim, when it only
12858 applied to the data read by a lookup.
12859 For details on match values see section &<<SECTlistresults>>& et. al.
12860
12861 The &%check_local_user%& router option also sets this variable.
12862
12863 .vindex &$local_part_prefix$& &&&
12864         &$local_part_prefix_v$& &&&
12865         &$local_part_suffix$& &&&
12866         &$local_part_suffix_v$&
12867 .cindex affix variables
12868 If a local part prefix or suffix has been recognized, it is not included in the
12869 value of &$local_part$& during routing and subsequent delivery. The values of
12870 any prefix or suffix are in &$local_part_prefix$& and
12871 &$local_part_suffix$&, respectively.
12872 .cindex "tainted data"
12873 If the specification did not include a wildcard then
12874 the affix variable value is not tainted.
12875
12876 If the affix specification included a wildcard then the portion of
12877 the affix matched by the wildcard is in
12878 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12879 and both the whole and varying values are tainted.
12880
12881 .vitem &$local_scan_data$&
12882 .vindex "&$local_scan_data$&"
12883 This variable contains the text returned by the &[local_scan()]& function when
12884 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12885
12886 .vitem &$local_user_gid$&
12887 .vindex "&$local_user_gid$&"
12888 See &$local_user_uid$&.
12889
12890 .vitem &$local_user_uid$&
12891 .vindex "&$local_user_uid$&"
12892 This variable and &$local_user_gid$& are set to the uid and gid after the
12893 &%check_local_user%& router precondition succeeds. This means that their values
12894 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12895 and &%condition%&), for the &%address_data%& expansion, and for any
12896 router-specific expansions. At all other times, the values in these variables
12897 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12898
12899 .vitem &$localhost_number$&
12900 .vindex "&$localhost_number$&"
12901 This contains the expanded value of the
12902 &%localhost_number%& option. The expansion happens after the main options have
12903 been read.
12904
12905 .vitem &$log_inodes$&
12906 .vindex "&$log_inodes$&"
12907 The number of free inodes in the disk partition where Exim's
12908 log files are being written. The value is recalculated whenever the variable is
12909 referenced. If the relevant file system does not have the concept of inodes,
12910 the value of is -1. See also the &%check_log_inodes%& option.
12911
12912 .vitem &$log_space$&
12913 .vindex "&$log_space$&"
12914 The amount of free space (as a number of kilobytes) in the disk
12915 partition where Exim's log files are being written. The value is recalculated
12916 whenever the variable is referenced. If the operating system does not have the
12917 ability to find the amount of free space (only true for experimental systems),
12918 the space value is -1. See also the &%check_log_space%& option.
12919
12920
12921 .vitem &$lookup_dnssec_authenticated$&
12922 .vindex "&$lookup_dnssec_authenticated$&"
12923 This variable is set after a DNS lookup done by
12924 a dnsdb lookup expansion, dnslookup router or smtp transport.
12925 .cindex "DNS" "DNSSEC"
12926 It will be empty if &(DNSSEC)& was not requested,
12927 &"no"& if the result was not labelled as authenticated data
12928 and &"yes"& if it was.
12929 Results that are labelled as authoritative answer that match
12930 the &%dns_trust_aa%& configuration variable count also
12931 as authenticated data.
12932
12933 .vitem &$mailstore_basename$&
12934 .vindex "&$mailstore_basename$&"
12935 This variable is set only when doing deliveries in &"mailstore"& format in the
12936 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12937 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12938 contains the basename of the files that are being written, that is, the name
12939 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12940 variable is empty.
12941
12942 .vitem &$malware_name$&
12943 .vindex "&$malware_name$&"
12944 This variable is available when Exim is compiled with the
12945 content-scanning extension. It is set to the name of the virus that was found
12946 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12947
12948 .vitem &$max_received_linelength$&
12949 .vindex "&$max_received_linelength$&"
12950 .cindex "maximum" "line length"
12951 .cindex "line length" "maximum"
12952 This variable contains the number of bytes in the longest line that was
12953 received as part of the message, not counting the line termination
12954 character(s).
12955 It is not valid if the &%spool_wireformat%& option is used.
12956
12957 .vitem &$message_age$&
12958 .cindex "message" "age of"
12959 .vindex "&$message_age$&"
12960 This variable is set at the start of a delivery attempt to contain the number
12961 of seconds since the message was received. It does not change during a single
12962 delivery attempt.
12963
12964 .vitem &$message_body$&
12965 .cindex "body of message" "expansion variable"
12966 .cindex "message body" "in expansion"
12967 .cindex "binary zero" "in message body"
12968 .vindex "&$message_body$&"
12969 .oindex "&%message_body_visible%&"
12970 This variable contains the initial portion of a message's body while it is
12971 being delivered, and is intended mainly for use in filter files. The maximum
12972 number of characters of the body that are put into the variable is set by the
12973 &%message_body_visible%& configuration option; the default is 500.
12974
12975 .oindex "&%message_body_newlines%&"
12976 By default, newlines are converted into spaces in &$message_body$&, to make it
12977 easier to search for phrases that might be split over a line break. However,
12978 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12979 zeros are always converted into spaces.
12980
12981 .vitem &$message_body_end$&
12982 .cindex "body of message" "expansion variable"
12983 .cindex "message body" "in expansion"
12984 .vindex "&$message_body_end$&"
12985 This variable contains the final portion of a message's
12986 body while it is being delivered. The format and maximum size are as for
12987 &$message_body$&.
12988
12989 .vitem &$message_body_size$&
12990 .cindex "body of message" "size"
12991 .cindex "message body" "size"
12992 .vindex "&$message_body_size$&"
12993 When a message is being delivered, this variable contains the size of the body
12994 in bytes. The count starts from the character after the blank line that
12995 separates the body from the header. Newlines are included in the count. See
12996 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12997
12998 If the spool file is wireformat
12999 (see the &%spool_wireformat%& main option)
13000 the CRLF line-terminators are included in the count.
13001
13002 .vitem &$message_exim_id$&
13003 .vindex "&$message_exim_id$&"
13004 When a message is being received or delivered, this variable contains the
13005 unique message id that is generated and used by Exim to identify the message.
13006 An id is not created for a message until after its header has been successfully
13007 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
13008 line; it is the local id that Exim assigns to the message, for example:
13009 &`1BXTIK-0001yO-VA`&.
13010
13011 .vitem &$message_headers$&
13012 .vindex &$message_headers$&
13013 This variable contains a concatenation of all the header lines when a message
13014 is being processed, except for lines added by routers or transports. The header
13015 lines are separated by newline characters. Their contents are decoded in the
13016 same way as a header line that is inserted by &%bheader%&.
13017
13018 .vitem &$message_headers_raw$&
13019 .vindex &$message_headers_raw$&
13020 This variable is like &$message_headers$& except that no processing of the
13021 contents of header lines is done.
13022
13023 .vitem &$message_id$&
13024 This is an old name for &$message_exim_id$&. It is now deprecated.
13025
13026 .vitem &$message_linecount$&
13027 .vindex "&$message_linecount$&"
13028 This variable contains the total number of lines in the header and body of the
13029 message. Compare &$body_linecount$&, which is the count for the body only.
13030 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
13031 number of lines received. Before delivery happens (that is, before filters,
13032 routers, and transports run) the count is increased to include the
13033 &'Received:'& header line that Exim standardly adds, and also any other header
13034 lines that are added by ACLs. The blank line that separates the message header
13035 from the body is not counted.
13036
13037 As with the special case of &$message_size$&, during the expansion of the
13038 appendfile transport's maildir_tag option in maildir format, the value of
13039 &$message_linecount$& is the precise size of the number of newlines in the
13040 file that has been written (minus one for the blank line between the
13041 header and the body).
13042
13043 Here is an example of the use of this variable in a DATA ACL:
13044 .code
13045 deny condition = \
13046       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
13047      message   = Too many lines in message header
13048 .endd
13049 In the MAIL and RCPT ACLs, the value is zero because at that stage the
13050 message has not yet been received.
13051
13052 This variable is not valid if the &%spool_wireformat%& option is used.
13053
13054 .vitem &$message_size$&
13055 .cindex "size" "of message"
13056 .cindex "message" "size"
13057 .vindex "&$message_size$&"
13058 When a message is being processed, this variable contains its size in bytes. In
13059 most cases, the size includes those headers that were received with the
13060 message, but not those (such as &'Envelope-to:'&) that are added to individual
13061 deliveries as they are written. However, there is one special case: during the
13062 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
13063 doing a delivery in maildir format, the value of &$message_size$& is the
13064 precise size of the file that has been written. See also
13065 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
13066
13067 .cindex "RCPT" "value of &$message_size$&"
13068 While running a per message ACL (mail/rcpt/predata), &$message_size$&
13069 contains the size supplied on the MAIL command, or -1 if no size was given. The
13070 value may not, of course, be truthful.
13071
13072 .vitem &$mime_anomaly_level$& &&&
13073        &$mime_anomaly_text$& &&&
13074        &$mime_boundary$& &&&
13075        &$mime_charset$& &&&
13076        &$mime_content_description$& &&&
13077        &$mime_content_disposition$& &&&
13078        &$mime_content_id$& &&&
13079        &$mime_content_size$& &&&
13080        &$mime_content_transfer_encoding$& &&&
13081        &$mime_content_type$& &&&
13082        &$mime_decoded_filename$& &&&
13083        &$mime_filename$& &&&
13084        &$mime_is_coverletter$& &&&
13085        &$mime_is_multipart$& &&&
13086        &$mime_is_rfc822$& &&&
13087        &$mime_part_count$&
13088 A number of variables whose names start with &$mime$& are
13089 available when Exim is compiled with the content-scanning extension. For
13090 details, see section &<<SECTscanmimepart>>&.
13091
13092 .vitem "&$n0$& &-- &$n9$&"
13093 These variables are counters that can be incremented by means
13094 of the &%add%& command in filter files.
13095
13096 .vitem &$original_domain$&
13097 .vindex "&$domain$&"
13098 .vindex "&$original_domain$&"
13099 When a top-level address is being processed for delivery, this contains the
13100 same value as &$domain$&. However, if a &"child"& address (for example,
13101 generated by an alias, forward, or filter file) is being processed, this
13102 variable contains the domain of the original address (lower cased). This
13103 differs from &$parent_domain$& only when there is more than one level of
13104 aliasing or forwarding. When more than one address is being delivered in a
13105 single transport run, &$original_domain$& is not set.
13106
13107 If a new address is created by means of a &%deliver%& command in a system
13108 filter, it is set up with an artificial &"parent"& address. This has the local
13109 part &'system-filter'& and the default qualify domain.
13110
13111 .vitem &$original_local_part$&
13112 .vindex "&$local_part$&"
13113 .vindex "&$original_local_part$&"
13114 When a top-level address is being processed for delivery, this contains the
13115 same value as &$local_part$&, unless a prefix or suffix was removed from the
13116 local part, because &$original_local_part$& always contains the full local
13117 part. When a &"child"& address (for example, generated by an alias, forward, or
13118 filter file) is being processed, this variable contains the full local part of
13119 the original address.
13120
13121 If the router that did the redirection processed the local part
13122 case-insensitively, the value in &$original_local_part$& is in lower case.
13123 This variable differs from &$parent_local_part$& only when there is more than
13124 one level of aliasing or forwarding. When more than one address is being
13125 delivered in a single transport run, &$original_local_part$& is not set.
13126
13127 If a new address is created by means of a &%deliver%& command in a system
13128 filter, it is set up with an artificial &"parent"& address. This has the local
13129 part &'system-filter'& and the default qualify domain.
13130
13131 .vitem &$originator_gid$&
13132 .cindex "gid (group id)" "of originating user"
13133 .cindex "sender" "gid"
13134 .vindex "&$caller_gid$&"
13135 .vindex "&$originator_gid$&"
13136 This variable contains the value of &$caller_gid$& that was set when the
13137 message was received. For messages received via the command line, this is the
13138 gid of the sending user. For messages received by SMTP over TCP/IP, this is
13139 normally the gid of the Exim user.
13140
13141 .vitem &$originator_uid$&
13142 .cindex "uid (user id)" "of originating user"
13143 .cindex "sender" "uid"
13144 .vindex "&$caller_uid$&"
13145 .vindex "&$originator_uid$&"
13146 The value of &$caller_uid$& that was set when the message was received. For
13147 messages received via the command line, this is the uid of the sending user.
13148 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
13149 user.
13150
13151 .vitem &$parent_domain$&
13152 .vindex "&$parent_domain$&"
13153 This variable is similar to &$original_domain$& (see
13154 above), except that it refers to the immediately preceding parent address.
13155
13156 .vitem &$parent_local_part$&
13157 .vindex "&$parent_local_part$&"
13158 This variable is similar to &$original_local_part$&
13159 (see above), except that it refers to the immediately preceding parent address.
13160
13161 .vitem &$pid$&
13162 .cindex "pid (process id)" "of current process"
13163 .vindex "&$pid$&"
13164 This variable contains the current process id.
13165
13166 .vitem &$pipe_addresses$&
13167 .cindex "filter" "transport filter"
13168 .cindex "transport" "filter"
13169 .vindex "&$pipe_addresses$&"
13170 This is not an expansion variable, but is mentioned here because the string
13171 &`$pipe_addresses`& is handled specially in the command specification for the
13172 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13173 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13174 It cannot be used in general expansion strings, and provokes an &"unknown
13175 variable"& error if encountered.
13176
13177 .vitem &$primary_hostname$&
13178 .vindex "&$primary_hostname$&"
13179 This variable contains the value set by &%primary_hostname%& in the
13180 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13181 a single-component name, Exim calls &[gethostbyname()]& (or
13182 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13183 qualified host name. See also &$smtp_active_hostname$&.
13184
13185
13186 .vitem &$proxy_external_address$& &&&
13187        &$proxy_external_port$& &&&
13188        &$proxy_local_address$& &&&
13189        &$proxy_local_port$& &&&
13190        &$proxy_session$&
13191 These variables are only available when built with Proxy Protocol
13192 or SOCKS5 support.
13193 For details see chapter &<<SECTproxyInbound>>&.
13194
13195 .vitem &$prdr_requested$&
13196 .cindex "PRDR" "variable for"
13197 This variable is set to &"yes"& if PRDR was requested by the client for the
13198 current message, otherwise &"no"&.
13199
13200 .vitem &$prvscheck_address$& &&&
13201        &$prvscheck_keynum$& &&&
13202        &$prvscheck_result$&
13203 These variables are used in conjunction with the &%prvscheck%& expansion item,
13204 which is described in sections &<<SECTexpansionitems>>& and
13205 &<<SECTverifyPRVS>>&.
13206
13207 .vitem &$qualify_domain$&
13208 .vindex "&$qualify_domain$&"
13209 The value set for the &%qualify_domain%& option in the configuration file.
13210
13211 .vitem &$qualify_recipient$&
13212 .vindex "&$qualify_recipient$&"
13213 The value set for the &%qualify_recipient%& option in the configuration file,
13214 or if not set, the value of &$qualify_domain$&.
13215
13216 .vitem &$queue_name$&
13217 .vindex &$queue_name$&
13218 .cindex "named queues" variable
13219 .cindex queues named
13220 The name of the spool queue in use; empty for the default queue.
13221
13222 .vitem &$queue_size$&
13223 .vindex "&$queue_size$&"
13224 .cindex "queue" "size of"
13225 .cindex "spool" "number of messages"
13226 This variable contains the number of messages queued.
13227 It is evaluated on demand, but no more often than once every minute.
13228 If there is no daemon notifier socket open, the value will be
13229 an empty string.
13230
13231 .vitem &$r_...$&
13232 .vindex &$r_...$&
13233 .cindex router variables
13234 Values can be placed in these variables by the &%set%& option of a router.
13235 They can be given any name that starts with &$r_$&.
13236 The values persist for the address being handled through subsequent routers
13237 and the eventual transport.
13238
13239 .vitem &$rcpt_count$&
13240 .vindex "&$rcpt_count$&"
13241 When a message is being received by SMTP, this variable contains the number of
13242 RCPT commands received for the current message. If this variable is used in a
13243 RCPT ACL, its value includes the current command.
13244
13245 .vitem &$rcpt_defer_count$&
13246 .vindex "&$rcpt_defer_count$&"
13247 .cindex "4&'xx'& responses" "count of"
13248 When a message is being received by SMTP, this variable contains the number of
13249 RCPT commands in the current message that have previously been rejected with a
13250 temporary (4&'xx'&) response.
13251
13252 .vitem &$rcpt_fail_count$&
13253 .vindex "&$rcpt_fail_count$&"
13254 When a message is being received by SMTP, this variable contains the number of
13255 RCPT commands in the current message that have previously been rejected with a
13256 permanent (5&'xx'&) response.
13257
13258 .vitem &$received_count$&
13259 .vindex "&$received_count$&"
13260 This variable contains the number of &'Received:'& header lines in the message,
13261 including the one added by Exim (so its value is always greater than zero). It
13262 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13263 delivering.
13264
13265 .vitem &$received_for$&
13266 .vindex "&$received_for$&"
13267 If there is only a single recipient address in an incoming message, this
13268 variable contains that address when the &'Received:'& header line is being
13269 built. The value is copied after recipient rewriting has happened, but before
13270 the &[local_scan()]& function is run.
13271
13272 .vitem &$received_ip_address$& &&&
13273        &$received_port$&
13274 .vindex "&$received_ip_address$&"
13275 .vindex "&$received_port$&"
13276 As soon as an Exim server starts processing an incoming TCP/IP connection, these
13277 variables are set to the address and port on the local IP interface.
13278 (The remote IP address and port are in
13279 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13280 the port value is -1 unless it has been set using the &%-oMi%& command line
13281 option.
13282
13283 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13284 could be used, for example, to make the filename for a TLS certificate depend
13285 on which interface and/or port is being used for the incoming connection. The
13286 values of &$received_ip_address$& and &$received_port$& are saved with any
13287 messages that are received, thus making these variables available at delivery
13288 time.
13289 For outbound connections see &$sending_ip_address$&.
13290
13291 .vitem &$received_protocol$&
13292 .vindex "&$received_protocol$&"
13293 When a message is being processed, this variable contains the name of the
13294 protocol by which it was received. Most of the names used by Exim are defined
13295 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13296 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13297 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13298 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13299 connection and the client was successfully authenticated.
13300
13301 Exim uses the protocol name &"smtps"& for the case when encryption is
13302 automatically set up on connection without the use of STARTTLS (see
13303 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13304 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13305 where the client initially uses EHLO, sets up an encrypted connection using
13306 STARTTLS, and then uses HELO afterwards.
13307
13308 The &%-oMr%& option provides a way of specifying a custom protocol name for
13309 messages that are injected locally by trusted callers. This is commonly used to
13310 identify messages that are being re-injected after some kind of scanning.
13311
13312 .vitem &$received_time$&
13313 .vindex "&$received_time$&"
13314 This variable contains the date and time when the current message was received,
13315 as a number of seconds since the start of the Unix epoch.
13316
13317 .vitem &$recipient_data$&
13318 .vindex "&$recipient_data$&"
13319 This variable is set after an indexing lookup success in an ACL &%recipients%&
13320 condition. It contains the data from the lookup, and the value remains set
13321 until the next &%recipients%& test. Thus, you can do things like this:
13322 .display
13323 &`require recipients  = cdb*@;/some/file`&
13324 &`deny    `&&'some further test involving'& &`$recipient_data`&
13325 .endd
13326 &*Warning*&: This variable is set only when a lookup is used as an indexing
13327 method in the address list, using the semicolon syntax as in the example above.
13328 The variable is not set for a lookup that is used as part of the string
13329 expansion that all such lists undergo before being interpreted.
13330
13331 .vitem &$recipient_verify_failure$&
13332 .vindex "&$recipient_verify_failure$&"
13333 In an ACL, when a recipient verification fails, this variable contains
13334 information about the failure. It is set to one of the following words:
13335
13336 .ilist
13337 &"qualify"&: The address was unqualified (no domain), and the message
13338 was neither local nor came from an exempted host.
13339
13340 .next
13341 &"route"&: Routing failed.
13342
13343 .next
13344 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13345 or before the MAIL command (that is, on initial connection, HELO, or
13346 MAIL).
13347
13348 .next
13349 &"recipient"&: The RCPT command in a callout was rejected.
13350 .next
13351
13352 &"postmaster"&: The postmaster check in a callout was rejected.
13353 .endlist
13354
13355 The main use of this variable is expected to be to distinguish between
13356 rejections of MAIL and rejections of RCPT.
13357
13358 .vitem &$recipients$&
13359 .vindex "&$recipients$&"
13360 This variable contains a list of envelope recipients for a message. A comma and
13361 a space separate the addresses in the replacement text. However, the variable
13362 is not generally available, to prevent exposure of Bcc recipients in
13363 unprivileged users' filter files. You can use &$recipients$& only in these
13364 cases:
13365
13366 .olist
13367 In a system filter file.
13368 .next
13369 In the ACLs associated with the DATA command and with non-SMTP messages, that
13370 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13371 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13372 &%acl_not_smtp_mime%&.
13373 .next
13374 From within a &[local_scan()]& function.
13375 .endlist
13376
13377
13378 .vitem &$recipients_count$&
13379 .vindex "&$recipients_count$&"
13380 When a message is being processed, this variable contains the number of
13381 envelope recipients that came with the message. Duplicates are not excluded
13382 from the count. While a message is being received over SMTP, the number
13383 increases for each accepted recipient. It can be referenced in an ACL.
13384
13385
13386 .vitem &$regex_match_string$&
13387 .vindex "&$regex_match_string$&"
13388 This variable is set to contain the matching regular expression after a
13389 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13390
13391 .vitem "&$regex1$&, &$regex2$&, etc"
13392 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13393 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13394 these variables contain the
13395 captured substrings identified by the regular expression.
13396
13397
13398 .vitem &$reply_address$&
13399 .vindex "&$reply_address$&"
13400 When a message is being processed, this variable contains the contents of the
13401 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13402 contents of the &'From:'& header line. Apart from the removal of leading
13403 white space, the value is not processed in any way. In particular, no RFC 2047
13404 decoding or character code translation takes place.
13405
13406 .vitem &$return_path$&
13407 .vindex "&$return_path$&"
13408 When a message is being delivered, this variable contains the return path &--
13409 the sender field that will be sent as part of the envelope. It is not enclosed
13410 in <> characters. At the start of routing an address, &$return_path$& has the
13411 same value as &$sender_address$&, but if, for example, an incoming message to a
13412 mailing list has been expanded by a router which specifies a different address
13413 for bounce messages, &$return_path$& subsequently contains the new bounce
13414 address, whereas &$sender_address$& always contains the original sender address
13415 that was received with the message. In other words, &$sender_address$& contains
13416 the incoming envelope sender, and &$return_path$& contains the outgoing
13417 envelope sender.
13418
13419 .vitem &$return_size_limit$&
13420 .vindex "&$return_size_limit$&"
13421 This is an obsolete name for &$bounce_return_size_limit$&.
13422
13423 .vitem &$router_name$&
13424 .cindex "router" "name"
13425 .cindex "name" "of router"
13426 .vindex "&$router_name$&"
13427 During the running of a router this variable contains its name.
13428
13429 .vitem &$runrc$&
13430 .cindex "return code" "from &%run%& expansion"
13431 .vindex "&$runrc$&"
13432 This variable contains the return code from a command that is run by the
13433 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13434 assume the order in which option values are expanded, except for those
13435 preconditions whose order of testing is documented. Therefore, you cannot
13436 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13437 another.
13438
13439 .vitem &$self_hostname$&
13440 .oindex "&%self%&" "value of host name"
13441 .vindex "&$self_hostname$&"
13442 When an address is routed to a supposedly remote host that turns out to be the
13443 local host, what happens is controlled by the &%self%& generic router option.
13444 One of its values causes the address to be passed to another router. When this
13445 happens, &$self_hostname$& is set to the name of the local host that the
13446 original router encountered. In other circumstances its contents are null.
13447
13448 .vitem &$sender_address$&
13449 .vindex "&$sender_address$&"
13450 When a message is being processed, this variable contains the sender's address
13451 that was received in the message's envelope. The case of letters in the address
13452 is retained, in both the local part and the domain. For bounce messages, the
13453 value of this variable is the empty string. See also &$return_path$&.
13454
13455 .vitem &$sender_address_data$&
13456 .vindex "&$address_data$&"
13457 .vindex "&$sender_address_data$&"
13458 If &$address_data$& is set when the routers are called from an ACL to verify a
13459 sender address, the final value is preserved in &$sender_address_data$&, to
13460 distinguish it from data from a recipient address. The value does not persist
13461 after the end of the current ACL statement. If you want to preserve it for
13462 longer, you can save it in an ACL variable.
13463
13464 .vitem &$sender_address_domain$&
13465 .vindex "&$sender_address_domain$&"
13466 The domain portion of &$sender_address$&.
13467
13468 .vitem &$sender_address_local_part$&
13469 .vindex "&$sender_address_local_part$&"
13470 The local part portion of &$sender_address$&.
13471
13472 .vitem &$sender_data$&
13473 .vindex "&$sender_data$&"
13474 This variable is set after a lookup success in an ACL &%senders%& condition or
13475 in a router &%senders%& option. It contains the data from the lookup, and the
13476 value remains set until the next &%senders%& test. Thus, you can do things like
13477 this:
13478 .display
13479 &`require senders      = cdb*@;/some/file`&
13480 &`deny    `&&'some further test involving'& &`$sender_data`&
13481 .endd
13482 &*Warning*&: This variable is set only when a lookup is used as an indexing
13483 method in the address list, using the semicolon syntax as in the example above.
13484 The variable is not set for a lookup that is used as part of the string
13485 expansion that all such lists undergo before being interpreted.
13486
13487 .vitem &$sender_fullhost$&
13488 .vindex "&$sender_fullhost$&"
13489 When a message is received from a remote host, this variable contains the host
13490 name and IP address in a single string. It ends with the IP address in square
13491 brackets, followed by a colon and a port number if the logging of ports is
13492 enabled. The format of the rest of the string depends on whether the host
13493 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13494 looking up its IP address. (Looking up the IP address can be forced by the
13495 &%host_lookup%& option, independent of verification.) A plain host name at the
13496 start of the string is a verified host name; if this is not present,
13497 verification either failed or was not requested. A host name in parentheses is
13498 the argument of a HELO or EHLO command. This is omitted if it is identical to
13499 the verified host name or to the host's IP address in square brackets.
13500
13501 .vitem &$sender_helo_dnssec$&
13502 .vindex "&$sender_helo_dnssec$&"
13503 This boolean variable is true if a successful HELO verification was
13504 .cindex "DNS" "DNSSEC"
13505 done using DNS information the resolver library stated was authenticated data.
13506
13507 .vitem &$sender_helo_name$&
13508 .vindex "&$sender_helo_name$&"
13509 When a message is received from a remote host that has issued a HELO or EHLO
13510 command, the argument of that command is placed in this variable. It is also
13511 set if HELO or EHLO is used when a message is received using SMTP locally via
13512 the &%-bs%& or &%-bS%& options.
13513
13514 .vitem &$sender_host_address$&
13515 .vindex "&$sender_host_address$&"
13516 When a message is received from a remote host using SMTP,
13517 this variable contains that
13518 host's IP address. For locally non-SMTP submitted messages, it is empty.
13519
13520 .vitem &$sender_host_authenticated$&
13521 .vindex "&$sender_host_authenticated$&"
13522 This variable contains the name (not the public name) of the authenticator
13523 driver that successfully authenticated the client from which the message was
13524 received. It is empty if there was no successful authentication. See also
13525 &$authenticated_id$&.
13526
13527 .vitem &$sender_host_dnssec$&
13528 .vindex "&$sender_host_dnssec$&"
13529 If an attempt to populate &$sender_host_name$& has been made
13530 (by reference, &%hosts_lookup%& or
13531 otherwise) then this boolean will have been set true if, and only if, the
13532 resolver library states that both
13533 the reverse and forward DNS were authenticated data.  At all
13534 other times, this variable is false.
13535
13536 .cindex "DNS" "DNSSEC"
13537 It is likely that you will need to coerce DNSSEC support on in the resolver
13538 library, by setting:
13539 .code
13540 dns_dnssec_ok = 1
13541 .endd
13542
13543 In addition, on Linux with glibc 2.31 or newer the resolver library will
13544 default to stripping out a successful validation status.
13545 This will break a previously working Exim installation.
13546 Provided that you do trust the resolver (ie, is on localhost) you can tell
13547 glibc to pass through any successful validation with a new option in
13548 &_/etc/resolv.conf_&:
13549 .code
13550 options trust-ad
13551 .endd
13552
13553 Exim does not perform DNSSEC validation itself, instead leaving that to a
13554 validating resolver (e.g. unbound, or bind with suitable configuration).
13555
13556 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13557 mechanism in the list, then this variable will be false.
13558
13559 This requires that your system resolver library support EDNS0 (and that
13560 DNSSEC flags exist in the system headers).  If the resolver silently drops
13561 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13562 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13563
13564
13565 .vitem &$sender_host_name$&
13566 .vindex "&$sender_host_name$&"
13567 When a message is received from a remote host, this variable contains the
13568 host's name as obtained by looking up its IP address. For messages received by
13569 other means, this variable is empty.
13570
13571 .vindex "&$host_lookup_failed$&"
13572 If the host name has not previously been looked up, a reference to
13573 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13574 A looked up name is accepted only if it leads back to the original IP address
13575 via a forward lookup. If either the reverse or the forward lookup fails to find
13576 any data, or if the forward lookup does not yield the original IP address,
13577 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13578
13579 .vindex "&$host_lookup_deferred$&"
13580 However, if either of the lookups cannot be completed (for example, there is a
13581 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13582 &$host_lookup_failed$& remains set to &"0"&.
13583
13584 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13585 host name again if there is a subsequent reference to &$sender_host_name$&
13586 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13587 is set to &"1"&.
13588
13589 Exim does not automatically look up every calling host's name. If you want
13590 maximum efficiency, you should arrange your configuration so that it avoids
13591 these lookups altogether. The lookup happens only if one or more of the
13592 following are true:
13593
13594 .ilist
13595 A string containing &$sender_host_name$& is expanded.
13596 .next
13597 The calling host matches the list in &%host_lookup%&. In the default
13598 configuration, this option is set to *, so it must be changed if lookups are
13599 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13600 .next
13601 Exim needs the host name in order to test an item in a host list. The items
13602 that require this are described in sections &<<SECThoslispatnam>>& and
13603 &<<SECThoslispatnamsk>>&.
13604 .next
13605 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13606 In this case, the host name is required to compare with the name quoted in any
13607 EHLO or HELO commands that the client issues.
13608 .next
13609 The remote host issues a EHLO or HELO command that quotes one of the
13610 domains in &%helo_lookup_domains%&. The default value of this option is
13611 . ==== As this is a nested list, any displays it contains must be indented
13612 . ==== as otherwise they are too far to the left.
13613 .code
13614   helo_lookup_domains = @ : @[]
13615 .endd
13616 which causes a lookup if a remote host (incorrectly) gives the server's name or
13617 IP address in an EHLO or HELO command.
13618 .endlist
13619
13620
13621 .vitem &$sender_host_port$&
13622 .vindex "&$sender_host_port$&"
13623 When a message is received from a remote host, this variable contains the port
13624 number that was used on the remote host.
13625
13626 .vitem &$sender_ident$&
13627 .vindex "&$sender_ident$&"
13628 When a message is received from a remote host, this variable contains the
13629 identification received in response to an RFC 1413 request. When a message has
13630 been received locally, this variable contains the login name of the user that
13631 called Exim.
13632
13633 .vitem &$sender_rate_$&&'xxx'&
13634 A number of variables whose names begin &$sender_rate_$& are set as part of the
13635 &%ratelimit%& ACL condition. Details are given in section
13636 &<<SECTratelimiting>>&.
13637
13638 .vitem &$sender_rcvhost$&
13639 .cindex "DNS" "reverse lookup"
13640 .cindex "reverse DNS lookup"
13641 .vindex "&$sender_rcvhost$&"
13642 This is provided specifically for use in &'Received:'& headers. It starts with
13643 either the verified host name (as obtained from a reverse DNS lookup) or, if
13644 there is no verified host name, the IP address in square brackets. After that
13645 there may be text in parentheses. When the first item is a verified host name,
13646 the first thing in the parentheses is the IP address in square brackets,
13647 followed by a colon and a port number if port logging is enabled. When the
13648 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13649 the parentheses.
13650
13651 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13652 was used and its argument was not identical to the real host name or IP
13653 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13654 all three items are present in the parentheses, a newline and tab are inserted
13655 into the string, to improve the formatting of the &'Received:'& header.
13656
13657 .vitem &$sender_verify_failure$&
13658 .vindex "&$sender_verify_failure$&"
13659 In an ACL, when a sender verification fails, this variable contains information
13660 about the failure. The details are the same as for
13661 &$recipient_verify_failure$&.
13662
13663 .vitem &$sending_ip_address$&
13664 .vindex "&$sending_ip_address$&"
13665 This variable is set whenever an outgoing SMTP connection to another host has
13666 been set up. It contains the IP address of the local interface that is being
13667 used. This is useful if a host that has more than one IP address wants to take
13668 on different personalities depending on which one is being used. For incoming
13669 connections, see &$received_ip_address$&.
13670
13671 .vitem &$sending_port$&
13672 .vindex "&$sending_port$&"
13673 This variable is set whenever an outgoing SMTP connection to another host has
13674 been set up. It contains the local port that is being used. For incoming
13675 connections, see &$received_port$&.
13676
13677 .vitem &$smtp_active_hostname$&
13678 .vindex "&$smtp_active_hostname$&"
13679 During an incoming SMTP session, this variable contains the value of the active
13680 host name, as specified by the &%smtp_active_hostname%& option. The value of
13681 &$smtp_active_hostname$& is saved with any message that is received, so its
13682 value can be consulted during routing and delivery.
13683
13684 .vitem &$smtp_command$&
13685 .vindex "&$smtp_command$&"
13686 During the processing of an incoming SMTP command, this variable contains the
13687 entire command. This makes it possible to distinguish between HELO and EHLO in
13688 the HELO ACL, and also to distinguish between commands such as these:
13689 .code
13690 MAIL FROM:<>
13691 MAIL FROM: <>
13692 .endd
13693 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13694 command, the address in &$smtp_command$& is the original address before any
13695 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13696 the address after SMTP-time rewriting.
13697
13698 .vitem &$smtp_command_argument$&
13699 .cindex "SMTP" "command, argument for"
13700 .vindex "&$smtp_command_argument$&"
13701 While an ACL is running to check an SMTP command, this variable contains the
13702 argument, that is, the text that follows the command name, with leading white
13703 space removed. Following the introduction of &$smtp_command$&, this variable is
13704 somewhat redundant, but is retained for backwards compatibility.
13705
13706 .vitem &$smtp_command_history$&
13707 .cindex SMTP "command history"
13708 .vindex "&$smtp_command_history$&"
13709 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13710 received, in time-order left to right.  Only a limited number of commands
13711 are remembered.
13712
13713 .vitem &$smtp_count_at_connection_start$&
13714 .vindex "&$smtp_count_at_connection_start$&"
13715 This variable is set greater than zero only in processes spawned by the Exim
13716 daemon for handling incoming SMTP connections. The name is deliberately long,
13717 in order to emphasize what the contents are. When the daemon accepts a new
13718 connection, it increments this variable. A copy of the variable is passed to
13719 the child process that handles the connection, but its value is fixed, and
13720 never changes. It is only an approximation of how many incoming connections
13721 there actually are, because many other connections may come and go while a
13722 single connection is being processed. When a child process terminates, the
13723 daemon decrements its copy of the variable.
13724
13725 .vitem "&$sn0$& &-- &$sn9$&"
13726 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13727 that were current at the end of the system filter file. This allows a system
13728 filter file to set values that can be tested in users' filter files. For
13729 example, a system filter could set a value indicating how likely it is that a
13730 message is junk mail.
13731
13732 .vitem &$spam_score$& &&&
13733        &$spam_score_int$& &&&
13734        &$spam_bar$& &&&
13735        &$spam_report$& &&&
13736        &$spam_action$&
13737 A number of variables whose names start with &$spam$& are available when Exim
13738 is compiled with the content-scanning extension. For details, see section
13739 &<<SECTscanspamass>>&.
13740
13741 .vitem &$spf_header_comment$& &&&
13742        &$spf_received$& &&&
13743        &$spf_result$& &&&
13744        &$spf_result_guessed$& &&&
13745        &$spf_smtp_comment$&
13746 These variables are only available if Exim is built with SPF support.
13747 For details see section &<<SECSPF>>&.
13748
13749 .vitem &$spool_directory$&
13750 .vindex "&$spool_directory$&"
13751 The name of Exim's spool directory.
13752
13753 .vitem &$spool_inodes$&
13754 .vindex "&$spool_inodes$&"
13755 The number of free inodes in the disk partition where Exim's spool files are
13756 being written. The value is recalculated whenever the variable is referenced.
13757 If the relevant file system does not have the concept of inodes, the value of
13758 is -1. See also the &%check_spool_inodes%& option.
13759
13760 .vitem &$spool_space$&
13761 .vindex "&$spool_space$&"
13762 The amount of free space (as a number of kilobytes) in the disk partition where
13763 Exim's spool files are being written. The value is recalculated whenever the
13764 variable is referenced. If the operating system does not have the ability to
13765 find the amount of free space (only true for experimental systems), the space
13766 value is -1. For example, to check in an ACL that there is at least 50
13767 megabytes free on the spool, you could write:
13768 .code
13769 condition = ${if > {$spool_space}{50000}}
13770 .endd
13771 See also the &%check_spool_space%& option.
13772
13773
13774 .vitem &$thisaddress$&
13775 .vindex "&$thisaddress$&"
13776 This variable is set only during the processing of the &%foranyaddress%&
13777 command in a filter file. Its use is explained in the description of that
13778 command, which can be found in the separate document entitled &'Exim's
13779 interfaces to mail filtering'&.
13780
13781 .vitem &$tls_in_bits$&
13782 .vindex "&$tls_in_bits$&"
13783 Contains an approximation of the TLS cipher's bit-strength
13784 on the inbound connection; the meaning of
13785 this depends upon the TLS implementation used.
13786 If TLS has not been negotiated, the value will be 0.
13787 The value of this is automatically fed into the Cyrus SASL authenticator
13788 when acting as a server, to specify the "external SSF" (a SASL term).
13789
13790 The deprecated &$tls_bits$& variable refers to the inbound side
13791 except when used in the context of an outbound SMTP delivery, when it refers to
13792 the outbound.
13793
13794 .vitem &$tls_out_bits$&
13795 .vindex "&$tls_out_bits$&"
13796 Contains an approximation of the TLS cipher's bit-strength
13797 on an outbound SMTP connection; the meaning of
13798 this depends upon the TLS implementation used.
13799 If TLS has not been negotiated, the value will be 0.
13800
13801 .vitem &$tls_in_ourcert$&
13802 .vindex "&$tls_in_ourcert$&"
13803 .cindex certificate variables
13804 This variable refers to the certificate presented to the peer of an
13805 inbound connection when the message was received.
13806 It is only useful as the argument of a
13807 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13808 or a &%def%& condition.
13809
13810 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13811 when a list of more than one
13812 file is used for &%tls_certificate%&, this variable is not reliable.
13813 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13814
13815 .vitem &$tls_in_peercert$&
13816 .vindex "&$tls_in_peercert$&"
13817 This variable refers to the certificate presented by the peer of an
13818 inbound connection when the message was received.
13819 It is only useful as the argument of a
13820 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13821 or a &%def%& condition.
13822 If certificate verification fails it may refer to a failing chain element
13823 which is not the leaf.
13824
13825 .vitem &$tls_out_ourcert$&
13826 .vindex "&$tls_out_ourcert$&"
13827 This variable refers to the certificate presented to the peer of an
13828 outbound connection.  It is only useful as the argument of a
13829 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13830 or a &%def%& condition.
13831
13832 .vitem &$tls_out_peercert$&
13833 .vindex "&$tls_out_peercert$&"
13834 This variable refers to the certificate presented by the peer of an
13835 outbound connection.  It is only useful as the argument of a
13836 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13837 or a &%def%& condition.
13838 If certificate verification fails it may refer to a failing chain element
13839 which is not the leaf.
13840
13841 .vitem &$tls_in_certificate_verified$&
13842 .vindex "&$tls_in_certificate_verified$&"
13843 This variable is set to &"1"& if a TLS certificate was verified when the
13844 message was received, and &"0"& otherwise.
13845
13846 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13847 except when used in the context of an outbound SMTP delivery, when it refers to
13848 the outbound.
13849
13850 .vitem &$tls_out_certificate_verified$&
13851 .vindex "&$tls_out_certificate_verified$&"
13852 This variable is set to &"1"& if a TLS certificate was verified when an
13853 outbound SMTP connection was made,
13854 and &"0"& otherwise.
13855
13856 .vitem &$tls_in_cipher$&
13857 .vindex "&$tls_in_cipher$&"
13858 .vindex "&$tls_cipher$&"
13859 When a message is received from a remote host over an encrypted SMTP
13860 connection, this variable is set to the cipher suite that was negotiated, for
13861 example DES-CBC3-SHA. In other circumstances, in particular, for message
13862 received over unencrypted connections, the variable is empty. Testing
13863 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13864 non-encrypted connections during ACL processing.
13865
13866 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13867 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13868 becomes the same as &$tls_out_cipher$&.
13869
13870 .vitem &$tls_in_cipher_std$&
13871 .vindex "&$tls_in_cipher_std$&"
13872 As above, but returning the RFC standard name for the cipher suite.
13873
13874 .vitem &$tls_out_cipher$&
13875 .vindex "&$tls_out_cipher$&"
13876 This variable is
13877 cleared before any outgoing SMTP connection is made,
13878 and then set to the outgoing cipher suite if one is negotiated. See chapter
13879 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13880 details of the &(smtp)& transport.
13881
13882 .vitem &$tls_out_cipher_std$&
13883 .vindex "&$tls_out_cipher_std$&"
13884 As above, but returning the RFC standard name for the cipher suite.
13885
13886 .vitem &$tls_out_dane$&
13887 .vindex &$tls_out_dane$&
13888 DANE active status.  See section &<<SECDANE>>&.
13889
13890 .vitem &$tls_in_ocsp$&
13891 .vindex "&$tls_in_ocsp$&"
13892 When a message is received from a remote client connection
13893 the result of any OCSP request from the client is encoded in this variable:
13894 .code
13895 0 OCSP proof was not requested (default value)
13896 1 No response to request
13897 2 Response not verified
13898 3 Verification failed
13899 4 Verification succeeded
13900 .endd
13901
13902 .vitem &$tls_out_ocsp$&
13903 .vindex "&$tls_out_ocsp$&"
13904 When a message is sent to a remote host connection
13905 the result of any OCSP request made is encoded in this variable.
13906 See &$tls_in_ocsp$& for values.
13907
13908 .vitem &$tls_in_peerdn$&
13909 .vindex "&$tls_in_peerdn$&"
13910 .vindex "&$tls_peerdn$&"
13911 .cindex certificate "extracting fields"
13912 When a message is received from a remote host over an encrypted SMTP
13913 connection, and Exim is configured to request a certificate from the client,
13914 the value of the Distinguished Name of the certificate is made available in the
13915 &$tls_in_peerdn$& during subsequent processing.
13916 If certificate verification fails it may refer to a failing chain element
13917 which is not the leaf.
13918
13919 The deprecated &$tls_peerdn$& variable refers to the inbound side
13920 except when used in the context of an outbound SMTP delivery, when it refers to
13921 the outbound.
13922
13923 .vitem &$tls_out_peerdn$&
13924 .vindex "&$tls_out_peerdn$&"
13925 When a message is being delivered to a remote host over an encrypted SMTP
13926 connection, and Exim is configured to request a certificate from the server,
13927 the value of the Distinguished Name of the certificate is made available in the
13928 &$tls_out_peerdn$& during subsequent processing.
13929 If certificate verification fails it may refer to a failing chain element
13930 which is not the leaf.
13931
13932
13933 .vitem &$tls_in_resumption$& &&&
13934        &$tls_out_resumption$&
13935 .vindex &$tls_in_resumption$&
13936 .vindex &$tls_out_resumption$&
13937 .cindex TLS resumption
13938 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
13939
13940
13941 .vitem &$tls_in_sni$&
13942 .vindex "&$tls_in_sni$&"
13943 .vindex "&$tls_sni$&"
13944 .cindex "TLS" "Server Name Indication"
13945 .cindex "TLS" SNI
13946 .cindex SNI "observability on server"
13947 When a TLS session is being established, if the client sends the Server
13948 Name Indication extension, the value will be placed in this variable.
13949 If the variable appears in &%tls_certificate%& then this option and
13950 some others, described in &<<SECTtlssni>>&,
13951 will be re-expanded early in the TLS session, to permit
13952 a different certificate to be presented (and optionally a different key to be
13953 used) to the client, based upon the value of the SNI extension.
13954
13955 The deprecated &$tls_sni$& variable refers to the inbound side
13956 except when used in the context of an outbound SMTP delivery, when it refers to
13957 the outbound.
13958
13959 .vitem &$tls_out_sni$&
13960 .vindex "&$tls_out_sni$&"
13961 .cindex "TLS" "Server Name Indication"
13962 .cindex "TLS" SNI
13963 .cindex SNI "observability in client"
13964 During outbound
13965 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13966 the transport.
13967
13968 .vitem &$tls_out_tlsa_usage$&
13969 .vindex &$tls_out_tlsa_usage$&
13970 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13971
13972 .vitem &$tls_in_ver$&
13973 .vindex "&$tls_in_ver$&"
13974 When a message is received from a remote host over an encrypted SMTP connection
13975 this variable is set to the protocol version, eg &'TLS1.2'&.
13976
13977 .vitem &$tls_out_ver$&
13978 .vindex "&$tls_out_ver$&"
13979 When a message is being delivered to a remote host over an encrypted SMTP connection
13980 this variable is set to the protocol version.
13981
13982
13983 .vitem &$tod_bsdinbox$&
13984 .vindex "&$tod_bsdinbox$&"
13985 The time of day and the date, in the format required for BSD-style mailbox
13986 files, for example: Thu Oct 17 17:14:09 1995.
13987
13988 .vitem &$tod_epoch$&
13989 .vindex "&$tod_epoch$&"
13990 The time and date as a number of seconds since the start of the Unix epoch.
13991
13992 .vitem &$tod_epoch_l$&
13993 .vindex "&$tod_epoch_l$&"
13994 The time and date as a number of microseconds since the start of the Unix epoch.
13995
13996 .vitem &$tod_full$&
13997 .vindex "&$tod_full$&"
13998 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13999 +0100. The timezone is always given as a numerical offset from UTC, with
14000 positive values used for timezones that are ahead (east) of UTC, and negative
14001 values for those that are behind (west).
14002
14003 .vitem &$tod_log$&
14004 .vindex "&$tod_log$&"
14005 The time and date in the format used for writing Exim's log files, for example:
14006 1995-10-12 15:32:29, but without a timezone.
14007
14008 .vitem &$tod_logfile$&
14009 .vindex "&$tod_logfile$&"
14010 This variable contains the date in the format yyyymmdd. This is the format that
14011 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
14012 flag.
14013
14014 .vitem &$tod_zone$&
14015 .vindex "&$tod_zone$&"
14016 This variable contains the numerical value of the local timezone, for example:
14017 -0500.
14018
14019 .vitem &$tod_zulu$&
14020 .vindex "&$tod_zulu$&"
14021 This variable contains the UTC date and time in &"Zulu"& format, as specified
14022 by ISO 8601, for example: 20030221154023Z.
14023
14024 .vitem &$transport_name$&
14025 .cindex "transport" "name"
14026 .cindex "name" "of transport"
14027 .vindex "&$transport_name$&"
14028 During the running of a transport, this variable contains its name.
14029
14030 .vitem &$value$&
14031 .vindex "&$value$&"
14032 This variable contains the result of an expansion lookup, extraction operation,
14033 or external command, as described above. It is also used during a
14034 &*reduce*& expansion.
14035
14036 .vitem &$verify_mode$&
14037 .vindex "&$verify_mode$&"
14038 While a router or transport is being run in verify mode or for cutthrough delivery,
14039 contains "S" for sender-verification or "R" for recipient-verification.
14040 Otherwise, empty.
14041
14042 .vitem &$version_number$&
14043 .vindex "&$version_number$&"
14044 The version number of Exim. Same as &$exim_version$&, may be overridden
14045 by the &%exim_version%& main config option.
14046
14047 .vitem &$warn_message_delay$&
14048 .vindex "&$warn_message_delay$&"
14049 This variable is set only during the creation of a message warning about a
14050 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14051
14052 .vitem &$warn_message_recipients$&
14053 .vindex "&$warn_message_recipients$&"
14054 This variable is set only during the creation of a message warning about a
14055 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14056 .endlist
14057 .ecindex IIDstrexp
14058
14059
14060
14061 . ////////////////////////////////////////////////////////////////////////////
14062 . ////////////////////////////////////////////////////////////////////////////
14063
14064 .chapter "Embedded Perl" "CHAPperl"
14065 .scindex IIDperl "Perl" "calling from Exim"
14066 Exim can be built to include an embedded Perl interpreter. When this is done,
14067 Perl subroutines can be called as part of the string expansion process. To make
14068 use of the Perl support, you need version 5.004 or later of Perl installed on
14069 your system. To include the embedded interpreter in the Exim binary, include
14070 the line
14071 .code
14072 EXIM_PERL = perl.o
14073 .endd
14074 in your &_Local/Makefile_& and then build Exim in the normal way.
14075
14076
14077 .section "Setting up so Perl can be used" "SECID85"
14078 .oindex "&%perl_startup%&"
14079 Access to Perl subroutines is via a global configuration option called
14080 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
14081 no &%perl_startup%& option in the Exim configuration file then no Perl
14082 interpreter is started and there is almost no overhead for Exim (since none of
14083 the Perl library will be paged in unless used). If there is a &%perl_startup%&
14084 option then the associated value is taken to be Perl code which is executed in
14085 a newly created Perl interpreter.
14086
14087 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
14088 need backslashes before any characters to escape special meanings. The option
14089 should usually be something like
14090 .code
14091 perl_startup = do '/etc/exim.pl'
14092 .endd
14093 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
14094 use from Exim. Exim can be configured either to start up a Perl interpreter as
14095 soon as it is entered, or to wait until the first time it is needed. Starting
14096 the interpreter at the beginning ensures that it is done while Exim still has
14097 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
14098 fact used in a particular run. Also, note that this does not mean that Exim is
14099 necessarily running as root when Perl is called at a later time. By default,
14100 the interpreter is started only when it is needed, but this can be changed in
14101 two ways:
14102
14103 .ilist
14104 .oindex "&%perl_at_start%&"
14105 Setting &%perl_at_start%& (a boolean option) in the configuration requests
14106 a startup when Exim is entered.
14107 .next
14108 The command line option &%-ps%& also requests a startup when Exim is entered,
14109 overriding the setting of &%perl_at_start%&.
14110 .endlist
14111
14112 There is also a command line option &%-pd%& (for delay) which suppresses the
14113 initial startup, even if &%perl_at_start%& is set.
14114
14115 .ilist
14116 .oindex "&%perl_taintmode%&"
14117 .cindex "Perl" "taintmode"
14118 To provide more security executing Perl code via the embedded Perl
14119 interpreter, the &%perl_taintmode%& option can be set. This enables the
14120 taint mode of the Perl interpreter. You are encouraged to set this
14121 option to a true value. To avoid breaking existing installations, it
14122 defaults to false.
14123
14124 &*Note*&: This is entirely separate from Exim's tainted-data tracking.
14125
14126
14127 .section "Calling Perl subroutines" "SECID86"
14128 When the configuration file includes a &%perl_startup%& option you can make use
14129 of the string expansion item to call the Perl subroutines that are defined
14130 by the &%perl_startup%& code. The operator is used in any of the following
14131 forms:
14132 .code
14133 ${perl{foo}}
14134 ${perl{foo}{argument}}
14135 ${perl{foo}{argument1}{argument2} ... }
14136 .endd
14137 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
14138 arguments may be passed. Passing more than this results in an expansion failure
14139 with an error message of the form
14140 .code
14141 Too many arguments passed to Perl subroutine "foo" (max is 8)
14142 .endd
14143 The return value of the Perl subroutine is evaluated in a scalar context before
14144 it is passed back to Exim to be inserted into the expanded string. If the
14145 return value is &'undef'&, the expansion is forced to fail in the same way as
14146 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
14147 by obeying Perl's &%die%& function, the expansion fails with the error message
14148 that was passed to &%die%&.
14149
14150
14151 .section "Calling Exim functions from Perl" "SECID87"
14152 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
14153 is available to call back into Exim's string expansion function. For example,
14154 the Perl code
14155 .code
14156 my $lp = Exim::expand_string('$local_part');
14157 .endd
14158 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14159 Note those are single quotes and not double quotes to protect against
14160 &$local_part$& being interpolated as a Perl variable.
14161
14162 If the string expansion is forced to fail by a &"fail"& item, the result of
14163 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14164 expansion string, the Perl call from the original expansion string fails with
14165 an appropriate error message, in the same way as if &%die%& were used.
14166
14167 .cindex "debugging" "from embedded Perl"
14168 .cindex "log" "writing from embedded Perl"
14169 Two other Exim functions are available for use from within Perl code.
14170 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14171 debugging is enabled. If you want a newline at the end, you must supply it.
14172 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14173 timestamp. In this case, you should not supply a terminating newline.
14174
14175
14176 .section "Use of standard output and error by Perl" "SECID88"
14177 .cindex "Perl" "standard output and error"
14178 You should not write to the standard error or output streams from within your
14179 Perl code, as it is not defined how these are set up. In versions of Exim
14180 before 4.50, it is possible for the standard output or error to refer to the
14181 SMTP connection during message reception via the daemon. Writing to this stream
14182 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14183 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14184 avoided, but the output is lost.
14185
14186 .cindex "Perl" "use of &%warn%&"
14187 The Perl &%warn%& statement writes to the standard error stream by default.
14188 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14189 you have no control. When Exim starts up the Perl interpreter, it arranges for
14190 output from the &%warn%& statement to be written to the Exim main log. You can
14191 change this by including appropriate Perl magic somewhere in your Perl code.
14192 For example, to discard &%warn%& output completely, you need this:
14193 .code
14194 $SIG{__WARN__} = sub { };
14195 .endd
14196 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14197 example, the code for the subroutine is empty, so it does nothing, but you can
14198 include any Perl code that you like. The text of the &%warn%& message is passed
14199 as the first subroutine argument.
14200 .ecindex IIDperl
14201
14202
14203 . ////////////////////////////////////////////////////////////////////////////
14204 . ////////////////////////////////////////////////////////////////////////////
14205
14206 .chapter "Starting the daemon and the use of network interfaces" &&&
14207          "CHAPinterfaces" &&&
14208          "Starting the daemon"
14209 .cindex "daemon" "starting"
14210 .cindex "interface" "listening"
14211 .cindex "network interface"
14212 .cindex "interface" "network"
14213 .cindex "IP address" "for listening"
14214 .cindex "daemon" "listening IP addresses"
14215 .cindex "TCP/IP" "setting listening interfaces"
14216 .cindex "TCP/IP" "setting listening ports"
14217 A host that is connected to a TCP/IP network may have one or more physical
14218 hardware network interfaces. Each of these interfaces may be configured as one
14219 or more &"logical"& interfaces, which are the entities that a program actually
14220 works with. Each of these logical interfaces is associated with an IP address.
14221 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14222 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14223 knowledge about the host's interfaces for use in three different circumstances:
14224
14225 .olist
14226 When a listening daemon is started, Exim needs to know which interfaces
14227 and ports to listen on.
14228 .next
14229 When Exim is routing an address, it needs to know which IP addresses
14230 are associated with local interfaces. This is required for the correct
14231 processing of MX lists by removing the local host and others with the
14232 same or higher priority values. Also, Exim needs to detect cases
14233 when an address is routed to an IP address that in fact belongs to the
14234 local host. Unless the &%self%& router option or the &%allow_localhost%&
14235 option of the smtp transport is set (as appropriate), this is treated
14236 as an error situation.
14237 .next
14238 When Exim connects to a remote host, it may need to know which interface to use
14239 for the outgoing connection.
14240 .endlist
14241
14242
14243 Exim's default behaviour is likely to be appropriate in the vast majority
14244 of cases. If your host has only one interface, and you want all its IP
14245 addresses to be treated in the same way, and you are using only the
14246 standard SMTP port, you should not need to take any special action. The
14247 rest of this chapter does not apply to you.
14248
14249 In a more complicated situation you may want to listen only on certain
14250 interfaces, or on different ports, and for this reason there are a number of
14251 options that can be used to influence Exim's behaviour. The rest of this
14252 chapter describes how they operate.
14253
14254 When a message is received over TCP/IP, the interface and port that were
14255 actually used are set in &$received_ip_address$& and &$received_port$&.
14256
14257
14258
14259 .section "Starting a listening daemon" "SECID89"
14260 When a listening daemon is started (by means of the &%-bd%& command line
14261 option), the interfaces and ports on which it listens are controlled by the
14262 following options:
14263
14264 .ilist
14265 &%daemon_smtp_ports%& contains a list of default ports
14266 or service names.
14267 (For backward compatibility, this option can also be specified in the singular.)
14268 .next
14269 &%local_interfaces%& contains list of interface IP addresses on which to
14270 listen. Each item may optionally also specify a port.
14271 .endlist
14272
14273 The default list separator in both cases is a colon, but this can be changed as
14274 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14275 it is usually best to change the separator to avoid having to double all the
14276 colons. For example:
14277 .code
14278 local_interfaces = <; 127.0.0.1 ; \
14279                       192.168.23.65 ; \
14280                       ::1 ; \
14281                       3ffe:ffff:836f::fe86:a061
14282 .endd
14283 There are two different formats for specifying a port along with an IP address
14284 in &%local_interfaces%&:
14285
14286 .olist
14287 The port is added onto the address with a dot separator. For example, to listen
14288 on port 1234 on two different IP addresses:
14289 .code
14290 local_interfaces = <; 192.168.23.65.1234 ; \
14291                       3ffe:ffff:836f::fe86:a061.1234
14292 .endd
14293 .next
14294 The IP address is enclosed in square brackets, and the port is added
14295 with a colon separator, for example:
14296 .code
14297 local_interfaces = <; [192.168.23.65]:1234 ; \
14298                       [3ffe:ffff:836f::fe86:a061]:1234
14299 .endd
14300 .endlist
14301
14302 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14303 default setting contains just one port:
14304 .code
14305 daemon_smtp_ports = smtp
14306 .endd
14307 If more than one port is listed, each interface that does not have its own port
14308 specified listens on all of them. Ports that are listed in
14309 &%daemon_smtp_ports%& can be identified either by name (defined in
14310 &_/etc/services_&) or by number. However, when ports are given with individual
14311 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14312
14313
14314
14315 .section "Special IP listening addresses" "SECID90"
14316 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14317 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14318 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14319 instead of setting up separate listening sockets for each interface. The
14320 default value of &%local_interfaces%& is
14321 .code
14322 local_interfaces = 0.0.0.0
14323 .endd
14324 when Exim is built without IPv6 support; otherwise it is:
14325 .code
14326 local_interfaces = <; ::0 ; 0.0.0.0
14327 .endd
14328 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14329
14330
14331
14332 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14333 The &%-oX%& command line option can be used to override the values of
14334 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14335 instance. Another way of doing this would be to use macros and the &%-D%&
14336 option. However, &%-oX%& can be used by any admin user, whereas modification of
14337 the runtime configuration by &%-D%& is allowed only when the caller is root or
14338 exim.
14339
14340 The value of &%-oX%& is a list of items. The default colon separator can be
14341 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14342 If there are any items that do not
14343 contain dots or colons (that is, are not IP addresses), the value of
14344 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14345 items that do contain dots or colons, the value of &%local_interfaces%& is
14346 replaced by those items. Thus, for example,
14347 .code
14348 -oX 1225
14349 .endd
14350 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14351 whereas
14352 .code
14353 -oX 192.168.34.5.1125
14354 .endd
14355 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14356 (However, since &%local_interfaces%& now contains no items without ports, the
14357 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14358
14359
14360
14361 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14362 .cindex "submissions protocol"
14363 .cindex "ssmtp protocol"
14364 .cindex "smtps protocol"
14365 .cindex "SMTP" "ssmtp protocol"
14366 .cindex "SMTP" "smtps protocol"
14367 Exim supports the use of TLS-on-connect, used by mail clients in the
14368 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14369 For some years, IETF Standards Track documents only blessed the
14370 STARTTLS-based Submission service (port 587) while common practice was to support
14371 the same feature set on port 465, but using TLS-on-connect.
14372 If your installation needs to provide service to mail clients
14373 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14374 the 465 TCP ports.
14375
14376 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14377 service names, connections to those ports must first establish TLS, before
14378 proceeding to the application layer use of the SMTP protocol.
14379
14380 The common use of this option is expected to be
14381 .code
14382 tls_on_connect_ports = 465
14383 .endd
14384 per RFC 8314.
14385 There is also a command line option &%-tls-on-connect%&, which forces all ports
14386 to behave in this way when a daemon is started.
14387
14388 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14389 daemon to listen on those ports. You must still specify them in
14390 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14391 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14392 connections via the daemon.)
14393
14394
14395
14396
14397 .section "IPv6 address scopes" "SECID92"
14398 .cindex "IPv6" "address scopes"
14399 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14400 can, in principle, have the same link-local IPv6 address on different
14401 interfaces. Thus, additional information is needed, over and above the IP
14402 address, to distinguish individual interfaces. A convention of using a
14403 percent sign followed by something (often the interface name) has been
14404 adopted in some cases, leading to addresses like this:
14405 .code
14406 fe80::202:b3ff:fe03:45c1%eth0
14407 .endd
14408 To accommodate this usage, a percent sign followed by an arbitrary string is
14409 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14410 to convert a textual IPv6 address for actual use. This function recognizes the
14411 percent convention in operating systems that support it, and it processes the
14412 address appropriately. Unfortunately, some older libraries have problems with
14413 &[getaddrinfo()]&. If
14414 .code
14415 IPV6_USE_INET_PTON=yes
14416 .endd
14417 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14418 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14419 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14420 function.) Of course, this means that the additional functionality of
14421 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14422
14423 .section "Disabling IPv6" "SECID93"
14424 .cindex "IPv6" "disabling"
14425 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14426 run on a host whose kernel does not support IPv6. The binary will fall back to
14427 using IPv4, but it may waste resources looking up AAAA records, and trying to
14428 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14429 .oindex "&%disable_ipv6%&"
14430 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14431 activities take place. AAAA records are never looked up, and any IPv6 addresses
14432 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14433 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14434 to handle IPv6 literal addresses.
14435
14436 On the other hand, when IPv6 is in use, there may be times when you want to
14437 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14438 option to globally suppress the lookup of AAAA records for specified domains,
14439 and you can use the &%ignore_target_hosts%& generic router option to ignore
14440 IPv6 addresses in an individual router.
14441
14442
14443
14444 .section "Examples of starting a listening daemon" "SECID94"
14445 The default case in an IPv6 environment is
14446 .code
14447 daemon_smtp_ports = smtp
14448 local_interfaces = <; ::0 ; 0.0.0.0
14449 .endd
14450 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14451 Either one or two sockets may be used, depending on the characteristics of
14452 the TCP/IP stack. (This is complicated and messy; for more information,
14453 read the comments in the &_daemon.c_& source file.)
14454
14455 To specify listening on ports 25 and 26 on all interfaces:
14456 .code
14457 daemon_smtp_ports = 25 : 26
14458 .endd
14459 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14460 .code
14461 local_interfaces = <; ::0.25     ; ::0.26 \
14462                       0.0.0.0.25 ; 0.0.0.0.26
14463 .endd
14464 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14465 IPv4 loopback address only:
14466 .code
14467 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14468 .endd
14469 To specify listening on the default port on specific interfaces only:
14470 .code
14471 local_interfaces = 10.0.0.67 : 192.168.34.67
14472 .endd
14473 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14474
14475
14476
14477 .section "Recognizing the local host" "SECTreclocipadd"
14478 The &%local_interfaces%& option is also used when Exim needs to determine
14479 whether or not an IP address refers to the local host. That is, the IP
14480 addresses of all the interfaces on which a daemon is listening are always
14481 treated as local.
14482
14483 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14484 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14485 available interfaces from the operating system, and extracts the relevant
14486 (that is, IPv4 or IPv6) addresses to use for checking.
14487
14488 Some systems set up large numbers of virtual interfaces in order to provide
14489 many virtual web servers. In this situation, you may want to listen for
14490 email on only a few of the available interfaces, but nevertheless treat all
14491 interfaces as local when routing. You can do this by setting
14492 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14493 &"all"& wildcard values. These addresses are recognized as local, but are not
14494 used for listening. Consider this example:
14495 .code
14496 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14497                       192.168.53.235 ; \
14498                       3ffe:2101:12:1:a00:20ff:fe86:a061
14499
14500 extra_local_interfaces = <; ::0 ; 0.0.0.0
14501 .endd
14502 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14503 address, but all available interface addresses are treated as local when
14504 Exim is routing.
14505
14506 In some environments the local host name may be in an MX list, but with an IP
14507 address that is not assigned to any local interface. In other cases it may be
14508 desirable to treat other host names as if they referred to the local host. Both
14509 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14510 This contains host names rather than IP addresses. When a host is referenced
14511 during routing, either via an MX record or directly, it is treated as the local
14512 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14513 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14514
14515
14516
14517 .section "Delivering to a remote host" "SECID95"
14518 Delivery to a remote host is handled by the smtp transport. By default, it
14519 allows the system's TCP/IP functions to choose which interface to use (if
14520 there is more than one) when connecting to a remote host. However, the
14521 &%interface%& option can be set to specify which interface is used. See the
14522 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14523 details.
14524
14525
14526
14527
14528 . ////////////////////////////////////////////////////////////////////////////
14529 . ////////////////////////////////////////////////////////////////////////////
14530
14531 .chapter "Main configuration" "CHAPmainconfig"
14532 .scindex IIDconfima "configuration file" "main section"
14533 .scindex IIDmaiconf "main configuration"
14534 The first part of the runtime configuration file contains three types of item:
14535
14536 .ilist
14537 Macro definitions: These lines start with an upper case letter. See section
14538 &<<SECTmacrodefs>>& for details of macro processing.
14539 .next
14540 Named list definitions: These lines start with one of the words &"domainlist"&,
14541 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14542 section &<<SECTnamedlists>>&.
14543 .next
14544 Main configuration settings: Each setting occupies one line of the file
14545 (with possible continuations). If any setting is preceded by the word
14546 &"hide"&, the &%-bP%& command line option displays its value to admin users
14547 only. See section &<<SECTcos>>& for a description of the syntax of these option
14548 settings.
14549 .endlist
14550
14551 This chapter specifies all the main configuration options, along with their
14552 types and default values. For ease of finding a particular option, they appear
14553 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14554 are now so many options, they are first listed briefly in functional groups, as
14555 an aid to finding the name of the option you are looking for. Some options are
14556 listed in more than one group.
14557
14558 .section "Miscellaneous" "SECID96"
14559 .table2
14560 .row &%add_environment%&             "environment variables"
14561 .row &%allow_insecure_tainted_data%& "turn taint errors into warnings"
14562 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14563 .row &%debug_store%&                 "do extra internal checks"
14564 .row &%disable_ipv6%&                "do no IPv6 processing"
14565 .row &%keep_environment%&            "environment variables"
14566 .row &%keep_malformed%&              "for broken files &-- should not happen"
14567 .row &%localhost_number%&            "for unique message ids in clusters"
14568 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14569 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14570 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14571 .row &%print_topbitchars%&           "top-bit characters are printing"
14572 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14573 .row &%timezone%&                    "force time zone"
14574 .endtable
14575
14576
14577 .section "Exim parameters" "SECID97"
14578 .table2
14579 .row &%exim_group%&                  "override compiled-in value"
14580 .row &%exim_path%&                   "override compiled-in value"
14581 .row &%exim_user%&                   "override compiled-in value"
14582 .row &%primary_hostname%&            "default from &[uname()]&"
14583 .row &%split_spool_directory%&       "use multiple directories"
14584 .row &%spool_directory%&             "override compiled-in value"
14585 .endtable
14586
14587
14588
14589 .section "Privilege controls" "SECID98"
14590 .table2
14591 .row &%admin_groups%&                "groups that are Exim admin users"
14592 .row &%commandline_checks_require_admin%& "require admin for various checks"
14593 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14594 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14595 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14596 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14597 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14598 .row &%never_users%&                 "do not run deliveries as these"
14599 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14600 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14601 .row &%trusted_groups%&              "groups that are trusted"
14602 .row &%trusted_users%&               "users that are trusted"
14603 .endtable
14604
14605
14606
14607 .section "Logging" "SECID99"
14608 .table2
14609 .row &%event_action%&                "custom logging"
14610 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14611 .row &%log_file_path%&               "override compiled-in value"
14612 .row &%log_selector%&                "set/unset optional logging"
14613 .row &%log_timezone%&                "add timezone to log lines"
14614 .row &%message_logs%&                "create per-message logs"
14615 .row &%preserve_message_logs%&       "after message completion"
14616 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14617 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14618 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14619 .row &%syslog_facility%&             "set syslog &""facility""& field"
14620 .row &%syslog_pid%&                  "pid in syslog lines"
14621 .row &%syslog_processname%&          "set syslog &""ident""& field"
14622 .row &%syslog_timestamp%&            "timestamp syslog lines"
14623 .row &%write_rejectlog%&             "control use of message log"
14624 .endtable
14625
14626
14627
14628 .section "Frozen messages" "SECID100"
14629 .table2
14630 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14631 .row &%freeze_tell%&                 "send message when freezing"
14632 .row &%move_frozen_messages%&        "to another directory"
14633 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14634 .endtable
14635
14636
14637
14638 .section "Data lookups" "SECID101"
14639 .table2
14640 .row &%ibase_servers%&               "InterBase servers"
14641 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14642 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14643 .row &%ldap_cert_file%&              "client cert file for LDAP"
14644 .row &%ldap_cert_key%&               "client key file for LDAP"
14645 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14646 .row &%ldap_default_servers%&        "used if no server in query"
14647 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14648 .row &%ldap_start_tls%&              "require TLS within LDAP"
14649 .row &%ldap_version%&                "set protocol version"
14650 .row &%lookup_open_max%&             "lookup files held open"
14651 .row &%mysql_servers%&               "default MySQL servers"
14652 .row &%oracle_servers%&              "Oracle servers"
14653 .row &%pgsql_servers%&               "default PostgreSQL servers"
14654 .row &%sqlite_lock_timeout%&         "as it says"
14655 .endtable
14656
14657
14658
14659 .section "Message ids" "SECID102"
14660 .table2
14661 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14662 .row &%message_id_header_text%&      "ditto"
14663 .endtable
14664
14665
14666
14667 .section "Embedded Perl Startup" "SECID103"
14668 .table2
14669 .row &%perl_at_start%&               "always start the interpreter"
14670 .row &%perl_startup%&                "code to obey when starting Perl"
14671 .row &%perl_taintmode%&              "enable taint mode in Perl"
14672 .endtable
14673
14674
14675
14676 .section "Daemon" "SECID104"
14677 .table2
14678 .row &%daemon_smtp_ports%&           "default ports"
14679 .row &%daemon_startup_retries%&      "number of times to retry"
14680 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14681 .row &%extra_local_interfaces%&      "not necessarily listened on"
14682 .row &%local_interfaces%&            "on which to listen, with optional ports"
14683 .row &%notifier_socket%&             "override compiled-in value"
14684 .row &%pid_file_path%&               "override compiled-in value"
14685 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14686 .row &%smtp_backlog_monitor%&        "level to log listen backlog"
14687 .endtable
14688
14689
14690
14691 .section "Resource control" "SECID105"
14692 .table2
14693 .row &%check_log_inodes%&            "before accepting a message"
14694 .row &%check_log_space%&             "before accepting a message"
14695 .row &%check_spool_inodes%&          "before accepting a message"
14696 .row &%check_spool_space%&           "before accepting a message"
14697 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14698 .row &%queue_only_load%&             "queue incoming if load high"
14699 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14700 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14701 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14702 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14703 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14704 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14705 .row &%smtp_accept_max_per_connection%& "messages per connection"
14706 .row &%smtp_accept_max_per_host%&    "connections from one host"
14707 .row &%smtp_accept_queue%&           "queue mail if more connections"
14708 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14709                                            connection"
14710 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14711 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14712 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14713 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14714 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14715 .endtable
14716
14717
14718
14719 .section "Policy controls" "SECID106"
14720 .table2
14721 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14722 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14723 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14724 .row &%acl_smtp_auth%&               "ACL for AUTH"
14725 .row &%acl_smtp_connect%&            "ACL for connection"
14726 .row &%acl_smtp_data%&               "ACL for DATA"
14727 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14728 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14729 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14730 .row &%acl_smtp_expn%&               "ACL for EXPN"
14731 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14732 .row &%acl_smtp_mail%&               "ACL for MAIL"
14733 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14734 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14735 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14736 .row &%acl_smtp_predata%&            "ACL for start of data"
14737 .row &%acl_smtp_quit%&               "ACL for QUIT"
14738 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14739 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14740 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14741 .row &%av_scanner%&                  "specify virus scanner"
14742 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14743                                       words""&"
14744 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14745 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14746 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14747 .row &%header_maxsize%&              "total size of message header"
14748 .row &%header_line_maxsize%&         "individual header line limit"
14749 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14750 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14751 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14752 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14753 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14754 .row &%host_lookup%&                 "host name looked up for these hosts"
14755 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14756 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14757 .row &%host_reject_connection%&      "reject connection from these hosts"
14758 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14759 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14760 .row &%message_size_limit%&          "for all messages"
14761 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14762 .row &%proxy_protocol_timeout%&      "timeout for proxy protocol negotiation"
14763 .row &%spamd_address%&               "set interface to SpamAssassin"
14764 .row &%strict_acl_vars%&             "object to unset ACL variables"
14765 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14766 .endtable
14767
14768
14769
14770 .section "Callout cache" "SECID107"
14771 .table2
14772 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14773                                          item"
14774 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14775                                          item"
14776 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14777 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14778 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14779 .endtable
14780
14781
14782
14783 .section "TLS" "SECID108"
14784 .table2
14785 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14786 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14787 .row &%hosts_require_alpn%&          "mandatory ALPN"
14788 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14789 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14790 .row &%tls_alpn%&                    "acceptable protocol names"
14791 .row &%tls_certificate%&             "location of server certificate"
14792 .row &%tls_crl%&                     "certificate revocation list"
14793 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14794 .row &%tls_dhparam%&                 "DH parameters for server"
14795 .row &%tls_eccurve%&                 "EC curve selection for server"
14796 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14797 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14798 .row &%tls_privatekey%&              "location of server private key"
14799 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14800 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14801 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14802 .row &%tls_verify_certificates%&     "expected client certificates"
14803 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14804 .endtable
14805
14806
14807
14808 .section "Local user handling" "SECID109"
14809 .table2
14810 .row &%finduser_retries%&            "useful in NIS environments"
14811 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14812 .row &%gecos_pattern%&               "ditto"
14813 .row &%max_username_length%&         "for systems that truncate"
14814 .row &%unknown_login%&               "used when no login name found"
14815 .row &%unknown_username%&            "ditto"
14816 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14817 .row &%uucp_from_sender%&            "ditto"
14818 .endtable
14819
14820
14821
14822 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14823 .table2
14824 .row &%header_maxsize%&              "total size of message header"
14825 .row &%header_line_maxsize%&         "individual header line limit"
14826 .row &%message_size_limit%&          "applies to all messages"
14827 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14828 .row &%received_header_text%&        "expanded to make &'Received:'&"
14829 .row &%received_headers_max%&        "for mail loop detection"
14830 .row &%recipients_max%&              "limit per message"
14831 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14832 .endtable
14833
14834
14835
14836
14837 .section "Non-SMTP incoming messages" "SECID111"
14838 .table2
14839 .row &%receive_timeout%&             "for non-SMTP messages"
14840 .endtable
14841
14842
14843
14844
14845
14846 .section "Incoming SMTP messages" "SECID112"
14847 See also the &'Policy controls'& section above.
14848
14849 .table2
14850 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14851 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14852 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14853 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14854 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14855 .row &%dmarc_history_file%&          "DMARC results log"
14856 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14857 .row &%host_lookup%&                 "host name looked up for these hosts"
14858 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14859 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14860 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14861 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14862 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14863 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14864 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14865 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14866 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14867 .row &%smtp_accept_max_per_connection%& "messages per connection"
14868 .row &%smtp_accept_max_per_host%&    "connections from one host"
14869 .row &%smtp_accept_queue%&           "queue mail if more connections"
14870 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14871                                            connection"
14872 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14873 .row &%smtp_active_hostname%&        "host name to use in messages"
14874 .row &%smtp_banner%&                 "text for welcome banner"
14875 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14876 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14877 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14878 .row &%smtp_etrn_command%&           "what to run for ETRN"
14879 .row &%smtp_etrn_serialize%&         "only one at once"
14880 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14881 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14882 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14883 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14884 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14885 .row &%smtp_receive_timeout%&        "per command or data line"
14886 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14887 .row &%smtp_return_error_details%&   "give detail on rejections"
14888 .endtable
14889
14890
14891
14892 .section "SMTP extensions" "SECID113"
14893 .table2
14894 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14895 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14896 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14897 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14898 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14899 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14900 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14901 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14902 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14903 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14904 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14905 .endtable
14906
14907
14908
14909 .section "Processing messages" "SECID114"
14910 .table2
14911 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14912 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14913 .row &%allow_utf8_domains%&          "in addresses"
14914 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14915                                       words""&"
14916 .row &%delivery_date_remove%&        "from incoming messages"
14917 .row &%envelope_to_remove%&          "from incoming messages"
14918 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14919 .row &%headers_charset%&             "default for translations"
14920 .row &%qualify_domain%&              "default for senders"
14921 .row &%qualify_recipient%&           "default for recipients"
14922 .row &%return_path_remove%&          "from incoming messages"
14923 .row &%strip_excess_angle_brackets%& "in addresses"
14924 .row &%strip_trailing_dot%&          "at end of addresses"
14925 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14926 .endtable
14927
14928
14929
14930 .section "System filter" "SECID115"
14931 .table2
14932 .row &%system_filter%&               "locate system filter"
14933 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14934                                             directory"
14935 .row &%system_filter_file_transport%& "transport for delivery to a file"
14936 .row &%system_filter_group%&         "group for filter running"
14937 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14938 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14939 .row &%system_filter_user%&          "user for filter running"
14940 .endtable
14941
14942
14943
14944 .section "Routing and delivery" "SECID116"
14945 .table2
14946 .row &%disable_ipv6%&                "do no IPv6 processing"
14947 .row &%dns_again_means_nonexist%&    "for broken domains"
14948 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14949 .row &%dns_dnssec_ok%&               "parameter for resolver"
14950 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14951 .row &%dns_retrans%&                 "parameter for resolver"
14952 .row &%dns_retry%&                   "parameter for resolver"
14953 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14954 .row &%dns_use_edns0%&               "parameter for resolver"
14955 .row &%hold_domains%&                "hold delivery for these domains"
14956 .row &%local_interfaces%&            "for routing checks"
14957 .row &%queue_domains%&               "no immediate delivery for these"
14958 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
14959 .row &%queue_only%&                  "no immediate delivery at all"
14960 .row &%queue_only_file%&             "no immediate delivery if file exists"
14961 .row &%queue_only_load%&             "no immediate delivery if load is high"
14962 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14963 .row &%queue_only_override%&         "allow command line to override"
14964 .row &%queue_run_in_order%&          "order of arrival"
14965 .row &%queue_run_max%&               "of simultaneous queue runners"
14966 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14967 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14968 .row &%remote_sort_domains%&         "order of remote deliveries"
14969 .row &%retry_data_expire%&           "timeout for retry data"
14970 .row &%retry_interval_max%&          "safety net for retry rules"
14971 .endtable
14972
14973
14974
14975 .section "Bounce and warning messages" "SECID117"
14976 .table2
14977 .row &%bounce_message_file%&         "content of bounce"
14978 .row &%bounce_message_text%&         "content of bounce"
14979 .row &%bounce_return_body%&          "include body if returning message"
14980 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14981 .row &%bounce_return_message%&       "include original message in bounce"
14982 .row &%bounce_return_size_limit%&    "limit on returned message"
14983 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14984 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14985 .row &%errors_copy%&                 "copy bounce messages"
14986 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14987 .row &%delay_warning%&               "time schedule"
14988 .row &%delay_warning_condition%&     "condition for warning messages"
14989 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14990 .row &%smtp_return_error_details%&   "give detail on rejections"
14991 .row &%warn_message_file%&           "content of warning message"
14992 .endtable
14993
14994
14995
14996 .section "Alphabetical list of main options" "SECTalomo"
14997 Those options that undergo string expansion before use are marked with
14998 &dagger;.
14999
15000 .option accept_8bitmime main boolean true
15001 .cindex "8BITMIME"
15002 .cindex "8-bit characters"
15003 .cindex "log" "selectors"
15004 .cindex "log" "8BITMIME"
15005 .cindex "ESMTP extensions" 8BITMIME
15006 This option causes Exim to send 8BITMIME in its response to an SMTP
15007 EHLO command, and to accept the BODY= parameter on MAIL commands.
15008 However, though Exim is 8-bit clean, it is not a protocol converter, and it
15009 takes no steps to do anything special with messages received by this route.
15010
15011 Historically Exim kept this option off by default, but the maintainers
15012 feel that in today's Internet, this causes more problems than it solves.
15013 It now defaults to true.
15014 A more detailed analysis of the issues is provided by Dan Bernstein:
15015 .display
15016 &url(https://cr.yp.to/smtp/8bitmime.html)
15017 .endd
15018
15019 To log received 8BITMIME status use
15020 .code
15021 log_selector = +8bitmime
15022 .endd
15023
15024 .option acl_not_smtp main string&!! unset
15025 .cindex "&ACL;" "for non-SMTP messages"
15026 .cindex "non-SMTP messages" "ACLs for"
15027 This option defines the ACL that is run when a non-SMTP message has been
15028 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
15029 further details.
15030
15031 .option acl_not_smtp_mime main string&!! unset
15032 This option defines the ACL that is run for individual MIME parts of non-SMTP
15033 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
15034 SMTP messages.
15035
15036 .option acl_not_smtp_start main string&!! unset
15037 .cindex "&ACL;" "at start of non-SMTP message"
15038 .cindex "non-SMTP messages" "ACLs for"
15039 This option defines the ACL that is run before Exim starts reading a
15040 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
15041
15042 .option acl_smtp_auth main string&!! unset
15043 .cindex "&ACL;" "setting up for SMTP commands"
15044 .cindex "AUTH" "ACL for"
15045 This option defines the ACL that is run when an SMTP AUTH command is
15046 received. See chapter &<<CHAPACL>>& for further details.
15047
15048 .option acl_smtp_connect main string&!! unset
15049 .cindex "&ACL;" "on SMTP connection"
15050 This option defines the ACL that is run when an SMTP connection is received.
15051 See chapter &<<CHAPACL>>& for further details.
15052
15053 .option acl_smtp_data main string&!! unset
15054 .cindex "DATA" "ACL for"
15055 This option defines the ACL that is run after an SMTP DATA command has been
15056 processed and the message itself has been received, but before the final
15057 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15058
15059 .option acl_smtp_data_prdr main string&!! accept
15060 .cindex "PRDR" "ACL for"
15061 .cindex "DATA" "PRDR ACL for"
15062 .cindex "&ACL;" "PRDR-related"
15063 .cindex "&ACL;" "per-user data processing"
15064 This option defines the ACL that,
15065 if the PRDR feature has been negotiated,
15066 is run for each recipient after an SMTP DATA command has been
15067 processed and the message itself has been received, but before the
15068 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15069
15070 .option acl_smtp_dkim main string&!! unset
15071 .cindex DKIM "ACL for"
15072 This option defines the ACL that is run for each DKIM signature
15073 (by default, or as specified in the dkim_verify_signers option)
15074 of a received message.
15075 See section &<<SECDKIMVFY>>& for further details.
15076
15077 .option acl_smtp_etrn main string&!! unset
15078 .cindex "ETRN" "ACL for"
15079 This option defines the ACL that is run when an SMTP ETRN command is
15080 received. See chapter &<<CHAPACL>>& for further details.
15081
15082 .option acl_smtp_expn main string&!! unset
15083 .cindex "EXPN" "ACL for"
15084 This option defines the ACL that is run when an SMTP EXPN command is
15085 received. See chapter &<<CHAPACL>>& for further details.
15086
15087 .option acl_smtp_helo main string&!! unset
15088 .cindex "EHLO" "ACL for"
15089 .cindex "HELO" "ACL for"
15090 This option defines the ACL that is run when an SMTP EHLO or HELO
15091 command is received. See chapter &<<CHAPACL>>& for further details.
15092
15093
15094 .option acl_smtp_mail main string&!! unset
15095 .cindex "MAIL" "ACL for"
15096 This option defines the ACL that is run when an SMTP MAIL command is
15097 received. See chapter &<<CHAPACL>>& for further details.
15098
15099 .option acl_smtp_mailauth main string&!! unset
15100 .cindex "AUTH" "on MAIL command"
15101 This option defines the ACL that is run when there is an AUTH parameter on
15102 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
15103 &<<CHAPSMTPAUTH>>& for details of authentication.
15104
15105 .option acl_smtp_mime main string&!! unset
15106 .cindex "MIME content scanning" "ACL for"
15107 This option is available when Exim is built with the content-scanning
15108 extension. It defines the ACL that is run for each MIME part in a message. See
15109 section &<<SECTscanmimepart>>& for details.
15110
15111 .option acl_smtp_notquit main string&!! unset
15112 .cindex "not-QUIT, ACL for"
15113 This option defines the ACL that is run when an SMTP session
15114 ends without a QUIT command being received.
15115 See chapter &<<CHAPACL>>& for further details.
15116
15117 .option acl_smtp_predata main string&!! unset
15118 This option defines the ACL that is run when an SMTP DATA command is
15119 received, before the message itself is received. See chapter &<<CHAPACL>>& for
15120 further details.
15121
15122 .option acl_smtp_quit main string&!! unset
15123 .cindex "QUIT, ACL for"
15124 This option defines the ACL that is run when an SMTP QUIT command is
15125 received. See chapter &<<CHAPACL>>& for further details.
15126
15127 .option acl_smtp_rcpt main string&!! unset
15128 .cindex "RCPT" "ACL for"
15129 This option defines the ACL that is run when an SMTP RCPT command is
15130 received. See chapter &<<CHAPACL>>& for further details.
15131
15132 .option acl_smtp_starttls main string&!! unset
15133 .cindex "STARTTLS, ACL for"
15134 This option defines the ACL that is run when an SMTP STARTTLS command is
15135 received. See chapter &<<CHAPACL>>& for further details.
15136
15137 .option acl_smtp_vrfy main string&!! unset
15138 .cindex "VRFY" "ACL for"
15139 This option defines the ACL that is run when an SMTP VRFY command is
15140 received. See chapter &<<CHAPACL>>& for further details.
15141
15142 .option add_environment main "string list" empty
15143 .cindex "environment" "set values"
15144 This option adds individual environment variables that the
15145 currently linked libraries and programs in child processes may use.
15146 Each list element should be of the form &"name=value"&.
15147
15148 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
15149
15150 .option admin_groups main "string list&!!" unset
15151 .cindex "admin user"
15152 This option is expanded just once, at the start of Exim's processing. If the
15153 current group or any of the supplementary groups of an Exim caller is in this
15154 colon-separated list, the caller has admin privileges. If all your system
15155 programmers are in a specific group, for example, you can give them all Exim
15156 admin privileges by putting that group in &%admin_groups%&. However, this does
15157 not permit them to read Exim's spool files (whose group owner is the Exim gid).
15158 To permit this, you have to add individuals to the Exim group.
15159
15160 .option allow_domain_literals main boolean false
15161 .cindex "domain literal"
15162 If this option is set, the RFC 2822 domain literal format is permitted in
15163 email addresses. The option is not set by default, because the domain literal
15164 format is not normally required these days, and few people know about it. It
15165 has, however, been exploited by mail abusers.
15166
15167 Unfortunately, it seems that some DNS black list maintainers are using this
15168 format to report black listing to postmasters. If you want to accept messages
15169 addressed to your hosts by IP address, you need to set
15170 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15171 domains (defined in the named domain list &%local_domains%& in the default
15172 configuration). This &"magic string"& matches the domain literal form of all
15173 the local host's IP addresses.
15174
15175 .option allow_insecure_tainted_data main boolean false
15176 .cindex "de-tainting"
15177 .oindex "allow_insecure_tainted_data"
15178 The handling of tainted data may break older (pre 4.94) configurations.
15179 Setting this option to "true" turns taint errors (which result in a temporary
15180 message rejection) into warnings. This option is meant as mitigation only
15181 and deprecated already today. Future releases of Exim may ignore it.
15182 The &%taint%& log selector can be used to suppress even the warnings.
15183
15184
15185
15186 .option allow_mx_to_ip main boolean false
15187 .cindex "MX record" "pointing to IP address"
15188 It appears that more and more DNS zone administrators are breaking the rules
15189 and putting domain names that look like IP addresses on the right hand side of
15190 MX records. Exim follows the rules and rejects this, giving an error message
15191 that explains the misconfiguration. However, some other MTAs support this
15192 practice, so to avoid &"Why can't Exim do this?"& complaints,
15193 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15194 recommended, except when you have no other choice.
15195
15196 .option allow_utf8_domains main boolean false
15197 .cindex "domain" "UTF-8 characters in"
15198 .cindex "UTF-8" "in domain name"
15199 Lots of discussion is going on about internationalized domain names. One
15200 camp is strongly in favour of just using UTF-8 characters, and it seems
15201 that at least two other MTAs permit this.
15202 This option allows Exim users to experiment if they wish.
15203
15204 If it is set true, Exim's domain parsing function allows valid
15205 UTF-8 multicharacters to appear in domain name components, in addition to
15206 letters, digits, and hyphens.
15207
15208 If Exim is built with internationalization support
15209 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15210 this option can be left as default.
15211 Without that,
15212 if you want to look up such domain names in the DNS, you must also
15213 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15214 suitable setting is:
15215 .code
15216 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15217   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15218 .endd
15219 Alternatively, you can just disable this feature by setting
15220 .code
15221 dns_check_names_pattern =
15222 .endd
15223 That is, set the option to an empty string so that no check is done.
15224
15225
15226 .option auth_advertise_hosts main "host list&!!" *
15227 .cindex "authentication" "advertising"
15228 .cindex "AUTH" "advertising"
15229 .cindex "ESMTP extensions" AUTH
15230 If any server authentication mechanisms are configured, Exim advertises them in
15231 response to an EHLO command only if the calling host matches this list.
15232 Otherwise, Exim does not advertise AUTH.
15233 Exim does not accept AUTH commands from clients to which it has not
15234 advertised the availability of AUTH. The advertising of individual
15235 authentication mechanisms can be controlled by the use of the
15236 &%server_advertise_condition%& generic authenticator option on the individual
15237 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15238
15239 Certain mail clients (for example, Netscape) require the user to provide a name
15240 and password for authentication if AUTH is advertised, even though it may
15241 not be needed (the host may accept messages from hosts on its local LAN without
15242 authentication, for example). The &%auth_advertise_hosts%& option can be used
15243 to make these clients more friendly by excluding them from the set of hosts to
15244 which Exim advertises AUTH.
15245
15246 .cindex "AUTH" "advertising when encrypted"
15247 If you want to advertise the availability of AUTH only when the connection
15248 is encrypted using TLS, you can make use of the fact that the value of this
15249 option is expanded, with a setting like this:
15250 .code
15251 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15252 .endd
15253 .vindex "&$tls_in_cipher$&"
15254 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15255 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15256 expansion is *, which matches all hosts.
15257
15258
15259 .option auto_thaw main time 0s
15260 .cindex "thawing messages"
15261 .cindex "unfreezing messages"
15262 If this option is set to a time greater than zero, a queue runner will try a
15263 new delivery attempt on any frozen message, other than a bounce message, if
15264 this much time has passed since it was frozen. This may result in the message
15265 being re-frozen if nothing has changed since the last attempt. It is a way of
15266 saying &"keep on trying, even though there are big problems"&.
15267
15268 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15269 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15270 thought to be very useful any more, and its use should probably be avoided.
15271
15272
15273 .option av_scanner main string "see below"
15274 This option is available if Exim is built with the content-scanning extension.
15275 It specifies which anti-virus scanner to use. The default value is:
15276 .code
15277 sophie:/var/run/sophie
15278 .endd
15279 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15280 before use. See section &<<SECTscanvirus>>& for further details.
15281
15282
15283 .option bi_command main string unset
15284 .oindex "&%-bi%&"
15285 This option supplies the name of a command that is run when Exim is called with
15286 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15287 just the command name, it is not a complete command line. If an argument is
15288 required, it must come from the &%-oA%& command line option.
15289
15290
15291 .option bounce_message_file main string&!! unset
15292 .cindex "bounce message" "customizing"
15293 .cindex "customizing" "bounce message"
15294 This option defines a template file containing paragraphs of text to be used
15295 for constructing bounce messages.  Details of the file's contents are given in
15296 chapter &<<CHAPemsgcust>>&.
15297 .cindex bounce_message_file "tainted data"
15298 The option is expanded to give the file path, which must be
15299 absolute and untainted.
15300 See also &%warn_message_file%&.
15301
15302
15303 .option bounce_message_text main string unset
15304 When this option is set, its contents are included in the default bounce
15305 message immediately after &"This message was created automatically by mail
15306 delivery software."& It is not used if &%bounce_message_file%& is set.
15307
15308 .option bounce_return_body main boolean true
15309 .cindex "bounce message" "including body"
15310 This option controls whether the body of an incoming message is included in a
15311 bounce message when &%bounce_return_message%& is true. The default setting
15312 causes the entire message, both header and body, to be returned (subject to the
15313 value of &%bounce_return_size_limit%&). If this option is false, only the
15314 message header is included. In the case of a non-SMTP message containing an
15315 error that is detected during reception, only those header lines preceding the
15316 point at which the error was detected are returned.
15317 .cindex "bounce message" "including original"
15318
15319 .option bounce_return_linesize_limit main integer 998
15320 .cindex "size" "of bounce lines, limit"
15321 .cindex "bounce message" "line length limit"
15322 .cindex "limit" "bounce message line length"
15323 This option sets a limit in bytes on the line length of messages
15324 that are returned to senders due to delivery problems,
15325 when &%bounce_return_message%& is true.
15326 The default value corresponds to RFC limits.
15327 If the message being returned has lines longer than this value it is
15328 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15329
15330 The option also applies to bounces returned when an error is detected
15331 during reception of a message.
15332 In this case lines from the original are truncated.
15333
15334 The option does not apply to messages generated by an &(autoreply)& transport.
15335
15336
15337 .option bounce_return_message main boolean true
15338 If this option is set false, none of the original message is included in
15339 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15340 &%bounce_return_body%&.
15341
15342
15343 .option bounce_return_size_limit main integer 100K
15344 .cindex "size" "of bounce, limit"
15345 .cindex "bounce message" "size limit"
15346 .cindex "limit" "bounce message size"
15347 This option sets a limit in bytes on the size of messages that are returned to
15348 senders as part of bounce messages when &%bounce_return_message%& is true. The
15349 limit should be less than the value of the global &%message_size_limit%& and of
15350 any &%message_size_limit%& settings on transports, to allow for the bounce text
15351 that Exim generates. If this option is set to zero there is no limit.
15352
15353 When the body of any message that is to be included in a bounce message is
15354 greater than the limit, it is truncated, and a comment pointing this out is
15355 added at the top. The actual cutoff may be greater than the value given, owing
15356 to the use of buffering for transferring the message in chunks (typically 8K in
15357 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15358 messages.
15359
15360 .option bounce_sender_authentication main string unset
15361 .cindex "bounce message" "sender authentication"
15362 .cindex "authentication" "bounce message"
15363 .cindex "AUTH" "on bounce message"
15364 This option provides an authenticated sender address that is sent with any
15365 bounce messages generated by Exim that are sent over an authenticated SMTP
15366 connection. A typical setting might be:
15367 .code
15368 bounce_sender_authentication = mailer-daemon@my.domain.example
15369 .endd
15370 which would cause bounce messages to be sent using the SMTP command:
15371 .code
15372 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15373 .endd
15374 The value of &%bounce_sender_authentication%& must always be a complete email
15375 address.
15376
15377 .option callout_domain_negative_expire main time 3h
15378 .cindex "caching" "callout timeouts"
15379 .cindex "callout" "caching timeouts"
15380 This option specifies the expiry time for negative callout cache data for a
15381 domain. See section &<<SECTcallver>>& for details of callout verification, and
15382 section &<<SECTcallvercache>>& for details of the caching.
15383
15384
15385 .option callout_domain_positive_expire main time 7d
15386 This option specifies the expiry time for positive callout cache data for a
15387 domain. See section &<<SECTcallver>>& for details of callout verification, and
15388 section &<<SECTcallvercache>>& for details of the caching.
15389
15390
15391 .option callout_negative_expire main time 2h
15392 This option specifies the expiry time for negative callout cache data for an
15393 address. See section &<<SECTcallver>>& for details of callout verification, and
15394 section &<<SECTcallvercache>>& for details of the caching.
15395
15396
15397 .option callout_positive_expire main time 24h
15398 This option specifies the expiry time for positive callout cache data for an
15399 address. See section &<<SECTcallver>>& for details of callout verification, and
15400 section &<<SECTcallvercache>>& for details of the caching.
15401
15402
15403 .option callout_random_local_part main string&!! "see below"
15404 This option defines the &"random"& local part that can be used as part of
15405 callout verification. The default value is
15406 .code
15407 $primary_hostname-$tod_epoch-testing
15408 .endd
15409 See section &<<CALLaddparcall>>& for details of how this value is used.
15410
15411
15412 .option check_log_inodes main integer 100
15413 See &%check_spool_space%& below.
15414
15415
15416 .option check_log_space main integer 10M
15417 See &%check_spool_space%& below.
15418
15419 .oindex "&%check_rfc2047_length%&"
15420 .cindex "RFC 2047" "disabling length check"
15421 .option check_rfc2047_length main boolean true
15422 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15423 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15424 word; strings to be encoded that exceed this length are supposed to use
15425 multiple encoded words. By default, Exim does not recognize encoded words that
15426 exceed the maximum length. However, it seems that some software, in violation
15427 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15428 set false, Exim recognizes encoded words of any length.
15429
15430
15431 .option check_spool_inodes main integer 100
15432 See &%check_spool_space%& below.
15433
15434
15435 .option check_spool_space main integer 10M
15436 .cindex "checking disk space"
15437 .cindex "disk space, checking"
15438 .cindex "spool directory" "checking space"
15439 The four &%check_...%& options allow for checking of disk resources before a
15440 message is accepted.
15441
15442 .vindex "&$log_inodes$&"
15443 .vindex "&$log_space$&"
15444 .vindex "&$spool_inodes$&"
15445 .vindex "&$spool_space$&"
15446 When any of these options are nonzero, they apply to all incoming messages. If you
15447 want to apply different checks to different kinds of message, you can do so by
15448 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15449 &$spool_space$& in an ACL with appropriate additional conditions.
15450
15451
15452 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15453 either value is greater than zero, for example:
15454 .code
15455 check_spool_space = 100M
15456 check_spool_inodes = 100
15457 .endd
15458 The spool partition is the one that contains the directory defined by
15459 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15460 transit.
15461
15462 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15463 files are written if either is greater than zero. These should be set only if
15464 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15465
15466 If there is less space or fewer inodes than requested, Exim refuses to accept
15467 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15468 error response to the MAIL command. If ESMTP is in use and there was a
15469 SIZE parameter on the MAIL command, its value is added to the
15470 &%check_spool_space%& value, and the check is performed even if
15471 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15472
15473 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15474 number of kilobytes (though specified in bytes).
15475 If a non-multiple of 1024 is specified, it is rounded up.
15476
15477 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15478 failure a message is written to stderr and Exim exits with a non-zero code, as
15479 it obviously cannot send an error message of any kind.
15480
15481 There is a slight performance penalty for these checks.
15482 Versions of Exim preceding 4.88 had these disabled by default;
15483 high-rate installations confident they will never run out of resources
15484 may wish to deliberately disable them.
15485
15486 .option chunking_advertise_hosts main "host list&!!" *
15487 .cindex CHUNKING advertisement
15488 .cindex "RFC 3030" "CHUNKING"
15489 .cindex "ESMTP extensions" CHUNKING
15490 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15491 these hosts.
15492 Hosts may use the BDAT command as an alternate to DATA.
15493
15494 .option commandline_checks_require_admin main boolean &`false`&
15495 .cindex "restricting access to features"
15496 This option restricts various basic checking features to require an
15497 administrative user.
15498 This affects most of the &%-b*%& options, such as &%-be%&.
15499
15500 .option debug_store main boolean &`false`&
15501 .cindex debugging "memory corruption"
15502 .cindex memory debugging
15503 This option, when true, enables extra checking in Exim's internal memory
15504 management.  For use when a memory corruption issue is being investigated,
15505 it should normally be left as default.
15506
15507 .option daemon_smtp_ports main string &`smtp`&
15508 .cindex "port" "for daemon"
15509 .cindex "TCP/IP" "setting listening ports"
15510 This option specifies one or more default SMTP ports on which the Exim daemon
15511 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15512 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15513
15514 .option daemon_startup_retries main integer 9
15515 .cindex "daemon startup, retrying"
15516 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15517 the daemon at startup when it cannot immediately bind a listening socket
15518 (typically because the socket is already in use): &%daemon_startup_retries%&
15519 defines the number of retries after the first failure, and
15520 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15521
15522 .option daemon_startup_sleep main time 30s
15523 See &%daemon_startup_retries%&.
15524
15525 .option delay_warning main "time list" 24h
15526 .cindex "warning of delay"
15527 .cindex "delay warning, specifying"
15528 .cindex "queue" "delay warning"
15529 When a message is delayed, Exim sends a warning message to the sender at
15530 intervals specified by this option. The data is a colon-separated list of times
15531 after which to send warning messages. If the value of the option is an empty
15532 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15533 message has been in the queue for longer than the last time, the last interval
15534 between the times is used to compute subsequent warning times. For example,
15535 with
15536 .code
15537 delay_warning = 4h:8h:24h
15538 .endd
15539 the first message is sent after 4 hours, the second after 8 hours, and
15540 the third one after 24 hours. After that, messages are sent every 16 hours,
15541 because that is the interval between the last two times on the list. If you set
15542 just one time, it specifies the repeat interval. For example, with:
15543 .code
15544 delay_warning = 6h
15545 .endd
15546 messages are repeated every six hours. To stop warnings after a given time, set
15547 a very large time at the end of the list. For example:
15548 .code
15549 delay_warning = 2h:12h:99d
15550 .endd
15551 Note that the option is only evaluated at the time a delivery attempt fails,
15552 which depends on retry and queue-runner configuration.
15553 Typically retries will be configured more frequently than warning messages.
15554
15555 .option delay_warning_condition main string&!! "see below"
15556 .vindex "&$domain$&"
15557 The string is expanded at the time a warning message might be sent. If all the
15558 deferred addresses have the same domain, it is set in &$domain$& during the
15559 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15560 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15561 &"false"& (the comparison being done caselessly) then the warning message is
15562 not sent. The default is:
15563 .code
15564 delay_warning_condition = ${if or {\
15565   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15566   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15567   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15568   } {no}{yes}}
15569 .endd
15570 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15571 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15572 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15573 &"auto-replied"& in an &'Auto-Submitted:'& header.
15574
15575 .option deliver_drop_privilege main boolean false
15576 .cindex "unprivileged delivery"
15577 .cindex "delivery" "unprivileged"
15578 If this option is set true, Exim drops its root privilege at the start of a
15579 delivery process, and runs as the Exim user throughout. This severely restricts
15580 the kinds of local delivery that are possible, but is viable in certain types
15581 of configuration. There is a discussion about the use of root privilege in
15582 chapter &<<CHAPsecurity>>&.
15583
15584 .option deliver_queue_load_max main fixed-point unset
15585 .cindex "load average"
15586 .cindex "queue runner" "abandoning"
15587 When this option is set, a queue run is abandoned if the system load average
15588 becomes greater than the value of the option. The option has no effect on
15589 ancient operating systems on which Exim cannot determine the load average.
15590 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15591
15592
15593 .option delivery_date_remove main boolean true
15594 .cindex "&'Delivery-date:'& header line"
15595 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15596 message when it is delivered, in exactly the same way as &'Return-path:'& is
15597 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15598 should not be present in incoming messages, and this option causes them to be
15599 removed at the time the message is received, to avoid any problems that might
15600 occur when a delivered message is subsequently sent on to some other recipient.
15601
15602 .option disable_fsync main boolean false
15603 .cindex "&[fsync()]&, disabling"
15604 This option is available only if Exim was built with the compile-time option
15605 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15606 a runtime configuration generates an &"unknown option"& error. You should not
15607 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15608 really, really, really understand what you are doing. &'No pre-compiled
15609 distributions of Exim should ever make this option available.'&
15610
15611 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15612 updated files' data to be written to disc before continuing. Unexpected events
15613 such as crashes and power outages may cause data to be lost or scrambled.
15614 Here be Dragons. &*Beware.*&
15615
15616
15617 .option disable_ipv6 main boolean false
15618 .cindex "IPv6" "disabling"
15619 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15620 activities take place. AAAA records are never looked up, and any IPv6 addresses
15621 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15622 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15623 to handle IPv6 literal addresses.
15624
15625
15626 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15627 .cindex DKIM "selecting signature algorithms"
15628 This option gives a list of hash types which are acceptable in signatures,
15629 and an order of processing.
15630 Signatures with algorithms not in the list will be ignored.
15631
15632 Acceptable values include:
15633 .code
15634 sha1
15635 sha256
15636 sha512
15637 .endd
15638
15639 Note that the acceptance of sha1 violates RFC 8301.
15640
15641 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15642 This option gives a list of key types which are acceptable in signatures,
15643 and an order of processing.
15644 Signatures with algorithms not in the list will be ignored.
15645
15646
15647 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15648 This option gives a list of key sizes which are acceptable in signatures.
15649 The list is keyed by the algorithm type for the key; the values are in bits.
15650 Signatures with keys smaller than given by this option will fail verification.
15651
15652 The default enforces the RFC 8301 minimum key size for RSA signatures.
15653
15654 .option dkim_verify_minimal main boolean false
15655 If set to true, verification of signatures will terminate after the
15656 first success.
15657
15658 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15659 .cindex DKIM "controlling calls to the ACL"
15660 This option gives a list of DKIM domains for which the DKIM ACL is run.
15661 It is expanded after the message is received; by default it runs
15662 the ACL once for each signature in the message.
15663 See section &<<SECDKIMVFY>>&.
15664
15665
15666 .option dmarc_forensic_sender main string&!! unset
15667 .option dmarc_history_file main string unset
15668 .option dmarc_tld_file main string unset
15669 .cindex DMARC "main section options"
15670 These options control DMARC processing.
15671 See section &<<SECDMARC>>& for details.
15672
15673
15674 .option dns_again_means_nonexist main "domain list&!!" unset
15675 .cindex "DNS" "&""try again""& response; overriding"
15676 DNS lookups give a &"try again"& response for the DNS errors
15677 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15678 keep trying to deliver a message, or to give repeated temporary errors to
15679 incoming mail. Sometimes the effect is caused by a badly set up name server and
15680 may persist for a long time. If a domain which exhibits this problem matches
15681 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15682 This option should be used with care. You can make it apply to reverse lookups
15683 by a setting such as this:
15684 .code
15685 dns_again_means_nonexist = *.in-addr.arpa
15686 .endd
15687 This option applies to all DNS lookups that Exim does. It also applies when the
15688 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15689 since these are most likely to be caused by DNS lookup problems. The
15690 &(dnslookup)& router has some options of its own for controlling what happens
15691 when lookups for MX or SRV records give temporary errors. These more specific
15692 options are applied after this global option.
15693
15694 .option dns_check_names_pattern main string "see below"
15695 .cindex "DNS" "pre-check of name syntax"
15696 When this option is set to a non-empty string, it causes Exim to check domain
15697 names for characters that are not allowed in host names before handing them to
15698 the DNS resolver, because some resolvers give temporary errors for names that
15699 contain unusual characters. If a domain name contains any unwanted characters,
15700 a &"not found"& result is forced, and the resolver is not called. The check is
15701 done by matching the domain name against a regular expression, which is the
15702 value of this option. The default pattern is
15703 .code
15704 dns_check_names_pattern = \
15705   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15706 .endd
15707 which permits only letters, digits, slashes, and hyphens in components, but
15708 they must start and end with a letter or digit. Slashes are not, in fact,
15709 permitted in host names, but they are found in certain NS records (which can be
15710 accessed in Exim by using a &%dnsdb%& lookup). If you set
15711 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15712 empty string.
15713
15714 .option dns_csa_search_limit main integer 5
15715 This option controls the depth of parental searching for CSA SRV records in the
15716 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15717
15718 .option dns_csa_use_reverse main boolean true
15719 This option controls whether or not an IP address, given as a CSA domain, is
15720 reversed and looked up in the reverse DNS, as described in more detail in
15721 section &<<SECTverifyCSA>>&.
15722
15723 .option dns_cname_loops main integer 1
15724 .cindex DNS "CNAME following"
15725 This option controls the following of CNAME chains, needed if the resolver does
15726 not do it internally.
15727 As of 2018 most should, and the default can be left.
15728 If you have an ancient one, a value of 10 is likely needed.
15729
15730 The default value of one CNAME-follow is needed
15731 thanks to the observed return for an MX request,
15732 given no MX presence but a CNAME to an A, of the CNAME.
15733
15734
15735 .option dns_dnssec_ok main integer -1
15736 .cindex "DNS" "resolver options"
15737 .cindex "DNS" "DNSSEC"
15738 If this option is set to a non-negative number then Exim will initialise the
15739 DNS resolver library to either use or not use DNSSEC, overriding the system
15740 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15741
15742 If the resolver library does not support DNSSEC then this option has no effect.
15743
15744 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15745 will default to stripping out a successful validation status.
15746 This will break a previously working Exim installation.
15747 Provided that you do trust the resolver (ie, is on localhost) you can tell
15748 glibc to pass through any successful validation with a new option in
15749 &_/etc/resolv.conf_&:
15750 .code
15751 options trust-ad
15752 .endd
15753
15754
15755 .option dns_ipv4_lookup main "domain list&!!" unset
15756 .cindex "IPv6" "DNS lookup for AAAA records"
15757 .cindex "DNS" "IPv6 lookup for AAAA records"
15758 .cindex DNS "IPv6 disabling"
15759 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15760 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15761 (A records) when trying to find IP addresses for hosts, unless the host's
15762 domain matches this list.
15763
15764 This is a fudge to help with name servers that give big delays or otherwise do
15765 not work for the AAAA record type. In due course, when the world's name
15766 servers have all been upgraded, there should be no need for this option.
15767 Note that all lookups, including those done for verification, are affected;
15768 this will result in verify failure for IPv6 connections or ones using names
15769 only valid for IPv6 addresses.
15770
15771
15772 .option dns_retrans main time 0s
15773 .cindex "DNS" "resolver options"
15774 .cindex timeout "dns lookup"
15775 .cindex "DNS" timeout
15776 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15777 retransmission and retry parameters for DNS lookups. Values of zero (the
15778 defaults) leave the system default settings unchanged. The first value is the
15779 time between retries, and the second is the number of retries. It isn't
15780 totally clear exactly how these settings affect the total time a DNS lookup may
15781 take. I haven't found any documentation about timeouts on DNS lookups; these
15782 parameter values are available in the external resolver interface structure,
15783 but nowhere does it seem to describe how they are used or what you might want
15784 to set in them.
15785 See also the &%slow_lookup_log%& option.
15786
15787
15788 .option dns_retry main integer 0
15789 See &%dns_retrans%& above.
15790
15791
15792 .option dns_trust_aa main "domain list&!!" unset
15793 .cindex "DNS" "resolver options"
15794 .cindex "DNS" "DNSSEC"
15795 If this option is set then lookup results marked with the AA bit
15796 (Authoritative Answer) are trusted the same way as if they were
15797 DNSSEC-verified. The authority section's name of the answer must
15798 match with this expanded domain list.
15799
15800 Use this option only if you talk directly to a resolver that is
15801 authoritative for some zones and does not set the AD (Authentic Data)
15802 bit in the answer. Some DNS servers may have an configuration option to
15803 mark the answers from their own zones as verified (they set the AD bit).
15804 Others do not have this option. It is considered as poor practice using
15805 a resolver that is an authoritative server for some zones.
15806
15807 Use this option only if you really have to (e.g. if you want
15808 to use DANE for remote delivery to a server that is listed in the DNS
15809 zones that your resolver is authoritative for).
15810
15811 If the DNS answer packet has the AA bit set and contains resource record
15812 in the answer section, the name of the first NS record appearing in the
15813 authority section is compared against the list. If the answer packet is
15814 authoritative but the answer section is empty, the name of the first SOA
15815 record in the authoritative section is used instead.
15816
15817 .cindex "DNS" "resolver options"
15818 .option dns_use_edns0 main integer -1
15819 .cindex "DNS" "resolver options"
15820 .cindex "DNS" "EDNS0"
15821 .cindex "DNS" "OpenBSD
15822 If this option is set to a non-negative number then Exim will initialise the
15823 DNS resolver library to either use or not use EDNS0 extensions, overriding
15824 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15825 on.
15826
15827 If the resolver library does not support EDNS0 then this option has no effect.
15828
15829 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15830 means that DNSSEC will not work with Exim on that platform either, unless Exim
15831 is linked against an alternative DNS client library.
15832
15833
15834 .option drop_cr main boolean false
15835 This is an obsolete option that is now a no-op. It used to affect the way Exim
15836 handled CR and LF characters in incoming messages. What happens now is
15837 described in section &<<SECTlineendings>>&.
15838
15839 .option dsn_advertise_hosts main "host list&!!" unset
15840 .cindex "bounce messages" "success"
15841 .cindex "DSN" "success"
15842 .cindex "Delivery Status Notification" "success"
15843 .cindex "ESMTP extensions" DSN
15844 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15845 and accepted from, these hosts.
15846 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15847 and RET and ORCPT options on MAIL FROM commands.
15848 A NOTIFY=SUCCESS option requests success-DSN messages.
15849 A NOTIFY= option with no argument requests that no delay or failure DSNs
15850 are sent.
15851 &*Note*&: Supplying success-DSN messages has been criticised
15852 on privacy grounds; it can leak details of internal forwarding.
15853
15854 .option dsn_from main "string&!!" "see below"
15855 .cindex "&'From:'& header line" "in bounces"
15856 .cindex "bounce messages" "&'From:'& line, specifying"
15857 This option can be used to vary the contents of &'From:'& header lines in
15858 bounces and other automatically generated messages (&"Delivery Status
15859 Notifications"& &-- hence the name of the option). The default setting is:
15860 .code
15861 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15862 .endd
15863 The value is expanded every time it is needed. If the expansion fails, a
15864 panic is logged, and the default value is used.
15865
15866 .option envelope_to_remove main boolean true
15867 .cindex "&'Envelope-to:'& header line"
15868 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15869 message when it is delivered, in exactly the same way as &'Return-path:'& is
15870 handled. &'Envelope-to:'& records the original recipient address from the
15871 message's envelope that caused the delivery to happen. Such headers should not
15872 be present in incoming messages, and this option causes them to be removed at
15873 the time the message is received, to avoid any problems that might occur when a
15874 delivered message is subsequently sent on to some other recipient.
15875
15876
15877 .option errors_copy main "string list&!!" unset
15878 .cindex "bounce message" "copy to other address"
15879 .cindex "copy of bounce message"
15880 Setting this option causes Exim to send bcc copies of bounce messages that it
15881 generates to other addresses. &*Note*&: This does not apply to bounce messages
15882 coming from elsewhere. The value of the option is a colon-separated list of
15883 items. Each item consists of a pattern, terminated by white space, followed by
15884 a comma-separated list of email addresses. If a pattern contains spaces, it
15885 must be enclosed in double quotes.
15886
15887 Each pattern is processed in the same way as a single item in an address list
15888 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15889 the bounce message, the message is copied to the addresses on the list. The
15890 items are scanned in order, and once a matching one is found, no further items
15891 are examined. For example:
15892 .code
15893 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15894               rqps@mydomain   hostmaster@mydomain.example,\
15895                               postmaster@mydomain.example
15896 .endd
15897 .vindex "&$domain$&"
15898 .vindex "&$local_part$&"
15899 The address list is expanded before use. The expansion variables &$local_part$&
15900 and &$domain$& are set from the original recipient of the error message, and if
15901 there was any wildcard matching in the pattern, the expansion
15902 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15903 variables &$0$&, &$1$&, etc. are set in the normal way.
15904
15905
15906 .option errors_reply_to main string unset
15907 .cindex "bounce message" "&'Reply-to:'& in"
15908 By default, Exim's bounce and delivery warning messages contain the header line
15909 .display
15910 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15911 .endd
15912 .oindex &%quota_warn_message%&
15913 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15914 A warning message that is generated by the &%quota_warn_message%& option in an
15915 &(appendfile)& transport may contain its own &'From:'& header line that
15916 overrides the default.
15917
15918 Experience shows that people reply to bounce messages. If the
15919 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15920 and warning messages. For example:
15921 .code
15922 errors_reply_to = postmaster@my.domain.example
15923 .endd
15924 The value of the option is not expanded. It must specify a valid RFC 2822
15925 address. However, if a warning message that is generated by the
15926 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15927 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15928 not used.
15929
15930
15931 .option event_action main string&!! unset
15932 .cindex events
15933 This option declares a string to be expanded for Exim's events mechanism.
15934 For details see chapter &<<CHAPevents>>&.
15935
15936
15937 .option exim_group main string "compile-time configured"
15938 .cindex "gid (group id)" "Exim's own"
15939 .cindex "Exim group"
15940 This option changes the gid under which Exim runs when it gives up root
15941 privilege. The default value is compiled into the binary. The value of this
15942 option is used only when &%exim_user%& is also set. Unless it consists entirely
15943 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15944 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15945 security issues.
15946
15947
15948 .option exim_path main string "see below"
15949 .cindex "Exim binary, path name"
15950 This option specifies the path name of the Exim binary, which is used when Exim
15951 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15952 the directory configured at compile time by the BIN_DIRECTORY setting. It
15953 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15954 other place.
15955 &*Warning*&: Do not use a macro to define the value of this option, because
15956 you will break those Exim utilities that scan the configuration file to find
15957 where the binary is. (They then use the &%-bP%& option to extract option
15958 settings such as the value of &%spool_directory%&.)
15959
15960
15961 .option exim_user main string "compile-time configured"
15962 .cindex "uid (user id)" "Exim's own"
15963 .cindex "Exim user"
15964 This option changes the uid under which Exim runs when it gives up root
15965 privilege. The default value is compiled into the binary. Ownership of the run
15966 time configuration file and the use of the &%-C%& and &%-D%& command line
15967 options is checked against the values in the binary, not what is set here.
15968
15969 Unless it consists entirely of digits, the string is looked up using
15970 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15971 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15972 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15973
15974
15975 .option exim_version main string "current version"
15976 .cindex "Exim version"
15977 .cindex customizing "version number"
15978 .cindex "version number of Exim" override
15979 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15980 various places.  Use with care; this may fool stupid security scanners.
15981
15982
15983 .option extra_local_interfaces main "string list" unset
15984 This option defines network interfaces that are to be considered local when
15985 routing, but which are not used for listening by the daemon. See section
15986 &<<SECTreclocipadd>>& for details.
15987
15988
15989 . Allow this long option name to split; give it unsplit as a fifth argument
15990 . for the automatic .oindex that is generated by .option.
15991
15992 .option "extract_addresses_remove_arguments" main boolean true &&&
15993          extract_addresses_remove_arguments
15994 .oindex "&%-t%&"
15995 .cindex "command line" "addresses with &%-t%&"
15996 .cindex "Sendmail compatibility" "&%-t%& option"
15997 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15998 are present on the command line when the &%-t%& option is used to build an
15999 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
16000 line addresses are removed from the recipients list. This is also how Smail
16001 behaves. However, other Sendmail documentation (the O'Reilly book) states that
16002 command line addresses are added to those obtained from the header lines. When
16003 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
16004 argument headers. If it is set false, Exim adds rather than removes argument
16005 addresses.
16006
16007
16008 .option finduser_retries main integer 0
16009 .cindex "NIS, retrying user lookups"
16010 On systems running NIS or other schemes in which user and group information is
16011 distributed from a remote system, there can be times when &[getpwnam()]& and
16012 related functions fail, even when given valid data, because things time out.
16013 Unfortunately these failures cannot be distinguished from genuine &"not found"&
16014 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
16015 many extra times to find a user or a group, waiting for one second between
16016 retries.
16017
16018 .cindex "&_/etc/passwd_&" "multiple reading of"
16019 You should not set this option greater than zero if your user information is in
16020 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
16021 search the file multiple times for non-existent users, and also cause delay.
16022
16023
16024
16025 .option freeze_tell main "string list, comma separated" unset
16026 .cindex "freezing messages" "sending a message when freezing"
16027 On encountering certain errors, or when configured to do so in a system filter,
16028 ACL, or special router, Exim freezes a message. This means that no further
16029 delivery attempts take place until an administrator thaws the message, or the
16030 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
16031 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
16032 warning message whenever it freezes something, unless the message it is
16033 freezing is a locally-generated bounce message. (Without this exception there
16034 is the possibility of looping.) The warning message is sent to the addresses
16035 supplied as the comma-separated value of this option. If several of the
16036 message's addresses cause freezing, only a single message is sent. If the
16037 freezing was automatic, the reason(s) for freezing can be found in the message
16038 log. If you configure freezing in a filter or ACL, you must arrange for any
16039 logging that you require.
16040
16041
16042 .option gecos_name main string&!! unset
16043 .cindex "HP-UX"
16044 .cindex "&""gecos""& field, parsing"
16045 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
16046 password file to hold other information in addition to users' real names. Exim
16047 looks up this field for use when it is creating &'Sender:'& or &'From:'&
16048 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
16049 of the field are used unchanged, except that, if an ampersand is encountered,
16050 it is replaced by the user's login name with the first character forced to
16051 upper case, since this is a convention that is observed on many systems.
16052
16053 When these options are set, &%gecos_pattern%& is treated as a regular
16054 expression that is to be applied to the field (again with && replaced by the
16055 login name), and if it matches, &%gecos_name%& is expanded and used as the
16056 user's name.
16057
16058 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
16059 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
16060 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
16061 name terminates at the first comma, the following can be used:
16062 .code
16063 gecos_pattern = ([^,]*)
16064 gecos_name = $1
16065 .endd
16066
16067 .option gecos_pattern main string unset
16068 See &%gecos_name%& above.
16069
16070
16071 .option gnutls_compat_mode main boolean unset
16072 This option controls whether GnuTLS is used in compatibility mode in an Exim
16073 server. This reduces security slightly, but improves interworking with older
16074 implementations of TLS.
16075
16076
16077 .option gnutls_allow_auto_pkcs11 main boolean unset
16078 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
16079 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
16080
16081 See
16082 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
16083 for documentation.
16084
16085
16086
16087 .option headers_charset main string "see below"
16088 This option sets a default character set for translating from encoded MIME
16089 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
16090 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
16091 ultimate default is ISO-8859-1. For more details see the description of header
16092 insertions in section &<<SECTexpansionitems>>&.
16093
16094
16095
16096 .option header_maxsize main integer "see below"
16097 .cindex "header section" "maximum size of"
16098 .cindex "limit" "size of message header section"
16099 This option controls the overall maximum size of a message's header
16100 section. The default is the value of HEADER_MAXSIZE in
16101 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
16102 sections are rejected.
16103
16104
16105 .option header_line_maxsize main integer 0
16106 .cindex "header lines" "maximum size of"
16107 .cindex "limit" "size of one header line"
16108 This option limits the length of any individual header line in a message, after
16109 all the continuations have been joined together. Messages with individual
16110 header lines that are longer than the limit are rejected. The default value of
16111 zero means &"no limit"&.
16112
16113
16114
16115
16116 .option helo_accept_junk_hosts main "host list&!!" unset
16117 .cindex "HELO" "accepting junk data"
16118 .cindex "EHLO" "accepting junk data"
16119 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
16120 mail, and gives an error response for invalid data. Unfortunately, there are
16121 some SMTP clients that send syntactic junk. They can be accommodated by setting
16122 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
16123 if you want to do semantic checking.
16124 See also &%helo_allow_chars%& for a way of extending the permitted character
16125 set.
16126
16127
16128 .option helo_allow_chars main string unset
16129 .cindex "HELO" "underscores in"
16130 .cindex "EHLO" "underscores in"
16131 .cindex "underscore in EHLO/HELO"
16132 This option can be set to a string of rogue characters that are permitted in
16133 all EHLO and HELO names in addition to the standard letters, digits,
16134 hyphens, and dots. If you really must allow underscores, you can set
16135 .code
16136 helo_allow_chars = _
16137 .endd
16138 Note that the value is one string, not a list.
16139
16140
16141 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
16142 .cindex "HELO" "forcing reverse lookup"
16143 .cindex "EHLO" "forcing reverse lookup"
16144 If the domain given by a client in a HELO or EHLO command matches this
16145 list, a reverse lookup is done in order to establish the host's true name. The
16146 default forces a lookup if the client host gives the server's name or any of
16147 its IP addresses (in brackets), something that broken clients have been seen to
16148 do.
16149
16150
16151 .option helo_try_verify_hosts main "host list&!!" unset
16152 .cindex "HELO verifying" "optional"
16153 .cindex "EHLO" "verifying, optional"
16154 By default, Exim just checks the syntax of HELO and EHLO commands (see
16155 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
16156 to do more extensive checking of the data supplied by these commands. The ACL
16157 condition &`verify = helo`& is provided to make this possible.
16158 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
16159 to force the check to occur. From release 4.53 onwards, this is no longer
16160 necessary. If the check has not been done before &`verify = helo`& is
16161 encountered, it is done at that time. Consequently, this option is obsolete.
16162 Its specification is retained here for backwards compatibility.
16163
16164 When an EHLO or HELO command is received, if the calling host matches
16165 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
16166 EHLO command either:
16167
16168 .ilist
16169 is an IP literal matching the calling address of the host, or
16170 .next
16171 .cindex "DNS" "reverse lookup"
16172 .cindex "reverse DNS lookup"
16173 matches the host name that Exim obtains by doing a reverse lookup of the
16174 calling host address, or
16175 .next
16176 when looked up in DNS yields the calling host address.
16177 .endlist
16178
16179 However, the EHLO or HELO command is not rejected if any of the checks
16180 fail. Processing continues, but the result of the check is remembered, and can
16181 be detected later in an ACL by the &`verify = helo`& condition.
16182
16183 If DNS was used for successful verification, the variable
16184 .cindex "DNS" "DNSSEC"
16185 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16186
16187 .option helo_verify_hosts main "host list&!!" unset
16188 .cindex "HELO verifying" "mandatory"
16189 .cindex "EHLO" "verifying, mandatory"
16190 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16191 backwards compatibility. For hosts that match this option, Exim checks the host
16192 name given in the HELO or EHLO in the same way as for
16193 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16194 rejected with a 550 error, and entries are written to the main and reject logs.
16195 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16196 error.
16197
16198 .option hold_domains main "domain list&!!" unset
16199 .cindex "domain" "delaying delivery"
16200 .cindex "delivery" "delaying certain domains"
16201 This option allows mail for particular domains to be held in the queue
16202 manually. The option is overridden if a message delivery is forced with the
16203 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16204 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16205 item in &%hold_domains%&, no routing or delivery for that address is done, and
16206 it is deferred every time the message is looked at.
16207
16208 This option is intended as a temporary operational measure for delaying the
16209 delivery of mail while some problem is being sorted out, or some new
16210 configuration tested. If you just want to delay the processing of some
16211 domains until a queue run occurs, you should use &%queue_domains%& or
16212 &%queue_smtp_domains%&, not &%hold_domains%&.
16213
16214 A setting of &%hold_domains%& does not override Exim's code for removing
16215 messages from the queue if they have been there longer than the longest retry
16216 time in any retry rule. If you want to hold messages for longer than the normal
16217 retry times, insert a dummy retry rule with a long retry time.
16218
16219
16220 .option host_lookup main "host list&!!" unset
16221 .cindex "host name" "lookup, forcing"
16222 Exim does not look up the name of a calling host from its IP address unless it
16223 is required to compare against some host list, or the host matches
16224 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16225 option (which normally contains IP addresses rather than host names). The
16226 default configuration file contains
16227 .code
16228 host_lookup = *
16229 .endd
16230 which causes a lookup to happen for all hosts. If the expense of these lookups
16231 is felt to be too great, the setting can be changed or removed.
16232
16233 After a successful reverse lookup, Exim does a forward lookup on the name it
16234 has obtained, to verify that it yields the IP address that it started with. If
16235 this check fails, Exim behaves as if the name lookup failed.
16236
16237 .vindex "&$host_lookup_failed$&"
16238 .vindex "&$sender_host_name$&"
16239 After any kind of failure, the host name (in &$sender_host_name$&) remains
16240 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16241 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16242 &`verify = reverse_host_lookup`& in ACLs.
16243
16244
16245 .option host_lookup_order main "string list" &`bydns:byaddr`&
16246 This option specifies the order of different lookup methods when Exim is trying
16247 to find a host name from an IP address. The default is to do a DNS lookup
16248 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16249 if that fails. You can change the order of these lookups, or omit one entirely,
16250 if you want.
16251
16252 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16253 multiple PTR records in the DNS and the IP address is not listed in
16254 &_/etc/hosts_&. Different operating systems give different results in this
16255 case. That is why the default tries a DNS lookup first.
16256
16257
16258
16259 .option host_reject_connection main "host list&!!" unset
16260 .cindex "host" "rejecting connections from"
16261 If this option is set, incoming SMTP calls from the hosts listed are rejected
16262 as soon as the connection is made.
16263 This option is obsolete, and retained only for backward compatibility, because
16264 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16265 connections immediately.
16266
16267 The ability to give an immediate rejection (either by this option or using an
16268 ACL) is provided for use in unusual cases. Many hosts will just try again,
16269 sometimes without much delay. Normally, it is better to use an ACL to reject
16270 incoming messages at a later stage, such as after RCPT commands. See
16271 chapter &<<CHAPACL>>&.
16272
16273
16274 .option hosts_connection_nolog main "host list&!!" unset
16275 .cindex "host" "not logging connections from"
16276 This option defines a list of hosts for which connection logging does not
16277 happen, even though the &%smtp_connection%& log selector is set. For example,
16278 you might want not to log SMTP connections from local processes, or from
16279 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16280 the daemon; you should therefore strive to restrict its value to a short inline
16281 list of IP addresses and networks. To disable logging SMTP connections from
16282 local processes, you must create a host list with an empty item. For example:
16283 .code
16284 hosts_connection_nolog = :
16285 .endd
16286 If the &%smtp_connection%& log selector is not set, this option has no effect.
16287
16288
16289 .option hosts_require_alpn main "host list&!!" unset
16290 .cindex ALPN "require negotiation in server"
16291 .cindex TLS ALPN
16292 .cindex TLS "Application Layer Protocol Names"
16293 If the TLS library supports ALPN
16294 then a successful negotiation of ALPN will be required for any client
16295 matching the list, for TLS to be used.
16296 See also the &%tls_alpn%& option.
16297
16298 &*Note*&: prevention of fallback to in-clear connection is not
16299 managed by this option, and should be done separately.
16300
16301
16302 .option hosts_proxy main "host list&!!" unset
16303 .cindex proxy "proxy protocol"
16304 This option enables use of Proxy Protocol proxies for incoming
16305 connections.  For details see section &<<SECTproxyInbound>>&.
16306
16307
16308 .option hosts_treat_as_local main "domain list&!!" unset
16309 .cindex "local host" "domains treated as"
16310 .cindex "host" "treated as local"
16311 If this option is set, any host names that match the domain list are treated as
16312 if they were the local host when Exim is scanning host lists obtained from MX
16313 records
16314 or other sources. Note that the value of this option is a domain list, not a
16315 host list, because it is always used to check host names, not IP addresses.
16316
16317 This option also applies when Exim is matching the special items
16318 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16319 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16320 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16321 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16322 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16323 interfaces and recognizing the local host.
16324
16325
16326 .option ibase_servers main "string list" unset
16327 .cindex "InterBase" "server list"
16328 This option provides a list of InterBase servers and associated connection data,
16329 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16330 The option is available only if Exim has been built with InterBase support.
16331
16332
16333
16334 .option ignore_bounce_errors_after main time 10w
16335 .cindex "bounce message" "discarding"
16336 .cindex "discarding bounce message"
16337 This option affects the processing of bounce messages that cannot be delivered,
16338 that is, those that suffer a permanent delivery failure. (Bounce messages that
16339 suffer temporary delivery failures are of course retried in the usual way.)
16340
16341 After a permanent delivery failure, bounce messages are frozen,
16342 because there is no sender to whom they can be returned. When a frozen bounce
16343 message has been in the queue for more than the given time, it is unfrozen at
16344 the next queue run, and a further delivery is attempted. If delivery fails
16345 again, the bounce message is discarded. This makes it possible to keep failed
16346 bounce messages around for a shorter time than the normal maximum retry time
16347 for frozen messages. For example,
16348 .code
16349 ignore_bounce_errors_after = 12h
16350 .endd
16351 retries failed bounce message deliveries after 12 hours, discarding any further
16352 failures. If the value of this option is set to a zero time period, bounce
16353 failures are discarded immediately. Setting a very long time (as in the default
16354 value) has the effect of disabling this option. For ways of automatically
16355 dealing with other kinds of frozen message, see &%auto_thaw%& and
16356 &%timeout_frozen_after%&.
16357
16358
16359 .option ignore_fromline_hosts main "host list&!!" unset
16360 .cindex "&""From""& line"
16361 .cindex "UUCP" "&""From""& line"
16362 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16363 the headers of a message. By default this is treated as the start of the
16364 message's body, which means that any following headers are not recognized as
16365 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16366 match those hosts that insist on sending it. If the sender is actually a local
16367 process rather than a remote host, and is using &%-bs%& to inject the messages,
16368 &%ignore_fromline_local%& must be set to achieve this effect.
16369
16370
16371 .option ignore_fromline_local main boolean false
16372 See &%ignore_fromline_hosts%& above.
16373
16374 .option keep_environment main "string list" unset
16375 .cindex "environment" "values from"
16376 This option contains a string list of environment variables to keep.
16377 You have to trust these variables or you have to be sure that
16378 these variables do not impose any security risk. Keep in mind that
16379 during the startup phase Exim is running with an effective UID 0 in most
16380 installations. As the default value is an empty list, the default
16381 environment for using libraries, running embedded Perl code, or running
16382 external binaries is empty, and does not not even contain PATH or HOME.
16383
16384 Actually the list is interpreted as a list of patterns
16385 (&<<SECTlistexpand>>&), except that it is not expanded first.
16386
16387 WARNING: Macro substitution is still done first, so having a macro
16388 FOO and having FOO_HOME in your &%keep_environment%& option may have
16389 unexpected results. You may work around this using a regular expression
16390 that does not match the macro name: ^[F]OO_HOME$.
16391
16392 Current versions of Exim issue a warning during startup if you do not mention
16393 &%keep_environment%& in your runtime configuration file and if your
16394 current environment is not empty. Future versions may not issue that warning
16395 anymore.
16396
16397 See the &%add_environment%& main config option for a way to set
16398 environment variables to a fixed value.  The environment for &(pipe)&
16399 transports is handled separately, see section &<<SECTpipeenv>>& for
16400 details.
16401
16402
16403 .option keep_malformed main time 4d
16404 This option specifies the length of time to keep messages whose spool files
16405 have been corrupted in some way. This should, of course, never happen. At the
16406 next attempt to deliver such a message, it gets removed. The incident is
16407 logged.
16408
16409
16410 .option ldap_ca_cert_dir main string unset
16411 .cindex "LDAP", "TLS CA certificate directory"
16412 .cindex certificate "directory for LDAP"
16413 This option indicates which directory contains CA certificates for verifying
16414 a TLS certificate presented by an LDAP server.
16415 While Exim does not provide a default value, your SSL library may.
16416 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16417 and constrained to be a directory.
16418
16419
16420 .option ldap_ca_cert_file main string unset
16421 .cindex "LDAP", "TLS CA certificate file"
16422 .cindex certificate "file for LDAP"
16423 This option indicates which file contains CA certificates for verifying
16424 a TLS certificate presented by an LDAP server.
16425 While Exim does not provide a default value, your SSL library may.
16426 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16427 and constrained to be a file.
16428
16429
16430 .option ldap_cert_file main string unset
16431 .cindex "LDAP" "TLS client certificate file"
16432 .cindex certificate "file for LDAP"
16433 This option indicates which file contains an TLS client certificate which
16434 Exim should present to the LDAP server during TLS negotiation.
16435 Should be used together with &%ldap_cert_key%&.
16436
16437
16438 .option ldap_cert_key main string unset
16439 .cindex "LDAP" "TLS client key file"
16440 .cindex certificate "key for LDAP"
16441 This option indicates which file contains the secret/private key to use
16442 to prove identity to the LDAP server during TLS negotiation.
16443 Should be used together with &%ldap_cert_file%&, which contains the
16444 identity to be proven.
16445
16446
16447 .option ldap_cipher_suite main string unset
16448 .cindex "LDAP" "TLS cipher suite"
16449 This controls the TLS cipher-suite negotiation during TLS negotiation with
16450 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16451 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16452
16453
16454 .option ldap_default_servers main "string list" unset
16455 .cindex "LDAP" "default servers"
16456 This option provides a list of LDAP servers which are tried in turn when an
16457 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16458 details of LDAP queries. This option is available only when Exim has been built
16459 with LDAP support.
16460
16461
16462 .option ldap_require_cert main string unset.
16463 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16464 This should be one of the values "hard", "demand", "allow", "try" or "never".
16465 A value other than one of these is interpreted as "never".
16466 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16467 Although Exim does not set a default, the LDAP library probably defaults
16468 to hard/demand.
16469
16470
16471 .option ldap_start_tls main boolean false
16472 .cindex "LDAP" "whether or not to negotiate TLS"
16473 If set, Exim will attempt to negotiate TLS with the LDAP server when
16474 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16475 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16476 of SSL-on-connect.
16477 In the event of failure to negotiate TLS, the action taken is controlled
16478 by &%ldap_require_cert%&.
16479 This option is ignored for &`ldapi`& connections.
16480
16481
16482 .option ldap_version main integer unset
16483 .cindex "LDAP" "protocol version, forcing"
16484 This option can be used to force Exim to set a specific protocol version for
16485 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16486 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16487 the LDAP headers; otherwise it is 2. This option is available only when Exim
16488 has been built with LDAP support.
16489
16490
16491
16492 .option local_from_check main boolean true
16493 .cindex "&'Sender:'& header line" "disabling addition of"
16494 .cindex "&'From:'& header line" "disabling checking of"
16495 When a message is submitted locally (that is, not over a TCP/IP connection) by
16496 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16497 checks that the &'From:'& header line matches the login of the calling user and
16498 the domain specified by &%qualify_domain%&.
16499
16500 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16501 locally submitted message is automatically qualified by Exim, unless the
16502 &%-bnq%& command line option is used.
16503
16504 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16505 on the local part. If the &'From:'& header line does not match, Exim adds a
16506 &'Sender:'& header with an address constructed from the calling user's login
16507 and the default qualify domain.
16508
16509 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16510 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16511 &'Sender:'& header lines supplied by untrusted users, you must also set
16512 &%local_sender_retain%& to be true.
16513
16514 .cindex "envelope from"
16515 .cindex "envelope sender"
16516 These options affect only the header lines in the message. The envelope sender
16517 is still forced to be the login id at the qualify domain unless
16518 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16519
16520 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16521 request similar header line checking. See section &<<SECTthesenhea>>&, which
16522 has more details about &'Sender:'& processing.
16523
16524
16525
16526
16527 .option local_from_prefix main string unset
16528 When Exim checks the &'From:'& header line of locally submitted messages for
16529 matching the login id (see &%local_from_check%& above), it can be configured to
16530 ignore certain prefixes and suffixes in the local part of the address. This is
16531 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16532 appropriate lists, in the same form as the &%local_part_prefix%& and
16533 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16534 example, if
16535 .code
16536 local_from_prefix = *-
16537 .endd
16538 is set, a &'From:'& line containing
16539 .code
16540 From: anything-user@your.domain.example
16541 .endd
16542 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16543 matches the actual sender address that is constructed from the login name and
16544 qualify domain.
16545
16546
16547 .option local_from_suffix main string unset
16548 See &%local_from_prefix%& above.
16549
16550
16551 .option local_interfaces main "string list" "see below"
16552 This option controls which network interfaces are used by the daemon for
16553 listening; they are also used to identify the local host when routing. Chapter
16554 &<<CHAPinterfaces>>& contains a full description of this option and the related
16555 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16556 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16557 &%local_interfaces%& is
16558 .code
16559 local_interfaces = 0.0.0.0
16560 .endd
16561 when Exim is built without IPv6 support; otherwise it is
16562 .code
16563 local_interfaces = <; ::0 ; 0.0.0.0
16564 .endd
16565
16566 .option local_scan_timeout main time 5m
16567 .cindex "timeout" "for &[local_scan()]& function"
16568 .cindex "&[local_scan()]& function" "timeout"
16569 This timeout applies to the &[local_scan()]& function (see chapter
16570 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16571 the incoming message is rejected with a temporary error if it is an SMTP
16572 message. For a non-SMTP message, the message is dropped and Exim ends with a
16573 non-zero code. The incident is logged on the main and reject logs.
16574
16575
16576
16577 .option local_sender_retain main boolean false
16578 .cindex "&'Sender:'& header line" "retaining from local submission"
16579 When a message is submitted locally (that is, not over a TCP/IP connection) by
16580 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16581 do not want this to happen, you must set &%local_sender_retain%&, and you must
16582 also set &%local_from_check%& to be false (Exim will complain if you do not).
16583 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16584 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16585
16586
16587
16588
16589 .option localhost_number main string&!! unset
16590 .cindex "host" "locally unique number for"
16591 .cindex "message ids" "with multiple hosts"
16592 .vindex "&$localhost_number$&"
16593 Exim's message ids are normally unique only within the local host. If
16594 uniqueness among a set of hosts is required, each host must set a different
16595 value for the &%localhost_number%& option. The string is expanded immediately
16596 after reading the configuration file (so that a number can be computed from the
16597 host name, for example) and the result of the expansion must be a number in the
16598 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16599 systems). This is available in subsequent string expansions via the variable
16600 &$localhost_number$&. When &%localhost_number is set%&, the final two
16601 characters of the message id, instead of just being a fractional part of the
16602 time, are computed from the time and the local host number as described in
16603 section &<<SECTmessiden>>&.
16604
16605
16606
16607 .option log_file_path main "string list&!!" "set at compile time"
16608 .cindex "log" "file path for"
16609 This option sets the path which is used to determine the names of Exim's log
16610 files, or indicates that logging is to be to syslog, or both. It is expanded
16611 when Exim is entered, so it can, for example, contain a reference to the host
16612 name. If no specific path is set for the log files at compile or runtime,
16613 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16614 they are written in a sub-directory called &_log_& in Exim's spool directory.
16615 A path must start with a slash.
16616 To send to syslog, use the word &"syslog"&.
16617 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16618 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16619 used. If this string is fixed at your installation (contains no expansion
16620 variables) it is recommended that you do not set this option in the
16621 configuration file, but instead supply the path using LOG_FILE_PATH in
16622 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16623 early on &-- in particular, failure to read the configuration file.
16624
16625
16626 .option log_selector main string unset
16627 .cindex "log" "selectors"
16628 This option can be used to reduce or increase the number of things that Exim
16629 writes to its log files. Its argument is made up of names preceded by plus or
16630 minus characters. For example:
16631 .code
16632 log_selector = +arguments -retry_defer
16633 .endd
16634 A list of possible names and what they control is given in the chapter on
16635 logging, in section &<<SECTlogselector>>&.
16636
16637
16638 .option log_timezone main boolean false
16639 .cindex "log" "timezone for entries"
16640 .vindex "&$tod_log$&"
16641 .vindex "&$tod_zone$&"
16642 By default, the timestamps on log lines are in local time without the
16643 timezone. This means that if your timezone changes twice a year, the timestamps
16644 in log lines are ambiguous for an hour when the clocks go back. One way of
16645 avoiding this problem is to set the timezone to UTC. An alternative is to set
16646 &%log_timezone%& true. This turns on the addition of the timezone offset to
16647 timestamps in log lines. Turning on this option can add quite a lot to the size
16648 of log files because each line is extended by 6 characters. Note that the
16649 &$tod_log$& variable contains the log timestamp without the zone, but there is
16650 another variable called &$tod_zone$& that contains just the timezone offset.
16651
16652
16653 .option lookup_open_max main integer 25
16654 .cindex "too many open files"
16655 .cindex "open files, too many"
16656 .cindex "file" "too many open"
16657 .cindex "lookup" "maximum open files"
16658 .cindex "limit" "open files for lookups"
16659 This option limits the number of simultaneously open files for single-key
16660 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16661 Exim normally keeps these files open during routing, because often the same
16662 file is required several times. If the limit is reached, Exim closes the least
16663 recently used file. Note that if you are using the &'ndbm'& library, it
16664 actually opens two files for each logical DBM database, though it still counts
16665 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16666 open files"& errors with NDBM, you need to reduce the value of
16667 &%lookup_open_max%&.
16668
16669
16670 .option max_username_length main integer 0
16671 .cindex "length of login name"
16672 .cindex "user name" "maximum length"
16673 .cindex "limit" "user name length"
16674 Some operating systems are broken in that they truncate long arguments to
16675 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16676 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16677 an argument that is longer behaves as if &[getpwnam()]& failed.
16678
16679
16680 .option message_body_newlines main bool false
16681 .cindex "message body" "newlines in variables"
16682 .cindex "newline" "in message body variables"
16683 .vindex "&$message_body$&"
16684 .vindex "&$message_body_end$&"
16685 By default, newlines in the message body are replaced by spaces when setting
16686 the &$message_body$& and &$message_body_end$& expansion variables. If this
16687 option is set true, this no longer happens.
16688
16689
16690 .option message_body_visible main integer 500
16691 .cindex "body of message" "visible size"
16692 .cindex "message body" "visible size"
16693 .vindex "&$message_body$&"
16694 .vindex "&$message_body_end$&"
16695 This option specifies how much of a message's body is to be included in the
16696 &$message_body$& and &$message_body_end$& expansion variables.
16697
16698
16699 .option message_id_header_domain main string&!! unset
16700 .cindex "&'Message-ID:'& header line"
16701 If this option is set, the string is expanded and used as the right hand side
16702 (domain) of the &'Message-ID:'& header that Exim creates if a
16703 locally-originated incoming message does not have one. &"Locally-originated"&
16704 means &"not received over TCP/IP."&
16705 Otherwise, the primary host name is used.
16706 Only letters, digits, dot and hyphen are accepted; any other characters are
16707 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16708 empty string, the option is ignored.
16709
16710
16711 .option message_id_header_text main string&!! unset
16712 If this variable is set, the string is expanded and used to augment the text of
16713 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16714 message does not have one. The text of this header is required by RFC 2822 to
16715 take the form of an address. By default, Exim uses its internal message id as
16716 the local part, and the primary host name as the domain. If this option is set,
16717 it is expanded, and provided the expansion is not forced to fail, and does not
16718 yield an empty string, the result is inserted into the header immediately
16719 before the @, separated from the internal message id by a dot. Any characters
16720 that are illegal in an address are automatically converted into hyphens. This
16721 means that variables such as &$tod_log$& can be used, because the spaces and
16722 colons will become hyphens.
16723
16724
16725 .option message_logs main boolean true
16726 .cindex "message logs" "disabling"
16727 .cindex "log" "message log; disabling"
16728 If this option is turned off, per-message log files are not created in the
16729 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16730 Exim, by reducing the number of files involved in handling a message from a
16731 minimum of four (header spool file, body spool file, delivery journal, and
16732 per-message log) to three. The other major I/O activity is Exim's main log,
16733 which is not affected by this option.
16734
16735
16736 .option message_size_limit main string&!! 50M
16737 .cindex "message" "size limit"
16738 .cindex "limit" "message size"
16739 .cindex "size" "of message, limit"
16740 This option limits the maximum size of message that Exim will process. The
16741 value is expanded for each incoming connection so, for example, it can be made
16742 to depend on the IP address of the remote host for messages arriving via
16743 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16744 optionally followed by K or M.
16745
16746 .cindex "SIZE" "ESMTP extension, advertising"
16747 .cindex "ESMTP extensions" SIZE
16748 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16749 service extension keyword.
16750
16751 &*Note*&: This limit cannot be made to depend on a message's sender or any
16752 other properties of an individual message, because it has to be advertised in
16753 the server's response to EHLO. String expansion failure causes a temporary
16754 error. A value of zero means no limit, but its use is not recommended. See also
16755 &%bounce_return_size_limit%&.
16756
16757 Incoming SMTP messages are failed with a 552 error if the limit is
16758 exceeded; locally-generated messages either get a stderr message or a delivery
16759 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16760 an oversized message is logged in both the main and the reject logs. See also
16761 the generic transport option &%message_size_limit%&, which limits the size of
16762 message that an individual transport can process.
16763
16764 If you use a virus-scanner and set this option to to a value larger than the
16765 maximum size that your virus-scanner is configured to support, you may get
16766 failures triggered by large mails.  The right size to configure for the
16767 virus-scanner depends upon what data is passed and the options in use but it's
16768 probably safest to just set it to a little larger than this value.  E.g., with a
16769 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16770 some problems may result.
16771
16772 A value of 0 will disable size limit checking; Exim will still advertise the
16773 SIZE extension in an EHLO response, but without a limit, so as to permit
16774 SMTP clients to still indicate the message size along with the MAIL verb.
16775
16776
16777 .option move_frozen_messages main boolean false
16778 .cindex "frozen messages" "moving"
16779 This option, which is available only if Exim has been built with the setting
16780 .code
16781 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16782 .endd
16783 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16784 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16785 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16786 standard utilities for handling such moved messages, and they do not show up in
16787 lists generated by &%-bp%& or by the Exim monitor.
16788
16789
16790 .option mua_wrapper main boolean false
16791 Setting this option true causes Exim to run in a very restrictive mode in which
16792 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16793 contains a full description of this facility.
16794
16795
16796
16797 .option mysql_servers main "string list" unset
16798 .cindex "MySQL" "server list"
16799 This option provides a list of MySQL servers and associated connection data, to
16800 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16801 option is available only if Exim has been built with MySQL support.
16802
16803
16804 .option never_users main "string list&!!" unset
16805 This option is expanded just once, at the start of Exim's processing. Local
16806 message deliveries are normally run in processes that are setuid to the
16807 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16808 It is usually desirable to prevent any deliveries from running as root, as a
16809 safety precaution.
16810
16811 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16812 list of users that must not be used for local deliveries. This list is fixed in
16813 the binary and cannot be overridden by the configuration file. By default, it
16814 contains just the single user name &"root"&. The &%never_users%& runtime option
16815 can be used to add more users to the fixed list.
16816
16817 If a message is to be delivered as one of the users on the fixed list or the
16818 &%never_users%& list, an error occurs, and delivery is deferred. A common
16819 example is
16820 .code
16821 never_users = root:daemon:bin
16822 .endd
16823 Including root is redundant if it is also on the fixed list, but it does no
16824 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16825 transport driver.
16826
16827
16828 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16829 This option gives the name for a unix-domain socket on which the daemon
16830 listens for work and information-requests.
16831 Only installations running multiple daemons sharing a spool directory
16832 should need to modify the default.
16833
16834 The option is expanded before use.
16835 If the platform supports Linux-style abstract socket names, the result
16836 is used with a nul byte prefixed.
16837 Otherwise,
16838 it should be a full path name and use a directory accessible
16839 to Exim.
16840
16841 If this option is set as empty,
16842 or the command line &%-oY%& option is used, or
16843 the command line uses a &%-oX%& option and does not use &%-oP%&,
16844 then a notifier socket is not created.
16845
16846
16847 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16848 .cindex "OpenSSL "compatibility options"
16849 This option allows an administrator to adjust the SSL options applied
16850 by OpenSSL to connections.  It is given as a space-separated list of items,
16851 each one to be +added or -subtracted from the current value.
16852
16853 This option is only available if Exim is built against OpenSSL.  The values
16854 available for this option vary according to the age of your OpenSSL install.
16855 The &"all"& value controls a subset of flags which are available, typically
16856 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16857 list the values known on your system and Exim should support all the
16858 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16859 names lose the leading &"SSL_OP_"& and are lower-cased.
16860
16861 Note that adjusting the options can have severe impact upon the security of
16862 SSL as used by Exim.  It is possible to disable safety checks and shoot
16863 yourself in the foot in various unpleasant ways.  This option should not be
16864 adjusted lightly.  An unrecognised item will be detected at startup, by
16865 invoking Exim with the &%-bV%& flag.
16866
16867 The option affects Exim operating both as a server and as a client.
16868
16869 Historical note: prior to release 4.80, Exim defaulted this value to
16870 "+dont_insert_empty_fragments", which may still be needed for compatibility
16871 with some clients, but which lowers security by increasing exposure to
16872 some now infamous attacks.
16873
16874 Examples:
16875 .code
16876 # Make both old MS and old Eudora happy:
16877 openssl_options = -all +microsoft_big_sslv3_buffer \
16878                        +dont_insert_empty_fragments
16879
16880 # Disable older protocol versions:
16881 openssl_options = +no_sslv2 +no_sslv3
16882 .endd
16883
16884 Possible options may include:
16885 .ilist
16886 &`all`&
16887 .next
16888 &`allow_unsafe_legacy_renegotiation`&
16889 .next
16890 &`cipher_server_preference`&
16891 .next
16892 &`dont_insert_empty_fragments`&
16893 .next
16894 &`ephemeral_rsa`&
16895 .next
16896 &`legacy_server_connect`&
16897 .next
16898 &`microsoft_big_sslv3_buffer`&
16899 .next
16900 &`microsoft_sess_id_bug`&
16901 .next
16902 &`msie_sslv2_rsa_padding`&
16903 .next
16904 &`netscape_challenge_bug`&
16905 .next
16906 &`netscape_reuse_cipher_change_bug`&
16907 .next
16908 &`no_compression`&
16909 .next
16910 &`no_session_resumption_on_renegotiation`&
16911 .next
16912 &`no_sslv2`&
16913 .next
16914 &`no_sslv3`&
16915 .next
16916 &`no_ticket`&
16917 .next
16918 &`no_tlsv1`&
16919 .next
16920 &`no_tlsv1_1`&
16921 .next
16922 &`no_tlsv1_2`&
16923 .next
16924 &`safari_ecdhe_ecdsa_bug`&
16925 .next
16926 &`single_dh_use`&
16927 .next
16928 &`single_ecdh_use`&
16929 .next
16930 &`ssleay_080_client_dh_bug`&
16931 .next
16932 &`sslref2_reuse_cert_type_bug`&
16933 .next
16934 &`tls_block_padding_bug`&
16935 .next
16936 &`tls_d5_bug`&
16937 .next
16938 &`tls_rollback_bug`&
16939 .endlist
16940
16941 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16942 all clients connecting using the MacOS SecureTransport TLS facility prior
16943 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16944 to negotiate TLS then this option value might help, provided that your OpenSSL
16945 release is new enough to contain this work-around.  This may be a situation
16946 where you have to upgrade OpenSSL to get buggy clients working.
16947
16948
16949 .option oracle_servers main "string list" unset
16950 .cindex "Oracle" "server list"
16951 This option provides a list of Oracle servers and associated connection data,
16952 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16953 The option is available only if Exim has been built with Oracle support.
16954
16955
16956 .option percent_hack_domains main "domain list&!!" unset
16957 .cindex "&""percent hack""&"
16958 .cindex "source routing" "in email address"
16959 .cindex "address" "source-routed"
16960 The &"percent hack"& is the convention whereby a local part containing a
16961 percent sign is re-interpreted as a new email address, with the percent
16962 replaced by @. This is sometimes called &"source routing"&, though that term is
16963 also applied to RFC 2822 addresses that begin with an @ character. If this
16964 option is set, Exim implements the percent facility for those domains listed,
16965 but no others. This happens before an incoming SMTP address is tested against
16966 an ACL.
16967
16968 &*Warning*&: The &"percent hack"& has often been abused by people who are
16969 trying to get round relaying restrictions. For this reason, it is best avoided
16970 if at all possible. Unfortunately, a number of less security-conscious MTAs
16971 implement it unconditionally. If you are running Exim on a gateway host, and
16972 routing mail through to internal MTAs without processing the local parts, it is
16973 a good idea to reject recipient addresses with percent characters in their
16974 local parts. Exim's default configuration does this.
16975
16976
16977 .option perl_at_start main boolean false
16978 .cindex "Perl"
16979 This option is available only when Exim is built with an embedded Perl
16980 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16981
16982
16983 .option perl_startup main string unset
16984 .cindex "Perl"
16985 This option is available only when Exim is built with an embedded Perl
16986 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16987
16988 .option perl_taintmode main boolean false
16989 .cindex "Perl"
16990 This option enables the taint mode of the embedded Perl interpreter.
16991
16992
16993 .option pgsql_servers main "string list" unset
16994 .cindex "PostgreSQL lookup type" "server list"
16995 This option provides a list of PostgreSQL servers and associated connection
16996 data, to be used in conjunction with &(pgsql)& lookups (see section
16997 &<<SECID72>>&). The option is available only if Exim has been built with
16998 PostgreSQL support.
16999
17000
17001 .option pid_file_path main string&!! "set at compile time"
17002 .cindex "daemon" "pid file path"
17003 .cindex "pid file, path for"
17004 This option sets the name of the file to which the Exim daemon writes its
17005 process id. The string is expanded, so it can contain, for example, references
17006 to the host name:
17007 .code
17008 pid_file_path = /var/log/$primary_hostname/exim.pid
17009 .endd
17010 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
17011 spool directory.
17012 The value set by the option can be overridden by the &%-oP%& command line
17013 option. A pid file is not written if a &"non-standard"& daemon is run by means
17014 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
17015
17016
17017 .option pipelining_advertise_hosts main "host list&!!" *
17018 .cindex "PIPELINING" "suppressing advertising"
17019 .cindex "ESMTP extensions" PIPELINING
17020 This option can be used to suppress the advertisement of the SMTP
17021 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
17022 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
17023 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
17024 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
17025 that clients will use it; &"out of order"& commands that are &"expected"& do
17026 not count as protocol errors (see &%smtp_max_synprot_errors%&).
17027
17028 .option pipelining_connect_advertise_hosts main "host list&!!" *
17029 .cindex "pipelining" "early connection"
17030 .cindex "pipelining" PIPE_CONNECT
17031 .cindex "ESMTP extensions" PIPE_CONNECT
17032 If Exim is built with the SUPPORT_PIPE_CONNECT build option
17033 this option controls which hosts the facility is advertised to
17034 and from which pipeline early-connection (before MAIL) SMTP
17035 commands are acceptable.
17036 When used, the pipelining saves on roundtrip times.
17037
17038 See also the &%hosts_pipe_connect%& smtp transport option.
17039
17040 The SMTP service extension keyword advertised is &"PIPE_CONNECT"&.
17041
17042
17043 .option prdr_enable main boolean false
17044 .cindex "PRDR" "enabling on server"
17045 .cindex "ESMTP extensions" PRDR
17046 This option can be used to enable the Per-Recipient Data Response extension
17047 to SMTP, defined by Eric Hall.
17048 If the option is set, PRDR is advertised by Exim when operating as a server.
17049 If the client requests PRDR, and more than one recipient, for a message
17050 an additional ACL is called for each recipient after the message content
17051 is received.  See section &<<SECTPRDRACL>>&.
17052
17053 .option preserve_message_logs main boolean false
17054 .cindex "message logs" "preserving"
17055 If this option is set, message log files are not deleted when messages are
17056 completed. Instead, they are moved to a sub-directory of the spool directory
17057 called &_msglog.OLD_&, where they remain available for statistical or debugging
17058 purposes. This is a dangerous option to set on systems with any appreciable
17059 volume of mail. Use with care!
17060
17061
17062 .option primary_hostname main string "see below"
17063 .cindex "name" "of local host"
17064 .cindex "host" "name of local"
17065 .cindex "local host" "name of"
17066 .vindex "&$primary_hostname$&"
17067 This specifies the name of the current host. It is used in the default EHLO or
17068 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
17069 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
17070 The value is also used by default in some SMTP response messages from an Exim
17071 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
17072
17073 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
17074 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
17075 contains only one component, Exim passes it to &[gethostbyname()]& (or
17076 &[getipnodebyname()]& when available) in order to obtain the fully qualified
17077 version. The variable &$primary_hostname$& contains the host name, whether set
17078 explicitly by this option, or defaulted.
17079
17080
17081 .option print_topbitchars main boolean false
17082 .cindex "printing characters"
17083 .cindex "8-bit characters"
17084 By default, Exim considers only those characters whose codes lie in the range
17085 32&--126 to be printing characters. In a number of circumstances (for example,
17086 when writing log entries) non-printing characters are converted into escape
17087 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
17088 is set, code values of 128 and above are also considered to be printing
17089 characters.
17090
17091 This option also affects the header syntax checks performed by the
17092 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
17093 the user's full name when constructing From: and Sender: addresses (as
17094 described in section &<<SECTconstr>>&). Setting this option can cause
17095 Exim to generate eight bit message headers that do not conform to the
17096 standards.
17097
17098
17099 .option process_log_path main string unset
17100 .cindex "process log path"
17101 .cindex "log" "process log"
17102 .cindex "&'exiwhat'&"
17103 This option sets the name of the file to which an Exim process writes its
17104 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
17105 utility script. If this option is unset, the file called &_exim-process.info_&
17106 in Exim's spool directory is used. The ability to specify the name explicitly
17107 can be useful in environments where two different Exims are running, using
17108 different spool directories.
17109
17110
17111 .option prod_requires_admin main boolean true
17112 .cindex "restricting access to features"
17113 .oindex "&%-M%&"
17114 .oindex "&%-R%&"
17115 .oindex "&%-q%&"
17116 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
17117 admin user unless &%prod_requires_admin%& is set false. See also
17118 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
17119
17120
17121 .option proxy_protocol_timeout main time 3s
17122 .cindex proxy "proxy protocol"
17123 This option sets the timeout for proxy protocol negotiation.
17124 For details see section &<<SECTproxyInbound>>&.
17125
17126
17127 .option qualify_domain main string "see below"
17128 .cindex "domain" "for qualifying addresses"
17129 .cindex "address" "qualification"
17130 This option specifies the domain name that is added to any envelope sender
17131 addresses that do not have a domain qualification. It also applies to
17132 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
17133 are accepted by default only for locally-generated messages. Qualification is
17134 also applied to addresses in header lines such as &'From:'& and &'To:'& for
17135 locally-generated messages, unless the &%-bnq%& command line option is used.
17136
17137 Messages from external sources must always contain fully qualified addresses,
17138 unless the sending host matches &%sender_unqualified_hosts%& or
17139 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
17140 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
17141 necessary. Internally, Exim always works with fully qualified envelope
17142 addresses. If &%qualify_domain%& is not set, it defaults to the
17143 &%primary_hostname%& value.
17144
17145
17146 .option qualify_recipient main string "see below"
17147 This option allows you to specify a different domain for qualifying recipient
17148 addresses to the one that is used for senders. See &%qualify_domain%& above.
17149
17150
17151
17152 .option queue_domains main "domain list&!!" unset
17153 .cindex "domain" "specifying non-immediate delivery"
17154 .cindex "queueing incoming messages"
17155 .cindex "message" "queueing certain domains"
17156 This option lists domains for which immediate delivery is not required.
17157 A delivery process is started whenever a message is received, but only those
17158 domains that do not match are processed. All other deliveries wait until the
17159 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
17160
17161
17162 .option queue_fast_ramp main boolean false
17163 .cindex "queue runner" "two phase"
17164 .cindex "queue" "double scanning"
17165 If set to true, two-phase queue runs, initiated using &%-qq%& on the
17166 command line, may start parallel delivery processes during their first
17167 phase.  This will be done when a threshold number of messages have been
17168 routed for a single host.
17169
17170
17171 .option queue_list_requires_admin main boolean true
17172 .cindex "restricting access to features"
17173 .oindex "&%-bp%&"
17174 The &%-bp%& command-line option, which lists the messages that are on the
17175 queue, requires the caller to be an admin user unless
17176 &%queue_list_requires_admin%& is set false.
17177 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
17178
17179
17180 .option queue_only main boolean false
17181 .cindex "queueing incoming messages"
17182 .cindex "message" "queueing unconditionally"
17183 If &%queue_only%& is set, a delivery process is not automatically started
17184 whenever a message is received. Instead, the message waits in the queue for the
17185 next queue run. Even if &%queue_only%& is false, incoming messages may not get
17186 delivered immediately when certain conditions (such as heavy load) occur.
17187
17188 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
17189 and &%-odi%& command line options override &%queue_only%& unless
17190 &%queue_only_override%& is set false. See also &%queue_only_file%&,
17191 &%queue_only_load%&, and &%smtp_accept_queue%&.
17192
17193
17194 .option queue_only_file main string unset
17195 .cindex "queueing incoming messages"
17196 .cindex "message" "queueing by file existence"
17197 This option can be set to a colon-separated list of absolute path names, each
17198 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17199 it tests for the existence of each listed path using a call to &[stat()]&. For
17200 each path that exists, the corresponding queueing option is set.
17201 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17202 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17203 .code
17204 queue_only_file = smtp/some/file
17205 .endd
17206 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17207 &_/some/file_& exists.
17208
17209
17210 .option queue_only_load main fixed-point unset
17211 .cindex "load average"
17212 .cindex "queueing incoming messages"
17213 .cindex "message" "queueing by load"
17214 If the system load average is higher than this value, incoming messages from
17215 all sources are queued, and no automatic deliveries are started. If this
17216 happens during local or remote SMTP input, all subsequent messages received on
17217 the same SMTP connection are queued by default, whatever happens to the load in
17218 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17219 false.
17220
17221 Deliveries will subsequently be performed by queue runner processes. This
17222 option has no effect on ancient operating systems on which Exim cannot
17223 determine the load average. See also &%deliver_queue_load_max%& and
17224 &%smtp_load_reserve%&.
17225
17226
17227 .option queue_only_load_latch main boolean true
17228 .cindex "load average" "re-evaluating per message"
17229 When this option is true (the default), once one message has been queued
17230 because the load average is higher than the value set by &%queue_only_load%&,
17231 all subsequent messages received on the same SMTP connection are also queued.
17232 This is a deliberate choice; even though the load average may fall below the
17233 threshold, it doesn't seem right to deliver later messages on the same
17234 connection when not delivering earlier ones. However, there are special
17235 circumstances such as very long-lived connections from scanning appliances
17236 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17237 should be set false. This causes the value of the load average to be
17238 re-evaluated for each message.
17239
17240
17241 .option queue_only_override main boolean true
17242 .cindex "queueing incoming messages"
17243 When this option is true, the &%-od%&&'x'& command line options override the
17244 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17245 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17246 to override; they are accepted, but ignored.
17247
17248
17249 .option queue_run_in_order main boolean false
17250 .cindex "queue runner" "processing messages in order"
17251 If this option is set, queue runs happen in order of message arrival instead of
17252 in an arbitrary order. For this to happen, a complete list of the entire queue
17253 must be set up before the deliveries start. When the queue is all held in a
17254 single directory (the default), a single list is created for both the ordered
17255 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17256 single list is not created when &%queue_run_in_order%& is false. In this case,
17257 the sub-directories are processed one at a time (in a random order), and this
17258 avoids setting up one huge list for the whole queue. Thus, setting
17259 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17260 when the queue is large, because of the extra work in setting up the single,
17261 large list. In most situations, &%queue_run_in_order%& should not be set.
17262
17263
17264
17265 .option queue_run_max main integer&!! 5
17266 .cindex "queue runner" "maximum number of"
17267 This controls the maximum number of queue runner processes that an Exim daemon
17268 can run simultaneously. This does not mean that it starts them all at once,
17269 but rather that if the maximum number are still running when the time comes to
17270 start another one, it refrains from starting another one. This can happen with
17271 very large queues and/or very sluggish deliveries. This option does not,
17272 however, interlock with other processes, so additional queue runners can be
17273 started by other means, or by killing and restarting the daemon.
17274
17275 Setting this option to zero does not suppress queue runs; rather, it disables
17276 the limit, allowing any number of simultaneous queue runner processes to be
17277 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17278 the daemon's command line.
17279
17280 .cindex queues named
17281 .cindex "named queues" "resource limit"
17282 To set limits for different named queues use
17283 an expansion depending on the &$queue_name$& variable.
17284
17285 .option queue_smtp_domains main "domain list&!!" unset
17286 .cindex "queueing incoming messages"
17287 .cindex "message" "queueing remote deliveries"
17288 .cindex "first pass routing"
17289 When this option is set, a delivery process is started whenever a message is
17290 received, routing is performed, and local deliveries take place.
17291 However, if any SMTP deliveries are required for domains that match
17292 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17293 message waits in the queue for the next queue run. Since routing of the message
17294 has taken place, Exim knows to which remote hosts it must be delivered, and so
17295 when the queue run happens, multiple messages for the same host are delivered
17296 over a single SMTP connection. The &%-odqs%& command line option causes all
17297 SMTP deliveries to be queued in this way, and is equivalent to setting
17298 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17299 &%queue_domains%&.
17300
17301
17302 .option receive_timeout main time 0s
17303 .cindex "timeout" "for non-SMTP input"
17304 This option sets the timeout for accepting a non-SMTP message, that is, the
17305 maximum time that Exim waits when reading a message on the standard input. If
17306 the value is zero, it will wait forever. This setting is overridden by the
17307 &%-or%& command line option. The timeout for incoming SMTP messages is
17308 controlled by &%smtp_receive_timeout%&.
17309
17310 .option received_header_text main string&!! "see below"
17311 .cindex "customizing" "&'Received:'& header"
17312 .cindex "&'Received:'& header line" "customizing"
17313 This string defines the contents of the &'Received:'& message header that is
17314 added to each message, except for the timestamp, which is automatically added
17315 on at the end (preceded by a semicolon). The string is expanded each time it is
17316 used. If the expansion yields an empty string, no &'Received:'& header line is
17317 added to the message. Otherwise, the string should start with the text
17318 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17319 header lines.
17320 The default setting is:
17321
17322 .code
17323 received_header_text = Received: \
17324   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17325     {${if def:sender_ident \
17326       {from ${quote_local_part:$sender_ident} }}\
17327         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17328   by $primary_hostname \
17329   ${if def:received_protocol {with $received_protocol }}\
17330   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17331   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17332   (Exim $version_number)\n\t\
17333   ${if def:sender_address \
17334   {(envelope-from <$sender_address>)\n\t}}\
17335   id $message_exim_id\
17336   ${if def:received_for {\n\tfor $received_for}}
17337 .endd
17338
17339 The references to the TLS version and cipher are
17340 omitted when Exim is built without TLS
17341 support. The use of conditional expansions ensures that this works for both
17342 locally generated messages and messages received from remote hosts, giving
17343 header lines such as the following:
17344 .code
17345 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17346 by marley.carol.example with esmtp (Exim 4.00)
17347 (envelope-from <bob@carol.example>)
17348 id 16IOWa-00019l-00
17349 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17350 Received: by scrooge.carol.example with local (Exim 4.00)
17351 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17352 .endd
17353 Until the body of the message has been received, the timestamp is the time when
17354 the message started to be received. Once the body has arrived, and all policy
17355 checks have taken place, the timestamp is updated to the time at which the
17356 message was accepted.
17357
17358
17359 .option received_headers_max main integer 30
17360 .cindex "loop" "prevention"
17361 .cindex "mail loop prevention"
17362 .cindex "&'Received:'& header line" "counting"
17363 When a message is to be delivered, the number of &'Received:'& headers is
17364 counted, and if it is greater than this parameter, a mail loop is assumed to
17365 have occurred, the delivery is abandoned, and an error message is generated.
17366 This applies to both local and remote deliveries.
17367
17368
17369 .option recipient_unqualified_hosts main "host list&!!" unset
17370 .cindex "unqualified addresses"
17371 .cindex "host" "unqualified addresses from"
17372 This option lists those hosts from which Exim is prepared to accept unqualified
17373 recipient addresses in message envelopes. The addresses are made fully
17374 qualified by the addition of the &%qualify_recipient%& value. This option also
17375 affects message header lines. Exim does not reject unqualified recipient
17376 addresses in headers, but it qualifies them only if the message came from a
17377 host that matches &%recipient_unqualified_hosts%&,
17378 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17379 option was not set.
17380
17381
17382 .option recipients_max main integer 50000
17383 .cindex "limit" "number of recipients"
17384 .cindex "recipient" "maximum number"
17385 If this option is set greater than zero, it specifies the maximum number of
17386 original recipients for any message. Additional recipients that are generated
17387 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17388 all recipients over the limit; earlier recipients are delivered as normal.
17389 Non-SMTP messages with too many recipients are failed, and no deliveries are
17390 done.
17391
17392 .cindex "RCPT" "maximum number of incoming"
17393 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17394 RCPT commands in a single message.
17395
17396
17397 .option recipients_max_reject main boolean false
17398 If this option is set true, Exim rejects SMTP messages containing too many
17399 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17400 error to the eventual DATA command. Otherwise (the default) it gives a 452
17401 error to the surplus RCPT commands and accepts the message on behalf of the
17402 initial set of recipients. The remote server should then re-send the message
17403 for the remaining recipients at a later time.
17404
17405
17406 .option remote_max_parallel main integer 2
17407 .cindex "delivery" "parallelism for remote"
17408 This option controls parallel delivery of one message to a number of remote
17409 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17410 does all the remote deliveries for a message one by one. Otherwise, if a single
17411 message has to be delivered to more than one remote host, or if several copies
17412 have to be sent to the same remote host, up to &%remote_max_parallel%&
17413 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17414 deliveries are required, the maximum number of processes are started, and as
17415 each one finishes, another is begun. The order of starting processes is the
17416 same as if sequential delivery were being done, and can be controlled by the
17417 &%remote_sort_domains%& option. If parallel delivery takes place while running
17418 with debugging turned on, the debugging output from each delivery process is
17419 tagged with its process id.
17420
17421 This option controls only the maximum number of parallel deliveries for one
17422 message in one Exim delivery process. Because Exim has no central queue
17423 manager, there is no way of controlling the total number of simultaneous
17424 deliveries if the configuration allows a delivery attempt as soon as a message
17425 is received.
17426
17427 See also the &%max_parallel%& generic transport option,
17428 and the &%serialize_hosts%& smtp transport option.
17429
17430 .cindex "number of deliveries"
17431 .cindex "delivery" "maximum number of"
17432 If you want to control the total number of deliveries on the system, you
17433 need to set the &%queue_only%& option. This ensures that all incoming messages
17434 are added to the queue without starting a delivery process. Then set up an Exim
17435 daemon to start queue runner processes at appropriate intervals (probably
17436 fairly often, for example, every minute), and limit the total number of queue
17437 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17438 delivers only one message at a time, the maximum number of deliveries that can
17439 then take place at once is &%queue_run_max%& multiplied by
17440 &%remote_max_parallel%&.
17441
17442 If it is purely remote deliveries you want to control, use
17443 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17444 doing the SMTP routing before queueing, so that several messages for the same
17445 host will eventually get delivered down the same connection.
17446
17447
17448 .option remote_sort_domains main "domain list&!!" unset
17449 .cindex "sorting remote deliveries"
17450 .cindex "delivery" "sorting remote"
17451 When there are a number of remote deliveries for a message, they are sorted by
17452 domain into the order given by this list. For example,
17453 .code
17454 remote_sort_domains = *.cam.ac.uk:*.uk
17455 .endd
17456 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17457 then to those in the &%uk%& domain, then to any others.
17458
17459
17460 .option retry_data_expire main time 7d
17461 .cindex "hints database" "data expiry"
17462 This option sets a &"use before"& time on retry information in Exim's hints
17463 database. Any older retry data is ignored. This means that, for example, once a
17464 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17465 past failures.
17466
17467
17468 .option retry_interval_max main time 24h
17469 .cindex "retry" "limit on interval"
17470 .cindex "limit" "on retry interval"
17471 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17472 intervals between delivery attempts for messages that cannot be delivered
17473 straight away. This option sets an overall limit to the length of time between
17474 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17475 the default value.
17476
17477
17478 .option return_path_remove main boolean true
17479 .cindex "&'Return-path:'& header line" "removing"
17480 RFC 2821, section 4.4, states that an SMTP server must insert a
17481 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17482 The &'Return-path:'& header preserves the sender address as received in the
17483 MAIL command. This description implies that this header should not be present
17484 in an incoming message. If &%return_path_remove%& is true, any existing
17485 &'Return-path:'& headers are removed from messages at the time they are
17486 received. Exim's transports have options for adding &'Return-path:'& headers at
17487 the time of delivery. They are normally used only for final local deliveries.
17488
17489
17490 .option return_size_limit main integer 100K
17491 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17492
17493
17494 .option rfc1413_hosts main "host list&!!" @[]
17495 .cindex "RFC 1413"
17496 .cindex "host" "for RFC 1413 calls"
17497 RFC 1413 identification calls are made to any client host which matches
17498 an item in the list.
17499 The default value specifies just this host, being any local interface
17500 for the system.
17501
17502 .option rfc1413_query_timeout main time 0s
17503 .cindex "RFC 1413" "query timeout"
17504 .cindex "timeout" "for RFC 1413 call"
17505 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17506 no RFC 1413 calls are ever made.
17507
17508
17509 .option sender_unqualified_hosts main "host list&!!" unset
17510 .cindex "unqualified addresses"
17511 .cindex "host" "unqualified addresses from"
17512 This option lists those hosts from which Exim is prepared to accept unqualified
17513 sender addresses. The addresses are made fully qualified by the addition of
17514 &%qualify_domain%&. This option also affects message header lines. Exim does
17515 not reject unqualified addresses in headers that contain sender addresses, but
17516 it qualifies them only if the message came from a host that matches
17517 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17518 using TCP/IP), and the &%-bnq%& option was not set.
17519
17520
17521 .option slow_lookup_log main integer 0
17522 .cindex "logging" "slow lookups"
17523 .cindex "dns" "logging slow lookups"
17524 This option controls logging of slow lookups.
17525 If the value is nonzero it is taken as a number of milliseconds
17526 and lookups taking longer than this are logged.
17527 Currently this applies only to DNS lookups.
17528
17529
17530
17531 .option smtp_accept_keepalive main boolean true
17532 .cindex "keepalive" "on incoming connection"
17533 This option controls the setting of the SO_KEEPALIVE option on incoming
17534 TCP/IP socket connections. When set, it causes the kernel to probe idle
17535 connections periodically, by sending packets with &"old"& sequence numbers. The
17536 other end of the connection should send an acknowledgment if the connection is
17537 still okay or a reset if the connection has been aborted. The reason for doing
17538 this is that it has the beneficial effect of freeing up certain types of
17539 connection that can get stuck when the remote host is disconnected without
17540 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17541 hours to detect unreachable hosts.
17542
17543
17544
17545 .option smtp_accept_max main integer 20
17546 .cindex "limit" "incoming SMTP connections"
17547 .cindex "SMTP" "incoming connection count"
17548 .cindex "inetd"
17549 This option specifies the maximum number of simultaneous incoming SMTP calls
17550 that Exim will accept. It applies only to the listening daemon; there is no
17551 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17552 value is set to zero, no limit is applied. However, it is required to be
17553 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17554 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17555
17556 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17557 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17558 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17559 and &%smtp_load_reserve%& are then checked before accepting the connection.
17560
17561
17562 .option smtp_accept_max_nonmail main integer 10
17563 .cindex "limit" "non-mail SMTP commands"
17564 .cindex "SMTP" "limiting non-mail commands"
17565 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17566 the connection if there are too many. This option defines &"too many"&. The
17567 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17568 client looping sending EHLO, for example. The check is applied only if the
17569 client host matches &%smtp_accept_max_nonmail_hosts%&.
17570
17571 When a new message is expected, one occurrence of RSET is not counted. This
17572 allows a client to send one RSET between messages (this is not necessary,
17573 but some clients do it). Exim also allows one uncounted occurrence of HELO
17574 or EHLO, and one occurrence of STARTTLS between messages. After
17575 starting up a TLS session, another EHLO is expected, and so it too is not
17576 counted. The first occurrence of AUTH in a connection, or immediately
17577 following STARTTLS is not counted. Otherwise, all commands other than
17578 MAIL, RCPT, DATA, and QUIT are counted.
17579
17580
17581 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17582 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17583 check by setting this option. The default value makes it apply to all hosts. By
17584 changing the value, you can exclude any badly-behaved hosts that you have to
17585 live with.
17586
17587
17588 . Allow this long option name to split; give it unsplit as a fifth argument
17589 . for the automatic .oindex that is generated by .option.
17590 . We insert " &~&~" which is both pretty nasty visually and results in
17591 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17592 . zero-width-space, which would be nicer visually and results in (at least)
17593 . html that Firefox will split on when it's forced to reflow (rather than
17594 . inserting a horizontal scrollbar).  However, the text is still not
17595 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17596 . the option name to split.
17597
17598 .option "smtp_accept_max_per_connection" main integer&!! 1000 &&&
17599          smtp_accept_max_per_connection
17600 .cindex "SMTP" "limiting incoming message count"
17601 .cindex "limit" "messages per SMTP connection"
17602 The value of this option limits the number of MAIL commands that Exim is
17603 prepared to accept over a single SMTP connection, whether or not each command
17604 results in the transfer of a message. After the limit is reached, a 421
17605 response is given to subsequent MAIL commands. This limit is a safety
17606 precaution against a client that goes mad (incidents of this type have been
17607 seen).
17608 The option is expanded after the HELO or EHLO is received
17609 and may depend on values available at that time.
17610 An empty or zero value after expansion removes the limit.
17611
17612
17613 .option smtp_accept_max_per_host main string&!! unset
17614 .cindex "limit" "SMTP connections from one host"
17615 .cindex "host" "limiting SMTP connections from"
17616 This option restricts the number of simultaneous IP connections from a single
17617 host (strictly, from a single IP address) to the Exim daemon. The option is
17618 expanded, to enable different limits to be applied to different hosts by
17619 reference to &$sender_host_address$&. Once the limit is reached, additional
17620 connection attempts from the same host are rejected with error code 421. This
17621 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17622 of zero imposes no limit. If this option is set greater than zero, it is
17623 required that &%smtp_accept_max%& be non-zero.
17624
17625 &*Warning*&: When setting this option you should not use any expansion
17626 constructions that take an appreciable amount of time. The expansion and test
17627 happen in the main daemon loop, in order to reject additional connections
17628 without forking additional processes (otherwise a denial-of-service attack
17629 could cause a vast number or processes to be created). While the daemon is
17630 doing this processing, it cannot accept any other incoming connections.
17631
17632
17633
17634 .option smtp_accept_queue main integer 0
17635 .cindex "SMTP" "incoming connection count"
17636 .cindex "queueing incoming messages"
17637 .cindex "message" "queueing by SMTP connection count"
17638 If the number of simultaneous incoming SMTP connections being handled via the
17639 listening daemon exceeds this value, messages received by SMTP are just placed
17640 in the queue; no delivery processes are started automatically. The count is
17641 fixed at the start of an SMTP connection. It cannot be updated in the
17642 subprocess that receives messages, and so the queueing or not queueing applies
17643 to all messages received in the same connection.
17644
17645 A value of zero implies no limit, and clearly any non-zero value is useful only
17646 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17647 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17648 various &%-od%&&'x'& command line options.
17649
17650
17651 . See the comment on smtp_accept_max_per_connection
17652
17653 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17654          smtp_accept_queue_per_connection
17655 .cindex "queueing incoming messages"
17656 .cindex "message" "queueing by message count"
17657 This option limits the number of delivery processes that Exim starts
17658 automatically when receiving messages via SMTP, whether via the daemon or by
17659 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17660 and the number of messages received in a single SMTP session exceeds this
17661 number, subsequent messages are placed in the queue, but no delivery processes
17662 are started. This helps to limit the number of Exim processes when a server
17663 restarts after downtime and there is a lot of mail waiting for it on other
17664 systems. On large systems, the default should probably be increased, and on
17665 dial-in client systems it should probably be set to zero (that is, disabled).
17666
17667
17668 .option smtp_accept_reserve main integer 0
17669 .cindex "SMTP" "incoming call count"
17670 .cindex "host" "reserved"
17671 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17672 number of SMTP connections that are reserved for connections from the hosts
17673 that are specified in &%smtp_reserve_hosts%&. The value set in
17674 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17675 restricted to this number of connections; the option specifies a minimum number
17676 of connection slots for them, not a maximum. It is a guarantee that this group
17677 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17678 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17679 individual host.
17680
17681 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17682 set to 5, once there are 45 active connections (from any hosts), new
17683 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17684 provided the other criteria for acceptance are met.
17685
17686
17687 .option smtp_active_hostname main string&!! unset
17688 .cindex "host" "name in SMTP responses"
17689 .cindex "SMTP" "host name in responses"
17690 .vindex "&$primary_hostname$&"
17691 This option is provided for multi-homed servers that want to masquerade as
17692 several different hosts. At the start of an incoming SMTP connection, its value
17693 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17694 responses. For example, it is used as domain name in the response to an
17695 incoming HELO or EHLO command.
17696
17697 .vindex "&$smtp_active_hostname$&"
17698 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17699 is saved with any messages that are received. It is therefore available for use
17700 in routers and transports when the message is later delivered.
17701
17702 If this option is unset, or if its expansion is forced to fail, or if the
17703 expansion results in an empty string, the value of &$primary_hostname$& is
17704 used. Other expansion failures cause a message to be written to the main and
17705 panic logs, and the SMTP command receives a temporary error. Typically, the
17706 value of &%smtp_active_hostname%& depends on the incoming interface address.
17707 For example:
17708 .code
17709 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17710   {cox.mydomain}{box.mydomain}}
17711 .endd
17712
17713 Although &$smtp_active_hostname$& is primarily concerned with incoming
17714 messages, it is also used as the default for HELO commands in callout
17715 verification if there is no remote transport from which to obtain a
17716 &%helo_data%& value.
17717
17718 .option smtp_backlog_monitor main integer 0
17719 .cindex "connection backlog" monitoring
17720 If this option is set to greater than zero, and the backlog of available
17721 TCP connections on a socket listening for SMTP is larger than it, a line
17722 is logged giving the value and the socket address and port.
17723 The value is retrived jsut before an accept call.
17724 This facility is only available on Linux.
17725
17726 .option smtp_banner main string&!! "see below"
17727 .cindex "SMTP" "welcome banner"
17728 .cindex "banner for SMTP"
17729 .cindex "welcome banner for SMTP"
17730 .cindex "customizing" "SMTP banner"
17731 This string, which is expanded every time it is used, is output as the initial
17732 positive response to an SMTP connection. The default setting is:
17733 .code
17734 smtp_banner = $smtp_active_hostname ESMTP Exim \
17735   $version_number $tod_full
17736 .endd
17737 Failure to expand the string causes a panic error. If you want to create a
17738 multiline response to the initial SMTP connection, use &"\n"& in the string at
17739 appropriate points, but not at the end. Note that the 220 code is not included
17740 in this string. Exim adds it automatically (several times in the case of a
17741 multiline response).
17742
17743
17744 .option smtp_check_spool_space main boolean true
17745 .cindex "checking disk space"
17746 .cindex "disk space, checking"
17747 .cindex "spool directory" "checking space"
17748 When this option is set, if an incoming SMTP session encounters the SIZE
17749 option on a MAIL command, it checks that there is enough space in the
17750 spool directory's partition to accept a message of that size, while still
17751 leaving free the amount specified by &%check_spool_space%& (even if that value
17752 is zero). If there isn't enough space, a temporary error code is returned.
17753
17754
17755 .option smtp_connect_backlog main integer 20
17756 .cindex "connection backlog" "set maximum"
17757 .cindex "SMTP" "connection backlog"
17758 .cindex "backlog of connections"
17759 This option specifies a maximum number of waiting SMTP connections. Exim passes
17760 this value to the TCP/IP system when it sets up its listener. Once this number
17761 of connections are waiting for the daemon's attention, subsequent connection
17762 attempts are refused at the TCP/IP level. At least, that is what the manuals
17763 say; in some circumstances such connection attempts have been observed to time
17764 out instead. For large systems it is probably a good idea to increase the
17765 value (to 50, say). It also gives some protection against denial-of-service
17766 attacks by SYN flooding.
17767
17768
17769 .option smtp_enforce_sync main boolean true
17770 .cindex "SMTP" "synchronization checking"
17771 .cindex "synchronization checking in SMTP"
17772 The SMTP protocol specification requires the client to wait for a response from
17773 the server at certain points in the dialogue. Without PIPELINING these
17774 synchronization points are after every command; with PIPELINING they are
17775 fewer, but they still exist.
17776
17777 Some spamming sites send out a complete set of SMTP commands without waiting
17778 for any response. Exim protects against this by rejecting a message if the
17779 client has sent further input when it should not have. The error response &"554
17780 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17781 for this error cannot be perfect because of transmission delays (unexpected
17782 input may be on its way but not yet received when Exim checks). However, it
17783 does detect many instances.
17784
17785 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17786 If you want to disable the check selectively (for example, only for certain
17787 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17788 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17789
17790
17791
17792 .option smtp_etrn_command main string&!! unset
17793 .cindex "ETRN" "command to be run"
17794 .cindex "ESMTP extensions" ETRN
17795 .vindex "&$domain$&"
17796 If this option is set, the given command is run whenever an SMTP ETRN
17797 command is received from a host that is permitted to issue such commands (see
17798 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17799 are independently expanded. The expansion variable &$domain$& is set to the
17800 argument of the ETRN command, and no syntax checking is done on it. For
17801 example:
17802 .code
17803 smtp_etrn_command = /etc/etrn_command $domain \
17804                     $sender_host_address
17805 .endd
17806 If the option is not set, the argument for the ETRN command must
17807 be a &'#'& followed by an address string.
17808 In this case an &'exim -R <string>'& command is used;
17809 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17810
17811 A new process is created to run the command, but Exim does not wait for it to
17812 complete. Consequently, its status cannot be checked. If the command cannot be
17813 run, a line is written to the panic log, but the ETRN caller still receives
17814 a 250 success response. Exim is normally running under its own uid when
17815 receiving SMTP, so it is not possible for it to change the uid before running
17816 the command.
17817
17818
17819 .option smtp_etrn_serialize main boolean true
17820 .cindex "ETRN" "serializing"
17821 When this option is set, it prevents the simultaneous execution of more than
17822 one identical command as a result of ETRN in an SMTP connection. See
17823 section &<<SECTETRN>>& for details.
17824
17825
17826 .option smtp_load_reserve main fixed-point unset
17827 .cindex "load average"
17828 If the system load average ever gets higher than this, incoming SMTP calls are
17829 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17830 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17831 the load is over the limit. The option has no effect on ancient operating
17832 systems on which Exim cannot determine the load average. See also
17833 &%deliver_queue_load_max%& and &%queue_only_load%&.
17834
17835
17836
17837 .option smtp_max_synprot_errors main integer 3
17838 .cindex "SMTP" "limiting syntax and protocol errors"
17839 .cindex "limit" "SMTP syntax and protocol errors"
17840 Exim rejects SMTP commands that contain syntax or protocol errors. In
17841 particular, a syntactically invalid email address, as in this command:
17842 .code
17843 RCPT TO:<abc xyz@a.b.c>
17844 .endd
17845 causes immediate rejection of the command, before any other tests are done.
17846 (The ACL cannot be run if there is no valid address to set up for it.) An
17847 example of a protocol error is receiving RCPT before MAIL. If there are
17848 too many syntax or protocol errors in one SMTP session, the connection is
17849 dropped. The limit is set by this option.
17850
17851 .cindex "PIPELINING" "expected errors"
17852 When the PIPELINING extension to SMTP is in use, some protocol errors are
17853 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17854 Exim assumes that PIPELINING will be used if it advertises it (see
17855 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17856 not count towards the limit.
17857
17858
17859
17860 .option smtp_max_unknown_commands main integer 3
17861 .cindex "SMTP" "limiting unknown commands"
17862 .cindex "limit" "unknown SMTP commands"
17863 If there are too many unrecognized commands in an incoming SMTP session, an
17864 Exim server drops the connection. This is a defence against some kinds of abuse
17865 that subvert web
17866 clients
17867 into making connections to SMTP ports; in these circumstances, a number of
17868 non-SMTP command lines are sent first.
17869
17870
17871
17872 .option smtp_ratelimit_hosts main "host list&!!" unset
17873 .cindex "SMTP" "rate limiting"
17874 .cindex "limit" "rate of message arrival"
17875 .cindex "RCPT" "rate limiting"
17876 Some sites find it helpful to be able to limit the rate at which certain hosts
17877 can send them messages, and the rate at which an individual message can specify
17878 recipients.
17879
17880 Exim has two rate-limiting facilities. This section describes the older
17881 facility, which can limit rates within a single connection. The newer
17882 &%ratelimit%& ACL condition can limit rates across all connections. See section
17883 &<<SECTratelimiting>>& for details of the newer facility.
17884
17885 When a host matches &%smtp_ratelimit_hosts%&, the values of
17886 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17887 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17888 respectively. Each option, if set, must contain a set of four comma-separated
17889 values:
17890
17891 .ilist
17892 A threshold, before which there is no rate limiting.
17893 .next
17894 An initial time delay. Unlike other times in Exim, numbers with decimal
17895 fractional parts are allowed here.
17896 .next
17897 A factor by which to increase the delay each time.
17898 .next
17899 A maximum value for the delay. This should normally be less than 5 minutes,
17900 because after that time, the client is liable to timeout the SMTP command.
17901 .endlist
17902
17903 For example, these settings have been used successfully at the site which
17904 first suggested this feature, for controlling mail from their customers:
17905 .code
17906 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17907 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17908 .endd
17909 The first setting specifies delays that are applied to MAIL commands after
17910 two have been received over a single connection. The initial delay is 0.5
17911 seconds, increasing by a factor of 1.05 each time. The second setting applies
17912 delays to RCPT commands when more than four occur in a single message.
17913
17914
17915 .option smtp_ratelimit_mail main string unset
17916 See &%smtp_ratelimit_hosts%& above.
17917
17918
17919 .option smtp_ratelimit_rcpt main string unset
17920 See &%smtp_ratelimit_hosts%& above.
17921
17922
17923 .option smtp_receive_timeout main time&!! 5m
17924 .cindex "timeout" "for SMTP input"
17925 .cindex "SMTP" "input timeout"
17926 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17927 input, including batch SMTP. If a line of input (either an SMTP command or a
17928 data line) is not received within this time, the SMTP connection is dropped and
17929 the message is abandoned.
17930 A line is written to the log containing one of the following messages:
17931 .code
17932 SMTP command timeout on connection from...
17933 SMTP data timeout on connection from...
17934 .endd
17935 The former means that Exim was expecting to read an SMTP command; the latter
17936 means that it was in the DATA phase, reading the contents of a message.
17937
17938 If the first character of the option is a &"$"& the option is
17939 expanded before use and may depend on
17940 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17941
17942
17943 .oindex "&%-os%&"
17944 The value set by this option can be overridden by the
17945 &%-os%& command-line option. A setting of zero time disables the timeout, but
17946 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17947 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17948 timeout is controlled by &%receive_timeout%& and &%-or%&.
17949
17950
17951 .option smtp_reserve_hosts main "host list&!!" unset
17952 This option defines hosts for which SMTP connections are reserved; see
17953 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17954
17955
17956 .option smtp_return_error_details main boolean false
17957 .cindex "SMTP" "details policy failures"
17958 .cindex "policy control" "rejection, returning details"
17959 In the default state, Exim uses bland messages such as
17960 &"Administrative prohibition"& when it rejects SMTP commands for policy
17961 reasons. Many sysadmins like this because it gives away little information
17962 to spammers. However, some other sysadmins who are applying strict checking
17963 policies want to give out much fuller information about failures. Setting
17964 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17965 example, instead of &"Administrative prohibition"&, it might give:
17966 .code
17967 550-Rejected after DATA: '>' missing at end of address:
17968 550 failing address in "From" header is: <user@dom.ain
17969 .endd
17970
17971
17972 .option smtputf8_advertise_hosts main "host list&!!" *
17973 .cindex "SMTPUTF8" "ESMTP extension, advertising"
17974 .cindex "ESMTP extensions" SMTPUTF8
17975 When Exim is built with support for internationalised mail names,
17976 the availability thereof is advertised in
17977 response to EHLO only to those client hosts that match this option. See
17978 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17979
17980
17981 .option spamd_address main string "127.0.0.1 783"
17982 This option is available when Exim is compiled with the content-scanning
17983 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17984 See section &<<SECTscanspamass>>& for more details.
17985
17986
17987
17988 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17989 This option is available when Exim is compiled with SPF support.
17990 See section &<<SECSPF>>& for more details.
17991
17992 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
17993 This option is available when Exim is compiled with SPF support.  It
17994 allows the customisation of the SMTP comment that the SPF library
17995 generates.  You are strongly encouraged to link to your own explanative
17996 site. The template must not contain spaces. If you need spaces in the
17997 output, use the proper placeholder. If libspf2 can not parse the
17998 template, it uses a built-in default broken link. The following placeholders
17999 (along with Exim variables (but see below)) are allowed in the template:
18000 .ilist
18001 &*%_*&: A space.
18002 .next
18003 &*%{L}*&: Envelope sender's local part.
18004 .next
18005 &*%{S}*&: Envelope sender.
18006 .next
18007 &*%{O}*&: Envelope sender's domain.
18008 .next
18009 &*%{D}*&: Current(?) domain.
18010 .next
18011 &*%{I}*&: SMTP client Ip.
18012 .next
18013 &*%{C}*&: SMTP client pretty IP.
18014 .next
18015 &*%{T}*&: Epoch time (UTC).
18016 .next
18017 &*%{P}*&: SMTP client domain name.
18018 .next
18019 &*%{V}*&: IP version.
18020 .next
18021 &*%{H}*&: EHLO/HELO domain.
18022 .next
18023 &*%{R}*&: Receiving domain.
18024 .endlist
18025 The capitalized placeholders do proper URL encoding, if you use them
18026 lowercased, no encoding takes place.  This list was compiled from the
18027 libspf2 sources.
18028
18029 A note on using Exim variables: As
18030 currently the SPF library is initialized before the SMTP EHLO phase,
18031 the variables useful for expansion are quite limited.
18032
18033
18034 .option split_spool_directory main boolean false
18035 .cindex "multiple spool directories"
18036 .cindex "spool directory" "split"
18037 .cindex "directories, multiple"
18038 If this option is set, it causes Exim to split its input directory into 62
18039 subdirectories, each with a single alphanumeric character as its name. The
18040 sixth character of the message id is used to allocate messages to
18041 subdirectories; this is the least significant base-62 digit of the time of
18042 arrival of the message.
18043
18044 Splitting up the spool in this way may provide better performance on systems
18045 where there are long mail queues, by reducing the number of files in any one
18046 directory. The msglog directory is also split up in a similar way to the input
18047 directory; however, if &%preserve_message_logs%& is set, all old msglog files
18048 are still placed in the single directory &_msglog.OLD_&.
18049
18050 It is not necessary to take any special action for existing messages when
18051 changing &%split_spool_directory%&. Exim notices messages that are in the
18052 &"wrong"& place, and continues to process them. If the option is turned off
18053 after a period of being on, the subdirectories will eventually empty and be
18054 automatically deleted.
18055
18056 When &%split_spool_directory%& is set, the behaviour of queue runner processes
18057 changes. Instead of creating a list of all messages in the queue, and then
18058 trying to deliver each one, in turn, it constructs a list of those in one
18059 sub-directory and tries to deliver them, before moving on to the next
18060 sub-directory. The sub-directories are processed in a random order. This
18061 spreads out the scanning of the input directories, and uses less memory. It is
18062 particularly beneficial when there are lots of messages in the queue. However,
18063 if &%queue_run_in_order%& is set, none of this new processing happens. The
18064 entire queue has to be scanned and sorted before any deliveries can start.
18065
18066
18067 .option spool_directory main string&!! "set at compile time"
18068 .cindex "spool directory" "path to"
18069 This defines the directory in which Exim keeps its spool, that is, the messages
18070 it is waiting to deliver. The default value is taken from the compile-time
18071 configuration setting, if there is one. If not, this option must be set. The
18072 string is expanded, so it can contain, for example, a reference to
18073 &$primary_hostname$&.
18074
18075 If the spool directory name is fixed on your installation, it is recommended
18076 that you set it at build time rather than from this option, particularly if the
18077 log files are being written to the spool directory (see &%log_file_path%&).
18078 Otherwise log files cannot be used for errors that are detected early on, such
18079 as failures in the configuration file.
18080
18081 By using this option to override the compiled-in path, it is possible to run
18082 tests of Exim without using the standard spool.
18083
18084 .option spool_wireformat main boolean false
18085 .cindex "spool directory" "file formats"
18086 If this option is set, Exim may for some messages use an alternative format
18087 for data-files in the spool which matches the wire format.
18088 Doing this permits more efficient message reception and transmission.
18089 Currently it is only done for messages received using the ESMTP CHUNKING
18090 option.
18091
18092 The following variables will not have useful values:
18093 .code
18094 $max_received_linelength
18095 $body_linecount
18096 $body_zerocount
18097 .endd
18098
18099 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
18100 and any external programs which are passed a reference to a message data file
18101 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
18102 will need to be aware of the different formats potentially available.
18103
18104 Using any of the ACL conditions noted will negate the reception benefit
18105 (as a Unix-mbox-format file is constructed for them).
18106 The transmission benefit is maintained.
18107
18108 .option sqlite_lock_timeout main time 5s
18109 .cindex "sqlite lookup type" "lock timeout"
18110 This option controls the timeout that the &(sqlite)& lookup uses when trying to
18111 access an SQLite database. See section &<<SECTsqlite>>& for more details.
18112
18113 .option strict_acl_vars main boolean false
18114 .cindex "&ACL;" "variables, handling unset"
18115 This option controls what happens if a syntactically valid but undefined ACL
18116 variable is referenced. If it is false (the default), an empty string
18117 is substituted; if it is true, an error is generated. See section
18118 &<<SECTaclvariables>>& for details of ACL variables.
18119
18120 .option strip_excess_angle_brackets main boolean false
18121 .cindex "angle brackets, excess"
18122 If this option is set, redundant pairs of angle brackets round &"route-addr"&
18123 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
18124 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
18125 passed on to another MTA, the excess angle brackets are not passed on. If this
18126 option is not set, multiple pairs of angle brackets cause a syntax error.
18127
18128
18129 .option strip_trailing_dot main boolean false
18130 .cindex "trailing dot on domain"
18131 .cindex "dot" "trailing on domain"
18132 If this option is set, a trailing dot at the end of a domain in an address is
18133 ignored. If this is in the envelope and the message is passed on to another
18134 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
18135 domain causes a syntax error.
18136 However, addresses in header lines are checked only when an ACL requests header
18137 syntax checking.
18138
18139
18140 .option syslog_duplication main boolean true
18141 .cindex "syslog" "duplicate log lines; suppressing"
18142 When Exim is logging to syslog, it writes the log lines for its three
18143 separate logs at different syslog priorities so that they can in principle
18144 be separated on the logging hosts. Some installations do not require this
18145 separation, and in those cases, the duplication of certain log lines is a
18146 nuisance. If &%syslog_duplication%& is set false, only one copy of any
18147 particular log line is written to syslog. For lines that normally go to
18148 both the main log and the reject log, the reject log version (possibly
18149 containing message header lines) is written, at LOG_NOTICE priority.
18150 Lines that normally go to both the main and the panic log are written at
18151 the LOG_ALERT priority.
18152
18153
18154 .option syslog_facility main string unset
18155 .cindex "syslog" "facility; setting"
18156 This option sets the syslog &"facility"& name, used when Exim is logging to
18157 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
18158 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
18159 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
18160 details of Exim's logging.
18161
18162
18163 .option syslog_pid main boolean true
18164 .cindex "syslog" "pid"
18165 If &%syslog_pid%& is set false, the PID on Exim's log lines are
18166 omitted when these lines are sent to syslog. (Syslog normally prefixes
18167 the log lines with the PID of the logging process automatically.) You need
18168 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
18169 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
18170
18171
18172
18173 .option syslog_processname main string &`exim`&
18174 .cindex "syslog" "process name; setting"
18175 This option sets the syslog &"ident"& name, used when Exim is logging to
18176 syslog. The value must be no longer than 32 characters. See chapter
18177 &<<CHAPlog>>& for details of Exim's logging.
18178
18179
18180
18181 .option syslog_timestamp main boolean true
18182 .cindex "syslog" "timestamps"
18183 .cindex timestamps syslog
18184 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
18185 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
18186 details of Exim's logging.
18187
18188
18189 .option system_filter main string&!! unset
18190 .cindex "filter" "system filter"
18191 .cindex "system filter" "specifying"
18192 .cindex "Sieve filter" "not available for system filter"
18193 This option specifies an Exim filter file that is applied to all messages at
18194 the start of each delivery attempt, before any routing is done. System filters
18195 must be Exim filters; they cannot be Sieve filters. If the system filter
18196 generates any deliveries to files or pipes, or any new mail messages, the
18197 appropriate &%system_filter_..._transport%& option(s) must be set, to define
18198 which transports are to be used. Details of this facility are given in chapter
18199 &<<CHAPsystemfilter>>&.
18200 A forced expansion failure results in no filter operation.
18201
18202
18203 .option system_filter_directory_transport main string&!! unset
18204 .vindex "&$address_file$&"
18205 This sets the name of the transport driver that is to be used when the
18206 &%save%& command in a system message filter specifies a path ending in &"/"&,
18207 implying delivery of each message into a separate file in some directory.
18208 During the delivery, the variable &$address_file$& contains the path name.
18209
18210
18211 .option system_filter_file_transport main string&!! unset
18212 .cindex "file" "transport for system filter"
18213 This sets the name of the transport driver that is to be used when the &%save%&
18214 command in a system message filter specifies a path not ending in &"/"&. During
18215 the delivery, the variable &$address_file$& contains the path name.
18216
18217 .option system_filter_group main string unset
18218 .cindex "gid (group id)" "system filter"
18219 This option is used only when &%system_filter_user%& is also set. It sets the
18220 gid under which the system filter is run, overriding any gid that is associated
18221 with the user. The value may be numerical or symbolic.
18222
18223 .option system_filter_pipe_transport main string&!! unset
18224 .cindex "&(pipe)& transport" "for system filter"
18225 .vindex "&$address_pipe$&"
18226 This specifies the transport driver that is to be used when a &%pipe%& command
18227 is used in a system filter. During the delivery, the variable &$address_pipe$&
18228 contains the pipe command.
18229
18230
18231 .option system_filter_reply_transport main string&!! unset
18232 .cindex "&(autoreply)& transport" "for system filter"
18233 This specifies the transport driver that is to be used when a &%mail%& command
18234 is used in a system filter.
18235
18236
18237 .option system_filter_user main string unset
18238 .cindex "uid (user id)" "system filter"
18239 If this option is set to root, the system filter is run in the main Exim
18240 delivery process, as root.  Otherwise, the system filter runs in a separate
18241 process, as the given user, defaulting to the Exim run-time user.
18242 Unless the string consists entirely of digits, it
18243 is looked up in the password data. Failure to find the named user causes a
18244 configuration error. The gid is either taken from the password data, or
18245 specified by &%system_filter_group%&. When the uid is specified numerically,
18246 &%system_filter_group%& is required to be set.
18247
18248 If the system filter generates any pipe, file, or reply deliveries, the uid
18249 under which the filter is run is used when transporting them, unless a
18250 transport option overrides.
18251
18252
18253 .option tcp_nodelay main boolean true
18254 .cindex "daemon" "TCP_NODELAY on sockets"
18255 .cindex "Nagle algorithm"
18256 .cindex "TCP_NODELAY on listening sockets"
18257 If this option is set false, it stops the Exim daemon setting the
18258 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18259 turns off the &"Nagle algorithm"&, which is a way of improving network
18260 performance in interactive (character-by-character) situations. Turning it off
18261 should improve Exim's performance a bit, so that is what happens by default.
18262 However, it appears that some broken clients cannot cope, and time out. Hence
18263 this option. It affects only those sockets that are set up for listening by the
18264 daemon. Sockets created by the smtp transport for delivering mail always set
18265 TCP_NODELAY.
18266
18267
18268 .option timeout_frozen_after main time 0s
18269 .cindex "frozen messages" "timing out"
18270 .cindex "timeout" "frozen messages"
18271 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18272 message of any kind that has been in the queue for longer than the given time
18273 is automatically cancelled at the next queue run. If the frozen message is a
18274 bounce message, it is just discarded; otherwise, a bounce is sent to the
18275 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18276 If you want to timeout frozen bounce messages earlier than other kinds of
18277 frozen message, see &%ignore_bounce_errors_after%&.
18278
18279 &*Note:*& the default value of zero means no timeouts; with this setting,
18280 frozen messages remain in the queue forever (except for any frozen bounce
18281 messages that are released by &%ignore_bounce_errors_after%&).
18282
18283
18284 .option timezone main string unset
18285 .cindex "timezone, setting"
18286 .cindex "environment" "values from"
18287 The value of &%timezone%& is used to set the environment variable TZ while
18288 running Exim (if it is different on entry). This ensures that all timestamps
18289 created by Exim are in the required timezone. If you want all your timestamps
18290 to be in UTC (aka GMT) you should set
18291 .code
18292 timezone = UTC
18293 .endd
18294 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18295 or, if that is not set, from the value of the TZ environment variable when Exim
18296 is built. If &%timezone%& is set to the empty string, either at build or run
18297 time, any existing TZ variable is removed from the environment when Exim
18298 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18299 unfortunately not all, operating systems.
18300
18301
18302 .option tls_advertise_hosts main "host list&!!" *
18303 .cindex "TLS" "advertising"
18304 .cindex "encryption" "on SMTP connection"
18305 .cindex "SMTP" "encrypted connection"
18306 .cindex "ESMTP extensions" STARTTLS
18307 When Exim is built with support for TLS encrypted connections, the availability
18308 of the STARTTLS command to set up an encrypted session is advertised in
18309 response to EHLO only to those client hosts that match this option. See
18310 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18311 Note that the default value requires that a certificate be supplied
18312 using the &%tls_certificate%& option.  If TLS support for incoming connections
18313 is not required the &%tls_advertise_hosts%& option should be set empty.
18314
18315
18316 .option tls_alpn main "string list&!!" "smtp : esmtp"
18317 .cindex TLS "Application Layer Protocol Names"
18318 .cindex TLS ALPN
18319 .cindex ALPN "set acceptable names for server"
18320 If this option is set,
18321 the TLS library supports ALPN,
18322 and the client offers either more than
18323 ALPN name or a name which does not match the list,
18324 the TLS connection is declined.
18325
18326
18327 .option tls_certificate main "string list&!!" unset
18328 .cindex "TLS" "server certificate; location of"
18329 .cindex "certificate" "server, location of"
18330 The value of this option is expanded, and must then be a list of absolute paths to
18331 files which contain the server's certificates (in PEM format).
18332 Commonly only one file is needed.
18333 The server's private key is also
18334 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18335 &<<CHAPTLS>>& for further details.
18336
18337 &*Note*&: The certificates defined by this option are used only when Exim is
18338 receiving incoming messages as a server. If you want to supply certificates for
18339 use when sending messages as a client, you must set the &%tls_certificate%&
18340 option in the relevant &(smtp)& transport.
18341
18342 &*Note*&: If you use filenames based on IP addresses, change the list
18343 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18344
18345 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18346 when a list of more than one
18347 file is used, the &$tls_in_ourcert$& variable is unreliable.
18348 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18349
18350 .cindex SNI "selecting server certificate based on"
18351 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18352 if the OpenSSL build supports TLS extensions and the TLS client sends the
18353 Server Name Indication extension, then this option and others documented in
18354 &<<SECTtlssni>>& will be re-expanded.
18355
18356 If this option is unset or empty a self-signed certificate will be
18357 used.
18358 Under Linux this is generated at daemon startup; on other platforms it will be
18359 generated fresh for every connection.
18360
18361 .option tls_crl main string&!! unset
18362 .cindex "TLS" "server certificate revocation list"
18363 .cindex "certificate" "revocation list for server"
18364 This option specifies a certificate revocation list. The expanded value must
18365 be the name of a file that contains CRLs in PEM format.
18366
18367 Under OpenSSL the option can specify a directory with CRL files.
18368
18369 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18370 for each signing element of the certificate chain (i.e. all but the leaf).
18371 For the file variant this can be multiple PEM blocks in the one file.
18372
18373 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18374
18375
18376 .option tls_dh_max_bits main integer 2236
18377 .cindex "TLS" "D-H bit count"
18378 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18379 the chosen TLS library.  That value might prove to be too high for
18380 interoperability.  This option provides a maximum clamp on the value
18381 suggested, trading off security for interoperability.
18382
18383 The value must be at least 1024.
18384
18385 The value 2236 was chosen because, at time of adding the option, it was the
18386 hard-coded maximum value supported by the NSS cryptographic library, as used
18387 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18388
18389 If you prefer more security and are willing to break some clients, raise this
18390 number.
18391
18392 Note that the value passed to GnuTLS for *generating* a new prime may be a
18393 little less than this figure, because GnuTLS is inexact and may produce a
18394 larger prime than requested.
18395
18396
18397 .option tls_dhparam main string&!! unset
18398 .cindex "TLS" "D-H parameters for server"
18399 The value of this option is expanded and indicates the source of DH parameters
18400 to be used by Exim.
18401
18402 This option is ignored for GnuTLS version 3.6.0 and later.
18403 The library manages parameter negotiation internally.
18404
18405 &*Note: The Exim Maintainers strongly recommend,
18406 for other TLS library versions,
18407 using a filename with site-generated
18408 local DH parameters*&, which has been supported across all versions of Exim.  The
18409 other specific constants available are a fallback so that even when
18410 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18411
18412 If &%tls_dhparam%& is a filename starting with a &`/`&,
18413 then it names a file from which DH
18414 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18415 PKCS#3 representation of the DH prime.  If the file does not exist, for
18416 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18417 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18418 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18419 and treated as though the &%tls_dhparam%& were set to "none".
18420
18421 If this option expands to the string "none", then no DH parameters will be
18422 loaded by Exim.
18423
18424 If this option expands to the string "historic" and Exim is using GnuTLS, then
18425 Exim will attempt to load a file from inside the spool directory.  If the file
18426 does not exist, Exim will attempt to create it.
18427 See section &<<SECTgnutlsparam>>& for further details.
18428
18429 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18430 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18431
18432 In older versions of Exim the default was the 2048 bit prime described in section
18433 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18434 in IKE is assigned number 23.
18435
18436 Otherwise, the option must expand to the name used by Exim for any of a number
18437 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18438 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18439 the number used by IKE, or "default" which corresponds to
18440 &`exim.dev.20160529.3`&.
18441
18442 The available standard primes are:
18443 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18444 &`ike1`&, &`ike2`&, &`ike5`&,
18445 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18446 &`ike22`&, &`ike23`& and &`ike24`&.
18447
18448 The available additional primes are:
18449 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18450
18451 Some of these will be too small to be accepted by clients.
18452 Some may be too large to be accepted by clients.
18453 The open cryptographic community has suspicions about the integrity of some
18454 of the later IKE values, which led into RFC7919 providing new fixed constants
18455 (the "ffdhe" identifiers).
18456
18457 At this point, all of the "ike" values should be considered obsolete;
18458 they're still in Exim to avoid breaking unusual configurations, but are
18459 candidates for removal the next time we have backwards-incompatible changes.
18460
18461 The TLS protocol does not negotiate an acceptable size for this; clients tend
18462 to hard-drop connections if what is offered by the server is unacceptable,
18463 whether too large or too small, and there's no provision for the client to
18464 tell the server what these constraints are.  Thus, as a server operator, you
18465 need to make an educated guess as to what is most likely to work for your
18466 userbase.
18467
18468 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18469 is most likely to maximise interoperability.  The upper bound comes from
18470 applications using the Mozilla Network Security Services (NSS) library, which
18471 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18472 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18473 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18474 acceptable bound from 1024 to 2048.
18475
18476
18477 .option tls_eccurve main string&!! &`auto`&
18478 .cindex TLS "EC cryptography"
18479 This option selects a EC curve for use by Exim when used with OpenSSL.
18480 It has no effect when Exim is used with GnuTLS.
18481
18482 After expansion it must contain a valid EC curve parameter, such as
18483 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
18484 for valid selections.
18485
18486 For OpenSSL versions before (and not including) 1.0.2, the string
18487 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18488 &`auto`& tells the library to choose.
18489
18490 If the option expands to an empty string, no EC curves will be enabled.
18491
18492
18493 .option tls_ocsp_file main string&!! unset
18494 .cindex TLS "certificate status"
18495 .cindex TLS "OCSP proof file"
18496 This option
18497 must if set expand to the absolute path to a file which contains a current
18498 status proof for the server's certificate, as obtained from the
18499 Certificate Authority.
18500
18501 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18502 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18503
18504 For OpenSSL 1.1.0 or later, and
18505 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18506 of files, to match a list given for the &%tls_certificate%& option.
18507 The ordering of the two lists must match.
18508 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18509
18510 The file(s) should be in DER format,
18511 except for GnuTLS 3.6.3 or later
18512 or for OpenSSL,
18513 when an optional filetype prefix can be used.
18514 The prefix must be one of "DER" or "PEM", followed by
18515 a single space.  If one is used it sets the format for subsequent
18516 files in the list; the initial format is DER.
18517 If multiple proofs are wanted, for multiple chain elements
18518 (this only works under TLS1.3)
18519 they must be coded as a combined OCSP response.
18520
18521 Although GnuTLS will accept PEM files with multiple separate
18522 PEM blobs (ie. separate OCSP responses), it sends them in the
18523 TLS Certificate record interleaved with the certificates of the chain;
18524 although a GnuTLS client is happy with that, an OpenSSL client is not.
18525
18526 .option tls_on_connect_ports main "string list" unset
18527 .cindex SSMTP
18528 .cindex SMTPS
18529 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18530 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18531 set up without waiting for the client to issue a STARTTLS command. For
18532 further details, see section &<<SECTsupobssmt>>&.
18533
18534
18535
18536 .option tls_privatekey main "string list&!!" unset
18537 .cindex "TLS" "server private key; location of"
18538 The value of this option is expanded, and must then be a list of absolute paths to
18539 files which contains the server's private keys.
18540 If this option is unset, or if
18541 the expansion is forced to fail, or the result is an empty string, the private
18542 key is assumed to be in the same file as the server's certificates. See chapter
18543 &<<CHAPTLS>>& for further details.
18544
18545 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18546
18547
18548 .option tls_remember_esmtp main boolean false
18549 .cindex "TLS" "esmtp state; remembering"
18550 .cindex "TLS" "broken clients"
18551 If this option is set true, Exim violates the RFCs by remembering that it is in
18552 &"esmtp"& state after successfully negotiating a TLS session. This provides
18553 support for broken clients that fail to send a new EHLO after starting a
18554 TLS session.
18555
18556
18557 .option tls_require_ciphers main string&!! unset
18558 .cindex "TLS" "requiring specific ciphers"
18559 .cindex "cipher" "requiring specific"
18560 This option controls which ciphers can be used for incoming TLS connections.
18561 The &(smtp)& transport has an option of the same name for controlling outgoing
18562 connections. This option is expanded for each connection, so can be varied for
18563 different clients if required. The value of this option must be a list of
18564 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18565 in somewhat different ways. If GnuTLS is being used, the client controls the
18566 preference order of the available ciphers. Details are given in sections
18567 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18568
18569
18570 .option tls_resumption_hosts main "host list&!!" unset
18571 .cindex TLS resumption
18572 This option controls which connections to offer the TLS resumption feature.
18573 See &<<SECTresumption>>& for details.
18574
18575
18576 .option tls_try_verify_hosts main "host list&!!" unset
18577 .cindex "TLS" "client certificate verification"
18578 .cindex "certificate" "verification of client"
18579 See &%tls_verify_hosts%& below.
18580
18581
18582 .option tls_verify_certificates main string&!! system
18583 .cindex "TLS" "client certificate verification"
18584 .cindex "certificate" "verification of client"
18585 The value of this option is expanded, and must then be either the
18586 word "system"
18587 or the absolute path to
18588 a file or directory containing permitted certificates for clients that
18589 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18590
18591 The "system" value for the option will use a
18592 system default location compiled into the SSL library.
18593 This is not available for GnuTLS versions preceding 3.0.20,
18594 and will be taken as empty; an explicit location
18595 must be specified.
18596
18597 The use of a directory for the option value is not available for GnuTLS versions
18598 preceding 3.3.6 and a single file must be used.
18599
18600 With OpenSSL the certificates specified
18601 explicitly
18602 either by file or directory
18603 are added to those given by the system default location.
18604
18605 These certificates should be for the certificate authorities trusted, rather
18606 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18607 the value is a file then the certificates are sent by Exim as a server to
18608 connecting clients, defining the list of accepted certificate authorities.
18609 Thus the values defined should be considered public data.  To avoid this,
18610 use the explicit directory version. (If your peer is Exim up to 4.85,
18611 using GnuTLS, you may need to send the CAs (thus using the file
18612 variant). Otherwise the peer doesn't send its certificate.)
18613
18614 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18615
18616 A forced expansion failure or setting to an empty string is equivalent to
18617 being unset.
18618
18619
18620 .option tls_verify_hosts main "host list&!!" unset
18621 .cindex "TLS" "client certificate verification"
18622 .cindex "certificate" "verification of client"
18623 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18624 certificates from clients. The expected certificates are defined by
18625 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18626 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18627 &%tls_verify_certificates%& is not set.
18628
18629 Any client that matches &%tls_verify_hosts%& is constrained by
18630 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18631 present one of the listed certificates. If it does not, the connection is
18632 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18633 the host to use TLS. It can still send SMTP commands through unencrypted
18634 connections. Forcing a client to use TLS has to be done separately using an
18635 ACL to reject inappropriate commands when the connection is not encrypted.
18636
18637 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18638 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18639 certificate and checks it against &%tls_verify_certificates%&, but does not
18640 abort the connection if there is no certificate or if it does not match. This
18641 state can be detected in an ACL, which makes it possible to implement policies
18642 such as &"accept for relay only if a verified certificate has been received,
18643 but accept for local delivery if encrypted, even without a verified
18644 certificate"&.
18645
18646 Client hosts that match neither of these lists are not asked to present
18647 certificates.
18648
18649
18650 .option trusted_groups main "string list&!!" unset
18651 .cindex "trusted groups"
18652 .cindex "groups" "trusted"
18653 This option is expanded just once, at the start of Exim's processing. If this
18654 option is set, any process that is running in one of the listed groups, or
18655 which has one of them as a supplementary group, is trusted. The groups can be
18656 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18657 details of what trusted callers are permitted to do. If neither
18658 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18659 are trusted.
18660
18661 .option trusted_users main "string list&!!" unset
18662 .cindex "trusted users"
18663 .cindex "user" "trusted"
18664 This option is expanded just once, at the start of Exim's processing. If this
18665 option is set, any process that is running as one of the listed users is
18666 trusted. The users can be specified numerically or by name. See section
18667 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18668 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18669 Exim user are trusted.
18670
18671 .option unknown_login main string&!! unset
18672 .cindex "uid (user id)" "unknown caller"
18673 .vindex "&$caller_uid$&"
18674 This is a specialized feature for use in unusual configurations. By default, if
18675 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18676 gives up. The &%unknown_login%& option can be used to set a login name to be
18677 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18678 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18679 is used for the user's real name (gecos field), unless this has been set by the
18680 &%-F%& option.
18681
18682 .option unknown_username main string unset
18683 See &%unknown_login%&.
18684
18685 .option untrusted_set_sender main "address list&!!" unset
18686 .cindex "trusted users"
18687 .cindex "sender" "setting by untrusted user"
18688 .cindex "untrusted user setting sender"
18689 .cindex "user" "untrusted setting sender"
18690 .cindex "envelope from"
18691 .cindex "envelope sender"
18692 When an untrusted user submits a message to Exim using the standard input, Exim
18693 normally creates an envelope sender address from the user's login and the
18694 default qualification domain. Data from the &%-f%& option (for setting envelope
18695 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18696 is used) is ignored.
18697
18698 However, untrusted users are permitted to set an empty envelope sender address,
18699 to declare that a message should never generate any bounces. For example:
18700 .code
18701 exim -f '<>' user@domain.example
18702 .endd
18703 .vindex "&$sender_ident$&"
18704 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18705 other envelope sender addresses in a controlled way. When it is set, untrusted
18706 users are allowed to set envelope sender addresses that match any of the
18707 patterns in the list. Like all address lists, the string is expanded. The
18708 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18709 users to setting senders that start with their login ids
18710 followed by a hyphen
18711 by a setting like this:
18712 .code
18713 untrusted_set_sender = ^$sender_ident-
18714 .endd
18715 If you want to allow untrusted users to set envelope sender addresses without
18716 restriction, you can use
18717 .code
18718 untrusted_set_sender = *
18719 .endd
18720 The &%untrusted_set_sender%& option applies to all forms of local input, but
18721 only to the setting of the envelope sender. It does not permit untrusted users
18722 to use the other options which trusted user can use to override message
18723 parameters. Furthermore, it does not stop Exim from removing an existing
18724 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18725 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18726 overriding these actions. The handling of the &'Sender:'& header is also
18727 described in section &<<SECTthesenhea>>&.
18728
18729 The log line for a message's arrival shows the envelope sender following
18730 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18731 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18732 envelope sender address, the user's login is shown in parentheses after the
18733 sender address.
18734
18735
18736 .option uucp_from_pattern main string "see below"
18737 .cindex "&""From""& line"
18738 .cindex "UUCP" "&""From""& line"
18739 Some applications that pass messages to an MTA via a command line interface use
18740 an initial line starting with &"From&~"& to pass the envelope sender. In
18741 particular, this is used by UUCP software. Exim recognizes such a line by means
18742 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18743 matches, the sender address is constructed by expanding the contents of
18744 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18745 default pattern recognizes lines in the following two forms:
18746 .code
18747 From ph10 Fri Jan  5 12:35 GMT 1996
18748 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18749 .endd
18750 The pattern can be seen by running
18751 .code
18752 exim -bP uucp_from_pattern
18753 .endd
18754 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18755 year in the second case. The first word after &"From&~"& is matched in the
18756 regular expression by a parenthesized subpattern. The default value for
18757 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18758 (&"ph10"& in the example above) as the message's sender. See also
18759 &%ignore_fromline_hosts%&.
18760
18761
18762 .option uucp_from_sender main string&!! &`$1`&
18763 See &%uucp_from_pattern%& above.
18764
18765
18766 .option warn_message_file main string&!! unset
18767 .cindex "warning of delay" "customizing the message"
18768 .cindex "customizing" "warning message"
18769 This option defines a template file containing paragraphs of text to be used
18770 for constructing the warning message which is sent by Exim when a message has
18771 been in the queue for a specified amount of time, as specified by
18772 &%delay_warning%&. Details of the file's contents are given in chapter
18773 &<<CHAPemsgcust>>&.
18774 .cindex warn_message_file "tainted data"
18775 The option is expanded to give the file path, which must be
18776 absolute and untainted.
18777 See also &%bounce_message_file%&.
18778
18779
18780 .option write_rejectlog main boolean true
18781 .cindex "reject log" "disabling"
18782 If this option is set false, Exim no longer writes anything to the reject log.
18783 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18784 .ecindex IIDconfima
18785 .ecindex IIDmaiconf
18786
18787
18788
18789
18790 . ////////////////////////////////////////////////////////////////////////////
18791 . ////////////////////////////////////////////////////////////////////////////
18792
18793 .chapter "Generic options for routers" "CHAProutergeneric"
18794 .scindex IIDgenoprou1 "options" "generic; for routers"
18795 .scindex IIDgenoprou2 "generic options" "router"
18796 This chapter describes the generic options that apply to all routers.
18797 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18798
18799 For a general description of how a router operates, see sections
18800 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18801 which the preconditions are tested. The order of expansion of the options that
18802 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18803 &%headers_remove%&, &%transport%&.
18804
18805 The name of a router is limited to be &drivernamemax; ASCII characters long;
18806 prior to Exim 4.95 names would be silently truncated at this length, but now
18807 it is enforced.
18808
18809
18810 .option address_data routers string&!! unset
18811 .cindex "router" "data attached to address"
18812 The string is expanded just before the router is run, that is, after all the
18813 precondition tests have succeeded. If the expansion is forced to fail, the
18814 router declines, the value of &%address_data%& remains unchanged, and the
18815 &%more%& option controls what happens next. Other expansion failures cause
18816 delivery of the address to be deferred.
18817
18818 .vindex "&$address_data$&"
18819 When the expansion succeeds, the value is retained with the address, and can be
18820 accessed using the variable &$address_data$& in the current router, subsequent
18821 routers, and the eventual transport.
18822
18823 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18824 that runs a user's filter file, the contents of &$address_data$& are accessible
18825 in the filter. This is not normally a problem, because such data is usually
18826 either not confidential or it &"belongs"& to the current user, but if you do
18827 put confidential data into &$address_data$& you need to remember this point.
18828
18829 Even if the router declines or passes, the value of &$address_data$& remains
18830 with the address, though it can be changed by another &%address_data%& setting
18831 on a subsequent router. If a router generates child addresses, the value of
18832 &$address_data$& propagates to them. This also applies to the special kind of
18833 &"child"& that is generated by a router with the &%unseen%& option.
18834
18835 The idea of &%address_data%& is that you can use it to look up a lot of data
18836 for the address once, and then pick out parts of the data later. For example,
18837 you could use a single LDAP lookup to return a string of the form
18838 .code
18839 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18840 .endd
18841 In the transport you could pick out the mailbox by a setting such as
18842 .code
18843 file = ${extract{mailbox}{$address_data}}
18844 .endd
18845 This makes the configuration file less messy, and also reduces the number of
18846 lookups (though Exim does cache lookups).
18847
18848 See also the &%set%& option below.
18849
18850 .vindex "&$sender_address_data$&"
18851 .vindex "&$address_data$&"
18852 The &%address_data%& facility is also useful as a means of passing information
18853 from one router to another, and from a router to a transport. In addition, if
18854 &$address_data$& is set by a router when verifying a recipient address from an
18855 ACL, it remains available for use in the rest of the ACL statement. After
18856 verifying a sender, the value is transferred to &$sender_address_data$&.
18857
18858
18859
18860 .option address_test routers&!? boolean true
18861 .oindex "&%-bt%&"
18862 .cindex "router" "skipping when address testing"
18863 If this option is set false, the router is skipped when routing is being tested
18864 by means of the &%-bt%& command line option. This can be a convenience when
18865 your first router sends messages to an external scanner, because it saves you
18866 having to set the &"already scanned"& indicator when testing real address
18867 routing.
18868
18869
18870
18871 .option cannot_route_message routers string&!! unset
18872 .cindex "router" "customizing &""cannot route""& message"
18873 .cindex "customizing" "&""cannot route""& message"
18874 This option specifies a text message that is used when an address cannot be
18875 routed because Exim has run out of routers. The default message is
18876 &"Unrouteable address"&. This option is useful only on routers that have
18877 &%more%& set false, or on the very last router in a configuration, because the
18878 value that is used is taken from the last router that is considered. This
18879 includes a router that is skipped because its preconditions are not met, as
18880 well as a router that declines. For example, using the default configuration,
18881 you could put:
18882 .code
18883 cannot_route_message = Remote domain not found in DNS
18884 .endd
18885 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18886 and
18887 .code
18888 cannot_route_message = Unknown local user
18889 .endd
18890 on the final router that checks for local users. If string expansion fails for
18891 this option, the default message is used. Unless the expansion failure was
18892 explicitly forced, a message about the failure is written to the main and panic
18893 logs, in addition to the normal message about the routing failure.
18894
18895
18896 .option caseful_local_part routers boolean false
18897 .cindex "case of local parts"
18898 .cindex "router" "case of local parts"
18899 By default, routers handle the local parts of addresses in a case-insensitive
18900 manner, though the actual case is preserved for transmission with the message.
18901 If you want the case of letters to be significant in a router, you must set
18902 this option true. For individual router options that contain address or local
18903 part lists (for example, &%local_parts%&), case-sensitive matching can be
18904 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18905 more details.
18906
18907 .vindex "&$local_part$&"
18908 .vindex "&$original_local_part$&"
18909 .vindex "&$parent_local_part$&"
18910 The value of the &$local_part$& variable is forced to lower case while a
18911 router is running unless &%caseful_local_part%& is set. When a router assigns
18912 an address to a transport, the value of &$local_part$& when the transport runs
18913 is the same as it was in the router. Similarly, when a router generates child
18914 addresses by aliasing or forwarding, the values of &$original_local_part$&
18915 and &$parent_local_part$& are those that were used by the redirecting router.
18916
18917 This option applies to the processing of an address by a router. When a
18918 recipient address is being processed in an ACL, there is a separate &%control%&
18919 modifier that can be used to specify case-sensitive processing within the ACL
18920 (see section &<<SECTcontrols>>&).
18921
18922
18923
18924 .option check_local_user routers&!? boolean false
18925 .cindex "local user, checking in router"
18926 .cindex "router" "checking for local user"
18927 .cindex "&_/etc/passwd_&"
18928 .vindex "&$home$&"
18929 When this option is true, Exim checks that the local part of the recipient
18930 address (with affixes removed if relevant) is the name of an account on the
18931 local system. The check is done by calling the &[getpwnam()]& function rather
18932 than trying to read &_/etc/passwd_& directly. This means that other methods of
18933 holding password data (such as NIS) are supported. If the local part is a local
18934 user,
18935 .cindex "tainted data" "de-tainting"
18936 &$local_part_data$& is set to an untainted version of the local part and
18937 &$home$& is set from the password data. The latter can be tested in other
18938 preconditions that are evaluated after this one (the order of evaluation is
18939 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18940 overridden by &%router_home_directory%&. If the local part is not a local user,
18941 the router is skipped.
18942
18943 If you want to check that the local part is either the name of a local user
18944 or matches something else, you cannot combine &%check_local_user%& with a
18945 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18946 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18947 setting to achieve this. For example:
18948 .code
18949 local_parts = passwd;$local_part : lsearch;/etc/other/users
18950 .endd
18951 Note, however, that the side effects of &%check_local_user%& (such as setting
18952 up a home directory) do not occur when a &(passwd)& lookup is used in a
18953 &%local_parts%& (or any other) precondition.
18954
18955
18956
18957 .option condition routers&!? string&!! unset
18958 .cindex "router" "customized precondition"
18959 This option specifies a general precondition test that has to succeed for the
18960 router to be called. The &%condition%& option is the last precondition to be
18961 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18962 result is a forced failure, or an empty string, or one of the strings &"0"& or
18963 &"no"& or &"false"& (checked without regard to the case of the letters), the
18964 router is skipped, and the address is offered to the next one.
18965
18966 If the result is any other value, the router is run (as this is the last
18967 precondition to be evaluated, all the other preconditions must be true).
18968
18969 This option is unusual in that multiple &%condition%& options may be present.
18970 All &%condition%& options must succeed.
18971
18972 The &%condition%& option provides a means of applying custom conditions to the
18973 running of routers. Note that in the case of a simple conditional expansion,
18974 the default expansion values are exactly what is wanted. For example:
18975 .code
18976 condition = ${if >{$message_age}{600}}
18977 .endd
18978 Because of the default behaviour of the string expansion, this is equivalent to
18979 .code
18980 condition = ${if >{$message_age}{600}{true}{}}
18981 .endd
18982
18983 A multiple condition example, which succeeds:
18984 .code
18985 condition = ${if >{$message_age}{600}}
18986 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18987 condition = foobar
18988 .endd
18989
18990 If the expansion fails (other than forced failure) delivery is deferred. Some
18991 of the other precondition options are common special cases that could in fact
18992 be specified using &%condition%&.
18993
18994 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18995 are far older, and use one set of semantics.  ACLs are newer and when
18996 they were created, the ACL &%condition%& process was given far stricter
18997 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18998 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18999 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
19000 Router rules processing behavior.
19001
19002 This is best illustrated in an example:
19003 .code
19004 # If used in an ACL condition will fail with a syntax error, but
19005 # in a router condition any extra characters are treated as a string
19006
19007 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
19008 true {yes} {no}}
19009
19010 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
19011  {yes} {no}}
19012 .endd
19013 In each example above, the &%if%& statement actually ends after
19014 &"{google.com}}"&.  Since no true or false braces were defined, the
19015 default &%if%& behavior is to return a boolean true or a null answer
19016 (which evaluates to false). The rest of the line is then treated as a
19017 string. So the first example resulted in the boolean answer &"true"&
19018 with the string &" {yes} {no}}"& appended to it. The second example
19019 resulted in the null output (indicating false) with the string
19020 &" {yes} {no}}"& appended to it.
19021
19022 In fact you can put excess forward braces in too.  In the router
19023 &%condition%&, Exim's parser only looks for &"{"& symbols when they
19024 mean something, like after a &"$"& or when required as part of a
19025 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
19026 string characters.
19027
19028 Thus, in a Router, the above expansion strings will both always evaluate
19029 true, as the result of expansion is a non-empty string which doesn't
19030 match an explicit false value.  This can be tricky to debug.  By
19031 contrast, in an ACL either of those strings will always result in an
19032 expansion error because the result doesn't look sufficiently boolean.
19033
19034
19035 .option debug_print routers string&!! unset
19036 .cindex "testing" "variables in drivers"
19037 If this option is set and debugging is enabled (see the &%-d%& command line
19038 option) or in address-testing mode (see the &%-bt%& command line option),
19039 the string is expanded and included in the debugging output.
19040 If expansion of the string fails, the error message is written to the debugging
19041 output, and Exim carries on processing.
19042 This option is provided to help with checking out the values of variables and
19043 so on when debugging router configurations. For example, if a &%condition%&
19044 option appears not to be working, &%debug_print%& can be used to output the
19045 variables it references. The output happens after checks for &%domains%&,
19046 &%local_parts%&, and &%check_local_user%& but before any other preconditions
19047 are tested. A newline is added to the text if it does not end with one.
19048 The variable &$router_name$& contains the name of the router.
19049
19050
19051
19052 .option disable_logging routers boolean false
19053 If this option is set true, nothing is logged for any routing errors
19054 or for any deliveries caused by this router. You should not set this option
19055 unless you really, really know what you are doing. See also the generic
19056 transport option of the same name.
19057
19058 .option dnssec_request_domains routers "domain list&!!" *
19059 .cindex "MX record" "security"
19060 .cindex "DNSSEC" "MX lookup"
19061 .cindex "security" "MX lookup"
19062 .cindex "DNS" "DNSSEC"
19063 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
19064 the DNSSEC request bit set.
19065 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19066
19067 .option dnssec_require_domains routers "domain list&!!" unset
19068 .cindex "MX record" "security"
19069 .cindex "DNSSEC" "MX lookup"
19070 .cindex "security" "MX lookup"
19071 .cindex "DNS" "DNSSEC"
19072 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
19073 the DNSSEC request bit set.  Any returns not having the Authenticated Data bit
19074 (AD bit) set will be ignored and logged as a host-lookup failure.
19075 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19076
19077
19078 .option domains routers&!? "domain list&!!" unset
19079 .cindex "router" "restricting to specific domains"
19080 .vindex "&$domain_data$&"
19081 If this option is set, the router is skipped unless the current domain matches
19082 the list. If the match is achieved by means of a file lookup, the data that the
19083 lookup returned for the domain is placed in &$domain_data$& for use in string
19084 expansions of the driver's private options and in the transport.
19085 See section &<<SECTrouprecon>>& for
19086 a list of the order in which preconditions are evaluated.
19087
19088
19089
19090 .option driver routers string unset
19091 This option must always be set. It specifies which of the available routers is
19092 to be used.
19093
19094
19095 .option dsn_lasthop routers boolean false
19096 .cindex "DSN" "success"
19097 .cindex "Delivery Status Notification" "success"
19098 If this option is set true, and extended DSN (RFC3461) processing is in effect,
19099 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
19100 instead send a success DSN as if the next hop does not support DSN.
19101 Not effective on redirect routers.
19102
19103
19104
19105 .option errors_to routers string&!! unset
19106 .cindex "envelope from"
19107 .cindex "envelope sender"
19108 .cindex "router" "changing address for errors"
19109 If a router successfully handles an address, it may assign the address to a
19110 transport for delivery or it may generate child addresses. In both cases, if
19111 there is a delivery problem during later processing, the resulting bounce
19112 message is sent to the address that results from expanding this string,
19113 provided that the address verifies successfully. The &%errors_to%& option is
19114 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
19115
19116 The &%errors_to%& setting associated with an address can be overridden if it
19117 subsequently passes through other routers that have their own &%errors_to%&
19118 settings, or if the message is delivered by a transport with a &%return_path%&
19119 setting.
19120
19121 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
19122 the expansion fails to verify, the errors address associated with the incoming
19123 address is used. At top level, this is the envelope sender. A non-forced
19124 expansion failure causes delivery to be deferred.
19125
19126 If an address for which &%errors_to%& has been set ends up being delivered over
19127 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
19128 any bounces that are generated by other MTAs on the delivery route are also
19129 sent there. You can set &%errors_to%& to the empty string by either of these
19130 settings:
19131 .code
19132 errors_to =
19133 errors_to = ""
19134 .endd
19135 An expansion item that yields an empty string has the same effect. If you do
19136 this, a locally detected delivery error for addresses processed by this router
19137 no longer gives rise to a bounce message; the error is discarded. If the
19138 address is delivered to a remote host, the return path is set to &`<>`&, unless
19139 overridden by the &%return_path%& option on the transport.
19140
19141 .vindex "&$address_data$&"
19142 If for some reason you want to discard local errors, but use a non-empty
19143 MAIL command for remote delivery, you can preserve the original return
19144 path in &$address_data$& in the router, and reinstate it in the transport by
19145 setting &%return_path%&.
19146
19147 The most common use of &%errors_to%& is to direct mailing list bounces to the
19148 manager of the list, as described in section &<<SECTmailinglists>>&, or to
19149 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
19150
19151
19152
19153 .option expn routers&!? boolean true
19154 .cindex "address" "testing"
19155 .cindex "testing" "addresses"
19156 .cindex "EXPN" "router skipping"
19157 .cindex "router" "skipping for EXPN"
19158 If this option is turned off, the router is skipped when testing an address
19159 as a result of processing an SMTP EXPN command. You might, for example,
19160 want to turn it off on a router for users' &_.forward_& files, while leaving it
19161 on for the system alias file.
19162 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19163 are evaluated.
19164
19165 The use of the SMTP EXPN command is controlled by an ACL (see chapter
19166 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
19167 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
19168
19169
19170
19171 .option fail_verify routers boolean false
19172 .cindex "router" "forcing verification failure"
19173 Setting this option has the effect of setting both &%fail_verify_sender%& and
19174 &%fail_verify_recipient%& to the same value.
19175
19176
19177
19178 .option fail_verify_recipient routers boolean false
19179 If this option is true and an address is accepted by this router when
19180 verifying a recipient, verification fails.
19181
19182
19183
19184 .option fail_verify_sender routers boolean false
19185 If this option is true and an address is accepted by this router when
19186 verifying a sender, verification fails.
19187
19188
19189
19190 .option fallback_hosts routers "string list" unset
19191 .cindex "router" "fallback hosts"
19192 .cindex "fallback" "hosts specified on router"
19193 String expansion is not applied to this option. The argument must be a
19194 colon-separated list of host names or IP addresses. The list separator can be
19195 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
19196 each name or address. In fact, the format of each item is exactly the same as
19197 defined for the list of hosts in a &(manualroute)& router (see section
19198 &<<SECTformatonehostitem>>&).
19199
19200 If a router queues an address for a remote transport, this host list is
19201 associated with the address, and used instead of the transport's fallback host
19202 list. If &%hosts_randomize%& is set on the transport, the order of the list is
19203 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
19204 transport for further details.
19205
19206
19207 .option group routers string&!! "see below"
19208 .cindex "gid (group id)" "local delivery"
19209 .cindex "local transports" "uid and gid"
19210 .cindex "transport" "local"
19211 .cindex "router" "setting group"
19212 When a router queues an address for a transport, and the transport does not
19213 specify a group, the group given here is used when running the delivery
19214 process.
19215 The group may be specified numerically or by name. If expansion fails, the
19216 error is logged and delivery is deferred.
19217 The default is unset, unless &%check_local_user%& is set, when the default
19218 is taken from the password information. See also &%initgroups%& and &%user%&
19219 and the discussion in chapter &<<CHAPenvironment>>&.
19220
19221
19222
19223 .option headers_add routers list&!! unset
19224 .cindex "header lines" "adding"
19225 .cindex "router" "adding header lines"
19226 This option specifies a list of text headers,
19227 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19228 that is associated with any addresses that are accepted by the router.
19229 Each item is separately expanded, at routing time.  However, this
19230 option has no effect when an address is just being verified. The way in which
19231 the text is used to add header lines at transport time is described in section
19232 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19233 message is in the process of being transported. This means that references to
19234 header lines in string expansions in the transport's configuration do not
19235 &"see"& the added header lines.
19236
19237 The &%headers_add%& option is expanded after &%errors_to%&, but before
19238 &%headers_remove%& and &%transport%&. If an item is empty, or if
19239 an item expansion is forced to fail, the item has no effect. Other expansion
19240 failures are treated as configuration errors.
19241
19242 Unlike most options, &%headers_add%& can be specified multiple times
19243 for a router; all listed headers are added.
19244
19245 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19246 router that has the &%one_time%& option set.
19247
19248 .cindex "duplicate addresses"
19249 .oindex "&%unseen%&"
19250 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19251 additions are deleted when the address is passed on to subsequent routers.
19252 For a &%redirect%& router, if a generated address is the same as the incoming
19253 address, this can lead to duplicate addresses with different header
19254 modifications. Exim does not do duplicate deliveries (except, in certain
19255 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19256 which of the duplicates is discarded, so this ambiguous situation should be
19257 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19258
19259
19260
19261 .option headers_remove routers list&!! unset
19262 .cindex "header lines" "removing"
19263 .cindex "router" "removing header lines"
19264 This option specifies a list of text headers,
19265 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19266 that is associated with any addresses that are accepted by the router.
19267 However, the option has no effect when an address is just being verified.
19268 Each list item is separately expanded, at transport time.
19269 If an item ends in *, it will match any header with the given prefix.
19270 The way in which
19271 the text is used to remove header lines at transport time is described in
19272 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19273 the message is in the process of being transported. This means that references
19274 to header lines in string expansions in the transport's configuration still
19275 &"see"& the original header lines.
19276
19277 The &%headers_remove%& option is handled after &%errors_to%& and
19278 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19279 the item has no effect. Other expansion failures are treated as configuration
19280 errors.
19281
19282 Unlike most options, &%headers_remove%& can be specified multiple times
19283 for a router; all listed headers are removed.
19284
19285 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19286 router that has the &%one_time%& option set.
19287
19288 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19289 removal requests are deleted when the address is passed on to subsequent
19290 routers, and this can lead to problems with duplicates -- see the similar
19291 warning for &%headers_add%& above.
19292
19293 &*Warning 3*&: Because of the separate expansion of the list items,
19294 items that contain a list separator must have it doubled.
19295 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19296
19297
19298
19299 .option ignore_target_hosts routers "host list&!!" unset
19300 .cindex "IP address" "discarding"
19301 .cindex "router" "discarding IP addresses"
19302 Although this option is a host list, it should normally contain IP address
19303 entries rather than names. If any host that is looked up by the router has an
19304 IP address that matches an item in this list, Exim behaves as if that IP
19305 address did not exist. This option allows you to cope with rogue DNS entries
19306 like
19307 .code
19308 remote.domain.example.  A  127.0.0.1
19309 .endd
19310 by setting
19311 .code
19312 ignore_target_hosts = 127.0.0.1
19313 .endd
19314 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19315 discarded in this way, the router declines. In a conventional configuration, an
19316 attempt to mail to such a domain would normally provoke the &"unrouteable
19317 domain"& error, and an attempt to verify an address in the domain would fail.
19318 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19319 router declines if presented with one of the listed addresses.
19320
19321 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19322 means of the first or the second of the following settings, respectively:
19323 .code
19324 ignore_target_hosts = 0.0.0.0/0
19325 ignore_target_hosts = <; 0::0/0
19326 .endd
19327 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19328 in the second line matches all IPv6 addresses.
19329
19330 This option may also be useful for ignoring link-local and site-local IPv6
19331 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19332 is expanded before use as a list, it is possible to make it dependent on the
19333 domain that is being routed.
19334
19335 .vindex "&$host_address$&"
19336 During its expansion, &$host_address$& is set to the IP address that is being
19337 checked.
19338
19339 .option initgroups routers boolean false
19340 .cindex "additional groups"
19341 .cindex "groups" "additional"
19342 .cindex "local transports" "uid and gid"
19343 .cindex "transport" "local"
19344 If the router queues an address for a transport, and this option is true, and
19345 the uid supplied by the router is not overridden by the transport, the
19346 &[initgroups()]& function is called when running the transport to ensure that
19347 any additional groups associated with the uid are set up. See also &%group%&
19348 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19349
19350
19351
19352 .option local_part_prefix routers&!? "string list" unset
19353 .cindex affix "router precondition"
19354 .cindex "router" "prefix for local part"
19355 .cindex "prefix" "for local part, used in router"
19356 If this option is set, the router is skipped unless the local part starts with
19357 one of the given strings, or &%local_part_prefix_optional%& is true. See
19358 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19359 evaluated.
19360
19361 The list is scanned from left to right, and the first prefix that matches is
19362 used. A limited form of wildcard is available; if the prefix begins with an
19363 asterisk, it matches the longest possible sequence of arbitrary characters at
19364 the start of the local part. An asterisk should therefore always be followed by
19365 some character that does not occur in normal local parts.
19366 .cindex "multiple mailboxes"
19367 .cindex "mailbox" "multiple"
19368 Wildcarding can be used to set up multiple user mailboxes, as described in
19369 section &<<SECTmulbox>>&.
19370
19371 .vindex "&$local_part$&"
19372 .vindex "&$local_part_prefix$&"
19373 During the testing of the &%local_parts%& option, and while the router is
19374 running, the prefix is removed from the local part, and is available in the
19375 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19376 the router accepts the address, this remains true during subsequent delivery by
19377 a transport. In particular, the local part that is transmitted in the RCPT
19378 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19379 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19380 the relevant transport.
19381
19382 .vindex &$local_part_prefix_v$&
19383 If wildcarding (above) was used then the part of the prefix matching the
19384 wildcard is available in &$local_part_prefix_v$&.
19385
19386 When an address is being verified, &%local_part_prefix%& affects only the
19387 behaviour of the router. If the callout feature of verification is in use, this
19388 means that the full address, including the prefix, will be used during the
19389 callout.
19390
19391 The prefix facility is commonly used to handle local parts of the form
19392 &%owner-something%&. Another common use is to support local parts of the form
19393 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19394 to tell a user their forwarding is broken &-- by placing a router like this one
19395 immediately before the router that handles &_.forward_& files:
19396 .code
19397 real_localuser:
19398   driver = accept
19399   local_part_prefix = real-
19400   check_local_user
19401   transport = local_delivery
19402 .endd
19403 For security, it would probably be a good idea to restrict the use of this
19404 router to locally-generated messages, using a condition such as this:
19405 .code
19406   condition = ${if match {$sender_host_address}\
19407                          {\N^(|127\.0\.0\.1)$\N}}
19408 .endd
19409
19410 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19411 both conditions must be met if not optional. Care must be taken if wildcards
19412 are used in both a prefix and a suffix on the same router. Different
19413 separator characters must be used to avoid ambiguity.
19414
19415
19416 .option local_part_prefix_optional routers boolean false
19417 See &%local_part_prefix%& above.
19418
19419
19420
19421 .option local_part_suffix routers&!? "string list" unset
19422 .cindex "router" "suffix for local part"
19423 .cindex "suffix for local part" "used in router"
19424 This option operates in the same way as &%local_part_prefix%&, except that the
19425 local part must end (rather than start) with the given string, the
19426 &%local_part_suffix_optional%& option determines whether the suffix is
19427 mandatory, and the wildcard * character, if present, must be the last
19428 character of the suffix. This option facility is commonly used to handle local
19429 parts of the form &%something-request%& and multiple user mailboxes of the form
19430 &%username-foo%&.
19431
19432
19433 .option local_part_suffix_optional routers boolean false
19434 See &%local_part_suffix%& above.
19435
19436
19437
19438 .option local_parts routers&!? "local part list&!!" unset
19439 .cindex "router" "restricting to specific local parts"
19440 .cindex "local part" "checking in router"
19441 The router is run only if the local part of the address matches the list.
19442 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19443 are evaluated, and
19444 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19445 string is expanded, it is possible to make it depend on the domain, for
19446 example:
19447 .code
19448 local_parts = dbm;/usr/local/specials/$domain_data
19449 .endd
19450 .vindex "&$local_part_data$&"
19451 If the match is achieved by a lookup, the data that the lookup returned
19452 for the local part is placed in the variable &$local_part_data$& for use in
19453 expansions of the router's private options or in the transport.
19454 You might use this option, for
19455 example, if you have a large number of local virtual domains, and you want to
19456 send all postmaster mail to the same place without having to set up an alias in
19457 each virtual domain:
19458 .code
19459 postmaster:
19460   driver = redirect
19461   local_parts = postmaster
19462   data = postmaster@real.domain.example
19463 .endd
19464
19465
19466 .option log_as_local routers boolean "see below"
19467 .cindex "log" "delivery line"
19468 .cindex "delivery" "log line format"
19469 Exim has two logging styles for delivery, the idea being to make local
19470 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19471 recipient address is given just as the local part, without a domain. The use of
19472 this style is controlled by this option. It defaults to true for the &(accept)&
19473 router, and false for all the others. This option applies only when a
19474 router assigns an address to a transport. It has no effect on routers that
19475 redirect addresses.
19476
19477
19478
19479 .option more routers boolean&!! true
19480 The result of string expansion for this option must be a valid boolean value,
19481 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19482 result causes an error, and delivery is deferred. If the expansion is forced to
19483 fail, the default value for the option (true) is used. Other failures cause
19484 delivery to be deferred.
19485
19486 If this option is set false, and the router declines to handle the address, no
19487 further routers are tried, routing fails, and the address is bounced.
19488 .oindex "&%self%&"
19489 However, if the router explicitly passes an address to the following router by
19490 means of the setting
19491 .code
19492 self = pass
19493 .endd
19494 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19495 does not affect the behaviour if one of the precondition tests fails. In that
19496 case, the address is always passed to the next router.
19497
19498 Note that &%address_data%& is not considered to be a precondition. If its
19499 expansion is forced to fail, the router declines, and the value of &%more%&
19500 controls what happens next.
19501
19502
19503 .option pass_on_timeout routers boolean false
19504 .cindex "timeout" "of router"
19505 .cindex "router" "timeout"
19506 If a router times out during a host lookup, it normally causes deferral of the
19507 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19508 router, overriding &%no_more%&. This may be helpful for systems that are
19509 intermittently connected to the Internet, or those that want to pass to a smart
19510 host any messages that cannot immediately be delivered.
19511
19512 There are occasional other temporary errors that can occur while doing DNS
19513 lookups. They are treated in the same way as a timeout, and this option
19514 applies to all of them.
19515
19516
19517
19518 .option pass_router routers string unset
19519 .cindex "router" "go to after &""pass""&"
19520 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19521 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19522 routing to continue, and overriding a false setting of &%more%&. When one of
19523 these routers returns &"pass"&, the address is normally handed on to the next
19524 router in sequence. This can be changed by setting &%pass_router%& to the name
19525 of another router. However (unlike &%redirect_router%&) the named router must
19526 be below the current router, to avoid loops. Note that this option applies only
19527 to the special case of &"pass"&. It does not apply when a router returns
19528 &"decline"& because it cannot handle an address.
19529
19530
19531
19532 .option redirect_router routers string unset
19533 .cindex "router" "start at after redirection"
19534 Sometimes an administrator knows that it is pointless to reprocess addresses
19535 generated from alias or forward files with the same router again. For
19536 example, if an alias file translates real names into login ids there is no
19537 point searching the alias file a second time, especially if it is a large file.
19538
19539 The &%redirect_router%& option can be set to the name of any router instance.
19540 It causes the routing of any generated addresses to start at the named router
19541 instead of at the first router. This option has no effect if the router in
19542 which it is set does not generate new addresses.
19543
19544
19545
19546 .option require_files routers&!? "string list&!!" unset
19547 .cindex "file" "requiring for router"
19548 .cindex "router" "requiring file existence"
19549 This option provides a general mechanism for predicating the running of a
19550 router on the existence or non-existence of certain files or directories.
19551 Before running a router, as one of its precondition tests, Exim works its way
19552 through the &%require_files%& list, expanding each item separately.
19553
19554 Because the list is split before expansion, any colons in expansion items must
19555 be doubled, or the facility for using a different list separator must be used
19556 (&<<SECTlistsepchange>>&).
19557 If any expansion is forced to fail, the item is ignored. Other expansion
19558 failures cause routing of the address to be deferred.
19559
19560 If any expanded string is empty, it is ignored. Otherwise, except as described
19561 below, each string must be a fully qualified file path, optionally preceded by
19562 &"!"&. The paths are passed to the &[stat()]& function to test for the
19563 existence of the files or directories. The router is skipped if any paths not
19564 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19565
19566 .cindex "NFS"
19567 If &[stat()]& cannot determine whether a file exists or not, delivery of
19568 the message is deferred. This can happen when NFS-mounted filesystems are
19569 unavailable.
19570
19571 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19572 options, so you cannot use it to check for the existence of a file in which to
19573 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19574 full list of the order in which preconditions are evaluated.) However, as
19575 these options are all expanded, you can use the &%exists%& expansion condition
19576 to make such tests. The &%require_files%& option is intended for checking files
19577 that the router may be going to use internally, or which are needed by a
19578 transport (e.g., &_.procmailrc_&).
19579
19580 During delivery, the &[stat()]& function is run as root, but there is a
19581 facility for some checking of the accessibility of a file by another user.
19582 This is not a proper permissions check, but just a &"rough"& check that
19583 operates as follows:
19584
19585 If an item in a &%require_files%& list does not contain any forward slash
19586 characters, it is taken to be the user (and optional group, separated by a
19587 comma) to be checked for subsequent files in the list. If no group is specified
19588 but the user is specified symbolically, the gid associated with the uid is
19589 used. For example:
19590 .code
19591 require_files = mail:/some/file
19592 require_files = $local_part_data:$home/.procmailrc
19593 .endd
19594 If a user or group name in a &%require_files%& list does not exist, the
19595 &%require_files%& condition fails.
19596
19597 Exim performs the check by scanning along the components of the file path, and
19598 checking the access for the given uid and gid. It checks for &"x"& access on
19599 directories, and &"r"& access on the final file. Note that this means that file
19600 access control lists, if the operating system has them, are ignored.
19601
19602 &*Warning 1*&: When the router is being run to verify addresses for an
19603 incoming SMTP message, Exim is not running as root, but under its own uid. This
19604 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19605 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19606 user is not permitted to read one of the directories on the file's path.
19607
19608 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19609 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19610 without root access. In this case, if a check for access by a particular user
19611 is requested, Exim creates a subprocess that runs as that user, and tries the
19612 check again in that process.
19613
19614 The default action for handling an unresolved EACCES is to consider it to
19615 be caused by a configuration error, and routing is deferred because the
19616 existence or non-existence of the file cannot be determined. However, in some
19617 circumstances it may be desirable to treat this condition as if the file did
19618 not exist. If the filename (or the exclamation mark that precedes the filename
19619 for non-existence) is preceded by a plus sign, the EACCES error is treated
19620 as if the file did not exist. For example:
19621 .code
19622 require_files = +/some/file
19623 .endd
19624 If the router is not an essential part of verification (for example, it
19625 handles users' &_.forward_& files), another solution is to set the &%verify%&
19626 option false so that the router is skipped when verifying.
19627
19628
19629
19630 .option retry_use_local_part routers boolean "see below"
19631 .cindex "hints database" "retry keys"
19632 .cindex "local part" "in retry keys"
19633 When a delivery suffers a temporary routing failure, a retry record is created
19634 in Exim's hints database. For addresses whose routing depends only on the
19635 domain, the key for the retry record should not involve the local part, but for
19636 other addresses, both the domain and the local part should be included.
19637 Usually, remote routing is of the former kind, and local routing is of the
19638 latter kind.
19639
19640 This option controls whether the local part is used to form the key for retry
19641 hints for addresses that suffer temporary errors while being handled by this
19642 router. The default value is true for any router that has any of
19643 &%check_local_user%&,
19644 &%local_parts%&,
19645 &%condition%&,
19646 &%local_part_prefix%&,
19647 &%local_part_suffix%&,
19648 &%senders%& or
19649 &%require_files%&
19650 set, and false otherwise. Note that this option does not apply to hints keys
19651 for transport delays; they are controlled by a generic transport option of the
19652 same name.
19653
19654 Failing to set this option when it is needed
19655 (because a remote router handles only some of the local-parts for a domain)
19656 can result in incorrect error messages being generated.
19657
19658 The setting of &%retry_use_local_part%& applies only to the router on which it
19659 appears. If the router generates child addresses, they are routed
19660 independently; this setting does not become attached to them.
19661
19662
19663
19664 .option router_home_directory routers string&!! unset
19665 .cindex "router" "home directory for"
19666 .cindex "home directory" "for router"
19667 .vindex "&$home$&"
19668 This option sets a home directory for use while the router is running. (Compare
19669 &%transport_home_directory%&, which sets a home directory for later
19670 transporting.) In particular, if used on a &(redirect)& router, this option
19671 sets a value for &$home$& while a filter is running. The value is expanded;
19672 forced expansion failure causes the option to be ignored &-- other failures
19673 cause the router to defer.
19674
19675 Expansion of &%router_home_directory%& happens immediately after the
19676 &%check_local_user%& test (if configured), before any further expansions take
19677 place.
19678 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19679 are evaluated.)
19680 While the router is running, &%router_home_directory%& overrides the value of
19681 &$home$& that came from &%check_local_user%&.
19682
19683 When a router accepts an address and assigns it to a local transport (including
19684 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19685 delivery), the home directory setting for the transport is taken from the first
19686 of these values that is set:
19687
19688 .ilist
19689 The &%home_directory%& option on the transport;
19690 .next
19691 The &%transport_home_directory%& option on the router;
19692 .next
19693 The password data if &%check_local_user%& is set on the router;
19694 .next
19695 The &%router_home_directory%& option on the router.
19696 .endlist
19697
19698 In other words, &%router_home_directory%& overrides the password data for the
19699 router, but not for the transport.
19700
19701
19702
19703 .option self routers string freeze
19704 .cindex "MX record" "pointing to local host"
19705 .cindex "local host" "MX pointing to"
19706 This option applies to those routers that use a recipient address to find a
19707 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19708 and &(manualroute)& routers.
19709 Certain configurations of the &(queryprogram)& router can also specify a list
19710 of remote hosts.
19711 Usually such routers are configured to send the message to a remote host via an
19712 &(smtp)& transport. The &%self%& option specifies what happens when the first
19713 host on the list turns out to be the local host.
19714 The way in which Exim checks for the local host is described in section
19715 &<<SECTreclocipadd>>&.
19716
19717 Normally this situation indicates either an error in Exim's configuration (for
19718 example, the router should be configured not to process this domain), or an
19719 error in the DNS (for example, the MX should not point to this host). For this
19720 reason, the default action is to log the incident, defer the address, and
19721 freeze the message. The following alternatives are provided for use in special
19722 cases:
19723
19724 .vlist
19725 .vitem &%defer%&
19726 Delivery of the message is tried again later, but the message is not frozen.
19727
19728 .vitem "&%reroute%&: <&'domain'&>"
19729 The domain is changed to the given domain, and the address is passed back to
19730 be reprocessed by the routers. No rewriting of headers takes place. This
19731 behaviour is essentially a redirection.
19732
19733 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19734 The domain is changed to the given domain, and the address is passed back to be
19735 reprocessed by the routers. Any headers that contain the original domain are
19736 rewritten.
19737
19738 .vitem &%pass%&
19739 .oindex "&%more%&"
19740 .vindex "&$self_hostname$&"
19741 The router passes the address to the next router, or to the router named in the
19742 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19743 subsequent routing and delivery, the variable &$self_hostname$& contains the
19744 name of the local host that the router encountered. This can be used to
19745 distinguish between different cases for hosts with multiple names. The
19746 combination
19747 .code
19748 self = pass
19749 no_more
19750 .endd
19751 ensures that only those addresses that routed to the local host are passed on.
19752 Without &%no_more%&, addresses that were declined for other reasons would also
19753 be passed to the next router.
19754
19755 .vitem &%fail%&
19756 Delivery fails and an error report is generated.
19757
19758 .vitem &%send%&
19759 .cindex "local host" "sending to"
19760 The anomaly is ignored and the address is queued for the transport. This
19761 setting should be used with extreme caution. For an &(smtp)& transport, it
19762 makes sense only in cases where the program that is listening on the SMTP port
19763 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19764 different configuration file that handles the domain in another way.
19765 .endlist
19766
19767
19768
19769 .option senders routers&!? "address list&!!" unset
19770 .cindex "router" "checking senders"
19771 If this option is set, the router is skipped unless the message's sender
19772 address matches something on the list.
19773 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19774 are evaluated.
19775
19776 There are issues concerning verification when the running of routers is
19777 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19778 setting, it sets the sender to the null string. When using the &%-bt%& option
19779 to check a configuration file, it is necessary also to use the &%-f%& option to
19780 set an appropriate sender. For incoming mail, the sender is unset when
19781 verifying the sender, but is available when verifying any recipients. If the
19782 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19783 matters.
19784
19785
19786 .option set routers "string list" unset
19787 .cindex router variables
19788 This option may be used multiple times on a router;
19789 because of this the list aspect is mostly irrelevant.
19790 The list separator is a semicolon but can be changed in the
19791 usual way.
19792
19793 Each list-element given must be of the form &"name = value"&
19794 and the names used must start with the string &"r_"&.
19795 Values containing a list-separator should have them doubled.
19796 When a router runs, the strings are evaluated in order,
19797 to create variables which are added to the set associated with
19798 the address.
19799 This is done immediately after all the preconditions, before the
19800 evaluation of the &%address_data%& option.
19801 The variable is set with the expansion of the value.
19802 The variables can be used by the router options
19803 (not including any preconditions)
19804 and by the transport.
19805 Later definitions of a given named variable will override former ones.
19806 Variable use is via the usual &$r_...$& syntax.
19807
19808 This is similar to the &%address_data%& option, except that
19809 many independent variables can be used, with choice of naming.
19810
19811
19812 .option translate_ip_address routers string&!! unset
19813 .cindex "IP address" "translating"
19814 .cindex "packet radio"
19815 .cindex "router" "IP address translation"
19816 There exist some rare networking situations (for example, packet radio) where
19817 it is helpful to be able to translate IP addresses generated by normal routing
19818 mechanisms into other IP addresses, thus performing a kind of manual IP
19819 routing. This should be done only if the normal IP routing of the TCP/IP stack
19820 is inadequate or broken. Because this is an extremely uncommon requirement, the
19821 code to support this option is not included in the Exim binary unless
19822 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19823
19824 .vindex "&$host_address$&"
19825 The &%translate_ip_address%& string is expanded for every IP address generated
19826 by the router, with the generated address set in &$host_address$&. If the
19827 expansion is forced to fail, no action is taken.
19828 For any other expansion error, delivery of the message is deferred.
19829 If the result of the expansion is an IP address, that replaces the original
19830 address; otherwise the result is assumed to be a host name &-- this is looked
19831 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19832 produce one or more replacement IP addresses. For example, to subvert all IP
19833 addresses in some specific networks, this could be added to a router:
19834 .code
19835 translate_ip_address = \
19836   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19837     {$value}fail}}
19838 .endd
19839 The file would contain lines like
19840 .code
19841 10.2.3.128/26    some.host
19842 10.8.4.34/26     10.44.8.15
19843 .endd
19844 You should not make use of this facility unless you really understand what you
19845 are doing.
19846
19847
19848
19849 .option transport routers string&!! unset
19850 This option specifies the transport to be used when a router accepts an address
19851 and sets it up for delivery. A transport is never needed if a router is used
19852 only for verification. The value of the option is expanded at routing time,
19853 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19854 and result must be the name of one of the configured transports. If it is not,
19855 delivery is deferred.
19856
19857 The &%transport%& option is not used by the &(redirect)& router, but it does
19858 have some private options that set up transports for pipe and file deliveries
19859 (see chapter &<<CHAPredirect>>&).
19860
19861
19862
19863 .option transport_current_directory routers string&!! unset
19864 .cindex "current directory for local transport"
19865 This option associates a current directory with any address that is routed
19866 to a local transport. This can happen either because a transport is
19867 explicitly configured for the router, or because it generates a delivery to a
19868 file or a pipe. During the delivery process (that is, at transport time), this
19869 option string is expanded and is set as the current directory, unless
19870 overridden by a setting on the transport.
19871 If the expansion fails for any reason, including forced failure, an error is
19872 logged, and delivery is deferred.
19873 See chapter &<<CHAPenvironment>>& for details of the local delivery
19874 environment.
19875
19876
19877
19878
19879 .option transport_home_directory routers string&!! "see below"
19880 .cindex "home directory" "for local transport"
19881 This option associates a home directory with any address that is routed to a
19882 local transport. This can happen either because a transport is explicitly
19883 configured for the router, or because it generates a delivery to a file or a
19884 pipe. During the delivery process (that is, at transport time), the option
19885 string is expanded and is set as the home directory, unless overridden by a
19886 setting of &%home_directory%& on the transport.
19887 If the expansion fails for any reason, including forced failure, an error is
19888 logged, and delivery is deferred.
19889
19890 If the transport does not specify a home directory, and
19891 &%transport_home_directory%& is not set for the router, the home directory for
19892 the transport is taken from the password data if &%check_local_user%& is set for
19893 the router. Otherwise it is taken from &%router_home_directory%& if that option
19894 is set; if not, no home directory is set for the transport.
19895
19896 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19897 environment.
19898
19899
19900
19901
19902 .option unseen routers boolean&!! false
19903 .cindex "router" "carrying on after success"
19904 The result of string expansion for this option must be a valid boolean value,
19905 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19906 result causes an error, and delivery is deferred. If the expansion is forced to
19907 fail, the default value for the option (false) is used. Other failures cause
19908 delivery to be deferred.
19909
19910 When this option is set true, routing does not cease if the router accepts the
19911 address. Instead, a copy of the incoming address is passed to the next router,
19912 overriding a false setting of &%more%&. There is little point in setting
19913 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19914 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19915 sometimes true and sometimes false).
19916
19917 .cindex "copy of message (&%unseen%& option)"
19918 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19919 qualifier in filter files. It can be used to cause copies of messages to be
19920 delivered to some other destination, while also carrying out a normal delivery.
19921 In effect, the current address is made into a &"parent"& that has two children
19922 &-- one that is delivered as specified by this router, and a clone that goes on
19923 to be routed further. For this reason, &%unseen%& may not be combined with the
19924 &%one_time%& option in a &(redirect)& router.
19925
19926 &*Warning*&: Header lines added to the address (or specified for removal) by
19927 this router or by previous routers affect the &"unseen"& copy of the message
19928 only. The clone that continues to be processed by further routers starts with
19929 no added headers and none specified for removal. For a &%redirect%& router, if
19930 a generated address is the same as the incoming address, this can lead to
19931 duplicate addresses with different header modifications. Exim does not do
19932 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19933 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19934 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19935 &%redirect%& router may be of help.
19936
19937 Unlike the handling of header modifications, any data that was set by the
19938 &%address_data%& option in the current or previous routers &'is'& passed on to
19939 subsequent routers.
19940
19941
19942 .option user routers string&!! "see below"
19943 .cindex "uid (user id)" "local delivery"
19944 .cindex "local transports" "uid and gid"
19945 .cindex "transport" "local"
19946 .cindex "router" "user for filter processing"
19947 .cindex "filter" "user for processing"
19948 When a router queues an address for a transport, and the transport does not
19949 specify a user, the user given here is used when running the delivery process.
19950 The user may be specified numerically or by name. If expansion fails, the
19951 error is logged and delivery is deferred.
19952 This user is also used by the &(redirect)& router when running a filter file.
19953 The default is unset, except when &%check_local_user%& is set. In this case,
19954 the default is taken from the password information. If the user is specified as
19955 a name, and &%group%& is not set, the group associated with the user is used.
19956 See also &%initgroups%& and &%group%& and the discussion in chapter
19957 &<<CHAPenvironment>>&.
19958
19959
19960
19961 .option verify routers&!? boolean true
19962 Setting this option has the effect of setting &%verify_sender%& and
19963 &%verify_recipient%& to the same value.
19964
19965
19966 .option verify_only routers&!? boolean false
19967 .cindex "EXPN" "with &%verify_only%&"
19968 .oindex "&%-bv%&"
19969 .cindex "router" "used only when verifying"
19970 If this option is set, the router is used only when verifying an address,
19971 delivering in cutthrough mode or
19972 testing with the &%-bv%& option, not when actually doing a delivery, testing
19973 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19974 restricted to verifying only senders or recipients by means of
19975 &%verify_sender%& and &%verify_recipient%&.
19976
19977 &*Warning*&: When the router is being run to verify addresses for an incoming
19978 SMTP message, Exim is not running as root, but under its own uid. If the router
19979 accesses any files, you need to make sure that they are accessible to the Exim
19980 user or group.
19981
19982
19983 .option verify_recipient routers&!? boolean true
19984 If this option is false, the router is skipped when verifying recipient
19985 addresses,
19986 delivering in cutthrough mode
19987 or testing recipient verification using &%-bv%&.
19988 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19989 are evaluated.
19990 See also the &$verify_mode$& variable.
19991
19992
19993 .option verify_sender routers&!? boolean true
19994 If this option is false, the router is skipped when verifying sender addresses
19995 or testing sender verification using &%-bvs%&.
19996 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19997 are evaluated.
19998 See also the &$verify_mode$& variable.
19999 .ecindex IIDgenoprou1
20000 .ecindex IIDgenoprou2
20001
20002
20003
20004
20005
20006
20007 . ////////////////////////////////////////////////////////////////////////////
20008 . ////////////////////////////////////////////////////////////////////////////
20009
20010 .chapter "The accept router" "CHID4"
20011 .cindex "&(accept)& router"
20012 .cindex "routers" "&(accept)&"
20013 The &(accept)& router has no private options of its own. Unless it is being
20014 used purely for verification (see &%verify_only%&) a transport is required to
20015 be defined by the generic &%transport%& option. If the preconditions that are
20016 specified by generic options are met, the router accepts the address and queues
20017 it for the given transport. The most common use of this router is for setting
20018 up deliveries to local mailboxes. For example:
20019 .code
20020 localusers:
20021   driver = accept
20022   domains = mydomain.example
20023   check_local_user
20024   transport = local_delivery
20025 .endd
20026 The &%domains%& condition in this example checks the domain of the address, and
20027 &%check_local_user%& checks that the local part is the login of a local user.
20028 When both preconditions are met, the &(accept)& router runs, and queues the
20029 address for the &(local_delivery)& transport.
20030
20031
20032
20033
20034
20035
20036 . ////////////////////////////////////////////////////////////////////////////
20037 . ////////////////////////////////////////////////////////////////////////////
20038
20039 .chapter "The dnslookup router" "CHAPdnslookup"
20040 .scindex IIDdnsrou1 "&(dnslookup)& router"
20041 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
20042 The &(dnslookup)& router looks up the hosts that handle mail for the
20043 recipient's domain in the DNS. A transport must always be set for this router,
20044 unless &%verify_only%& is set.
20045
20046 If SRV support is configured (see &%check_srv%& below), Exim first searches for
20047 SRV records. If none are found, or if SRV support is not configured,
20048 MX records are looked up. If no MX records exist, address records are sought.
20049 However, &%mx_domains%& can be set to disable the direct use of address
20050 records.
20051
20052 MX records of equal priority are sorted by Exim into a random order. Exim then
20053 looks for address records for the host names obtained from MX or SRV records.
20054 When a host has more than one IP address, they are sorted into a random order,
20055 except that IPv6 addresses are sorted before IPv4 addresses. If all the
20056 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
20057 generic option, the router declines.
20058
20059 Unless they have the highest priority (lowest MX value), MX records that point
20060 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
20061 are discarded, together with any other MX records of equal or lower priority.
20062
20063 .cindex "MX record" "pointing to local host"
20064 .cindex "local host" "MX pointing to"
20065 .oindex "&%self%&" "in &(dnslookup)& router"
20066 If the host pointed to by the highest priority MX record, or looked up as an
20067 address record, is the local host, or matches &%hosts_treat_as_local%&, what
20068 happens is controlled by the generic &%self%& option.
20069
20070
20071 .section "Problems with DNS lookups" "SECTprowitdnsloo"
20072 There have been problems with DNS servers when SRV records are looked up.
20073 Some misbehaving servers return a DNS error or timeout when a non-existent
20074 SRV record is sought. Similar problems have in the past been reported for
20075 MX records. The global &%dns_again_means_nonexist%& option can help with this
20076 problem, but it is heavy-handed because it is a global option.
20077
20078 For this reason, there are two options, &%srv_fail_domains%& and
20079 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
20080 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
20081 an attempt to look up an SRV or MX record causes one of these results, and the
20082 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
20083 such record"&. In the case of an SRV lookup, this means that the router
20084 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
20085 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
20086 case routing fails.
20087
20088
20089 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
20090 .cindex "&(dnslookup)& router" "declines"
20091 There are a few cases where a &(dnslookup)& router will decline to accept
20092 an address; if such a router is expected to handle "all remaining non-local
20093 domains", then it is important to set &%no_more%&.
20094
20095 The router will defer rather than decline if the domain
20096 is found in the &%fail_defer_domains%& router option.
20097
20098 Reasons for a &(dnslookup)& router to decline currently include:
20099 .ilist
20100 The domain does not exist in DNS
20101 .next
20102 The domain exists but the MX record's host part is just "."; this is a common
20103 convention (borrowed from SRV) used to indicate that there is no such service
20104 for this domain and to not fall back to trying A/AAAA records.
20105 .next
20106 Ditto, but for SRV records, when &%check_srv%& is set on this router.
20107 .next
20108 MX record points to a non-existent host.
20109 .next
20110 MX record points to an IP address and the main section option
20111 &%allow_mx_to_ip%& is not set.
20112 .next
20113 MX records exist and point to valid hosts, but all hosts resolve only to
20114 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
20115 .next
20116 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
20117 &%dns_check_names_pattern%& for handling one variant of this)
20118 .next
20119 &%check_secondary_mx%& is set on this router but the local host can
20120 not be found in the MX records (see below)
20121 .endlist
20122
20123
20124
20125
20126 .section "Private options for dnslookup" "SECID118"
20127 .cindex "options" "&(dnslookup)& router"
20128 The private options for the &(dnslookup)& router are as follows:
20129
20130 .option check_secondary_mx dnslookup boolean false
20131 .cindex "MX record" "checking for secondary"
20132 If this option is set, the router declines unless the local host is found in
20133 (and removed from) the list of hosts obtained by MX lookup. This can be used to
20134 process domains for which the local host is a secondary mail exchanger
20135 differently to other domains. The way in which Exim decides whether a host is
20136 the local host is described in section &<<SECTreclocipadd>>&.
20137
20138
20139 .option check_srv dnslookup string&!! unset
20140 .cindex "SRV record" "enabling use of"
20141 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
20142 addition to MX and address records. The support is disabled by default. To
20143 enable SRV support, set the &%check_srv%& option to the name of the service
20144 required. For example,
20145 .code
20146 check_srv = smtp
20147 .endd
20148 looks for SRV records that refer to the normal smtp service. The option is
20149 expanded, so the service name can vary from message to message or address
20150 to address. This might be helpful if SRV records are being used for a
20151 submission service. If the expansion is forced to fail, the &%check_srv%&
20152 option is ignored, and the router proceeds to look for MX records in the
20153 normal way.
20154
20155 When the expansion succeeds, the router searches first for SRV records for
20156 the given service (it assumes TCP protocol). A single SRV record with a
20157 host name that consists of just a single dot indicates &"no such service for
20158 this domain"&; if this is encountered, the router declines. If other kinds of
20159 SRV record are found, they are used to construct a host list for delivery
20160 according to the rules of RFC 2782. MX records are not sought in this case.
20161
20162 When no SRV records are found, MX records (and address records) are sought in
20163 the traditional way. In other words, SRV records take precedence over MX
20164 records, just as MX records take precedence over address records. Note that
20165 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
20166 defined it. It is apparently believed that MX records are sufficient for email
20167 and that SRV records should not be used for this purpose. However, SRV records
20168 have an additional &"weight"& feature which some people might find useful when
20169 trying to split an SMTP load between hosts of different power.
20170
20171 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
20172 when there is a DNS lookup error.
20173
20174
20175
20176
20177 .option fail_defer_domains dnslookup "domain list&!!" unset
20178 .cindex "MX record" "not found"
20179 DNS lookups for domains matching &%fail_defer_domains%&
20180 which find no matching record will cause the router to defer
20181 rather than the default behaviour of decline.
20182 This maybe be useful for queueing messages for a newly created
20183 domain while the DNS configuration is not ready.
20184 However, it will result in any message with mistyped domains
20185 also being queued.
20186
20187
20188 .option ipv4_only "string&!!" unset
20189 .cindex IPv6 disabling
20190 .cindex DNS "IPv6 disabling"
20191 The string is expanded, and if the result is anything but a forced failure,
20192 or an empty string, or one of the strings “0” or “no” or “false”
20193 (checked without regard to the case of the letters),
20194 only A records are used.
20195
20196 .option ipv4_prefer "string&!!" unset
20197 .cindex IPv4 preference
20198 .cindex DNS "IPv4 preference"
20199 The string is expanded, and if the result is anything but a forced failure,
20200 or an empty string, or one of the strings “0” or “no” or “false”
20201 (checked without regard to the case of the letters),
20202 A records are sorted before AAAA records (inverting the default).
20203
20204 .option mx_domains dnslookup "domain list&!!" unset
20205 .cindex "MX record" "required to exist"
20206 .cindex "SRV record" "required to exist"
20207 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
20208 record in order to be recognized. (The name of this option could be improved.)
20209 For example, if all the mail hosts in &'fict.example'& are known to have MX
20210 records, except for those in &'discworld.fict.example'&, you could use this
20211 setting:
20212 .code
20213 mx_domains = ! *.discworld.fict.example : *.fict.example
20214 .endd
20215 This specifies that messages addressed to a domain that matches the list but
20216 has no MX record should be bounced immediately instead of being routed using
20217 the address record.
20218
20219
20220 .option mx_fail_domains dnslookup "domain list&!!" unset
20221 If the DNS lookup for MX records for one of the domains in this list causes a
20222 DNS lookup error, Exim behaves as if no MX records were found. See section
20223 &<<SECTprowitdnsloo>>& for more discussion.
20224
20225
20226
20227
20228 .option qualify_single dnslookup boolean true
20229 .cindex "DNS" "resolver options"
20230 .cindex "DNS" "qualifying single-component names"
20231 When this option is true, the resolver option RES_DEFNAMES is set for DNS
20232 lookups. Typically, but not standardly, this causes the resolver to qualify
20233 single-component names with the default domain. For example, on a machine
20234 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20235 &'thesaurus.ref.example'& inside the resolver. For details of what your
20236 resolver actually does, consult your man pages for &'resolver'& and
20237 &'resolv.conf'&.
20238
20239
20240
20241 .option rewrite_headers dnslookup boolean true
20242 .cindex "rewriting" "header lines"
20243 .cindex "header lines" "rewriting"
20244 If the domain name in the address that is being processed is not fully
20245 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20246 an address is specified as &'dormouse@teaparty'&, the domain might be
20247 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20248 occur as a result of setting the &%widen_domains%& option. If
20249 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20250 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20251 header lines of the message are rewritten with the full domain name.
20252
20253 This option should be turned off only when it is known that no message is
20254 ever going to be sent outside an environment where the abbreviation makes
20255 sense.
20256
20257 When an MX record is looked up in the DNS and matches a wildcard record, name
20258 servers normally return a record containing the name that has been looked up,
20259 making it impossible to detect whether a wildcard was present or not. However,
20260 some name servers have recently been seen to return the wildcard entry. If the
20261 name returned by a DNS lookup begins with an asterisk, it is not used for
20262 header rewriting.
20263
20264
20265 .option same_domain_copy_routing dnslookup boolean false
20266 .cindex "address" "copying routing"
20267 Addresses with the same domain are normally routed by the &(dnslookup)& router
20268 to the same list of hosts. However, this cannot be presumed, because the router
20269 options and preconditions may refer to the local part of the address. By
20270 default, therefore, Exim routes each address in a message independently. DNS
20271 servers run caches, so repeated DNS lookups are not normally expensive, and in
20272 any case, personal messages rarely have more than a few recipients.
20273
20274 If you are running mailing lists with large numbers of subscribers at the same
20275 domain, and you are using a &(dnslookup)& router which is independent of the
20276 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20277 lookups for identical domains in one message. In this case, when &(dnslookup)&
20278 routes an address to a remote transport, any other unrouted addresses in the
20279 message that have the same domain are automatically given the same routing
20280 without processing them independently,
20281 provided the following conditions are met:
20282
20283 .ilist
20284 No router that processed the address specified &%headers_add%& or
20285 &%headers_remove%&.
20286 .next
20287 The router did not change the address in any way, for example, by &"widening"&
20288 the domain.
20289 .endlist
20290
20291
20292
20293
20294 .option search_parents dnslookup boolean false
20295 .cindex "DNS" "resolver options"
20296 When this option is true, the resolver option RES_DNSRCH is set for DNS
20297 lookups. This is different from the &%qualify_single%& option in that it
20298 applies to domains containing dots. Typically, but not standardly, it causes
20299 the resolver to search for the name in the current domain and in parent
20300 domains. For example, on a machine in the &'fict.example'& domain, if looking
20301 up &'teaparty.wonderland'& failed, the resolver would try
20302 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20303 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20304
20305 Setting this option true can cause problems in domains that have a wildcard MX
20306 record, because any domain that does not have its own MX record matches the
20307 local wildcard.
20308
20309
20310
20311 .option srv_fail_domains dnslookup "domain list&!!" unset
20312 If the DNS lookup for SRV records for one of the domains in this list causes a
20313 DNS lookup error, Exim behaves as if no SRV records were found. See section
20314 &<<SECTprowitdnsloo>>& for more discussion.
20315
20316
20317
20318
20319 .option widen_domains dnslookup "string list" unset
20320 .cindex "domain" "partial; widening"
20321 If a DNS lookup fails and this option is set, each of its strings in turn is
20322 added onto the end of the domain, and the lookup is tried again. For example,
20323 if
20324 .code
20325 widen_domains = fict.example:ref.example
20326 .endd
20327 is set and a lookup of &'klingon.dictionary'& fails,
20328 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20329 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20330 and &%search_parents%& options can cause some widening to be undertaken inside
20331 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20332 when verifying, unless &%rewrite_headers%& is false (not the default).
20333
20334
20335 .section "Effect of qualify_single and search_parents" "SECID119"
20336 When a domain from an envelope recipient is changed by the resolver as a result
20337 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20338 corresponding address in the message's header lines unless &%rewrite_headers%&
20339 is set false. Exim then re-routes the address, using the full domain.
20340
20341 These two options affect only the DNS lookup that takes place inside the router
20342 for the domain of the address that is being routed. They do not affect lookups
20343 such as that implied by
20344 .code
20345 domains = @mx_any
20346 .endd
20347 that may happen while processing a router precondition before the router is
20348 entered. No widening ever takes place for these lookups.
20349 .ecindex IIDdnsrou1
20350 .ecindex IIDdnsrou2
20351
20352
20353
20354
20355
20356
20357
20358
20359
20360 . ////////////////////////////////////////////////////////////////////////////
20361 . ////////////////////////////////////////////////////////////////////////////
20362
20363 .chapter "The ipliteral router" "CHID5"
20364 .cindex "&(ipliteral)& router"
20365 .cindex "domain literal" "routing"
20366 .cindex "routers" "&(ipliteral)&"
20367 This router has no private options. Unless it is being used purely for
20368 verification (see &%verify_only%&) a transport is required to be defined by the
20369 generic &%transport%& option. The router accepts the address if its domain part
20370 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20371 router handles the address
20372 .code
20373 root@[192.168.1.1]
20374 .endd
20375 by setting up delivery to the host with that IP address. IPv4 domain literals
20376 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20377 are similar, but the address is preceded by &`ipv6:`&. For example:
20378 .code
20379 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20380 .endd
20381 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20382 grounds that sooner or later somebody will try it.
20383
20384 .oindex "&%self%&" "in &(ipliteral)& router"
20385 If the IP address matches something in &%ignore_target_hosts%&, the router
20386 declines. If an IP literal turns out to refer to the local host, the generic
20387 &%self%& option determines what happens.
20388
20389 The RFCs require support for domain literals; however, their use is
20390 controversial in today's Internet. If you want to use this router, you must
20391 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20392 Exim will not recognize the domain literal syntax in addresses.
20393
20394
20395
20396 . ////////////////////////////////////////////////////////////////////////////
20397 . ////////////////////////////////////////////////////////////////////////////
20398
20399 .chapter "The iplookup router" "CHID6"
20400 .cindex "&(iplookup)& router"
20401 .cindex "routers" "&(iplookup)&"
20402 The &(iplookup)& router was written to fulfil a specific requirement in
20403 Cambridge University (which in fact no longer exists). For this reason, it is
20404 not included in the binary of Exim by default. If you want to include it, you
20405 must set
20406 .code
20407 ROUTER_IPLOOKUP=yes
20408 .endd
20409 in your &_Local/Makefile_& configuration file.
20410
20411 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20412 connection to one or more specific hosts. The host can then return the same or
20413 a different address &-- in effect rewriting the recipient address in the
20414 message's envelope. The new address is then passed on to subsequent routers. If
20415 this process fails, the address can be passed on to other routers, or delivery
20416 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20417 must not be specified for it.
20418
20419 .cindex "options" "&(iplookup)& router"
20420 .option hosts iplookup string unset
20421 This option must be supplied. Its value is a colon-separated list of host
20422 names. The hosts are looked up using &[gethostbyname()]&
20423 (or &[getipnodebyname()]& when available)
20424 and are tried in order until one responds to the query. If none respond, what
20425 happens is controlled by &%optional%&.
20426
20427
20428 .option optional iplookup boolean false
20429 If &%optional%& is true, if no response is obtained from any host, the address
20430 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20431 delivery to the address is deferred.
20432
20433
20434 .option port iplookup integer 0
20435 .cindex "port" "&(iplookup)& router"
20436 This option must be supplied. It specifies the port number for the TCP or UDP
20437 call.
20438
20439
20440 .option protocol iplookup string udp
20441 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20442 protocols is to be used.
20443
20444
20445 .option query iplookup string&!! "see below"
20446 This defines the content of the query that is sent to the remote hosts. The
20447 default value is:
20448 .code
20449 $local_part@$domain $local_part@$domain
20450 .endd
20451 The repetition serves as a way of checking that a response is to the correct
20452 query in the default case (see &%response_pattern%& below).
20453
20454
20455 .option reroute iplookup string&!! unset
20456 If this option is not set, the rerouted address is precisely the byte string
20457 returned by the remote host, up to the first white space, if any. If set, the
20458 string is expanded to form the rerouted address. It can include parts matched
20459 in the response by &%response_pattern%& by means of numeric variables such as
20460 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20461 whether or not a pattern is in use. In all cases, the rerouted address must end
20462 up in the form &'local_part@domain'&.
20463
20464
20465 .option response_pattern iplookup string unset
20466 This option can be set to a regular expression that is applied to the string
20467 returned from the remote host. If the pattern does not match the response, the
20468 router declines. If &%response_pattern%& is not set, no checking of the
20469 response is done, unless the query was defaulted, in which case there is a
20470 check that the text returned after the first white space is the original
20471 address. This checks that the answer that has been received is in response to
20472 the correct question. For example, if the response is just a new domain, the
20473 following could be used:
20474 .code
20475 response_pattern = ^([^@]+)$
20476 reroute = $local_part@$1
20477 .endd
20478
20479 .option timeout iplookup time 5s
20480 This specifies the amount of time to wait for a response from the remote
20481 machine. The same timeout is used for the &[connect()]& function for a TCP
20482 call. It does not apply to UDP.
20483
20484
20485
20486
20487 . ////////////////////////////////////////////////////////////////////////////
20488 . ////////////////////////////////////////////////////////////////////////////
20489
20490 .chapter "The manualroute router" "CHID7"
20491 .scindex IIDmanrou1 "&(manualroute)& router"
20492 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20493 .cindex "domain" "manually routing"
20494 The &(manualroute)& router is so-called because it provides a way of manually
20495 routing an address according to its domain. It is mainly used when you want to
20496 route addresses to remote hosts according to your own rules, bypassing the
20497 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20498 route to local transports, a facility that may be useful if you want to save
20499 messages for dial-in hosts in local files.
20500
20501 The &(manualroute)& router compares a list of domain patterns with the domain
20502 it is trying to route. If there is no match, the router declines. Each pattern
20503 has associated with it a list of hosts and some other optional data, which may
20504 include a transport. The combination of a pattern and its data is called a
20505 &"routing rule"&. For patterns that do not have an associated transport, the
20506 generic &%transport%& option must specify a transport, unless the router is
20507 being used purely for verification (see &%verify_only%&).
20508
20509 .vindex "&$host$&"
20510 In the case of verification, matching the domain pattern is sufficient for the
20511 router to accept the address. When actually routing an address for delivery,
20512 an address that matches a domain pattern is queued for the associated
20513 transport. If the transport is not a local one, a host list must be associated
20514 with the pattern; IP addresses are looked up for the hosts, and these are
20515 passed to the transport along with the mail address. For local transports, a
20516 host list is optional. If it is present, it is passed in &$host$& as a single
20517 text string.
20518
20519 The list of routing rules can be provided as an inline string in
20520 &%route_list%&, or the data can be obtained by looking up the domain in a file
20521 or database by setting &%route_data%&. Only one of these settings may appear in
20522 any one instance of &(manualroute)&. The format of routing rules is described
20523 below, following the list of private options.
20524
20525
20526 .section "Private options for manualroute" "SECTprioptman"
20527
20528 .cindex "options" "&(manualroute)& router"
20529 The private options for the &(manualroute)& router are as follows:
20530
20531 .option host_all_ignored manualroute string defer
20532 See &%host_find_failed%&.
20533
20534 .option host_find_failed manualroute string freeze
20535 This option controls what happens when &(manualroute)& tries to find an IP
20536 address for a host, and the host does not exist. The option can be set to one
20537 of the following values:
20538 .code
20539 decline
20540 defer
20541 fail
20542 freeze
20543 ignore
20544 pass
20545 .endd
20546 The default (&"freeze"&) assumes that this state is a serious configuration
20547 error. The difference between &"pass"& and &"decline"& is that the former
20548 forces the address to be passed to the next router (or the router defined by
20549 &%pass_router%&),
20550 .oindex "&%more%&"
20551 overriding &%no_more%&, whereas the latter passes the address to the next
20552 router only if &%more%& is true.
20553
20554 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20555 cannot be found. If all the hosts in the list are ignored, the behaviour is
20556 controlled by the &%host_all_ignored%& option. This takes the same values
20557 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20558
20559 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20560 state; if a host lookup gets a temporary error, delivery is deferred unless the
20561 generic &%pass_on_timeout%& option is set.
20562
20563
20564 .option hosts_randomize manualroute boolean false
20565 .cindex "randomized host list"
20566 .cindex "host" "list of; randomized"
20567 If this option is set, the order of the items in a host list in a routing rule
20568 is randomized each time the list is used, unless an option in the routing rule
20569 overrides (see below). Randomizing the order of a host list can be used to do
20570 crude load sharing. However, if more than one mail address is routed by the
20571 same router to the same host list, the host lists are considered to be the same
20572 (even though they may be randomized into different orders) for the purpose of
20573 deciding whether to batch the deliveries into a single SMTP transaction.
20574
20575 When &%hosts_randomize%& is true, a host list may be split
20576 into groups whose order is separately randomized. This makes it possible to
20577 set up MX-like behaviour. The boundaries between groups are indicated by an
20578 item that is just &`+`& in the host list. For example:
20579 .code
20580 route_list = * host1:host2:host3:+:host4:host5
20581 .endd
20582 The order of the first three hosts and the order of the last two hosts is
20583 randomized for each use, but the first three always end up before the last two.
20584 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20585 randomized host list is passed to an &(smtp)& transport that also has
20586 &%hosts_randomize set%&, the list is not re-randomized.
20587
20588
20589 .option route_data manualroute string&!! unset
20590 If this option is set, it must expand to yield the data part of a routing rule.
20591 Typically, the expansion string includes a lookup based on the domain. For
20592 example:
20593 .code
20594 route_data = ${lookup{$domain}dbm{/etc/routes}}
20595 .endd
20596 If the expansion is forced to fail, or the result is an empty string, the
20597 router declines. Other kinds of expansion failure cause delivery to be
20598 deferred.
20599
20600
20601 .option route_list manualroute "string list" unset
20602 This string is a list of routing rules, in the form defined below. Note that,
20603 unlike most string lists, the items are separated by semicolons. This is so
20604 that they may contain colon-separated host lists.
20605
20606
20607 .option same_domain_copy_routing manualroute boolean false
20608 .cindex "address" "copying routing"
20609 Addresses with the same domain are normally routed by the &(manualroute)&
20610 router to the same list of hosts. However, this cannot be presumed, because the
20611 router options and preconditions may refer to the local part of the address. By
20612 default, therefore, Exim routes each address in a message independently. DNS
20613 servers run caches, so repeated DNS lookups are not normally expensive, and in
20614 any case, personal messages rarely have more than a few recipients.
20615
20616 If you are running mailing lists with large numbers of subscribers at the same
20617 domain, and you are using a &(manualroute)& router which is independent of the
20618 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20619 lookups for identical domains in one message. In this case, when
20620 &(manualroute)& routes an address to a remote transport, any other unrouted
20621 addresses in the message that have the same domain are automatically given the
20622 same routing without processing them independently. However, this is only done
20623 if &%headers_add%& and &%headers_remove%& are unset.
20624
20625
20626
20627
20628 .section "Routing rules in route_list" "SECID120"
20629 The value of &%route_list%& is a string consisting of a sequence of routing
20630 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20631 entered as two semicolons. Alternatively, the list separator can be changed as
20632 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20633 Empty rules are ignored. The format of each rule is
20634 .display
20635 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20636 .endd
20637 The following example contains two rules, each with a simple domain pattern and
20638 no options:
20639 .code
20640 route_list = \
20641   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20642   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20643 .endd
20644 The three parts of a rule are separated by white space. The pattern and the
20645 list of hosts can be enclosed in quotes if necessary, and if they are, the
20646 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20647 single domain pattern, which is the only mandatory item in the rule. The
20648 pattern is in the same format as one item in a domain list (see section
20649 &<<SECTdomainlist>>&),
20650 except that it may not be the name of an interpolated file.
20651 That is, it may be wildcarded, or a regular expression, or a file or database
20652 lookup (with semicolons doubled, because of the use of semicolon as a separator
20653 in a &%route_list%&).
20654
20655 The rules in &%route_list%& are searched in order until one of the patterns
20656 matches the domain that is being routed. The list of hosts and then options are
20657 then used as described below. If there is no match, the router declines. When
20658 &%route_list%& is set, &%route_data%& must not be set.
20659
20660
20661
20662 .section "Routing rules in route_data" "SECID121"
20663 The use of &%route_list%& is convenient when there are only a small number of
20664 routing rules. For larger numbers, it is easier to use a file or database to
20665 hold the routing information, and use the &%route_data%& option instead.
20666 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20667 Most commonly, &%route_data%& is set as a string that contains an
20668 expansion lookup. For example, suppose we place two routing rules in a file
20669 like this:
20670 .code
20671 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20672 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20673 .endd
20674 This data can be accessed by setting
20675 .code
20676 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20677 .endd
20678 Failure of the lookup results in an empty string, causing the router to
20679 decline. However, you do not have to use a lookup in &%route_data%&. The only
20680 requirement is that the result of expanding the string is a list of hosts,
20681 possibly followed by options, separated by white space. The list of hosts must
20682 be enclosed in quotes if it contains white space.
20683
20684
20685
20686
20687 .section "Format of the list of hosts" "SECID122"
20688 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20689 always separately expanded before use. If the expansion fails, the router
20690 declines. The result of the expansion must be a colon-separated list of names
20691 and/or IP addresses, optionally also including ports.
20692 If the list is written with spaces, it must be protected with quotes.
20693 The format of each item
20694 in the list is described in the next section. The list separator can be changed
20695 as described in section &<<SECTlistsepchange>>&.
20696
20697 If the list of hosts was obtained from a &%route_list%& item, the following
20698 variables are set during its expansion:
20699
20700 .ilist
20701 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20702 If the domain was matched against a regular expression, the numeric variables
20703 &$1$&, &$2$&, etc. may be set. For example:
20704 .code
20705 route_list = ^domain(\d+)   host-$1.text.example
20706 .endd
20707 .next
20708 &$0$& is always set to the entire domain.
20709 .next
20710 &$1$& is also set when partial matching is done in a file lookup.
20711
20712 .next
20713 .vindex "&$value$&"
20714 If the pattern that matched the domain was a lookup item, the data that was
20715 looked up is available in the expansion variable &$value$&. For example:
20716 .code
20717 route_list = lsearch;;/some/file.routes  $value
20718 .endd
20719 .endlist
20720
20721 Note the doubling of the semicolon in the pattern that is necessary because
20722 semicolon is the default route list separator.
20723
20724
20725
20726 .section "Format of one host item" "SECTformatonehostitem"
20727 Each item in the list of hosts can be either a host name or an IP address,
20728 optionally with an attached port number, or it can be a single "+"
20729 (see &%hosts_randomize%&).
20730 When no port is given, an IP address
20731 is not enclosed in brackets. When a port is specified, it overrides the port
20732 specification on the transport. The port is separated from the name or address
20733 by a colon. This leads to some complications:
20734
20735 .ilist
20736 Because colon is the default separator for the list of hosts, either
20737 the colon that specifies a port must be doubled, or the list separator must
20738 be changed. The following two examples have the same effect:
20739 .code
20740 route_list = * "host1.tld::1225 : host2.tld::1226"
20741 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20742 .endd
20743 .next
20744 When IPv6 addresses are involved, it gets worse, because they contain
20745 colons of their own. To make this case easier, it is permitted to
20746 enclose an IP address (either v4 or v6) in square brackets if a port
20747 number follows. For example:
20748 .code
20749 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20750 .endd
20751 .endlist
20752
20753 .section "How the list of hosts is used" "SECThostshowused"
20754 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20755 the hosts is tried, in the order specified, when carrying out the SMTP
20756 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20757 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20758 transport.
20759
20760 Hosts may be listed by name or by IP address. An unadorned name in the list of
20761 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20762 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20763 records in the DNS. For example:
20764 .code
20765 route_list = *  x.y.z:p.q.r/MX:e.f.g
20766 .endd
20767 If this feature is used with a port specifier, the port must come last. For
20768 example:
20769 .code
20770 route_list = *  dom1.tld/mx::1225
20771 .endd
20772 If the &%hosts_randomize%& option is set, the order of the items in the list is
20773 randomized before any lookups are done. Exim then scans the list; for any name
20774 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20775 be an interface on the local host and the item is not the first in the list,
20776 Exim discards it and any subsequent items. If it is the first item, what
20777 happens is controlled by the
20778 .oindex "&%self%&" "in &(manualroute)& router"
20779 &%self%& option of the router.
20780
20781 A name on the list that is followed by &`/MX`& is replaced with the list of
20782 hosts obtained by looking up MX records for the name. This is always a DNS
20783 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20784 below) are not relevant here. The order of these hosts is determined by the
20785 preference values in the MX records, according to the usual rules. Because
20786 randomizing happens before the MX lookup, it does not affect the order that is
20787 defined by MX preferences.
20788
20789 If the local host is present in the sublist obtained from MX records, but is
20790 not the most preferred host in that list, it and any equally or less
20791 preferred hosts are removed before the sublist is inserted into the main list.
20792
20793 If the local host is the most preferred host in the MX list, what happens
20794 depends on where in the original list of hosts the &`/MX`& item appears. If it
20795 is not the first item (that is, there are previous hosts in the main list),
20796 Exim discards this name and any subsequent items in the main list.
20797
20798 If the MX item is first in the list of hosts, and the local host is the
20799 most preferred host, what happens is controlled by the &%self%& option of the
20800 router.
20801
20802 DNS failures when lookup up the MX records are treated in the same way as DNS
20803 failures when looking up IP addresses: &%pass_on_timeout%& and
20804 &%host_find_failed%& are used when relevant.
20805
20806 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20807 whether obtained from an MX lookup or not.
20808
20809
20810
20811 .section "How the options are used" "SECThowoptused"
20812 The options are a sequence of words, space-separated.
20813 One of the words can be the name of a transport; this overrides the
20814 &%transport%& option on the router for this particular routing rule only. The
20815 other words (if present) control randomization of the list of hosts on a
20816 per-rule basis, and how the IP addresses of the hosts are to be found when
20817 routing to a remote transport. These options are as follows:
20818
20819 .ilist
20820 &%randomize%&: randomize the order of the hosts in this list, overriding the
20821 setting of &%hosts_randomize%& for this routing rule only.
20822 .next
20823 &%no_randomize%&: do not randomize the order of the hosts in this list,
20824 overriding the setting of &%hosts_randomize%& for this routing rule only.
20825 .next
20826 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20827 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20828 also look in &_/etc/hosts_& or other sources of information.
20829 .next
20830 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20831 no address records are found. If there is a temporary DNS error (such as a
20832 timeout), delivery is deferred.
20833 .next
20834 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20835 .next
20836 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20837 .endlist
20838
20839 For example:
20840 .code
20841 route_list = domain1  host1:host2:host3  randomize bydns;\
20842              domain2  host4:host5
20843 .endd
20844 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20845 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20846 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20847 or &[gethostbyname()]&, and the result of the lookup is the result of that
20848 call.
20849
20850 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20851 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20852 instead of TRY_AGAIN. That is why the default action is to try a DNS
20853 lookup first. Only if that gives a definite &"no such host"& is the local
20854 function called.
20855
20856 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20857 inadvertent constraint that a transport name as an option had to be the last
20858 option specified.
20859
20860
20861
20862 If no IP address for a host can be found, what happens is controlled by the
20863 &%host_find_failed%& option.
20864
20865 .vindex "&$host$&"
20866 When an address is routed to a local transport, IP addresses are not looked up.
20867 The host list is passed to the transport in the &$host$& variable.
20868
20869
20870
20871 .section "Manualroute examples" "SECID123"
20872 In some of the examples that follow, the presence of the &%remote_smtp%&
20873 transport, as defined in the default configuration file, is assumed:
20874
20875 .ilist
20876 .cindex "smart host" "example router"
20877 The &(manualroute)& router can be used to forward all external mail to a
20878 &'smart host'&. If you have set up, in the main part of the configuration, a
20879 named domain list that contains your local domains, for example:
20880 .code
20881 domainlist local_domains = my.domain.example
20882 .endd
20883 You can arrange for all other domains to be routed to a smart host by making
20884 your first router something like this:
20885 .code
20886 smart_route:
20887   driver = manualroute
20888   domains = !+local_domains
20889   transport = remote_smtp
20890   route_list = * smarthost.ref.example
20891 .endd
20892 This causes all non-local addresses to be sent to the single host
20893 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20894 they are tried in order
20895 (but you can use &%hosts_randomize%& to vary the order each time).
20896 Another way of configuring the same thing is this:
20897 .code
20898 smart_route:
20899   driver = manualroute
20900   transport = remote_smtp
20901   route_list = !+local_domains  smarthost.ref.example
20902 .endd
20903 There is no difference in behaviour between these two routers as they stand.
20904 However, they behave differently if &%no_more%& is added to them. In the first
20905 example, the router is skipped if the domain does not match the &%domains%&
20906 precondition; the following router is always tried. If the router runs, it
20907 always matches the domain and so can never decline. Therefore, &%no_more%&
20908 would have no effect. In the second case, the router is never skipped; it
20909 always runs. However, if it doesn't match the domain, it declines. In this case
20910 &%no_more%& would prevent subsequent routers from running.
20911
20912 .next
20913 .cindex "mail hub example"
20914 A &'mail hub'& is a host which receives mail for a number of domains via MX
20915 records in the DNS and delivers it via its own private routing mechanism. Often
20916 the final destinations are behind a firewall, with the mail hub being the one
20917 machine that can connect to machines both inside and outside the firewall. The
20918 &(manualroute)& router is usually used on a mail hub to route incoming messages
20919 to the correct hosts. For a small number of domains, the routing can be inline,
20920 using the &%route_list%& option, but for a larger number a file or database
20921 lookup is easier to manage.
20922
20923 If the domain names are in fact the names of the machines to which the mail is
20924 to be sent by the mail hub, the configuration can be quite simple. For
20925 example:
20926 .code
20927 hub_route:
20928   driver = manualroute
20929   transport = remote_smtp
20930   route_list = *.rhodes.tvs.example  $domain
20931 .endd
20932 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20933 whose names are the same as the mail domains. A similar approach can be taken
20934 if the host name can be obtained from the domain name by a string manipulation
20935 that the expansion facilities can handle. Otherwise, a lookup based on the
20936 domain can be used to find the host:
20937 .code
20938 through_firewall:
20939   driver = manualroute
20940   transport = remote_smtp
20941   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20942 .endd
20943 The result of the lookup must be the name or IP address of the host (or
20944 hosts) to which the address is to be routed. If the lookup fails, the route
20945 data is empty, causing the router to decline. The address then passes to the
20946 next router.
20947
20948 .next
20949 .cindex "batched SMTP output example"
20950 .cindex "SMTP" "batched outgoing; example"
20951 You can use &(manualroute)& to deliver messages to pipes or files in batched
20952 SMTP format for onward transportation by some other means. This is one way of
20953 storing mail for a dial-up host when it is not connected. The route list entry
20954 can be as simple as a single domain name in a configuration like this:
20955 .code
20956 save_in_file:
20957   driver = manualroute
20958   transport = batchsmtp_appendfile
20959   route_list = saved.domain.example
20960 .endd
20961 though often a pattern is used to pick up more than one domain. If there are
20962 several domains or groups of domains with different transport requirements,
20963 different transports can be listed in the routing information:
20964 .code
20965 save_in_file:
20966   driver = manualroute
20967   route_list = \
20968     *.saved.domain1.example  $domain  batch_appendfile; \
20969     *.saved.domain2.example  \
20970       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20971       batch_pipe
20972 .endd
20973 .vindex "&$domain$&"
20974 .vindex "&$host$&"
20975 The first of these just passes the domain in the &$host$& variable, which
20976 doesn't achieve much (since it is also in &$domain$&), but the second does a
20977 file lookup to find a value to pass, causing the router to decline to handle
20978 the address if the lookup fails.
20979
20980 .next
20981 .cindex "UUCP" "example of router for"
20982 Routing mail directly to UUCP software is a specific case of the use of
20983 &(manualroute)& in a gateway to another mail environment. This is an example of
20984 one way it can be done:
20985 .code
20986 # Transport
20987 uucp:
20988   driver = pipe
20989   user = nobody
20990   command = /usr/local/bin/uux -r - \
20991     ${substr_-5:$host}!rmail ${local_part}
20992   return_fail_output = true
20993
20994 # Router
20995 uucphost:
20996   transport = uucp
20997   driver = manualroute
20998   route_data = \
20999     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
21000 .endd
21001 The file &_/usr/local/exim/uucphosts_& contains entries like
21002 .code
21003 darksite.ethereal.example:           darksite.UUCP
21004 .endd
21005 It can be set up more simply without adding and removing &".UUCP"& but this way
21006 makes clear the distinction between the domain name
21007 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
21008 .endlist
21009 .ecindex IIDmanrou1
21010 .ecindex IIDmanrou2
21011
21012
21013
21014
21015
21016
21017
21018
21019 . ////////////////////////////////////////////////////////////////////////////
21020 . ////////////////////////////////////////////////////////////////////////////
21021
21022 .chapter "The queryprogram router" "CHAPdriverlast"
21023 .scindex IIDquerou1 "&(queryprogram)& router"
21024 .scindex IIDquerou2 "routers" "&(queryprogram)&"
21025 .cindex "routing" "by external program"
21026 The &(queryprogram)& router routes an address by running an external command
21027 and acting on its output. This is an expensive way to route, and is intended
21028 mainly for use in lightly-loaded systems, or for performing experiments.
21029 However, if it is possible to use the precondition options (&%domains%&,
21030 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
21031 be used in special cases, even on a busy host. There are the following private
21032 options:
21033 .cindex "options" "&(queryprogram)& router"
21034
21035 .option command queryprogram string&!! unset
21036 This option must be set. It specifies the command that is to be run. The
21037 command is split up into a command name and arguments, and then each is
21038 expanded separately (exactly as for a &(pipe)& transport, described in chapter
21039 &<<CHAPpipetransport>>&).
21040
21041
21042 .option command_group queryprogram string unset
21043 .cindex "gid (group id)" "in &(queryprogram)& router"
21044 This option specifies a gid to be set when running the command while routing an
21045 address for deliver. It must be set if &%command_user%& specifies a numerical
21046 uid. If it begins with a digit, it is interpreted as the numerical value of the
21047 gid. Otherwise it is looked up using &[getgrnam()]&.
21048
21049
21050 .option command_user queryprogram string unset
21051 .cindex "uid (user id)" "for &(queryprogram)&"
21052 This option must be set. It specifies the uid which is set when running the
21053 command while routing an address for delivery. If the value begins with a digit,
21054 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
21055 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
21056 not set, a value for the gid also.
21057
21058 &*Warning:*& Changing uid and gid is possible only when Exim is running as
21059 root, which it does during a normal delivery in a conventional configuration.
21060 However, when an address is being verified during message reception, Exim is
21061 usually running as the Exim user, not as root. If the &(queryprogram)& router
21062 is called from a non-root process, Exim cannot change uid or gid before running
21063 the command. In this circumstance the command runs under the current uid and
21064 gid.
21065
21066
21067 .option current_directory queryprogram string /
21068 This option specifies an absolute path which is made the current directory
21069 before running the command.
21070
21071
21072 .option timeout queryprogram time 1h
21073 If the command does not complete within the timeout period, its process group
21074 is killed and the message is frozen. A value of zero time specifies no
21075 timeout.
21076
21077
21078 The standard output of the command is connected to a pipe, which is read when
21079 the command terminates. It should consist of a single line of output,
21080 containing up to five fields, separated by white space. The maximum length of
21081 the line is 1023 characters. Longer lines are silently truncated. The first
21082 field is one of the following words (case-insensitive):
21083
21084 .ilist
21085 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
21086 below).
21087 .next
21088 &'Decline'&: the router declines; pass the address to the next router, unless
21089 &%no_more%& is set.
21090 .next
21091 &'Fail'&: routing failed; do not pass the address to any more routers. Any
21092 subsequent text on the line is an error message. If the router is run as part
21093 of address verification during an incoming SMTP message, the message is
21094 included in the SMTP response.
21095 .next
21096 &'Defer'&: routing could not be completed at this time; try again later. Any
21097 subsequent text on the line is an error message which is logged. It is not
21098 included in any SMTP response.
21099 .next
21100 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
21101 .next
21102 &'Pass'&: pass the address to the next router (or the router specified by
21103 &%pass_router%&), overriding &%no_more%&.
21104 .next
21105 &'Redirect'&: the message is redirected. The remainder of the line is a list of
21106 new addresses, which are routed independently, starting with the first router,
21107 or the router specified by &%redirect_router%&, if set.
21108 .endlist
21109
21110 When the first word is &'accept'&, the remainder of the line consists of a
21111 number of keyed data values, as follows (split into two lines here, to fit on
21112 the page):
21113 .code
21114 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
21115 LOOKUP=byname|bydns DATA=<text>
21116 .endd
21117 The data items can be given in any order, and all are optional. If no transport
21118 is included, the transport specified by the generic &%transport%& option is
21119 used. The list of hosts and the lookup type are needed only if the transport is
21120 an &(smtp)& transport that does not itself supply a list of hosts.
21121
21122 The format of the list of hosts is the same as for the &(manualroute)& router.
21123 As well as host names and IP addresses with optional port numbers, as described
21124 in section &<<SECTformatonehostitem>>&, it may contain names followed by
21125 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
21126 (see section &<<SECThostshowused>>&).
21127
21128 If the lookup type is not specified, Exim behaves as follows when trying to
21129 find an IP address for each host: First, a DNS lookup is done. If this yields
21130 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
21131 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
21132 result of the lookup is the result of that call.
21133
21134 .vindex "&$address_data$&"
21135 If the DATA field is set, its value is placed in the &$address_data$&
21136 variable. For example, this return line
21137 .code
21138 accept hosts=x1.y.example:x2.y.example data="rule1"
21139 .endd
21140 routes the address to the default transport, passing a list of two hosts. When
21141 the transport runs, the string &"rule1"& is in &$address_data$&.
21142 .ecindex IIDquerou1
21143 .ecindex IIDquerou2
21144
21145
21146
21147
21148 . ////////////////////////////////////////////////////////////////////////////
21149 . ////////////////////////////////////////////////////////////////////////////
21150
21151 .chapter "The redirect router" "CHAPredirect"
21152 .scindex IIDredrou1 "&(redirect)& router"
21153 .scindex IIDredrou2 "routers" "&(redirect)&"
21154 .cindex "alias file" "in a &(redirect)& router"
21155 .cindex "address redirection" "&(redirect)& router"
21156 The &(redirect)& router handles several kinds of address redirection. Its most
21157 common uses are for resolving local part aliases from a central alias file
21158 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
21159 files, but it has many other potential uses. The incoming address can be
21160 redirected in several different ways:
21161
21162 .ilist
21163 It can be replaced by one or more new addresses which are themselves routed
21164 independently.
21165 .next
21166 It can be routed to be delivered to a given file or directory.
21167 .next
21168 It can be routed to be delivered to a specified pipe command.
21169 .next
21170 It can cause an automatic reply to be generated.
21171 .next
21172 It can be forced to fail, optionally with a custom error message.
21173 .next
21174 It can be temporarily deferred, optionally with a custom message.
21175 .next
21176 It can be discarded.
21177 .endlist
21178
21179 The generic &%transport%& option must not be set for &(redirect)& routers.
21180 However, there are some private options which define transports for delivery to
21181 files and pipes, and for generating autoreplies. See the &%file_transport%&,
21182 &%pipe_transport%& and &%reply_transport%& descriptions below.
21183
21184 If success DSNs have been requested
21185 .cindex "DSN" "success"
21186 .cindex "Delivery Status Notification" "success"
21187 redirection triggers one and the DSN options are not passed any further.
21188
21189
21190
21191 .section "Redirection data" "SECID124"
21192 The router operates by interpreting a text string which it obtains either by
21193 expanding the contents of the &%data%& option, or by reading the entire
21194 contents of a file whose name is given in the &%file%& option. These two
21195 options are mutually exclusive. The first is commonly used for handling system
21196 aliases, in a configuration like this:
21197 .code
21198 system_aliases:
21199   driver = redirect
21200   data = ${lookup{$local_part}lsearch{/etc/aliases}}
21201 .endd
21202 If the lookup fails, the expanded string in this example is empty. When the
21203 expansion of &%data%& results in an empty string, the router declines. A forced
21204 expansion failure also causes the router to decline; other expansion failures
21205 cause delivery to be deferred.
21206
21207 A configuration using &%file%& is commonly used for handling users'
21208 &_.forward_& files, like this:
21209 .code
21210 userforward:
21211   driver = redirect
21212   check_local_user
21213   file = $home/.forward
21214   no_verify
21215 .endd
21216 If the file does not exist, or causes no action to be taken (for example, it is
21217 empty or consists only of comments), the router declines. &*Warning*&: This
21218 is not the case when the file contains syntactically valid items that happen to
21219 yield empty addresses, for example, items containing only RFC 2822 address
21220 comments.
21221
21222 .cindex "tainted data" "in filenames"
21223 .cindex redirect "tainted data"
21224 Tainted data may not be used for a filename.
21225
21226 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
21227 directly for redirection,
21228 as they are provided by a potential attacker.
21229 In the examples above, &$local_part$& is used for looking up data held locally
21230 on the system, and not used directly (the second example derives &$home$& via
21231 the passsword file or database, using &$local_part$&).
21232
21233
21234
21235 .section "Forward files and address verification" "SECID125"
21236 .cindex "address redirection" "while verifying"
21237 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21238 &_.forward_& files, as in the example above. There are two reasons for this:
21239
21240 .ilist
21241 When Exim is receiving an incoming SMTP message from a remote host, it is
21242 running under the Exim uid, not as root. Exim is unable to change uid to read
21243 the file as the user, and it may not be able to read it as the Exim user. So in
21244 practice the router may not be able to operate.
21245 .next
21246 However, even when the router can operate, the existence of a &_.forward_& file
21247 is unimportant when verifying an address. What should be checked is whether the
21248 local part is a valid user name or not. Cutting out the redirection processing
21249 saves some resources.
21250 .endlist
21251
21252
21253
21254
21255
21256
21257 .section "Interpreting redirection data" "SECID126"
21258 .cindex "Sieve filter" "specifying in redirection data"
21259 .cindex "filter" "specifying in redirection data"
21260 The contents of the data string, whether obtained from &%data%& or &%file%&,
21261 can be interpreted in two different ways:
21262
21263 .ilist
21264 If the &%allow_filter%& option is set true, and the data begins with the text
21265 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21266 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21267 respectively. Details of the syntax and semantics of filter files are described
21268 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21269 document is intended for use by end users.
21270 .next
21271 Otherwise, the data must be a comma-separated list of redirection items, as
21272 described in the next section.
21273 .endlist
21274
21275 When a message is redirected to a file (a &"mail folder"&), the filename given
21276 in a non-filter redirection list must always be an absolute path. A filter may
21277 generate a relative path &-- how this is handled depends on the transport's
21278 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21279 for the &(appendfile)& transport.
21280
21281
21282
21283 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21284 .cindex "address redirection" "non-filter list items"
21285 When the redirection data is not an Exim or Sieve filter, for example, if it
21286 comes from a conventional alias or forward file, it consists of a list of
21287 addresses, filenames, pipe commands, or certain special items (see section
21288 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21289 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21290 depending on their default values. The items in the list are separated by
21291 commas or newlines.
21292 If a comma is required in an item, the entire item must be enclosed in double
21293 quotes.
21294
21295 Lines starting with a # character are comments, and are ignored, and # may
21296 also appear following a comma, in which case everything between the # and the
21297 next newline character is ignored.
21298
21299 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21300 double quotes are retained because some forms of mail address require their use
21301 (but never to enclose the entire address). In the following description,
21302 &"item"& refers to what remains after any surrounding double quotes have been
21303 removed.
21304
21305 .vindex "&$local_part$&"
21306 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21307 and the expansion contains a reference to &$local_part$&, you should make use
21308 of the &%quote_local_part%& expansion operator, in case the local part contains
21309 special characters. For example, to redirect all mail for the domain
21310 &'obsolete.example'&, retaining the existing local part, you could use this
21311 setting:
21312 .code
21313 data = ${quote_local_part:$local_part}@newdomain.example
21314 .endd
21315
21316
21317 .section "Redirecting to a local mailbox" "SECTredlocmai"
21318 .cindex "routing" "loops in"
21319 .cindex "loop" "while routing, avoidance of"
21320 .cindex "address redirection" "to local mailbox"
21321 A redirection item may safely be the same as the address currently under
21322 consideration. This does not cause a routing loop, because a router is
21323 automatically skipped if any ancestor of the address that is being processed
21324 is the same as the current address and was processed by the current router.
21325 Such an address is therefore passed to the following routers, so it is handled
21326 as if there were no redirection. When making this loop-avoidance test, the
21327 complete local part, including any prefix or suffix, is used.
21328
21329 .cindex "address redirection" "local part without domain"
21330 Specifying the same local part without a domain is a common usage in personal
21331 filter files when the user wants to have messages delivered to the local
21332 mailbox and also forwarded elsewhere. For example, the user whose login is
21333 &'cleo'& might have a &_.forward_& file containing this:
21334 .code
21335 cleo, cleopatra@egypt.example
21336 .endd
21337 .cindex "backslash in alias file"
21338 .cindex "alias file" "backslash in"
21339 For compatibility with other MTAs, such unqualified local parts may be
21340 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21341 it does make a difference if more than one domain is being handled
21342 synonymously.
21343
21344 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21345 2822 address that does not include a domain, the item is qualified using the
21346 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21347 addresses are qualified using the value in &%qualify_recipient%&, but you can
21348 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21349
21350 Care must be taken if there are alias names for local users.
21351 Consider an MTA handling a single local domain where the system alias file
21352 contains:
21353 .code
21354 Sam.Reman: spqr
21355 .endd
21356 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21357 messages in the local mailbox, and also forward copies elsewhere. He creates
21358 this forward file:
21359 .code
21360 Sam.Reman, spqr@reme.elsewhere.example
21361 .endd
21362 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21363 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21364 second time round, because it has previously routed it,
21365 and the following routers presumably cannot handle the alias. The forward file
21366 should really contain
21367 .code
21368 spqr, spqr@reme.elsewhere.example
21369 .endd
21370 but because this is such a common error, the &%check_ancestor%& option (see
21371 below) exists to provide a way to get round it. This is normally set on a
21372 &(redirect)& router that is handling users' &_.forward_& files.
21373
21374
21375
21376 .section "Special items in redirection lists" "SECTspecitredli"
21377 In addition to addresses, the following types of item may appear in redirection
21378 lists (that is, in non-filter redirection data):
21379
21380 .ilist
21381 .cindex "pipe" "in redirection list"
21382 .cindex "address redirection" "to pipe"
21383 An item is treated as a pipe command if it begins with &"|"& and does not parse
21384 as a valid RFC 2822 address that includes a domain. A transport for running the
21385 command must be specified by the &%pipe_transport%& option.
21386 Normally, either the router or the transport specifies a user and a group under
21387 which to run the delivery. The default is to use the Exim user and group.
21388
21389 Single or double quotes can be used for enclosing the individual arguments of
21390 the pipe command; no interpretation of escapes is done for single quotes. If
21391 the command contains a comma character, it is necessary to put the whole item
21392 in double quotes, for example:
21393 .code
21394 "|/some/command ready,steady,go"
21395 .endd
21396 since items in redirection lists are terminated by commas. Do not, however,
21397 quote just the command. An item such as
21398 .code
21399 |"/some/command ready,steady,go"
21400 .endd
21401 is interpreted as a pipe with a rather strange command name, and no arguments.
21402
21403 Note that the above example assumes that the text comes from a lookup source
21404 of some sort, so that the quotes are part of the data.  If composing a
21405 redirect router with a &%data%& option directly specifying this command, the
21406 quotes will be used by the configuration parser to define the extent of one
21407 string, but will not be passed down into the redirect router itself.  There
21408 are two main approaches to get around this: escape quotes to be part of the
21409 data itself, or avoid using this mechanism and instead create a custom
21410 transport with the &%command%& option set and reference that transport from
21411 an &%accept%& router.
21412
21413 .next
21414 .cindex "file" "in redirection list"
21415 .cindex "address redirection" "to file"
21416 An item is interpreted as a path name if it begins with &"/"& and does not
21417 parse as a valid RFC 2822 address that includes a domain. For example,
21418 .code
21419 /home/world/minbari
21420 .endd
21421 is treated as a filename, but
21422 .code
21423 /s=molari/o=babylon/@x400gate.way
21424 .endd
21425 is treated as an address. For a filename, a transport must be specified using
21426 the &%file_transport%& option. However, if the generated path name ends with a
21427 forward slash character, it is interpreted as a directory name rather than a
21428 filename, and &%directory_transport%& is used instead.
21429
21430 Normally, either the router or the transport specifies a user and a group under
21431 which to run the delivery. The default is to use the Exim user and group.
21432
21433 .cindex "&_/dev/null_&"
21434 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21435 bypassed at a high level, and the log entry shows &"**bypassed**"&
21436 instead of a transport name. In this case the user and group are not used.
21437
21438 .next
21439 .cindex "included address list"
21440 .cindex "address redirection" "included external list"
21441 If an item is of the form
21442 .code
21443 :include:<path name>
21444 .endd
21445 a list of further items is taken from the given file and included at that
21446 point. &*Note*&: Such a file can not be a filter file; it is just an
21447 out-of-line addition to the list. The items in the included list are separated
21448 by commas or newlines and are not subject to expansion. If this is the first
21449 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21450 the alias name. This example is incorrect:
21451 .code
21452 list1    :include:/opt/lists/list1
21453 .endd
21454 It must be given as
21455 .code
21456 list1:   :include:/opt/lists/list1
21457 .endd
21458 .cindex "tainted data" "in filenames"
21459 .cindex redirect "tainted data"
21460 Tainted data may not be used for a filename.
21461 .next
21462 .cindex "address redirection" "to black hole"
21463 .cindex "delivery" "discard"
21464 .cindex "delivery" "blackhole"
21465 .cindex "black hole"
21466 .cindex "abandoning mail"
21467 Sometimes you want to throw away mail to a particular local part.  Making the
21468 &%data%& option expand to an empty string does not work, because that causes
21469 the router to decline. Instead, the alias item
21470 .code
21471 :blackhole:
21472 .endd
21473 can be used. It does what its name implies. No delivery is
21474 done, and no error message is generated. This has the same effect as specifying
21475 &_/dev/null_& as a destination, but it can be independently disabled.
21476
21477 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21478 delivery is done for the original local part, even if other redirection items
21479 are present. If you are generating a multi-item list (for example, by reading a
21480 database) and need the ability to provide a no-op item, you must use
21481 &_/dev/null_&.
21482
21483 .next
21484 .cindex "delivery" "forcing failure"
21485 .cindex "delivery" "forcing deferral"
21486 .cindex "failing delivery" "forcing"
21487 .cindex "deferred delivery, forcing"
21488 .cindex "customizing" "failure message"
21489 An attempt to deliver a particular address can be deferred or forced to fail by
21490 redirection items of the form
21491 .code
21492 :defer:
21493 :fail:
21494 .endd
21495 respectively. When a redirection list contains such an item, it applies
21496 to the entire redirection; any other items in the list are ignored. Any
21497 text following &':fail:'& or &':defer:'& is placed in the error text
21498 associated with the failure. For example, an alias file might contain:
21499 .code
21500 X.Employee:  :fail: Gone away, no forwarding address
21501 .endd
21502 In the case of an address that is being verified from an ACL or as the subject
21503 of a
21504 .cindex "VRFY" "error text, display of"
21505 VRFY command, the text is included in the SMTP error response by
21506 default.
21507 .cindex "EXPN" "error text, display of"
21508 The text is not included in the response to an EXPN command. In non-SMTP cases
21509 the text is included in the error message that Exim generates.
21510
21511 .cindex "SMTP" "error codes"
21512 By default for verify, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21513 &':fail:'&. However, if the message starts with three digits followed by a
21514 space, optionally followed by an extended code of the form &'n.n.n'&, also
21515 followed by a space, and the very first digit is the same as the default error
21516 code, the code from the message is used instead. If the very first digit is
21517 incorrect, a panic error is logged, and the default code is used. You can
21518 suppress the use of the supplied code in a redirect router by setting the
21519 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21520 ignored.
21521
21522 .vindex "&$acl_verify_message$&"
21523 In an ACL, an explicitly provided message overrides the default, but the
21524 default message is available in the variable &$acl_verify_message$& and can
21525 therefore be included in a custom message if this is desired.
21526
21527 Normally the error text is the rest of the redirection list &-- a comma does
21528 not terminate it &-- but a newline does act as a terminator. Newlines are not
21529 normally present in alias expansions. In &(lsearch)& lookups they are removed
21530 as part of the continuation process, but they may exist in other kinds of
21531 lookup and in &':include:'& files.
21532
21533 During routing for message delivery (as opposed to verification), a redirection
21534 containing &':fail:'& causes an immediate failure of the incoming address,
21535 whereas &':defer:'& causes the message to remain in the queue so that a
21536 subsequent delivery attempt can happen at a later time. If an address is
21537 deferred for too long, it will ultimately fail, because the normal retry
21538 rules still apply.
21539
21540 .next
21541 .cindex "alias file" "exception to default"
21542 Sometimes it is useful to use a single-key search type with a default (see
21543 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21544 for exceptions to the default. These can be handled by aliasing them to
21545 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21546 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21547 results in an empty redirection list has the same effect.
21548 .endlist
21549
21550
21551 .section "Duplicate addresses" "SECTdupaddr"
21552 .cindex "duplicate addresses"
21553 .cindex "address duplicate, discarding"
21554 .cindex "pipe" "duplicated"
21555 Exim removes duplicate addresses from the list to which it is delivering, so as
21556 to deliver just one copy to each address. This does not apply to deliveries
21557 routed to pipes by different immediate parent addresses, but an indirect
21558 aliasing scheme of the type
21559 .code
21560 pipe:       |/some/command $local_part
21561 localpart1: pipe
21562 localpart2: pipe
21563 .endd
21564 does not work with a message that is addressed to both local parts, because
21565 when the second is aliased to the intermediate local part &"pipe"& it gets
21566 discarded as being the same as a previously handled address. However, a scheme
21567 such as
21568 .code
21569 localpart1: |/some/command $local_part
21570 localpart2: |/some/command $local_part
21571 .endd
21572 does result in two different pipe deliveries, because the immediate parents of
21573 the pipes are distinct.
21574
21575
21576
21577 .section "Repeated redirection expansion" "SECID128"
21578 .cindex "repeated redirection expansion"
21579 .cindex "address redirection" "repeated for each delivery attempt"
21580 When a message cannot be delivered to all of its recipients immediately,
21581 leading to two or more delivery attempts, redirection expansion is carried out
21582 afresh each time for those addresses whose children were not all previously
21583 delivered. If redirection is being used as a mailing list, this can lead to new
21584 members of the list receiving copies of old messages. The &%one_time%& option
21585 can be used to avoid this.
21586
21587
21588 .section "Errors in redirection lists" "SECID129"
21589 .cindex "address redirection" "errors"
21590 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21591 error is skipped, and an entry is written to the main log. This may be useful
21592 for mailing lists that are automatically managed. Otherwise, if an error is
21593 detected while generating the list of new addresses, the original address is
21594 deferred. See also &%syntax_errors_to%&.
21595
21596
21597
21598 .section "Private options for the redirect router" "SECID130"
21599
21600 .cindex "options" "&(redirect)& router"
21601 The private options for the &(redirect)& router are as follows:
21602
21603
21604 .option allow_defer redirect boolean false
21605 Setting this option allows the use of &':defer:'& in non-filter redirection
21606 data, or the &%defer%& command in an Exim filter file.
21607
21608
21609 .option allow_fail redirect boolean false
21610 .cindex "failing delivery" "from filter"
21611 If this option is true, the &':fail:'& item can be used in a redirection list,
21612 and the &%fail%& command may be used in an Exim filter file.
21613
21614
21615 .option allow_filter redirect boolean false
21616 .cindex "filter" "enabling use of"
21617 .cindex "Sieve filter" "enabling use of"
21618 Setting this option allows Exim to interpret redirection data that starts with
21619 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21620 are some features of Exim filter files that some administrators may wish to
21621 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21622
21623 It is also possible to lock out Exim filters or Sieve filters while allowing
21624 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21625
21626
21627 The filter is run using the uid and gid set by the generic &%user%& and
21628 &%group%& options. These take their defaults from the password data if
21629 &%check_local_user%& is set, so in the normal case of users' personal filter
21630 files, the filter is run as the relevant user. When &%allow_filter%& is set
21631 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21632
21633
21634
21635 .option allow_freeze redirect boolean false
21636 .cindex "freezing messages" "allowing in filter"
21637 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21638 This command is more normally encountered in system filters, and is disabled by
21639 default for redirection filters because it isn't something you usually want to
21640 let ordinary users do.
21641
21642
21643
21644 .option check_ancestor redirect boolean false
21645 This option is concerned with handling generated addresses that are the same
21646 as some address in the list of redirection ancestors of the current address.
21647 Although it is turned off by default in the code, it is set in the default
21648 configuration file for handling users' &_.forward_& files. It is recommended
21649 for this use of the &(redirect)& router.
21650
21651 When &%check_ancestor%& is set, if a generated address (including the domain)
21652 is the same as any ancestor of the current address, it is replaced by a copy of
21653 the current address. This helps in the case where local part A is aliased to B,
21654 and B has a &_.forward_& file pointing back to A. For example, within a single
21655 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21656 &_&~jb/.forward_& contains:
21657 .code
21658 \Joe.Bloggs, <other item(s)>
21659 .endd
21660 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21661 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21662 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21663 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21664 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21665 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21666 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21667 original address. See also the &%repeat_use%& option below.
21668
21669
21670 .option check_group redirect boolean "see below"
21671 When the &%file%& option is used, the group owner of the file is checked only
21672 when this option is set. The permitted groups are those listed in the
21673 &%owngroups%& option, together with the user's default group if
21674 &%check_local_user%& is set. If the file has the wrong group, routing is
21675 deferred. The default setting for this option is true if &%check_local_user%&
21676 is set and the &%modemask%& option permits the group write bit, or if the
21677 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21678
21679
21680
21681 .option check_owner redirect boolean "see below"
21682 When the &%file%& option is used, the owner of the file is checked only when
21683 this option is set. If &%check_local_user%& is set, the local user is
21684 permitted; otherwise the owner must be one of those listed in the &%owners%&
21685 option. The default value for this option is true if &%check_local_user%& or
21686 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21687
21688
21689 .option data redirect string&!! unset
21690 This option is mutually exclusive with &%file%&. One or other of them must be
21691 set, but not both. The contents of &%data%& are expanded, and then used as the
21692 list of forwarding items, or as a set of filtering instructions. If the
21693 expansion is forced to fail, or the result is an empty string or a string that
21694 has no effect (consists entirely of comments), the router declines.
21695
21696 When filtering instructions are used, the string must begin with &"#Exim
21697 filter"&, and all comments in the string, including this initial one, must be
21698 terminated with newline characters. For example:
21699 .code
21700 data = #Exim filter\n\
21701        if $h_to: contains Exim then save $home/mail/exim endif
21702 .endd
21703 If you are reading the data from a database where newlines cannot be included,
21704 you can use the &${sg}$& expansion item to turn the escape string of your
21705 choice into a newline.
21706
21707
21708 .option directory_transport redirect string&!! unset
21709 A &(redirect)& router sets up a direct delivery to a directory when a path name
21710 ending with a slash is specified as a new &"address"&. The transport used is
21711 specified by this option, which, after expansion, must be the name of a
21712 configured transport. This should normally be an &(appendfile)& transport.
21713
21714
21715 .option file redirect string&!! unset
21716 This option specifies the name of a file that contains the redirection data. It
21717 is mutually exclusive with the &%data%& option. The string is expanded before
21718 use; if the expansion is forced to fail, the router declines. Other expansion
21719 failures cause delivery to be deferred. The result of a successful expansion
21720 must be an absolute path. The entire file is read and used as the redirection
21721 data. If the data is an empty string or a string that has no effect (consists
21722 entirely of comments), the router declines.
21723
21724 .cindex "NFS" "checking for file existence"
21725 If the attempt to open the file fails with a &"does not exist"& error, Exim
21726 runs a check on the containing directory,
21727 unless &%ignore_enotdir%& is true (see below).
21728 If the directory does not appear to exist, delivery is deferred. This can
21729 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21730 is a mount problem. If the containing directory does exist, but the file does
21731 not, the router declines.
21732
21733
21734 .option file_transport redirect string&!! unset
21735 .vindex "&$address_file$&"
21736 A &(redirect)& router sets up a direct delivery to a file when a path name not
21737 ending in a slash is specified as a new &"address"&. The transport used is
21738 specified by this option, which, after expansion, must be the name of a
21739 configured transport. This should normally be an &(appendfile)& transport. When
21740 it is running, the filename is in &$address_file$&.
21741
21742
21743 .option filter_prepend_home redirect boolean true
21744 When this option is true, if a &(save)& command in an Exim filter specifies a
21745 relative path, and &$home$& is defined, it is automatically prepended to the
21746 relative path. If this option is set false, this action does not happen. The
21747 relative path is then passed to the transport unmodified.
21748
21749
21750 .option forbid_blackhole redirect boolean false
21751 .cindex "restricting access to features"
21752 .cindex "filter" "locking out certain features"
21753 If this option is true, the &':blackhole:'& item may not appear in a
21754 redirection list.
21755
21756
21757 .option forbid_exim_filter redirect boolean false
21758 .cindex "restricting access to features"
21759 .cindex "filter" "locking out certain features"
21760 If this option is set true, only Sieve filters are permitted when
21761 &%allow_filter%& is true.
21762
21763
21764
21765
21766 .option forbid_file redirect boolean false
21767 .cindex "restricting access to features"
21768 .cindex "delivery" "to file; forbidding"
21769 .cindex "filter" "locking out certain features"
21770 .cindex "Sieve filter" "forbidding delivery to a file"
21771 .cindex "Sieve filter" "&""keep""& facility; disabling"
21772 If this option is true, this router may not generate a new address that
21773 specifies delivery to a local file or directory, either from a filter or from a
21774 conventional forward file. This option is forced to be true if &%one_time%& is
21775 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21776 locks out the Sieve's &"keep"& facility.
21777
21778
21779 .option forbid_filter_dlfunc redirect boolean false
21780 .cindex "restricting access to features"
21781 .cindex "filter" "locking out certain features"
21782 If this option is true, string expansions in Exim filters are not allowed to
21783 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21784 functions.
21785
21786 .option forbid_filter_existstest redirect boolean false
21787 .cindex "restricting access to features"
21788 .cindex "filter" "locking out certain features"
21789 .cindex "expansion" "statting a file"
21790 If this option is true, string expansions in Exim filters are not allowed to
21791 make use of the &%exists%& condition or the &%stat%& expansion item.
21792
21793 .option forbid_filter_logwrite redirect boolean false
21794 .cindex "restricting access to features"
21795 .cindex "filter" "locking out certain features"
21796 If this option is true, use of the logging facility in Exim filters is not
21797 permitted. Logging is in any case available only if the filter is being run
21798 under some unprivileged uid (which is normally the case for ordinary users'
21799 &_.forward_& files).
21800
21801
21802 .option forbid_filter_lookup redirect boolean false
21803 .cindex "restricting access to features"
21804 .cindex "filter" "locking out certain features"
21805 If this option is true, string expansions in Exim filter files are not allowed
21806 to make use of &%lookup%& items.
21807
21808
21809 .option forbid_filter_perl redirect boolean false
21810 .cindex "restricting access to features"
21811 .cindex "filter" "locking out certain features"
21812 This option has an effect only if Exim is built with embedded Perl support. If
21813 it is true, string expansions in Exim filter files are not allowed to make use
21814 of the embedded Perl support.
21815
21816
21817 .option forbid_filter_readfile redirect boolean false
21818 .cindex "restricting access to features"
21819 .cindex "filter" "locking out certain features"
21820 If this option is true, string expansions in Exim filter files are not allowed
21821 to make use of &%readfile%& items.
21822
21823
21824 .option forbid_filter_readsocket redirect boolean false
21825 .cindex "restricting access to features"
21826 .cindex "filter" "locking out certain features"
21827 If this option is true, string expansions in Exim filter files are not allowed
21828 to make use of &%readsocket%& items.
21829
21830
21831 .option forbid_filter_reply redirect boolean false
21832 .cindex "restricting access to features"
21833 .cindex "filter" "locking out certain features"
21834 If this option is true, this router may not generate an automatic reply
21835 message. Automatic replies can be generated only from Exim or Sieve filter
21836 files, not from traditional forward files. This option is forced to be true if
21837 &%one_time%& is set.
21838
21839
21840 .option forbid_filter_run redirect boolean false
21841 .cindex "restricting access to features"
21842 .cindex "filter" "locking out certain features"
21843 If this option is true, string expansions in Exim filter files are not allowed
21844 to make use of &%run%& items.
21845
21846
21847 .option forbid_include redirect boolean false
21848 .cindex "restricting access to features"
21849 .cindex "filter" "locking out certain features"
21850 If this option is true, items of the form
21851 .code
21852 :include:<path name>
21853 .endd
21854 are not permitted in non-filter redirection lists.
21855
21856
21857 .option forbid_pipe redirect boolean false
21858 .cindex "restricting access to features"
21859 .cindex "filter" "locking out certain features"
21860 .cindex "delivery" "to pipe; forbidding"
21861 If this option is true, this router may not generate a new address which
21862 specifies delivery to a pipe, either from an Exim filter or from a conventional
21863 forward file. This option is forced to be true if &%one_time%& is set.
21864
21865
21866 .option forbid_sieve_filter redirect boolean false
21867 .cindex "restricting access to features"
21868 .cindex "filter" "locking out certain features"
21869 If this option is set true, only Exim filters are permitted when
21870 &%allow_filter%& is true.
21871
21872
21873 .cindex "SMTP" "error codes"
21874 .option forbid_smtp_code redirect boolean false
21875 If this option is set true, any SMTP error codes that are present at the start
21876 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21877 the default codes (451 and 550, respectively) are always used.
21878
21879
21880
21881
21882 .option hide_child_in_errmsg redirect boolean false
21883 .cindex "bounce message" "redirection details; suppressing"
21884 If this option is true, it prevents Exim from quoting a child address if it
21885 generates a bounce or delay message for it. Instead it says &"an address
21886 generated from <&'the top level address'&>"&. Of course, this applies only to
21887 bounces generated locally. If a message is forwarded to another host, &'its'&
21888 bounce may well quote the generated address.
21889
21890
21891 .option ignore_eacces redirect boolean false
21892 .cindex "EACCES"
21893 If this option is set and an attempt to open a redirection file yields the
21894 EACCES error (permission denied), the &(redirect)& router behaves as if the
21895 file did not exist.
21896
21897
21898 .option ignore_enotdir redirect boolean false
21899 .cindex "ENOTDIR"
21900 If this option is set and an attempt to open a redirection file yields the
21901 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21902 router behaves as if the file did not exist.
21903
21904 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21905 router that has the &%file%& option set discovers that the file does not exist
21906 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21907 against unmounted NFS directories. If the parent can not be statted, delivery
21908 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21909 is set, because that option tells Exim to ignore &"something on the path is not
21910 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21911 that some operating systems give ENOENT where others give ENOTDIR.
21912
21913
21914
21915 .option include_directory redirect string unset
21916 If this option is set, the path names of any &':include:'& items in a
21917 redirection list must start with this directory.
21918
21919
21920 .option modemask redirect "octal integer" 022
21921 This specifies mode bits which must not be set for a file specified by the
21922 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21923
21924
21925 .option one_time redirect boolean false
21926 .cindex "one-time aliasing/forwarding expansion"
21927 .cindex "alias file" "one-time expansion"
21928 .cindex "forward file" "one-time expansion"
21929 .cindex "mailing lists" "one-time expansion"
21930 .cindex "address redirection" "one-time expansion"
21931 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21932 files each time it tries to deliver a message causes a problem when one or more
21933 of the generated addresses fails be delivered at the first attempt. The problem
21934 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21935 but of what happens when the redirection list changes during the time that the
21936 message is on Exim's queue. This is particularly true in the case of mailing
21937 lists, where new subscribers might receive copies of messages that were posted
21938 before they subscribed.
21939
21940 If &%one_time%& is set and any addresses generated by the router fail to
21941 deliver at the first attempt, the failing addresses are added to the message as
21942 &"top level"& addresses, and the parent address that generated them is marked
21943 &"delivered"&. Thus, redirection does not happen again at the next delivery
21944 attempt.
21945
21946 &*Warning 1*&: Any header line addition or removal that is specified by this
21947 router would be lost if delivery did not succeed at the first attempt. For this
21948 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21949 permitted when &%one_time%& is set.
21950
21951 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21952 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21953 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21954
21955 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21956 &%one_time%&.
21957
21958 The original top-level address is remembered with each of the generated
21959 addresses, and is output in any log messages. However, any intermediate parent
21960 addresses are not recorded. This makes a difference to the log only if
21961 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21962 typically be used for mailing lists, where there is normally just one level of
21963 expansion.
21964
21965
21966 .option owners redirect "string list" unset
21967 .cindex "ownership" "alias file"
21968 .cindex "ownership" "forward file"
21969 .cindex "alias file" "ownership"
21970 .cindex "forward file" "ownership"
21971 This specifies a list of permitted owners for the file specified by &%file%&.
21972 This list is in addition to the local user when &%check_local_user%& is set.
21973 See &%check_owner%& above.
21974
21975
21976 .option owngroups redirect "string list" unset
21977 This specifies a list of permitted groups for the file specified by &%file%&.
21978 The list is in addition to the local user's primary group when
21979 &%check_local_user%& is set. See &%check_group%& above.
21980
21981
21982 .option pipe_transport redirect string&!! unset
21983 .vindex "&$address_pipe$&"
21984 A &(redirect)& router sets up a direct delivery to a pipe when a string
21985 starting with a vertical bar character is specified as a new &"address"&. The
21986 transport used is specified by this option, which, after expansion, must be the
21987 name of a configured transport. This should normally be a &(pipe)& transport.
21988 When the transport is run, the pipe command is in &$address_pipe$&.
21989
21990
21991 .option qualify_domain redirect string&!! unset
21992 .vindex "&$qualify_recipient$&"
21993 If this option is set, and an unqualified address (one without a domain) is
21994 generated, and that address would normally be qualified by the global setting
21995 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21996 expanding this string. If the expansion fails, the router declines. If you want
21997 to revert to the default, you can have the expansion generate
21998 &$qualify_recipient$&.
21999
22000 This option applies to all unqualified addresses generated by Exim filters,
22001 but for traditional &_.forward_& files, it applies only to addresses that are
22002 not preceded by a backslash. Sieve filters cannot generate unqualified
22003 addresses.
22004
22005 .option qualify_preserve_domain redirect boolean false
22006 .cindex "domain" "in redirection; preserving"
22007 .cindex "preserving domain in redirection"
22008 .cindex "address redirection" "domain; preserving"
22009 If this option is set, the router's local &%qualify_domain%& option must not be
22010 set (a configuration error occurs if it is). If an unqualified address (one
22011 without a domain) is generated, it is qualified with the domain of the parent
22012 address (the immediately preceding ancestor) instead of the global
22013 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
22014 this applies whether or not the address is preceded by a backslash.
22015
22016
22017 .option repeat_use redirect boolean true
22018 If this option is set false, the router is skipped for a child address that has
22019 any ancestor that was routed by this router. This test happens before any of
22020 the other preconditions are tested. Exim's default anti-looping rules skip
22021 only when the ancestor is the same as the current address. See also
22022 &%check_ancestor%& above and the generic &%redirect_router%& option.
22023
22024
22025 .option reply_transport redirect string&!! unset
22026 A &(redirect)& router sets up an automatic reply when a &%mail%& or
22027 &%vacation%& command is used in a filter file. The transport used is specified
22028 by this option, which, after expansion, must be the name of a configured
22029 transport. This should normally be an &(autoreply)& transport. Other transports
22030 are unlikely to do anything sensible or useful.
22031
22032
22033 .option rewrite redirect boolean true
22034 .cindex "address redirection" "disabling rewriting"
22035 If this option is set false, addresses generated by the router are not
22036 subject to address rewriting. Otherwise, they are treated like new addresses
22037 and are rewritten according to the global rewriting rules.
22038
22039
22040 .option sieve_subaddress redirect string&!! unset
22041 The value of this option is passed to a Sieve filter to specify the
22042 :subaddress part of an address.
22043
22044 .option sieve_useraddress redirect string&!! unset
22045 The value of this option is passed to a Sieve filter to specify the :user part
22046 of an address. However, if it is unset, the entire original local part
22047 (including any prefix or suffix) is used for :user.
22048
22049
22050 .option sieve_vacation_directory redirect string&!! unset
22051 .cindex "Sieve filter" "vacation directory"
22052 To enable the &"vacation"& extension for Sieve filters, you must set
22053 &%sieve_vacation_directory%& to the directory where vacation databases are held
22054 (do not put anything else in that directory), and ensure that the
22055 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
22056 needs their own directory; Exim will create it if necessary.
22057
22058
22059
22060 .option skip_syntax_errors redirect boolean false
22061 .cindex "forward file" "broken"
22062 .cindex "address redirection" "broken files"
22063 .cindex "alias file" "broken"
22064 .cindex "broken alias or forward files"
22065 .cindex "ignoring faulty addresses"
22066 .cindex "skipping faulty addresses"
22067 .cindex "error" "skipping bad syntax"
22068 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
22069 non-filter redirection data are skipped, and each failing address is logged. If
22070 &%syntax_errors_to%& is set, a message is sent to the address it defines,
22071 giving details of the failures. If &%syntax_errors_text%& is set, its contents
22072 are expanded and placed at the head of the error message generated by
22073 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
22074 be the same address as the generic &%errors_to%& option. The
22075 &%skip_syntax_errors%& option is often used when handling mailing lists.
22076
22077 If all the addresses in a redirection list are skipped because of syntax
22078 errors, the router declines to handle the original address, and it is passed to
22079 the following routers.
22080
22081 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
22082 error in the filter causes filtering to be abandoned without any action being
22083 taken. The incident is logged, and the router declines to handle the address,
22084 so it is passed to the following routers.
22085
22086 .cindex "Sieve filter" "syntax errors in"
22087 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
22088 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
22089 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
22090
22091 &%skip_syntax_errors%& can be used to specify that errors in users' forward
22092 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
22093 option, used with an address that does not get redirected, can be used to
22094 notify users of these errors, by means of a router like this:
22095 .code
22096 userforward:
22097   driver = redirect
22098   allow_filter
22099   check_local_user
22100   file = $home/.forward
22101   file_transport = address_file
22102   pipe_transport = address_pipe
22103   reply_transport = address_reply
22104   no_verify
22105   skip_syntax_errors
22106   syntax_errors_to = real-$local_part@$domain
22107   syntax_errors_text = \
22108    This is an automatically generated message. An error has\n\
22109    been found in your .forward file. Details of the error are\n\
22110    reported below. While this error persists, you will receive\n\
22111    a copy of this message for every message that is addressed\n\
22112    to you. If your .forward file is a filter file, or if it is\n\
22113    a non-filter file containing no valid forwarding addresses,\n\
22114    a copy of each incoming message will be put in your normal\n\
22115    mailbox. If a non-filter file contains at least one valid\n\
22116    forwarding address, forwarding to the valid addresses will\n\
22117    happen, and those will be the only deliveries that occur.
22118 .endd
22119 You also need a router to ensure that local addresses that are prefixed by
22120 &`real-`& are recognized, but not forwarded or filtered. For example, you could
22121 put this immediately before the &(userforward)& router:
22122 .code
22123 real_localuser:
22124   driver = accept
22125   check_local_user
22126   local_part_prefix = real-
22127   transport = local_delivery
22128 .endd
22129 For security, it would probably be a good idea to restrict the use of this
22130 router to locally-generated messages, using a condition such as this:
22131 .code
22132   condition = ${if match {$sender_host_address}\
22133                          {\N^(|127\.0\.0\.1)$\N}}
22134 .endd
22135
22136
22137 .option syntax_errors_text redirect string&!! unset
22138 See &%skip_syntax_errors%& above.
22139
22140
22141 .option syntax_errors_to redirect string unset
22142 See &%skip_syntax_errors%& above.
22143 .ecindex IIDredrou1
22144 .ecindex IIDredrou2
22145
22146
22147
22148
22149
22150
22151 . ////////////////////////////////////////////////////////////////////////////
22152 . ////////////////////////////////////////////////////////////////////////////
22153
22154 .chapter "Environment for running local transports" "CHAPenvironment" &&&
22155          "Environment for local transports"
22156 .scindex IIDenvlotra1 "local transports" "environment for"
22157 .scindex IIDenvlotra2 "environment" "local transports"
22158 .scindex IIDenvlotra3 "transport" "local; environment for"
22159 Local transports handle deliveries to files and pipes. (The &(autoreply)&
22160 transport can be thought of as similar to a pipe.) Exim always runs transports
22161 in subprocesses, under specified uids and gids. Typical deliveries to local
22162 mailboxes run under the uid and gid of the local user.
22163
22164 Exim also sets a specific current directory while running the transport; for
22165 some transports a home directory setting is also relevant. The &(pipe)&
22166 transport is the only one that sets up environment variables; see section
22167 &<<SECTpipeenv>>& for details.
22168
22169 The values used for the uid, gid, and the directories may come from several
22170 different places. In many cases, the router that handles the address associates
22171 settings with that address as a result of its &%check_local_user%&, &%group%&,
22172 or &%user%& options. However, values may also be given in the transport's own
22173 configuration, and these override anything that comes from the router.
22174
22175
22176
22177 .section "Concurrent deliveries" "SECID131"
22178 .cindex "concurrent deliveries"
22179 .cindex "simultaneous deliveries"
22180 If two different messages for the same local recipient arrive more or less
22181 simultaneously, the two delivery processes are likely to run concurrently. When
22182 the &(appendfile)& transport is used to write to a file, Exim applies locking
22183 rules to stop concurrent processes from writing to the same file at the same
22184 time.
22185
22186 However, when you use a &(pipe)& transport, it is up to you to arrange any
22187 locking that is needed. Here is a silly example:
22188 .code
22189 my_transport:
22190   driver = pipe
22191   command = /bin/sh -c 'cat >>/some/file'
22192 .endd
22193 This is supposed to write the message at the end of the file. However, if two
22194 messages arrive at the same time, the file will be scrambled. You can use the
22195 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
22196 file using the same algorithm that Exim itself uses.
22197
22198
22199
22200
22201 .section "Uids and gids" "SECTenvuidgid"
22202 .cindex "local transports" "uid and gid"
22203 .cindex "transport" "local; uid and gid"
22204 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
22205 overrides any group that the router set in the address, even if &%user%& is not
22206 set for the transport. This makes it possible, for example, to run local mail
22207 delivery under the uid of the recipient (set by the router), but in a special
22208 group (set by the transport). For example:
22209 .code
22210 # Routers ...
22211 # User/group are set by check_local_user in this router
22212 local_users:
22213   driver = accept
22214   check_local_user
22215   transport = group_delivery
22216
22217 # Transports ...
22218 # This transport overrides the group
22219 group_delivery:
22220   driver = appendfile
22221   file = /var/spool/mail/$local_part_data
22222   group = mail
22223 .endd
22224 If &%user%& is set for a transport, its value overrides what is set in the
22225 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
22226 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
22227 set.
22228
22229 .oindex "&%initgroups%&"
22230 When the uid is taken from the transport's configuration, the &[initgroups()]&
22231 function is called for the groups associated with that uid if the
22232 &%initgroups%& option is set for the transport. When the uid is not specified
22233 by the transport, but is associated with the address by a router, the option
22234 for calling &[initgroups()]& is taken from the router configuration.
22235
22236 .cindex "&(pipe)& transport" "uid for"
22237 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22238 is set and &%user%& is not set, the uid of the process that called Exim to
22239 receive the message is used, and if &%group%& is not set, the corresponding
22240 original gid is also used.
22241
22242 This is the detailed preference order for obtaining a gid; the first of the
22243 following that is set is used:
22244
22245 .ilist
22246 A &%group%& setting of the transport;
22247 .next
22248 A &%group%& setting of the router;
22249 .next
22250 A gid associated with a user setting of the router, either as a result of
22251 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22252 .next
22253 The group associated with a non-numeric &%user%& setting of the transport;
22254 .next
22255 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22256 the uid is the creator's uid;
22257 .next
22258 The Exim gid if the Exim uid is being used as a default.
22259 .endlist
22260
22261 If, for example, the user is specified numerically on the router and there are
22262 no group settings, no gid is available. In this situation, an error occurs.
22263 This is different for the uid, for which there always is an ultimate default.
22264 The first of the following that is set is used:
22265
22266 .ilist
22267 A &%user%& setting of the transport;
22268 .next
22269 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22270 .next
22271 A &%user%& setting of the router;
22272 .next
22273 A &%check_local_user%& setting of the router;
22274 .next
22275 The Exim uid.
22276 .endlist
22277
22278 Of course, an error will still occur if the uid that is chosen is on the
22279 &%never_users%& list.
22280
22281
22282
22283
22284
22285 .section "Current and home directories" "SECID132"
22286 .cindex "current directory for local transport"
22287 .cindex "home directory" "for local transport"
22288 .cindex "transport" "local; home directory for"
22289 .cindex "transport" "local; current directory for"
22290 Routers may set current and home directories for local transports by means of
22291 the &%transport_current_directory%& and &%transport_home_directory%& options.
22292 However, if the transport's &%current_directory%& or &%home_directory%& options
22293 are set, they override the router's values. In detail, the home directory
22294 for a local transport is taken from the first of these values that is set:
22295
22296 .ilist
22297 The &%home_directory%& option on the transport;
22298 .next
22299 The &%transport_home_directory%& option on the router;
22300 .next
22301 The password data if &%check_local_user%& is set on the router;
22302 .next
22303 The &%router_home_directory%& option on the router.
22304 .endlist
22305
22306 The current directory is taken from the first of these values that is set:
22307
22308 .ilist
22309 The &%current_directory%& option on the transport;
22310 .next
22311 The &%transport_current_directory%& option on the router.
22312 .endlist
22313
22314
22315 If neither the router nor the transport sets a current directory, Exim uses the
22316 value of the home directory, if it is set. Otherwise it sets the current
22317 directory to &_/_& before running a local transport.
22318
22319
22320
22321 .section "Expansion variables derived from the address" "SECID133"
22322 .vindex "&$domain$&"
22323 .vindex "&$local_part$&"
22324 .vindex "&$original_domain$&"
22325 Normally a local delivery is handling a single address, and in that case the
22326 variables such as &$domain$& and &$local_part$& are set during local
22327 deliveries. However, in some circumstances more than one address may be handled
22328 at once (for example, while writing batch SMTP for onward transmission by some
22329 other means). In this case, the variables associated with the local part are
22330 never set, &$domain$& is set only if all the addresses have the same domain,
22331 and &$original_domain$& is never set.
22332 .ecindex IIDenvlotra1
22333 .ecindex IIDenvlotra2
22334 .ecindex IIDenvlotra3
22335
22336
22337
22338
22339
22340
22341
22342 . ////////////////////////////////////////////////////////////////////////////
22343 . ////////////////////////////////////////////////////////////////////////////
22344
22345 .chapter "Generic options for transports" "CHAPtransportgeneric"
22346 .scindex IIDgenoptra1 "generic options" "transport"
22347 .scindex IIDgenoptra2 "options" "generic; for transports"
22348 .scindex IIDgenoptra3 "transport" "generic options for"
22349 The name of a transport is limited to be &drivernamemax; ASCII characters long;
22350 prior to Exim 4.95 names would be silently truncated at this length, but now
22351 it is enforced.
22352
22353 The following generic options apply to all transports:
22354
22355
22356 .option body_only transports boolean false
22357 .cindex "transport" "body only"
22358 .cindex "message" "transporting body only"
22359 .cindex "body of message" "transporting"
22360 If this option is set, the message's headers are not transported. It is
22361 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22362 or &(pipe)& transports, the settings of &%message_prefix%& and
22363 &%message_suffix%& should be checked, because this option does not
22364 automatically suppress them.
22365
22366
22367 .option current_directory transports string&!! unset
22368 .cindex "transport" "current directory for"
22369 This specifies the current directory that is to be set while running the
22370 transport, overriding any value that may have been set by the router.
22371 If the expansion fails for any reason, including forced failure, an error is
22372 logged, and delivery is deferred.
22373
22374
22375 .option disable_logging transports boolean false
22376 If this option is set true, nothing is logged for any
22377 deliveries by the transport or for any
22378 transport errors. You should not set this option unless you really, really know
22379 what you are doing.
22380
22381
22382 .option debug_print transports string&!! unset
22383 .cindex "testing" "variables in drivers"
22384 If this option is set and debugging is enabled (see the &%-d%& command line
22385 option), the string is expanded and included in the debugging output when the
22386 transport is run.
22387 If expansion of the string fails, the error message is written to the debugging
22388 output, and Exim carries on processing.
22389 This facility is provided to help with checking out the values of variables and
22390 so on when debugging driver configurations. For example, if a &%headers_add%&
22391 option is not working properly, &%debug_print%& could be used to output the
22392 variables it references. A newline is added to the text if it does not end with
22393 one.
22394 The variables &$transport_name$& and &$router_name$& contain the name of the
22395 transport and the router that called it.
22396
22397 .option delivery_date_add transports boolean false
22398 .cindex "&'Delivery-date:'& header line"
22399 If this option is true, a &'Delivery-date:'& header is added to the message.
22400 This gives the actual time the delivery was made. As this is not a standard
22401 header, Exim has a configuration option (&%delivery_date_remove%&) which
22402 requests its removal from incoming messages, so that delivered messages can
22403 safely be resent to other recipients.
22404
22405
22406 .option driver transports string unset
22407 This specifies which of the available transport drivers is to be used.
22408 There is no default, and this option must be set for every transport.
22409
22410
22411 .option envelope_to_add transports boolean false
22412 .cindex "&'Envelope-to:'& header line"
22413 If this option is true, an &'Envelope-to:'& header is added to the message.
22414 This gives the original address(es) in the incoming envelope that caused this
22415 delivery to happen. More than one address may be present if the transport is
22416 configured to handle several addresses at once, or if more than one original
22417 address was redirected to the same final address. As this is not a standard
22418 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22419 its removal from incoming messages, so that delivered messages can safely be
22420 resent to other recipients.
22421
22422 &*Note:*& If used on a transport handling multiple recipients
22423 (the smtp transport unless &%rcpt_max%& is 1, the appendfile, pipe or lmtp
22424 transport if &%batch_max%& is greater than 1)
22425 then information about Bcc recipients will be leaked.
22426 Doing so is generally not advised.
22427
22428
22429 .option event_action transports string&!! unset
22430 .cindex events
22431 This option declares a string to be expanded for Exim's events mechanism.
22432 For details see chapter &<<CHAPevents>>&.
22433
22434
22435 .option group transports string&!! "Exim group"
22436 .cindex "transport" "group; specifying"
22437 This option specifies a gid for running the transport process, overriding any
22438 value that the router supplies, and also overriding any value associated with
22439 &%user%& (see below).
22440
22441
22442 .option headers_add transports list&!! unset
22443 .cindex "header lines" "adding in transport"
22444 .cindex "transport" "header lines; adding"
22445 This option specifies a list of text headers,
22446 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22447 which are (separately) expanded and added to the header
22448 portion of a message as it is transported, as described in section
22449 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22450 routers. If the result of the expansion is an empty string, or if the expansion
22451 is forced to fail, no action is taken. Other expansion failures are treated as
22452 errors and cause the delivery to be deferred.
22453
22454 Unlike most options, &%headers_add%& can be specified multiple times
22455 for a transport; all listed headers are added.
22456
22457
22458 .option headers_only transports boolean false
22459 .cindex "transport" "header lines only"
22460 .cindex "message" "transporting headers only"
22461 .cindex "header lines" "transporting"
22462 If this option is set, the message's body is not transported. It is mutually
22463 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22464 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22465 checked, since this option does not automatically suppress them.
22466
22467
22468 .option headers_remove transports list&!! unset
22469 .cindex "header lines" "removing"
22470 .cindex "transport" "header lines; removing"
22471 This option specifies a list of text headers,
22472 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22473 to be removed from the message.
22474 However, the option has no effect when an address is just being verified.
22475 Each list item is separately expanded.
22476 If the result of the expansion is an empty string, or if the expansion
22477 is forced to fail, no action is taken. Other expansion failures are treated as
22478 errors and cause the delivery to be deferred.
22479 If an item ends in *, it will match any header with the given prefix.
22480
22481 Matching headers are omitted from the message as it is transported, as described
22482 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22483 routers.
22484
22485 Unlike most options, &%headers_remove%& can be specified multiple times
22486 for a transport; all listed headers are removed.
22487
22488 &*Warning*&: Because of the separate expansion of the list items,
22489 items that contain a list separator must have it doubled.
22490 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22491
22492
22493
22494 .option headers_rewrite transports string unset
22495 .cindex "transport" "header lines; rewriting"
22496 .cindex "rewriting" "at transport time"
22497 This option allows addresses in header lines to be rewritten at transport time,
22498 that is, as the message is being copied to its destination. The contents of the
22499 option are a colon-separated list of rewriting rules. Each rule is in exactly
22500 the same form as one of the general rewriting rules that are applied when a
22501 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22502 example,
22503 .code
22504 headers_rewrite = a@b c@d f : \
22505                   x@y w@z
22506 .endd
22507 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22508 &'w@z'& in all address-bearing header lines. The rules are applied to the
22509 header lines just before they are written out at transport time, so they affect
22510 only those copies of the message that pass through the transport. However, only
22511 the message's original header lines, and any that were added by a system
22512 filter, are rewritten. If a router or transport adds header lines, they are not
22513 affected by this option. These rewriting rules are &'not'& applied to the
22514 envelope. You can change the return path using &%return_path%&, but you cannot
22515 change envelope recipients at this time.
22516
22517
22518 .option home_directory transports string&!! unset
22519 .cindex "transport" "home directory for"
22520 .vindex "&$home$&"
22521 This option specifies a home directory setting for a local transport,
22522 overriding any value that may be set by the router. The home directory is
22523 placed in &$home$& while expanding the transport's private options. It is also
22524 used as the current directory if no current directory is set by the
22525 &%current_directory%& option on the transport or the
22526 &%transport_current_directory%& option on the router. If the expansion fails
22527 for any reason, including forced failure, an error is logged, and delivery is
22528 deferred.
22529
22530
22531 .option initgroups transports boolean false
22532 .cindex "additional groups"
22533 .cindex "groups" "additional"
22534 .cindex "transport" "group; additional"
22535 If this option is true and the uid for the delivery process is provided by the
22536 transport, the &[initgroups()]& function is called when running the transport
22537 to ensure that any additional groups associated with the uid are set up.
22538
22539
22540 .option max_parallel transports integer&!! unset
22541 .cindex limit "transport parallelism"
22542 .cindex transport "parallel processes"
22543 .cindex transport "concurrency limit"
22544 .cindex "delivery" "parallelism for transport"
22545 If this option is set and expands to an integer greater than zero
22546 it limits the number of concurrent runs of the transport.
22547 The control does not apply to shadow transports.
22548
22549 .cindex "hints database" "transport concurrency control"
22550 Exim implements this control by means of a hints database in which a record is
22551 incremented whenever a transport process is being created. The record
22552 is decremented and possibly removed when the process terminates.
22553 Obviously there is scope for
22554 records to get left lying around if there is a system or program crash. To
22555 guard against this, Exim ignores any records that are more than six hours old.
22556
22557 If you use this option, you should also arrange to delete the
22558 relevant hints database whenever your system reboots. The names of the files
22559 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22560 may be one or two files, depending on the type of DBM in use. The same files
22561 are used for ETRN and smtp transport serialization.
22562
22563
22564 .option message_size_limit transports string&!! 0
22565 .cindex "limit" "message size per transport"
22566 .cindex "size" "of message, limit"
22567 .cindex "transport" "message size; limiting"
22568 This option controls the size of messages passed through the transport. It is
22569 expanded before use; the result of the expansion must be a sequence of decimal
22570 digits, optionally followed by K or M. If the expansion fails for any reason,
22571 including forced failure, or if the result is not of the required form,
22572 delivery is deferred. If the value is greater than zero and the size of a
22573 message exceeds this limit, the address is failed. If there is any chance that
22574 the resulting bounce message could be routed to the same transport, you should
22575 ensure that &%return_size_limit%& is less than the transport's
22576 &%message_size_limit%&, as otherwise the bounce message will fail to get
22577 delivered.
22578
22579
22580
22581 .option rcpt_include_affixes transports boolean false
22582 .cindex "prefix" "for local part, including in envelope"
22583 .cindex "suffix for local part" "including in envelope"
22584 .cindex "local part" "prefix"
22585 .cindex "local part" "suffix"
22586 When this option is false (the default), and an address that has had any
22587 affixes (prefixes or suffixes) removed from the local part is delivered by any
22588 form of SMTP or LMTP, the affixes are not included. For example, if a router
22589 that contains
22590 .code
22591 local_part_prefix = *-
22592 .endd
22593 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22594 is delivered with
22595 .code
22596 RCPT TO:<xyz@some.domain>
22597 .endd
22598 This is also the case when an ACL-time callout is being used to verify a
22599 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22600 whole local part is included in the RCPT command. This option applies to BSMTP
22601 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22602 &(lmtp)& and &(smtp)& transports.
22603
22604
22605 .option retry_use_local_part transports boolean "see below"
22606 .cindex "hints database" "retry keys"
22607 When a delivery suffers a temporary failure, a retry record is created
22608 in Exim's hints database. For remote deliveries, the key for the retry record
22609 is based on the name and/or IP address of the failing remote host. For local
22610 deliveries, the key is normally the entire address, including both the local
22611 part and the domain. This is suitable for most common cases of local delivery
22612 temporary failure &-- for example, exceeding a mailbox quota should delay only
22613 deliveries to that mailbox, not to the whole domain.
22614
22615 However, in some special cases you may want to treat a temporary local delivery
22616 as a failure associated with the domain, and not with a particular local part.
22617 (For example, if you are storing all mail for some domain in files.) You can do
22618 this by setting &%retry_use_local_part%& false.
22619
22620 For all the local transports, its default value is true. For remote transports,
22621 the default value is false for tidiness, but changing the value has no effect
22622 on a remote transport in the current implementation.
22623
22624
22625 .option return_path transports string&!! unset
22626 .cindex "envelope sender"
22627 .cindex "envelope from"
22628 .cindex "transport" "return path; changing"
22629 .cindex "return path" "changing in transport"
22630 If this option is set, the string is expanded at transport time and replaces
22631 the existing return path (envelope sender) value in the copy of the message
22632 that is being delivered. An empty return path is permitted. This feature is
22633 designed for remote deliveries, where the value of this option is used in the
22634 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22635 only effect is to change the address that is placed in the &'Return-path:'&
22636 header line, if one is added to the message (see the next option).
22637
22638 &*Note:*& A changed return path is not logged unless you add
22639 &%return_path_on_delivery%& to the log selector.
22640
22641 .vindex "&$return_path$&"
22642 The expansion can refer to the existing value via &$return_path$&. This is
22643 either the message's envelope sender, or an address set by the
22644 &%errors_to%& option on a router. If the expansion is forced to fail, no
22645 replacement occurs; if it fails for another reason, delivery is deferred. This
22646 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22647 section &<<SECTverp>>&.
22648
22649 &*Note*&: If a delivery error is detected locally, including the case when a
22650 remote server rejects a message at SMTP time, the bounce message is not sent to
22651 the value of this option. It is sent to the previously set errors address.
22652 This defaults to the incoming sender address, but can be changed by setting
22653 &%errors_to%& in a router.
22654
22655
22656
22657 .option return_path_add transports boolean false
22658 .chindex Return-path:
22659 If this option is true, a &'Return-path:'& header is added to the message.
22660 Although the return path is normally available in the prefix line of BSD
22661 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22662 have easy access to it.
22663
22664 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22665 the delivery SMTP server makes the final delivery"&. This implies that this
22666 header should not be present in incoming messages. Exim has a configuration
22667 option, &%return_path_remove%&, which requests removal of this header from
22668 incoming messages, so that delivered messages can safely be resent to other
22669 recipients.
22670
22671
22672 .option shadow_condition transports string&!! unset
22673 See &%shadow_transport%& below.
22674
22675
22676 .option shadow_transport transports string unset
22677 .cindex "shadow transport"
22678 .cindex "transport" "shadow"
22679 A local transport may set the &%shadow_transport%& option to the name of
22680 another local transport. Shadow remote transports are not supported.
22681
22682 Whenever a delivery to the main transport succeeds, and either
22683 &%shadow_condition%& is unset, or its expansion does not result in the empty
22684 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22685 passed to the shadow transport, with the same delivery address or addresses. If
22686 expansion fails, no action is taken except that non-forced expansion failures
22687 cause a log line to be written.
22688
22689 The result of the shadow transport is discarded and does not affect the
22690 subsequent processing of the message. Only a single level of shadowing is
22691 provided; the &%shadow_transport%& option is ignored on any transport when it
22692 is running as a shadow. Options concerned with output from pipes are also
22693 ignored. The log line for the successful delivery has an item added on the end,
22694 of the form
22695 .code
22696 ST=<shadow transport name>
22697 .endd
22698 If the shadow transport did not succeed, the error message is put in
22699 parentheses afterwards. Shadow transports can be used for a number of different
22700 purposes, including keeping more detailed log information than Exim normally
22701 provides, and implementing automatic acknowledgment policies based on message
22702 headers that some sites insist on.
22703
22704
22705 .option transport_filter transports string&!! unset
22706 .cindex "transport" "filter"
22707 .cindex "filter" "transport filter"
22708 This option sets up a filtering (in the Unix shell sense) process for messages
22709 at transport time. It should not be confused with mail filtering as set up by
22710 individual users or via a system filter.
22711 If unset, or expanding to an empty string, no filtering is done.
22712
22713 When the message is about to be written out, the command specified by
22714 &%transport_filter%& is started up in a separate, parallel process, and
22715 the entire message, including the header lines, is passed to it on its standard
22716 input (this in fact is done from a third process, to avoid deadlock). The
22717 command must be specified as an absolute path.
22718
22719 The lines of the message that are written to the transport filter are
22720 terminated by newline (&"\n"&). The message is passed to the filter before any
22721 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22722 lines beginning with a dot, and also before any processing implied by the
22723 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22724 &(pipe)& transports.
22725
22726 The standard error for the filter process is set to the same destination as its
22727 standard output; this is read and written to the message's ultimate
22728 destination. The process that writes the message to the filter, the
22729 filter itself, and the original process that reads the result and delivers it
22730 are all run in parallel, like a shell pipeline.
22731
22732 The filter can perform any transformations it likes, but of course should take
22733 care not to break RFC 2822 syntax. Exim does not check the result, except to
22734 test for a final newline when SMTP is in use. All messages transmitted over
22735 SMTP must end with a newline, so Exim supplies one if it is missing.
22736
22737 .cindex "content scanning" "per user"
22738 A transport filter can be used to provide content-scanning on a per-user basis
22739 at delivery time if the only required effect of the scan is to modify the
22740 message. For example, a content scan could insert a new header line containing
22741 a spam score. This could be interpreted by a filter in the user's MUA. It is
22742 not possible to discard a message at this stage.
22743
22744 .cindex "SIZE" "ESMTP extension"
22745 A problem might arise if the filter increases the size of a message that is
22746 being sent down an SMTP connection. If the receiving SMTP server has indicated
22747 support for the SIZE parameter, Exim will have sent the size of the message
22748 at the start of the SMTP session. If what is actually sent is substantially
22749 more, the server might reject the message. This can be worked round by setting
22750 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22751 additions to the message, or to disable the use of SIZE altogether.
22752
22753 .vindex "&$pipe_addresses$&"
22754 The value of the &%transport_filter%& option is the command string for starting
22755 the filter, which is run directly from Exim, not under a shell. The string is
22756 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22757 Exim breaks it up into arguments and then expands each argument separately (see
22758 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22759 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22760 of arguments, one for each address that applies to this delivery. (This isn't
22761 an ideal name for this feature here, but as it was already implemented for the
22762 &(pipe)& transport, it seemed sensible not to change it.)
22763
22764 .vindex "&$host$&"
22765 .vindex "&$host_address$&"
22766 The expansion variables &$host$& and &$host_address$& are available when the
22767 transport is a remote one. They contain the name and IP address of the host to
22768 which the message is being sent. For example:
22769 .code
22770 transport_filter = /some/directory/transport-filter.pl \
22771   $host $host_address $sender_address $pipe_addresses
22772 .endd
22773
22774 Two problems arise if you want to use more complicated expansion items to
22775 generate transport filter commands, both of which due to the fact that the
22776 command is split up &'before'& expansion.
22777 .ilist
22778 If an expansion item contains white space, you must quote it, so that it is all
22779 part of the same command item. If the entire option setting is one such
22780 expansion item, you have to take care what kind of quoting you use. For
22781 example:
22782 .code
22783 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22784 .endd
22785 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22786 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22787 stripped by Exim when it read the option's value. When the value is used, if
22788 the single quotes were missing, the line would be split into two items,
22789 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22790 Exim tried to expand the first one.
22791 .next
22792 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22793 expansion cannot generate multiple arguments, or a command name followed by
22794 arguments. Consider this example:
22795 .code
22796 transport_filter = ${lookup{$host}lsearch{/a/file}\
22797                     {$value}{/bin/cat}}
22798 .endd
22799 The result of the lookup is interpreted as the name of the command, even
22800 if it contains white space. The simplest way round this is to use a shell:
22801 .code
22802 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22803                                {$value}{/bin/cat}}
22804 .endd
22805 .endlist
22806
22807 The filter process is run under the same uid and gid as the normal delivery.
22808 For remote deliveries this is the Exim uid/gid by default. The command should
22809 normally yield a zero return code. Transport filters are not supposed to fail.
22810 A non-zero code is taken to mean that the transport filter encountered some
22811 serious problem. Delivery of the message is deferred; the message remains on
22812 the queue and is tried again later. It is not possible to cause a message to be
22813 bounced from a transport filter.
22814
22815 If a transport filter is set on an autoreply transport, the original message is
22816 passed through the filter as it is being copied into the newly generated
22817 message, which happens if the &%return_message%& option is set.
22818
22819
22820 .option transport_filter_timeout transports time 5m
22821 .cindex "transport" "filter, timeout"
22822 When Exim is reading the output of a transport filter, it applies a timeout
22823 that can be set by this option. Exceeding the timeout is normally treated as a
22824 temporary delivery failure. However, if a transport filter is used with a
22825 &(pipe)& transport, a timeout in the transport filter is treated in the same
22826 way as a timeout in the pipe command itself. By default, a timeout is a hard
22827 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22828 becomes a temporary error.
22829
22830
22831 .option user transports string&!! "Exim user"
22832 .cindex "uid (user id)" "local delivery"
22833 .cindex "transport" "user, specifying"
22834 This option specifies the user under whose uid the delivery process is to be
22835 run, overriding any uid that may have been set by the router. If the user is
22836 given as a name, the uid is looked up from the password data, and the
22837 associated group is taken as the value of the gid to be used if the &%group%&
22838 option is not set.
22839
22840 For deliveries that use local transports, a user and group are normally
22841 specified explicitly or implicitly (for example, as a result of
22842 &%check_local_user%&) by the router or transport.
22843
22844 .cindex "hints database" "access by remote transport"
22845 For remote transports, you should leave this option unset unless you really are
22846 sure you know what you are doing. When a remote transport is running, it needs
22847 to be able to access Exim's hints databases, because each host may have its own
22848 retry data.
22849 .ecindex IIDgenoptra1
22850 .ecindex IIDgenoptra2
22851 .ecindex IIDgenoptra3
22852
22853
22854
22855
22856
22857
22858 . ////////////////////////////////////////////////////////////////////////////
22859 . ////////////////////////////////////////////////////////////////////////////
22860
22861 .chapter "Address batching in local transports" "CHAPbatching" &&&
22862          "Address batching"
22863 .cindex "transport" "local; address batching in"
22864 The only remote transport (&(smtp)&) is normally configured to handle more than
22865 one address at a time, so that when several addresses are routed to the same
22866 remote host, just one copy of the message is sent. Local transports, however,
22867 normally handle one address at a time. That is, a separate instance of the
22868 transport is run for each address that is routed to the transport. A separate
22869 copy of the message is delivered each time.
22870
22871 .cindex "batched local delivery"
22872 .oindex "&%batch_max%&"
22873 .oindex "&%batch_id%&"
22874 In special cases, it may be desirable to handle several addresses at once in a
22875 local transport, for example:
22876
22877 .ilist
22878 In an &(appendfile)& transport, when storing messages in files for later
22879 delivery by some other means, a single copy of the message with multiple
22880 recipients saves space.
22881 .next
22882 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22883 a single copy saves time, and is the normal way LMTP is expected to work.
22884 .next
22885 In a &(pipe)& transport, when passing the message
22886 to a scanner program or
22887 to some other delivery mechanism such as UUCP, multiple recipients may be
22888 acceptable.
22889 .endlist
22890
22891 These three local transports all have the same options for controlling multiple
22892 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22893 repeating the information for each transport, these options are described here.
22894
22895 The &%batch_max%& option specifies the maximum number of addresses that can be
22896 delivered together in a single run of the transport. Its default value is one
22897 (no batching). When more than one address is routed to a transport that has a
22898 &%batch_max%& value greater than one, the addresses are delivered in a batch
22899 (that is, in a single run of the transport with multiple recipients), subject
22900 to certain conditions:
22901
22902 .ilist
22903 .vindex "&$local_part$&"
22904 If any of the transport's options contain a reference to &$local_part$&, no
22905 batching is possible.
22906 .next
22907 .vindex "&$domain$&"
22908 If any of the transport's options contain a reference to &$domain$&, only
22909 addresses with the same domain are batched.
22910 .next
22911 .cindex "customizing" "batching condition"
22912 If &%batch_id%& is set, it is expanded for each address, and only those
22913 addresses with the same expanded value are batched. This allows you to specify
22914 customized batching conditions. Failure of the expansion for any reason,
22915 including forced failure, disables batching, but it does not stop the delivery
22916 from taking place.
22917 .next
22918 Batched addresses must also have the same errors address (where to send
22919 delivery errors), the same header additions and removals, the same user and
22920 group for the transport, and if a host list is present, the first host must
22921 be the same.
22922 .endlist
22923
22924 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22925 both when the file or pipe command is specified in the transport, and when it
22926 is specified by a &(redirect)& router, but all the batched addresses must of
22927 course be routed to the same file or pipe command. These two transports have an
22928 option called &%use_bsmtp%&, which causes them to deliver the message in
22929 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22930 &%check_string%& and &%escape_string%& options are forced to the values
22931 .code
22932 check_string = "."
22933 escape_string = ".."
22934 .endd
22935 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22936 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22937 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22938
22939 .cindex "&'Envelope-to:'& header line"
22940 If the generic &%envelope_to_add%& option is set for a batching transport, the
22941 &'Envelope-to:'& header that is added to the message contains all the addresses
22942 that are being processed together. If you are using a batching &(appendfile)&
22943 transport without &%use_bsmtp%&, the only way to preserve the recipient
22944 addresses is to set the &%envelope_to_add%& option.
22945
22946 .cindex "&(pipe)& transport" "with multiple addresses"
22947 .vindex "&$pipe_addresses$&"
22948 If you are using a &(pipe)& transport without BSMTP, and setting the
22949 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22950 the command. This is not a true variable; it is a bit of magic that causes each
22951 of the recipient addresses to be inserted into the command as a separate
22952 argument. This provides a way of accessing all the addresses that are being
22953 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22954 are specified by a &(redirect)& router.
22955
22956
22957
22958
22959 . ////////////////////////////////////////////////////////////////////////////
22960 . ////////////////////////////////////////////////////////////////////////////
22961
22962 .chapter "The appendfile transport" "CHAPappendfile"
22963 .scindex IIDapptra1 "&(appendfile)& transport"
22964 .scindex IIDapptra2 "transports" "&(appendfile)&"
22965 .cindex "directory creation"
22966 .cindex "creating directories"
22967 The &(appendfile)& transport delivers a message by appending it to an existing
22968 file, or by creating an entirely new file in a specified directory. Single
22969 files to which messages are appended can be in the traditional Unix mailbox
22970 format, or optionally in the MBX format supported by the Pine MUA and
22971 University of Washington IMAP daemon, &'inter alia'&. When each message is
22972 being delivered as a separate file, &"maildir"& format can optionally be used
22973 to give added protection against failures that happen part-way through the
22974 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22975 supported. For all file formats, Exim attempts to create as many levels of
22976 directory as necessary, provided that &%create_directory%& is set.
22977
22978 The code for the optional formats is not included in the Exim binary by
22979 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22980 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22981 included.
22982
22983 .cindex "quota" "system"
22984 Exim recognizes system quota errors, and generates an appropriate message. Exim
22985 also supports its own quota control within the transport, for use when the
22986 system facility is unavailable or cannot be used for some reason.
22987
22988 If there is an error while appending to a file (for example, quota exceeded or
22989 partition filled), Exim attempts to reset the file's length and last
22990 modification time back to what they were before. If there is an error while
22991 creating an entirely new file, the new file is removed.
22992
22993 Before appending to a file, a number of security checks are made, and the
22994 file is locked. A detailed description is given below, after the list of
22995 private options.
22996
22997 The &(appendfile)& transport is most commonly used for local deliveries to
22998 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22999 putting messages into files for remote delivery by some means other than Exim.
23000 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
23001 option).
23002
23003
23004
23005 .section "The file and directory options" "SECTfildiropt"
23006 The &%file%& option specifies a single file, to which the message is appended;
23007 the &%directory%& option specifies a directory, in which a new file containing
23008 the message is created. Only one of these two options can be set, and for
23009 normal deliveries to mailboxes, one of them &'must'& be set.
23010
23011 .vindex "&$address_file$&"
23012 .vindex "&$local_part$&"
23013 However, &(appendfile)& is also used for delivering messages to files or
23014 directories whose names (or parts of names) are obtained from alias,
23015 forwarding, or filtering operations (for example, a &%save%& command in a
23016 user's Exim filter). When such a transport is running, &$local_part$& contains
23017 the local part that was aliased or forwarded, and &$address_file$& contains the
23018 name (or partial name) of the file or directory generated by the redirection
23019 operation. There are two cases:
23020
23021 .ilist
23022 If neither &%file%& nor &%directory%& is set, the redirection operation
23023 must specify an absolute path (one that begins with &`/`&). This is the most
23024 common case when users with local accounts use filtering to sort mail into
23025 different folders. See for example, the &(address_file)& transport in the
23026 default configuration. If the path ends with a slash, it is assumed to be the
23027 name of a directory. A delivery to a directory can also be forced by setting
23028 &%maildir_format%& or &%mailstore_format%&.
23029 .next
23030 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
23031 used to determine the file or directory name for the delivery. Normally, the
23032 contents of &$address_file$& are used in some way in the string expansion.
23033 .endlist
23034 If the &%create_file%& option is set to a path which
23035 matches (see the option definition below for details)
23036 a file or directory name
23037 for the delivery, that name becomes de-tainted.
23038
23039 .cindex "tainted data" "in filenames"
23040 .cindex appendfile "tainted data"
23041 Tainted data may not be used for a file or directory name.
23042 This means that, for instance, &$local_part$& cannot be used directly
23043 as a component of a path.  It can however be used as the key for a lookup
23044 which returns a path (or component).
23045
23046
23047 .cindex "Sieve filter" "configuring &(appendfile)&"
23048 .cindex "Sieve filter" "relative mailbox path handling"
23049 As an example of the second case, consider an environment where users do not
23050 have home directories. They may be permitted to use Exim filter commands of the
23051 form:
23052 .code
23053 save folder23
23054 .endd
23055 or Sieve filter commands of the form:
23056 .code
23057 require "fileinto";
23058 fileinto "folder23";
23059 .endd
23060 In this situation, the expansion of &%file%& or &%directory%& in the transport
23061 must transform the relative path into an appropriate absolute filename. In the
23062 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
23063 is used as a result of a &"keep"& action in the filter. This example shows one
23064 way of handling this requirement:
23065 .code
23066 file = ${if eq{$address_file}{inbox} \
23067             {/var/mail/$local_part_data} \
23068             {${if eq{${substr_0_1:$address_file}}{/} \
23069                   {$address_file} \
23070                   {$home/mail/$address_file} \
23071             }} \
23072        }
23073 .endd
23074 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
23075 location, absolute paths are used without change, and other folders are in the
23076 &_mail_& directory within the home directory.
23077
23078 &*Note 1*&: While processing an Exim filter, a relative path such as
23079 &_folder23_& is turned into an absolute path if a home directory is known to
23080 the router. In particular, this is the case if &%check_local_user%& is set. If
23081 you want to prevent this happening at routing time, you can set
23082 &%router_home_directory%& empty. This forces the router to pass the relative
23083 path to the transport.
23084
23085 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
23086 the &%file%& or &%directory%& option is still used if it is set.
23087
23088
23089
23090
23091 .section "Private options for appendfile" "SECID134"
23092 .cindex "options" "&(appendfile)& transport"
23093
23094
23095
23096 .option allow_fifo appendfile boolean false
23097 .cindex "fifo (named pipe)"
23098 .cindex "named pipe (fifo)"
23099 .cindex "pipe" "named (fifo)"
23100 Setting this option permits delivery to named pipes (FIFOs) as well as to
23101 regular files. If no process is reading the named pipe at delivery time, the
23102 delivery is deferred.
23103
23104
23105 .option allow_symlink appendfile boolean false
23106 .cindex "symbolic link" "to mailbox"
23107 .cindex "mailbox" "symbolic link"
23108 By default, &(appendfile)& will not deliver if the path name for the file is
23109 that of a symbolic link. Setting this option relaxes that constraint, but there
23110 are security issues involved in the use of symbolic links. Be sure you know
23111 what you are doing if you set this. Details of exactly what this option affects
23112 are included in the discussion which follows this list of options.
23113
23114
23115 .option batch_id appendfile string&!! unset
23116 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23117 However, batching is automatically disabled for &(appendfile)& deliveries that
23118 happen as a result of forwarding or aliasing or other redirection directly to a
23119 file.
23120
23121
23122 .option batch_max appendfile integer 1
23123 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23124
23125
23126 .option check_group appendfile boolean false
23127 When this option is set, the group owner of the file defined by the &%file%&
23128 option is checked to see that it is the same as the group under which the
23129 delivery process is running. The default setting is false because the default
23130 file mode is 0600, which means that the group is irrelevant.
23131
23132
23133 .option check_owner appendfile boolean true
23134 When this option is set, the owner of the file defined by the &%file%& option
23135 is checked to ensure that it is the same as the user under which the delivery
23136 process is running.
23137
23138
23139 .option check_string appendfile string "see below"
23140 .cindex "&""From""& line"
23141 As &(appendfile)& writes the message, the start of each line is tested for
23142 matching &%check_string%&, and if it does, the initial matching characters are
23143 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
23144 a literal string, not a regular expression, and the case of any letters it
23145 contains is significant.
23146
23147 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
23148 are forced to &"."& and &".."& respectively, and any settings in the
23149 configuration are ignored. Otherwise, they default to &"From&~"& and
23150 &">From&~"& when the &%file%& option is set, and unset when any of the
23151 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
23152
23153 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
23154 suitable for traditional &"BSD"& mailboxes, where a line beginning with
23155 &"From&~"& indicates the start of a new message. All four options need changing
23156 if another format is used. For example, to deliver to mailboxes in MMDF format:
23157 .cindex "MMDF format mailbox"
23158 .cindex "mailbox" "MMDF format"
23159 .code
23160 check_string = "\1\1\1\1\n"
23161 escape_string = "\1\1\1\1 \n"
23162 message_prefix = "\1\1\1\1\n"
23163 message_suffix = "\1\1\1\1\n"
23164 .endd
23165 .option create_directory appendfile boolean true
23166 .cindex "directory creation"
23167 When this option is true, Exim attempts to create any missing superior
23168 directories for the file that it is about to write. A created directory's mode
23169 is given by the &%directory_mode%& option.
23170
23171 The group ownership of a newly created directory is highly dependent on the
23172 operating system (and possibly the file system) that is being used. For
23173 example, in Solaris, if the parent directory has the setgid bit set, its group
23174 is propagated to the child; if not, the currently set group is used. However,
23175 in FreeBSD, the parent's group is always used.
23176
23177
23178
23179 .option create_file appendfile string anywhere
23180 This option constrains the location of files and directories that are created
23181 by this transport. It applies to files defined by the &%file%& option and
23182 directories defined by the &%directory%& option. In the case of maildir
23183 delivery, it applies to the top level directory, not the maildir directories
23184 beneath.
23185
23186 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
23187 &"belowhome"&, or to an absolute path.
23188
23189 In the second and third cases, a home directory must have been
23190 set for the transport, and the file or directory being created must
23191 reside within it.
23192 The "belowhome" checking additionally checks for attempts to use "../"
23193 to evade the testing.
23194 This option is not useful when an explicit filename is
23195 given for normal mailbox deliveries. It is intended for the case when filenames
23196 are generated from users' &_.forward_& files. These are usually handled
23197 by an &(appendfile)& transport called &%address_file%&. See also
23198 &%file_must_exist%&.
23199
23200 In the fourth case,
23201 the value given for this option must be an absolute path for an
23202 existing directory.
23203 The value is used for checking instead of a home directory;
23204 checking is done in "belowhome" mode.
23205
23206 .cindex "tainted data" "de-tainting"
23207 If "belowhome" checking is used, the file or directory path
23208 becomes de-tainted.
23209
23210
23211 .option directory appendfile string&!! unset
23212 This option is mutually exclusive with the &%file%& option, but one of &%file%&
23213 or &%directory%& must be set, unless the delivery is the direct result of a
23214 redirection (see section &<<SECTfildiropt>>&).
23215
23216 When &%directory%& is set, the string is expanded, and the message is delivered
23217 into a new file or files in or below the given directory, instead of being
23218 appended to a single mailbox file. A number of different formats are provided
23219 (see &%maildir_format%& and &%mailstore_format%&), and see section
23220 &<<SECTopdir>>& for further details of this form of delivery.
23221
23222 The result of expansion must not be tainted, unless the &%create_file%& option
23223 specifies a path.
23224
23225
23226 .option directory_file appendfile string&!! "see below"
23227 .cindex "base62"
23228 .vindex "&$inode$&"
23229 When &%directory%& is set, but neither &%maildir_format%& nor
23230 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
23231 whose name is obtained by expanding this string. The default value is:
23232 .code
23233 q${base62:$tod_epoch}-$inode
23234 .endd
23235 This generates a unique name from the current time, in base 62 form, and the
23236 inode of the file. The variable &$inode$& is available only when expanding this
23237 option.
23238
23239
23240 .option directory_mode appendfile "octal integer" 0700
23241 If &(appendfile)& creates any directories as a result of the
23242 &%create_directory%& option, their mode is specified by this option.
23243
23244
23245 .option escape_string appendfile string "see description"
23246 See &%check_string%& above.
23247
23248
23249 .option file appendfile string&!! unset
23250 This option is mutually exclusive with the &%directory%& option, but one of
23251 &%file%& or &%directory%& must be set, unless the delivery is the direct result
23252 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
23253 specifies a single file, to which the message is appended. One or more of
23254 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
23255 &%file%&.
23256
23257 The result of expansion must not be tainted, unless the &%create_file%& option
23258 specifies a path.
23259
23260 .cindex "NFS" "lock file"
23261 .cindex "locking files"
23262 .cindex "lock files"
23263 If you are using more than one host to deliver over NFS into the same
23264 mailboxes, you should always use lock files.
23265
23266 The string value is expanded for each delivery, and must yield an absolute
23267 path. The most common settings of this option are variations on one of these
23268 examples:
23269 .code
23270 file = /var/spool/mail/$local_part_data
23271 file = /home/$local_part_data/inbox
23272 file = $home/inbox
23273 .endd
23274 .cindex "&""sticky""& bit"
23275 In the first example, all deliveries are done into the same directory. If Exim
23276 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23277 create a file in the directory, so the &"sticky"& bit must be turned on for
23278 deliveries to be possible, or alternatively the &%group%& option can be used to
23279 run the delivery under a group id which has write access to the directory.
23280
23281
23282
23283 .option file_format appendfile string unset
23284 .cindex "file" "mailbox; checking existing format"
23285 This option requests the transport to check the format of an existing file
23286 before adding to it. The check consists of matching a specific string at the
23287 start of the file. The value of the option consists of an even number of
23288 colon-separated strings. The first of each pair is the test string, and the
23289 second is the name of a transport. If the transport associated with a matched
23290 string is not the current transport, control is passed over to the other
23291 transport. For example, suppose the standard &(local_delivery)& transport has
23292 this added to it:
23293 .code
23294 file_format = "From       : local_delivery :\
23295                \1\1\1\1\n : local_mmdf_delivery"
23296 .endd
23297 Mailboxes that begin with &"From"& are still handled by this transport, but if
23298 a mailbox begins with four binary ones followed by a newline, control is passed
23299 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23300 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23301 is assumed to match the current transport. If the start of a mailbox doesn't
23302 match any string, or if the transport named for a given string is not defined,
23303 delivery is deferred.
23304
23305
23306 .option file_must_exist appendfile boolean false
23307 If this option is true, the file specified by the &%file%& option must exist.
23308 A temporary error occurs if it does not, causing delivery to be deferred.
23309 If this option is false, the file is created if it does not exist.
23310
23311
23312 .option lock_fcntl_timeout appendfile time 0s
23313 .cindex "timeout" "mailbox locking"
23314 .cindex "mailbox" "locking, blocking and non-blocking"
23315 .cindex "locking files"
23316 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23317 when locking an open mailbox file. If the call fails, the delivery process
23318 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23319 Non-blocking calls are used so that the file is not kept open during the wait
23320 for the lock; the reason for this is to make it as safe as possible for
23321 deliveries over NFS in the case when processes might be accessing an NFS
23322 mailbox without using a lock file. This should not be done, but
23323 misunderstandings and hence misconfigurations are not unknown.
23324
23325 On a busy system, however, the performance of a non-blocking lock approach is
23326 not as good as using a blocking lock with a timeout. In this case, the waiting
23327 is done inside the system call, and Exim's delivery process acquires the lock
23328 and can proceed as soon as the previous lock holder releases it.
23329
23330 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23331 timeout, are used. There may still be some retrying: the maximum number of
23332 retries is
23333 .code
23334 (lock_retries * lock_interval) / lock_fcntl_timeout
23335 .endd
23336 rounded up to the next whole number. In other words, the total time during
23337 which &(appendfile)& is trying to get a lock is roughly the same, unless
23338 &%lock_fcntl_timeout%& is set very large.
23339
23340 You should consider setting this option if you are getting a lot of delayed
23341 local deliveries because of errors of the form
23342 .code
23343 failed to lock mailbox /some/file (fcntl)
23344 .endd
23345
23346 .option lock_flock_timeout appendfile time 0s
23347 This timeout applies to file locking when using &[flock()]& (see
23348 &%use_flock%&); the timeout operates in a similar manner to
23349 &%lock_fcntl_timeout%&.
23350
23351
23352 .option lock_interval appendfile time 3s
23353 This specifies the time to wait between attempts to lock the file. See below
23354 for details of locking.
23355
23356
23357 .option lock_retries appendfile integer 10
23358 This specifies the maximum number of attempts to lock the file. A value of zero
23359 is treated as 1. See below for details of locking.
23360
23361
23362 .option lockfile_mode appendfile "octal integer" 0600
23363 This specifies the mode of the created lock file, when a lock file is being
23364 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23365
23366
23367 .option lockfile_timeout appendfile time 30m
23368 .cindex "timeout" "mailbox locking"
23369 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23370 exists and is older than this value, it is assumed to have been left behind by
23371 accident, and Exim attempts to remove it.
23372
23373
23374 .option mailbox_filecount appendfile string&!! unset
23375 .cindex "mailbox" "specifying size of"
23376 .cindex "size" "of mailbox"
23377 If this option is set, it is expanded, and the result is taken as the current
23378 number of files in the mailbox. It must be a decimal number, optionally
23379 followed by K or M. This provides a way of obtaining this information from an
23380 external source that maintains the data.
23381
23382
23383 .option mailbox_size appendfile string&!! unset
23384 .cindex "mailbox" "specifying size of"
23385 .cindex "size" "of mailbox"
23386 If this option is set, it is expanded, and the result is taken as the current
23387 size the mailbox. It must be a decimal number, optionally followed by K or M.
23388 This provides a way of obtaining this information from an external source that
23389 maintains the data. This is likely to be helpful for maildir deliveries where
23390 it is computationally expensive to compute the size of a mailbox.
23391
23392
23393
23394 .option maildir_format appendfile boolean false
23395 .cindex "maildir format" "specifying"
23396 If this option is set with the &%directory%& option, the delivery is into a new
23397 file, in the &"maildir"& format that is used by other mail software. When the
23398 transport is activated directly from a &(redirect)& router (for example, the
23399 &(address_file)& transport in the default configuration), setting
23400 &%maildir_format%& causes the path received from the router to be treated as a
23401 directory, whether or not it ends with &`/`&. This option is available only if
23402 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23403 &<<SECTmaildirdelivery>>& below for further details.
23404
23405
23406 .option maildir_quota_directory_regex appendfile string "See below"
23407 .cindex "maildir format" "quota; directories included in"
23408 .cindex "quota" "maildir; directories included in"
23409 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23410 a regular expression for specifying directories, relative to the quota
23411 directory (see &%quota_directory%&), that should be included in the quota
23412 calculation. The default value is:
23413 .code
23414 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23415 .endd
23416 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23417 (directories whose names begin with a dot). If you want to exclude the
23418 &_Trash_&
23419 folder from the count (as some sites do), you need to change this setting to
23420 .code
23421 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23422 .endd
23423 This uses a negative lookahead in the regular expression to exclude the
23424 directory whose name is &_.Trash_&. When a directory is excluded from quota
23425 calculations, quota processing is bypassed for any messages that are delivered
23426 directly into that directory.
23427
23428
23429 .option maildir_retries appendfile integer 10
23430 This option specifies the number of times to retry when writing a file in
23431 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23432
23433
23434 .option maildir_tag appendfile string&!! unset
23435 This option applies only to deliveries in maildir format, and is described in
23436 section &<<SECTmaildirdelivery>>& below.
23437
23438
23439 .option maildir_use_size_file appendfile&!! boolean false
23440 .cindex "maildir format" "&_maildirsize_& file"
23441 The result of string expansion for this option must be a valid boolean value.
23442 If it is true, it enables support for &_maildirsize_& files. Exim
23443 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23444 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23445 value is zero. See &%maildir_quota_directory_regex%& above and section
23446 &<<SECTmaildirdelivery>>& below for further details.
23447
23448 .option maildirfolder_create_regex appendfile string unset
23449 .cindex "maildir format" "&_maildirfolder_& file"
23450 .cindex "&_maildirfolder_&, creating"
23451 The value of this option is a regular expression. If it is unset, it has no
23452 effect. Otherwise, before a maildir delivery takes place, the pattern is
23453 matched against the name of the maildir directory, that is, the directory
23454 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23455 delivery. If there is a match, Exim checks for the existence of a file called
23456 &_maildirfolder_& in the directory, and creates it if it does not exist.
23457 See section &<<SECTmaildirdelivery>>& for more details.
23458
23459
23460 .option mailstore_format appendfile boolean false
23461 .cindex "mailstore format" "specifying"
23462 If this option is set with the &%directory%& option, the delivery is into two
23463 new files in  &"mailstore"& format. The option is available only if
23464 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23465 below for further details.
23466
23467
23468 .option mailstore_prefix appendfile string&!! unset
23469 This option applies only to deliveries in mailstore format, and is described in
23470 section &<<SECTopdir>>& below.
23471
23472
23473 .option mailstore_suffix appendfile string&!! unset
23474 This option applies only to deliveries in mailstore format, and is described in
23475 section &<<SECTopdir>>& below.
23476
23477
23478 .option mbx_format appendfile boolean false
23479 .cindex "locking files"
23480 .cindex "file" "locking"
23481 .cindex "file" "MBX format"
23482 .cindex "MBX format, specifying"
23483 This option is available only if Exim has been compiled with SUPPORT_MBX
23484 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23485 the message is appended to the mailbox file in MBX format instead of
23486 traditional Unix format. This format is supported by Pine4 and its associated
23487 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23488
23489 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23490 automatically changed by the use of &%mbx_format%&. They should normally be set
23491 empty when using MBX format, so this option almost always appears in this
23492 combination:
23493 .code
23494 mbx_format = true
23495 message_prefix =
23496 message_suffix =
23497 .endd
23498 If none of the locking options are mentioned in the configuration,
23499 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23500 is possible to specify the other kinds of locking with &%mbx_format%&, but
23501 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23502 interworks with &'c-client'&, providing for shared access to the mailbox. It
23503 should not be used if any program that does not use this form of locking is
23504 going to access the mailbox, nor should it be used if the mailbox file is NFS
23505 mounted, because it works only when the mailbox is accessed from a single host.
23506
23507 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23508 the standard version of &'c-client'&, because as long as it has a mailbox open
23509 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23510 append messages to it.
23511
23512
23513 .option message_prefix appendfile string&!! "see below"
23514 .cindex "&""From""& line"
23515 The string specified here is expanded and output at the start of every message.
23516 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23517 in which case it is:
23518 .code
23519 message_prefix = "From ${if def:return_path{$return_path}\
23520   {MAILER-DAEMON}} $tod_bsdinbox\n"
23521 .endd
23522 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23523 &`\n`& to &`\r\n`& in &%message_prefix%&.
23524
23525 .option message_suffix appendfile string&!! "see below"
23526 The string specified here is expanded and output at the end of every message.
23527 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23528 in which case it is a single newline character. The suffix can be suppressed by
23529 setting
23530 .code
23531 message_suffix =
23532 .endd
23533 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23534 &`\n`& to &`\r\n`& in &%message_suffix%&.
23535
23536 .option mode appendfile "octal integer" 0600
23537 If the output file is created, it is given this mode. If it already exists and
23538 has wider permissions, they are reduced to this mode. If it has narrower
23539 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23540 if the delivery is the result of a &%save%& command in a filter file specifying
23541 a particular mode, the mode of the output file is always forced to take that
23542 value, and this option is ignored.
23543
23544
23545 .option mode_fail_narrower appendfile boolean true
23546 This option applies in the case when an existing mailbox file has a narrower
23547 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23548 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23549 continues with the delivery attempt, using the existing mode of the file.
23550
23551
23552 .option notify_comsat appendfile boolean false
23553 If this option is true, the &'comsat'& daemon is notified after every
23554 successful delivery to a user mailbox. This is the daemon that notifies logged
23555 on users about incoming mail.
23556
23557
23558 .option quota appendfile string&!! unset
23559 .cindex "quota" "imposed by Exim"
23560 This option imposes a limit on the size of the file to which Exim is appending,
23561 or to the total space used in the directory tree when the &%directory%& option
23562 is set. In the latter case, computation of the space used is expensive, because
23563 all the files in the directory (and any sub-directories) have to be
23564 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23565 &%maildir_use_size_file%& for ways to avoid this in environments where users
23566 have no shell access to their mailboxes).
23567
23568 As there is no interlock against two simultaneous deliveries into a
23569 multi-file mailbox, it is possible for the quota to be overrun in this case.
23570 For single-file mailboxes, of course, an interlock is a necessity.
23571
23572 A file's size is taken as its &'used'& value. Because of blocking effects, this
23573 may be a lot less than the actual amount of disk space allocated to the file.
23574 If the sizes of a number of files are being added up, the rounding effect can
23575 become quite noticeable, especially on systems that have large block sizes.
23576 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23577 the obvious value which users understand most easily.
23578
23579 The value of the option is expanded, and must then be a numerical value
23580 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23581 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23582 and further option modifiers. If Exim is running on a system with
23583 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23584 be handled.
23585
23586 The option modifier &%no_check%& can be used to force delivery even if the over
23587 quota condition is met. The quota gets updated as usual.
23588
23589 &*Note*&: A value of zero is interpreted as &"no quota"&.
23590
23591 The expansion happens while Exim is running as root, before it changes uid for
23592 the delivery. This means that files that are inaccessible to the end user can
23593 be used to hold quota values that are looked up in the expansion. When delivery
23594 fails because this quota is exceeded, the handling of the error is as for
23595 system quota failures.
23596
23597 By default, Exim's quota checking mimics system quotas, and restricts the
23598 mailbox to the specified maximum size, though the value is not accurate to the
23599 last byte, owing to separator lines and additional headers that may get added
23600 during message delivery. When a mailbox is nearly full, large messages may get
23601 refused even though small ones are accepted, because the size of the current
23602 message is added to the quota when the check is made. This behaviour can be
23603 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23604 for exceeding the quota does not include the current message. Thus, deliveries
23605 continue until the quota has been exceeded; thereafter, no further messages are
23606 delivered. See also &%quota_warn_threshold%&.
23607
23608
23609 .option quota_directory appendfile string&!! unset
23610 This option defines the directory to check for quota purposes when delivering
23611 into individual files. The default is the delivery directory, or, if a file
23612 called &_maildirfolder_& exists in a maildir directory, the parent of the
23613 delivery directory.
23614
23615
23616 .option quota_filecount appendfile string&!! 0
23617 This option applies when the &%directory%& option is set. It limits the total
23618 number of files in the directory (compare the inode limit in system quotas). It
23619 can only be used if &%quota%& is also set. The value is expanded; an expansion
23620 failure causes delivery to be deferred. A value of zero is interpreted as
23621 &"no quota"&.
23622
23623 The option modifier &%no_check%& can be used to force delivery even if the over
23624 quota condition is met. The quota gets updated as usual.
23625
23626 .option quota_is_inclusive appendfile boolean true
23627 See &%quota%& above.
23628
23629
23630 .option quota_size_regex appendfile string unset
23631 This option applies when one of the delivery modes that writes a separate file
23632 for each message is being used. When Exim wants to find the size of one of
23633 these files in order to test the quota, it first checks &%quota_size_regex%&.
23634 If this is set to a regular expression that matches the filename, and it
23635 captures one string, that string is interpreted as a representation of the
23636 file's size. The value of &%quota_size_regex%& is not expanded.
23637
23638 This feature is useful only when users have no shell access to their mailboxes
23639 &-- otherwise they could defeat the quota simply by renaming the files. This
23640 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23641 the file length to the filename. For example:
23642 .code
23643 maildir_tag = ,S=$message_size
23644 quota_size_regex = ,S=(\d+)
23645 .endd
23646 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23647 number of lines in the message.
23648
23649 The regular expression should not assume that the length is at the end of the
23650 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23651 sometimes add other information onto the ends of message filenames.
23652
23653 Section &<<SECID136>>& contains further information.
23654
23655 This option should not be used when other message-handling software
23656 may duplicate messages by making hardlinks to the files.  When that is done Exim
23657 will count the message size once for each filename, in contrast with the actual
23658 disk usage.  When the option is not set, calculating total usage requires
23659 a system-call per file to get the size; the number of links is then available also
23660 as is used to adjust the effective size.
23661
23662
23663 .option quota_warn_message appendfile string&!! "see below"
23664 See below for the use of this option. If it is not set when
23665 &%quota_warn_threshold%& is set, it defaults to
23666 .code
23667 quota_warn_message = "\
23668   To: $local_part@$domain\n\
23669   Subject: Your mailbox\n\n\
23670   This message is automatically created \
23671   by mail delivery software.\n\n\
23672   The size of your mailbox has exceeded \
23673   a warning threshold that is\n\
23674   set by the system administrator.\n"
23675 .endd
23676
23677
23678 .option quota_warn_threshold appendfile string&!! 0
23679 .cindex "quota" "warning threshold"
23680 .cindex "mailbox" "size warning"
23681 .cindex "size" "of mailbox"
23682 This option is expanded in the same way as &%quota%& (see above). If the
23683 resulting value is greater than zero, and delivery of the message causes the
23684 size of the file or total space in the directory tree to cross the given
23685 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23686 may be specified as a percentage of it by following the value with a percent
23687 sign. For example:
23688 .code
23689 quota = 10M
23690 quota_warn_threshold = 75%
23691 .endd
23692 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23693 percent sign is ignored.
23694
23695 The warning message itself is specified by the &%quota_warn_message%& option,
23696 and it must start with a &'To:'& header line containing the recipient(s) of the
23697 warning message. These do not necessarily have to include the recipient(s) of
23698 the original message. A &'Subject:'& line should also normally be supplied. You
23699 can include any other header lines that you want. If you do not include a
23700 &'From:'& line, the default is:
23701 .code
23702 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23703 .endd
23704 .oindex &%errors_reply_to%&
23705 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23706 option.
23707
23708 The &%quota%& option does not have to be set in order to use this option; they
23709 are independent of one another except when the threshold is specified as a
23710 percentage.
23711
23712
23713 .option use_bsmtp appendfile boolean false
23714 .cindex "envelope from"
23715 .cindex "envelope sender"
23716 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23717 format, with the envelope sender and recipient(s) included as SMTP commands. If
23718 you want to include a leading HELO command with such messages, you can do
23719 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23720 for details of batch SMTP.
23721
23722
23723 .option use_crlf appendfile boolean false
23724 .cindex "carriage return"
23725 .cindex "linefeed"
23726 This option causes lines to be terminated with the two-character CRLF sequence
23727 (carriage return, linefeed) instead of just a linefeed character. In the case
23728 of batched SMTP, the byte sequence written to the file is then an exact image
23729 of what would be sent down a real SMTP connection.
23730
23731 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23732 (which are used to supply the traditional &"From&~"& and blank line separators
23733 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23734 carriage return characters if these are needed. In cases where these options
23735 have non-empty defaults, the values end with a single linefeed, so they must be
23736 changed to end with &`\r\n`& if &%use_crlf%& is set.
23737
23738
23739 .option use_fcntl_lock appendfile boolean "see below"
23740 This option controls the use of the &[fcntl()]& function to lock a file for
23741 exclusive use when a message is being appended. It is set by default unless
23742 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23743 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23744 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23745
23746
23747 .option use_flock_lock appendfile boolean false
23748 This option is provided to support the use of &[flock()]& for file locking, for
23749 the few situations where it is needed. Most modern operating systems support
23750 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23751 each other. Exim uses &[fcntl()]& locking by default.
23752
23753 This option is required only if you are using an operating system where
23754 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23755 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23756 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23757
23758 .cindex "Solaris" "&[flock()]& support"
23759 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23760 have it (and some, I think, provide a not quite right version built on top of
23761 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23762 the ability to use it, and any attempt to do so will cause a configuration
23763 error.
23764
23765 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23766 is just being mapped onto &[fcntl()]& by the OS).
23767
23768
23769 .option use_lockfile appendfile boolean "see below"
23770 If this option is turned off, Exim does not attempt to create a lock file when
23771 appending to a mailbox file. In this situation, the only locking is by
23772 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23773 sure that every MUA that is ever going to look at your users' mailboxes uses
23774 &[fcntl()]& rather than a lock file, and even then only when you are not
23775 delivering over NFS from more than one host.
23776
23777 .cindex "NFS" "lock file"
23778 In order to append to an NFS file safely from more than one host, it is
23779 necessary to take out a lock &'before'& opening the file, and the lock file
23780 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23781 file corruption.
23782
23783 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23784 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23785 except when &%mbx_format%& is set.
23786
23787
23788 .option use_mbx_lock appendfile boolean "see below"
23789 This option is available only if Exim has been compiled with SUPPORT_MBX
23790 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23791 locking rules be used. It is set by default if &%mbx_format%& is set and none
23792 of the locking options are mentioned in the configuration. The locking rules
23793 are the same as are used by the &'c-client'& library that underlies Pine and
23794 the IMAP4 and POP daemons that come with it (see the discussion below). The
23795 rules allow for shared access to the mailbox. However, this kind of locking
23796 does not work when the mailbox is NFS mounted.
23797
23798 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23799 &%use_flock_lock%& to control what kind of locking is used in implementing the
23800 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23801 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23802
23803
23804
23805
23806 .section "Operational details for appending" "SECTopappend"
23807 .cindex "appending to a file"
23808 .cindex "file" "appending"
23809 Before appending to a file, the following preparations are made:
23810
23811 .ilist
23812 If the name of the file is &_/dev/null_&, no action is taken, and a success
23813 return is given.
23814
23815 .next
23816 .cindex "directory creation"
23817 If any directories on the file's path are missing, Exim creates them if the
23818 &%create_directory%& option is set. A created directory's mode is given by the
23819 &%directory_mode%& option.
23820
23821 .next
23822 If &%file_format%& is set, the format of an existing file is checked. If this
23823 indicates that a different transport should be used, control is passed to that
23824 transport.
23825
23826 .next
23827 .cindex "file" "locking"
23828 .cindex "locking files"
23829 .cindex "NFS" "lock file"
23830 If &%use_lockfile%& is set, a lock file is built in a way that will work
23831 reliably over NFS, as follows:
23832
23833 .olist
23834 Create a &"hitching post"& file whose name is that of the lock file with the
23835 current time, primary host name, and process id added, by opening for writing
23836 as a new file. If this fails with an access error, delivery is deferred.
23837 .next
23838 Close the hitching post file, and hard link it to the lock filename.
23839 .next
23840 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23841 Unlink the hitching post name.
23842 .next
23843 Otherwise, use &[stat()]& to get information about the hitching post file, and
23844 then unlink hitching post name. If the number of links is exactly two, creation
23845 of the lock file succeeded but something (for example, an NFS server crash and
23846 restart) caused this fact not to be communicated to the &[link()]& call.
23847 .next
23848 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23849 up to &%lock_retries%& times. However, since any program that writes to a
23850 mailbox should complete its task very quickly, it is reasonable to time out old
23851 lock files that are normally the result of user agent and system crashes. If an
23852 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23853 it before trying again.
23854 .endlist olist
23855
23856 .next
23857 A call is made to &[lstat()]& to discover whether the main file exists, and if
23858 so, what its characteristics are. If &[lstat()]& fails for any reason other
23859 than non-existence, delivery is deferred.
23860
23861 .next
23862 .cindex "symbolic link" "to mailbox"
23863 .cindex "mailbox" "symbolic link"
23864 If the file does exist and is a symbolic link, delivery is deferred, unless the
23865 &%allow_symlink%& option is set, in which case the ownership of the link is
23866 checked, and then &[stat()]& is called to find out about the real file, which
23867 is then subjected to the checks below. The check on the top-level link
23868 ownership prevents one user creating a link for another's mailbox in a sticky
23869 directory, though allowing symbolic links in this case is definitely not a good
23870 idea. If there is a chain of symbolic links, the intermediate ones are not
23871 checked.
23872
23873 .next
23874 If the file already exists but is not a regular file, or if the file's owner
23875 and group (if the group is being checked &-- see &%check_group%& above) are
23876 different from the user and group under which the delivery is running,
23877 delivery is deferred.
23878
23879 .next
23880 If the file's permissions are more generous than specified, they are reduced.
23881 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23882 is set false, in which case the delivery is tried using the existing
23883 permissions.
23884
23885 .next
23886 The file's inode number is saved, and the file is then opened for appending.
23887 If this fails because the file has vanished, &(appendfile)& behaves as if it
23888 hadn't existed (see below). For any other failures, delivery is deferred.
23889
23890 .next
23891 If the file is opened successfully, check that the inode number hasn't
23892 changed, that it is still a regular file, and that the owner and permissions
23893 have not changed. If anything is wrong, defer delivery and freeze the message.
23894
23895 .next
23896 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23897 option is set. Otherwise, check that the file is being created in a permitted
23898 directory if the &%create_file%& option is set (deferring on failure), and then
23899 open for writing as a new file, with the O_EXCL and O_CREAT options,
23900 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23901 set). In this case, which can happen if the link points to a non-existent file,
23902 the file is opened for writing using O_CREAT but not O_EXCL, because
23903 that prevents link following.
23904
23905 .next
23906 .cindex "loop" "while file testing"
23907 If opening fails because the file exists, obey the tests given above for
23908 existing files. However, to avoid looping in a situation where the file is
23909 being continuously created and destroyed, the exists/not-exists loop is broken
23910 after 10 repetitions, and the message is then frozen.
23911
23912 .next
23913 If opening fails with any other error, defer delivery.
23914
23915 .next
23916 .cindex "file" "locking"
23917 .cindex "locking files"
23918 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23919 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23920 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23921 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23922 file, and an exclusive lock on the file whose name is
23923 .code
23924 /tmp/.<device-number>.<inode-number>
23925 .endd
23926 using the device and inode numbers of the open mailbox file, in accordance with
23927 the MBX locking rules. This file is created with a mode that is specified by
23928 the &%lockfile_mode%& option.
23929
23930 If Exim fails to lock the file, there are two possible courses of action,
23931 depending on the value of the locking timeout. This is obtained from
23932 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23933
23934 If the timeout value is zero, the file is closed, Exim waits for
23935 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23936 to lock it again. This happens up to &%lock_retries%& times, after which the
23937 delivery is deferred.
23938
23939 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23940 &[flock()]& are used (with the given timeout), so there has already been some
23941 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23942 immediately. It retries up to
23943 .code
23944 (lock_retries * lock_interval) / <timeout>
23945 .endd
23946 times (rounded up).
23947 .endlist
23948
23949 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23950 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23951
23952
23953 .section "Operational details for delivery to a new file" "SECTopdir"
23954 .cindex "delivery" "to single file"
23955 .cindex "&""From""& line"
23956 When the &%directory%& option is set instead of &%file%&, each message is
23957 delivered into a newly-created file or set of files. When &(appendfile)& is
23958 activated directly from a &(redirect)& router, neither &%file%& nor
23959 &%directory%& is normally set, because the path for delivery is supplied by the
23960 router. (See for example, the &(address_file)& transport in the default
23961 configuration.) In this case, delivery is to a new file if either the path name
23962 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23963
23964 No locking is required while writing the message to a new file, so the various
23965 locking options of the transport are ignored. The &"From"& line that by default
23966 separates messages in a single file is not normally needed, nor is the escaping
23967 of message lines that start with &"From"&, and there is no need to ensure a
23968 newline at the end of each message. Consequently, the default values for
23969 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23970 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23971
23972 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23973 the files in the delivery directory by default. However, you can specify a
23974 different directory by setting &%quota_directory%&. Also, for maildir
23975 deliveries (see below) the &_maildirfolder_& convention is honoured.
23976
23977
23978 .cindex "maildir format"
23979 .cindex "mailstore format"
23980 There are three different ways in which delivery to individual files can be
23981 done, controlled by the settings of the &%maildir_format%& and
23982 &%mailstore_format%& options. Note that code to support maildir or mailstore
23983 formats is not included in the binary unless SUPPORT_MAILDIR or
23984 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23985
23986 .cindex "directory creation"
23987 In all three cases an attempt is made to create the directory and any necessary
23988 sub-directories if they do not exist, provided that the &%create_directory%&
23989 option is set (the default). The location of a created directory can be
23990 constrained by setting &%create_file%&. A created directory's mode is given by
23991 the &%directory_mode%& option. If creation fails, or if the
23992 &%create_directory%& option is not set when creation is required, delivery is
23993 deferred.
23994
23995
23996
23997 .section "Maildir delivery" "SECTmaildirdelivery"
23998 .cindex "maildir format" "description of"
23999 If the &%maildir_format%& option is true, Exim delivers each message by writing
24000 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
24001 directory that is defined by the &%directory%& option (the &"delivery
24002 directory"&). If the delivery is successful, the file is renamed into the
24003 &_new_& subdirectory.
24004
24005 In the filename, <&'stime'&> is the current time of day in seconds, and
24006 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
24007 Exim checks that the time-of-day clock has moved on by at least one microsecond
24008 before terminating the delivery process. This guarantees uniqueness for the
24009 filename. However, as a precaution, Exim calls &[stat()]& for the file before
24010 opening it. If any response other than ENOENT (does not exist) is given,
24011 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
24012
24013 Before Exim carries out a maildir delivery, it ensures that subdirectories
24014 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
24015 do not exist, Exim tries to create them and any superior directories in their
24016 path, subject to the &%create_directory%& and &%create_file%& options. If the
24017 &%maildirfolder_create_regex%& option is set, and the regular expression it
24018 contains matches the delivery directory, Exim also ensures that a file called
24019 &_maildirfolder_& exists in the delivery directory. If a missing directory or
24020 &_maildirfolder_& file cannot be created, delivery is deferred.
24021
24022 These features make it possible to use Exim to create all the necessary files
24023 and directories in a maildir mailbox, including subdirectories for maildir++
24024 folders. Consider this example:
24025 .code
24026 maildir_format = true
24027 directory = /var/mail/$local_part_data\
24028            ${if eq{$local_part_suffix}{}{}\
24029            {/.${substr_1:$local_part_suffix}}}
24030 maildirfolder_create_regex = /\.[^/]+$
24031 .endd
24032 If &$local_part_suffix$& is empty (there was no suffix for the local part),
24033 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
24034 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
24035 not match this name, so Exim will not look for or create the file
24036 &_/var/mail/pimbo/maildirfolder_&, though it will create
24037 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
24038
24039 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
24040 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
24041 does match &%maildirfolder_create_regex%&. In this case, Exim will create
24042 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
24043 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
24044
24045 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
24046 not inadvertently match the toplevel maildir directory, because a
24047 &_maildirfolder_& file at top level would completely break quota calculations.
24048
24049 .cindex "quota" "in maildir delivery"
24050 .cindex "maildir++"
24051 If Exim is required to check a &%quota%& setting before a maildir delivery, and
24052 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
24053 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
24054 Exim assumes the directory is a maildir++ folder directory, which is one level
24055 down from the user's top level mailbox directory. This causes it to start at
24056 the parent directory instead of the current directory when calculating the
24057 amount of space used.
24058
24059 One problem with delivering into a multi-file mailbox is that it is
24060 computationally expensive to compute the size of the mailbox for quota
24061 checking. Various approaches have been taken to reduce the amount of work
24062 needed. The next two sections describe two of them. A third alternative is to
24063 use some external process for maintaining the size data, and use the expansion
24064 of the &%mailbox_size%& option as a way of importing it into Exim.
24065
24066
24067
24068
24069 .section "Using tags to record message sizes" "SECID135"
24070 If &%maildir_tag%& is set, the string is expanded for each delivery.
24071 When the maildir file is renamed into the &_new_& sub-directory, the
24072 tag is added to its name. However, if adding the tag takes the length of the
24073 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
24074 the tag is dropped and the maildir file is created with no tag.
24075
24076
24077 .vindex "&$message_size$&"
24078 Tags can be used to encode the size of files in their names; see
24079 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
24080 happens after the message has been written. The value of the &$message_size$&
24081 variable is set to the number of bytes actually written. If the expansion is
24082 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
24083 be deferred. The expanded tag may contain any printing characters except &"/"&.
24084 Non-printing characters in the string are ignored; if the resulting string is
24085 empty, it is ignored. If it starts with an alphanumeric character, a leading
24086 colon is inserted; this default has not proven to be the path that popular
24087 maildir implementations have chosen (but changing it in Exim would break
24088 backwards compatibility).
24089
24090 For one common implementation, you might set:
24091 .code
24092 maildir_tag = ,S=${message_size}
24093 .endd
24094 but you should check the documentation of the other software to be sure.
24095
24096 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
24097 as this allows Exim to extract the size from your tag, instead of having to
24098 &[stat()]& each message file.
24099
24100
24101 .section "Using a maildirsize file" "SECID136"
24102 .cindex "quota" "in maildir delivery"
24103 .cindex "maildir format" "&_maildirsize_& file"
24104 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
24105 storing quota and message size information in a file called &_maildirsize_&
24106 within the toplevel maildir directory. If this file does not exist, Exim
24107 creates it, setting the quota from the &%quota%& option of the transport. If
24108 the maildir directory itself does not exist, it is created before any attempt
24109 to write a &_maildirsize_& file.
24110
24111 The &_maildirsize_& file is used to hold information about the sizes of
24112 messages in the maildir, thus speeding up quota calculations. The quota value
24113 in the file is just a cache; if the quota is changed in the transport, the new
24114 value overrides the cached value when the next message is delivered. The cache
24115 is maintained for the benefit of other programs that access the maildir and
24116 need to know the quota.
24117
24118 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
24119 file is maintained (with a zero quota setting), but no quota is imposed.
24120
24121 A regular expression is available for controlling which directories in the
24122 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
24123 See the description of the &%maildir_quota_directory_regex%& option above for
24124 details.
24125
24126
24127 .section "Mailstore delivery" "SECID137"
24128 .cindex "mailstore format" "description of"
24129 If the &%mailstore_format%& option is true, each message is written as two
24130 files in the given directory. A unique base name is constructed from the
24131 message id and the current delivery process, and the files that are written use
24132 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
24133 contains the message's envelope, and the &_.msg_& file contains the message
24134 itself. The base name is placed in the variable &$mailstore_basename$&.
24135
24136 During delivery, the envelope is first written to a file with the suffix
24137 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
24138 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
24139 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
24140 file before accessing either of them. An alternative approach is to wait for
24141 the absence of a &_.tmp_& file.
24142
24143 The envelope file starts with any text defined by the &%mailstore_prefix%&
24144 option, expanded and terminated by a newline if there isn't one. Then follows
24145 the sender address on one line, then all the recipient addresses, one per line.
24146 There can be more than one recipient only if the &%batch_max%& option is set
24147 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
24148 appended to the file, followed by a newline if it does not end with one.
24149
24150 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
24151 failure, it is ignored. Other expansion errors are treated as serious
24152 configuration errors, and delivery is deferred. The variable
24153 &$mailstore_basename$& is available for use during these expansions.
24154
24155
24156 .section "Non-special new file delivery" "SECID138"
24157 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
24158 file is created directly in the named directory. For example, when delivering
24159 messages into files in batched SMTP format for later delivery to some host (see
24160 section &<<SECTbatchSMTP>>&), a setting such as
24161 .code
24162 directory = /var/bsmtp/$host
24163 .endd
24164 might be used. A message is written to a file with a temporary name, which is
24165 then renamed when the delivery is complete. The final name is obtained by
24166 expanding the contents of the &%directory_file%& option.
24167 .ecindex IIDapptra1
24168 .ecindex IIDapptra2
24169
24170
24171
24172
24173
24174
24175 . ////////////////////////////////////////////////////////////////////////////
24176 . ////////////////////////////////////////////////////////////////////////////
24177
24178 .chapter "The autoreply transport" "CHID8"
24179 .scindex IIDauttra1 "transports" "&(autoreply)&"
24180 .scindex IIDauttra2 "&(autoreply)& transport"
24181 The &(autoreply)& transport is not a true transport in that it does not cause
24182 the message to be transmitted. Instead, it generates a new mail message as an
24183 automatic reply to the incoming message. &'References:'& and
24184 &'Auto-Submitted:'& header lines are included. These are constructed according
24185 to the rules in RFCs 2822 and 3834, respectively.
24186
24187 If the router that passes the message to this transport does not have the
24188 &%unseen%& option set, the original message (for the current recipient) is not
24189 delivered anywhere. However, when the &%unseen%& option is set on the router
24190 that passes the message to this transport, routing of the address continues, so
24191 another router can set up a normal message delivery.
24192
24193
24194 The &(autoreply)& transport is usually run as the result of mail filtering, a
24195 &"vacation"& message being the standard example. However, it can also be run
24196 directly from a router like any other transport. To reduce the possibility of
24197 message cascades, messages created by the &(autoreply)& transport always have
24198 empty envelope sender addresses, like bounce messages.
24199
24200 The parameters of the message to be sent can be specified in the configuration
24201 by options described below. However, these are used only when the address
24202 passed to the transport does not contain its own reply information. When the
24203 transport is run as a consequence of a
24204 &%mail%&
24205 or &%vacation%& command in a filter file, the parameters of the message are
24206 supplied by the filter, and passed with the address. The transport's options
24207 that define the message are then ignored (so they are not usually set in this
24208 case). The message is specified entirely by the filter or by the transport; it
24209 is never built from a mixture of options. However, the &%file_optional%&,
24210 &%mode%&, and &%return_message%& options apply in all cases.
24211
24212 &(Autoreply)& is implemented as a local transport. When used as a result of a
24213 command in a user's filter file, &(autoreply)& normally runs under the uid and
24214 gid of the user, and with appropriate current and home directories (see chapter
24215 &<<CHAPenvironment>>&).
24216
24217 There is a subtle difference between routing a message to a &(pipe)& transport
24218 that generates some text to be returned to the sender, and routing it to an
24219 &(autoreply)& transport. This difference is noticeable only if more than one
24220 address from the same message is so handled. In the case of a pipe, the
24221 separate outputs from the different addresses are gathered up and returned to
24222 the sender in a single message, whereas if &(autoreply)& is used, a separate
24223 message is generated for each address that is passed to it.
24224
24225 Non-printing characters are not permitted in the header lines generated for the
24226 message that &(autoreply)& creates, with the exception of newlines that are
24227 immediately followed by white space. If any non-printing characters are found,
24228 the transport defers.
24229 Whether characters with the top bit set count as printing characters or not is
24230 controlled by the &%print_topbitchars%& global option.
24231
24232 If any of the generic options for manipulating headers (for example,
24233 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
24234 of the original message that is included in the generated message when
24235 &%return_message%& is set. They do not apply to the generated message itself.
24236
24237 .vindex "&$sender_address$&"
24238 If the &(autoreply)& transport receives return code 2 from Exim when it submits
24239 the message, indicating that there were no recipients, it does not treat this
24240 as an error. This means that autoreplies sent to &$sender_address$& when this
24241 is empty (because the incoming message is a bounce message) do not cause
24242 problems. They are just discarded.
24243
24244
24245
24246 .section "Private options for autoreply" "SECID139"
24247 .cindex "options" "&(autoreply)& transport"
24248
24249 .option bcc autoreply string&!! unset
24250 This specifies the addresses that are to receive &"blind carbon copies"& of the
24251 message when the message is specified by the transport.
24252
24253
24254 .option cc autoreply string&!! unset
24255 This specifies recipients of the message and the contents of the &'Cc:'& header
24256 when the message is specified by the transport.
24257
24258
24259 .option file autoreply string&!! unset
24260 The contents of the file are sent as the body of the message when the message
24261 is specified by the transport. If both &%file%& and &%text%& are set, the text
24262 string comes first.
24263
24264
24265 .option file_expand autoreply boolean false
24266 If this is set, the contents of the file named by the &%file%& option are
24267 subjected to string expansion as they are added to the message.
24268
24269
24270 .option file_optional autoreply boolean false
24271 If this option is true, no error is generated if the file named by the &%file%&
24272 option or passed with the address does not exist or cannot be read.
24273
24274
24275 .option from autoreply string&!! unset
24276 This specifies the contents of the &'From:'& header when the message is
24277 specified by the transport.
24278
24279
24280 .option headers autoreply string&!! unset
24281 This specifies additional RFC 2822 headers that are to be added to the message
24282 when the message is specified by the transport. Several can be given by using
24283 &"\n"& to separate them. There is no check on the format.
24284
24285
24286 .option log autoreply string&!! unset
24287 This option names a file in which a record of every message sent is logged when
24288 the message is specified by the transport.
24289
24290
24291 .option mode autoreply "octal integer" 0600
24292 If either the log file or the &"once"& file has to be created, this mode is
24293 used.
24294
24295
24296 .option never_mail autoreply "address list&!!" unset
24297 If any run of the transport creates a message with a recipient that matches any
24298 item in the list, that recipient is quietly discarded. If all recipients are
24299 discarded, no message is created. This applies both when the recipients are
24300 generated by a filter and when they are specified in the transport.
24301
24302
24303
24304 .option once autoreply string&!! unset
24305 This option names a file or DBM database in which a record of each &'To:'&
24306 recipient is kept when the message is specified by the transport. &*Note*&:
24307 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24308
24309 If &%once%& is unset, or is set to an empty string, the message is always sent.
24310 By default, if &%once%& is set to a non-empty filename, the message
24311 is not sent if a potential recipient is already listed in the database.
24312 However, if the &%once_repeat%& option specifies a time greater than zero, the
24313 message is sent if that much time has elapsed since a message was last sent to
24314 this recipient. A setting of zero time for &%once_repeat%& (the default)
24315 prevents a message from being sent a second time &-- in this case, zero means
24316 infinity.
24317
24318 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24319 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24320 greater than zero, it changes the way Exim implements the &%once%& option.
24321 Instead of using a DBM file to record every recipient it sends to, it uses a
24322 regular file, whose size will never get larger than the given value.
24323
24324 In the file, Exim keeps a linear list of recipient addresses and the times at
24325 which they were sent messages. If the file is full when a new address needs to
24326 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24327 means that a given recipient may receive multiple messages, but at
24328 unpredictable intervals that depend on the rate of turnover of addresses in the
24329 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24330
24331
24332 .option once_file_size autoreply integer 0
24333 See &%once%& above.
24334
24335
24336 .option once_repeat autoreply time&!! 0s
24337 See &%once%& above.
24338 After expansion, the value of this option must be a valid time value.
24339
24340
24341 .option reply_to autoreply string&!! unset
24342 This specifies the contents of the &'Reply-To:'& header when the message is
24343 specified by the transport.
24344
24345
24346 .option return_message autoreply boolean false
24347 If this is set, a copy of the original message is returned with the new
24348 message, subject to the maximum size set in the &%return_size_limit%& global
24349 configuration option.
24350
24351
24352 .option subject autoreply string&!! unset
24353 This specifies the contents of the &'Subject:'& header when the message is
24354 specified by the transport. It is tempting to quote the original subject in
24355 automatic responses. For example:
24356 .code
24357 subject = Re: $h_subject:
24358 .endd
24359 There is a danger in doing this, however. It may allow a third party to
24360 subscribe your users to an opt-in mailing list, provided that the list accepts
24361 bounce messages as subscription confirmations. Well-managed lists require a
24362 non-bounce message to confirm a subscription, so the danger is relatively
24363 small.
24364
24365
24366
24367 .option text autoreply string&!! unset
24368 This specifies a single string to be used as the body of the message when the
24369 message is specified by the transport. If both &%text%& and &%file%& are set,
24370 the text comes first.
24371
24372
24373 .option to autoreply string&!! unset
24374 This specifies recipients of the message and the contents of the &'To:'& header
24375 when the message is specified by the transport.
24376 .ecindex IIDauttra1
24377 .ecindex IIDauttra2
24378
24379
24380
24381
24382 . ////////////////////////////////////////////////////////////////////////////
24383 . ////////////////////////////////////////////////////////////////////////////
24384
24385 .chapter "The lmtp transport" "CHAPLMTP"
24386 .cindex "transports" "&(lmtp)&"
24387 .cindex "&(lmtp)& transport"
24388 .cindex "LMTP" "over a pipe"
24389 .cindex "LMTP" "over a socket"
24390 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24391 specified command
24392 or by interacting with a Unix domain socket.
24393 This transport is something of a cross between the &(pipe)& and &(smtp)&
24394 transports. Exim also has support for using LMTP over TCP/IP; this is
24395 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24396 to be of minority interest, the default build-time configure in &_src/EDITME_&
24397 has it commented out. You need to ensure that
24398 .code
24399 TRANSPORT_LMTP=yes
24400 .endd
24401 .cindex "options" "&(lmtp)& transport"
24402 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24403 included in the Exim binary. The private options of the &(lmtp)& transport are
24404 as follows:
24405
24406 .option batch_id lmtp string&!! unset
24407 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24408
24409
24410 .option batch_max lmtp integer 1
24411 This limits the number of addresses that can be handled in a single delivery.
24412 Most LMTP servers can handle several addresses at once, so it is normally a
24413 good idea to increase this value. See the description of local delivery
24414 batching in chapter &<<CHAPbatching>>&.
24415
24416
24417 .option command lmtp string&!! unset
24418 This option must be set if &%socket%& is not set. The string is a command which
24419 is run in a separate process. It is split up into a command name and list of
24420 arguments, each of which is separately expanded (so expansion cannot change the
24421 number of arguments). The command is run directly, not via a shell. The message
24422 is passed to the new process using the standard input and output to operate the
24423 LMTP protocol.
24424
24425 .option ignore_quota lmtp boolean false
24426 .cindex "LMTP" "ignoring quota errors"
24427 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24428 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24429 in its response to the LHLO command.
24430
24431 .option socket lmtp string&!! unset
24432 This option must be set if &%command%& is not set. The result of expansion must
24433 be the name of a Unix domain socket. The transport connects to the socket and
24434 delivers the message to it using the LMTP protocol.
24435
24436
24437 .option timeout lmtp time 5m
24438 The transport is aborted if the created process or Unix domain socket does not
24439 respond to LMTP commands or message input within this timeout. Delivery
24440 is deferred, and will be tried again later. Here is an example of a typical
24441 LMTP transport:
24442 .code
24443 lmtp:
24444   driver = lmtp
24445   command = /some/local/lmtp/delivery/program
24446   batch_max = 20
24447   user = exim
24448 .endd
24449 This delivers up to 20 addresses at a time, in a mixture of domains if
24450 necessary, running as the user &'exim'&.
24451
24452
24453
24454 . ////////////////////////////////////////////////////////////////////////////
24455 . ////////////////////////////////////////////////////////////////////////////
24456
24457 .chapter "The pipe transport" "CHAPpipetransport"
24458 .scindex IIDpiptra1 "transports" "&(pipe)&"
24459 .scindex IIDpiptra2 "&(pipe)& transport"
24460 The &(pipe)& transport is used to deliver messages via a pipe to a command
24461 running in another process. One example is the use of &(pipe)& as a
24462 pseudo-remote transport for passing messages to some other delivery mechanism
24463 (such as UUCP). Another is the use by individual users to automatically process
24464 their incoming messages. The &(pipe)& transport can be used in one of the
24465 following ways:
24466
24467 .ilist
24468 .vindex "&$local_part$&"
24469 A router routes one address to a transport in the normal way, and the
24470 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24471 contains the local part of the address (as usual), and the command that is run
24472 is specified by the &%command%& option on the transport.
24473 .next
24474 .vindex "&$pipe_addresses$&"
24475 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24476 transport can handle more than one address in a single run. In this case, when
24477 more than one address is routed to the transport, &$local_part$& is not set
24478 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24479 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24480 that are routed to the transport.
24481 .next
24482 .vindex "&$address_pipe$&"
24483 A router redirects an address directly to a pipe command (for example, from an
24484 alias or forward file). In this case, &$address_pipe$& contains the text of the
24485 pipe command, and the &%command%& option on the transport is ignored unless
24486 &%force_command%& is set. If only one address is being transported
24487 (&%batch_max%& is not greater than one, or only one address was redirected to
24488 this pipe command), &$local_part$& contains the local part that was redirected.
24489 .endlist
24490
24491
24492 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24493 deliver messages over pipes using the LMTP interactive protocol. This is
24494 implemented by the &(lmtp)& transport.
24495
24496 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24497 &_.forward_& file, the command runs under the uid and gid of that user. In
24498 other cases, the uid and gid have to be specified explicitly, either on the
24499 transport or on the router that handles the address. Current and &"home"&
24500 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24501 details of the local delivery environment and chapter &<<CHAPbatching>>&
24502 for a discussion of local delivery batching.
24503
24504 .cindex "tainted data" "in pipe command"
24505 .cindex pipe "tainted data"
24506 Tainted data may not be used for the command name.
24507
24508
24509 .section "Concurrent delivery" "SECID140"
24510 If two messages arrive at almost the same time, and both are routed to a pipe
24511 delivery, the two pipe transports may be run concurrently. You must ensure that
24512 any pipe commands you set up are robust against this happening. If the commands
24513 write to a file, the &%exim_lock%& utility might be of use.
24514 Alternatively the &%max_parallel%& option could be used with a value
24515 of "1" to enforce serialization.
24516
24517
24518
24519
24520 .section "Returned status and data" "SECID141"
24521 .cindex "&(pipe)& transport" "returned data"
24522 If the command exits with a non-zero return code, the delivery is deemed to
24523 have failed, unless either the &%ignore_status%& option is set (in which case
24524 the return code is treated as zero), or the return code is one of those listed
24525 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24526 later"&. In this case, delivery is deferred. Details of a permanent failure are
24527 logged, but are not included in the bounce message, which merely contains
24528 &"local delivery failed"&.
24529
24530 If the command exits on a signal and the &%freeze_signal%& option is set then
24531 the message will be frozen in the queue. If that option is not set, a bounce
24532 will be sent as normal.
24533
24534 If the return code is greater than 128 and the command being run is a shell
24535 script, it normally means that the script was terminated by a signal whose
24536 value is the return code minus 128. The &%freeze_signal%& option does not
24537 apply in this case.
24538
24539 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24540 return code is set to 127. This is the value that a shell returns if it is
24541 asked to run a non-existent command. The wording for the log line suggests that
24542 a non-existent command may be the problem.
24543
24544 The &%return_output%& option can affect the result of a pipe delivery. If it is
24545 set and the command produces any output on its standard output or standard
24546 error streams, the command is considered to have failed, even if it gave a zero
24547 return code or if &%ignore_status%& is set. The output from the command is
24548 included as part of the bounce message. The &%return_fail_output%& option is
24549 similar, except that output is returned only when the command exits with a
24550 failure return code, that is, a value other than zero or a code that matches
24551 &%temp_errors%&.
24552
24553
24554
24555 .section "How the command is run" "SECThowcommandrun"
24556 .cindex "&(pipe)& transport" "path for command"
24557 The command line is (by default) broken down into a command name and arguments
24558 by the &(pipe)& transport itself. The &%allow_commands%& and
24559 &%restrict_to_path%& options can be used to restrict the commands that may be
24560 run.
24561
24562 .cindex "quoting" "in pipe command"
24563 Unquoted arguments are delimited by white space. If an argument appears in
24564 double quotes, backslash is interpreted as an escape character in the usual
24565 way. If an argument appears in single quotes, no escaping is done.
24566
24567 String expansion is applied to the command line except when it comes from a
24568 traditional &_.forward_& file (commands from a filter file are expanded). The
24569 expansion is applied to each argument in turn rather than to the whole line.
24570 For this reason, any string expansion item that contains white space must be
24571 quoted so as to be contained within a single argument. A setting such as
24572 .code
24573 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24574 .endd
24575 will not work, because the expansion item gets split between several
24576 arguments. You have to write
24577 .code
24578 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24579 .endd
24580 to ensure that it is all in one argument. The expansion is done in this way,
24581 argument by argument, so that the number of arguments cannot be changed as a
24582 result of expansion, and quotes or backslashes in inserted variables do not
24583 interact with external quoting. However, this leads to problems if you want to
24584 generate multiple arguments (or the command name plus arguments) from a single
24585 expansion. In this situation, the simplest solution is to use a shell. For
24586 example:
24587 .code
24588 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24589 .endd
24590
24591 .cindex "transport" "filter"
24592 .cindex "filter" "transport filter"
24593 .vindex "&$pipe_addresses$&"
24594 Special handling takes place when an argument consists of precisely the text
24595 &`$pipe_addresses`& (no quotes).
24596 This is not a general expansion variable; the only
24597 place this string is recognized is when it appears as an argument for a pipe or
24598 transport filter command. It causes each address that is being handled to be
24599 inserted in the argument list at that point &'as a separate argument'&. This
24600 avoids any problems with spaces or shell metacharacters, and is of use when a
24601 &(pipe)& transport is handling groups of addresses in a batch.
24602
24603 If &%force_command%& is enabled on the transport, special handling takes place
24604 for an argument that consists of precisely the text &`$address_pipe`&.  It
24605 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24606 argument is inserted in the argument list at that point
24607 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24608 the only item in the argument; in fact, if it were then &%force_command%&
24609 should behave as a no-op.  Rather, it should be used to adjust the command
24610 run while preserving the argument vector separation.
24611
24612 After splitting up into arguments and expansion, the resulting command is run
24613 in a subprocess directly from the transport, &'not'& under a shell. The
24614 message that is being delivered is supplied on the standard input, and the
24615 standard output and standard error are both connected to a single pipe that is
24616 read by Exim. The &%max_output%& option controls how much output the command
24617 may produce, and the &%return_output%& and &%return_fail_output%& options
24618 control what is done with it.
24619
24620 Not running the command under a shell (by default) lessens the security risks
24621 in cases when a command from a user's filter file is built out of data that was
24622 taken from an incoming message. If a shell is required, it can of course be
24623 explicitly specified as the command to be run. However, there are circumstances
24624 where existing commands (for example, in &_.forward_& files) expect to be run
24625 under a shell and cannot easily be modified. To allow for these cases, there is
24626 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24627 works. Instead of breaking up the command line as just described, it expands it
24628 as a single string and passes the result to &_/bin/sh_&. The
24629 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24630 with &%use_shell%&, and the whole mechanism is inherently less secure.
24631
24632
24633
24634 .section "Environment variables" "SECTpipeenv"
24635 .cindex "&(pipe)& transport" "environment for command"
24636 .cindex "environment" "&(pipe)& transport"
24637 The environment variables listed below are set up when the command is invoked.
24638 This list is a compromise for maximum compatibility with other MTAs. Note that
24639 the &%environment%& option can be used to add additional variables to this
24640 environment. The environment for the &(pipe)& transport is not subject
24641 to the &%add_environment%& and &%keep_environment%& main config options.
24642 .display
24643 &`DOMAIN            `&   the domain of the address
24644 &`HOME              `&   the home directory, if set
24645 &`HOST              `&   the host name when called from a router (see below)
24646 &`LOCAL_PART        `&   see below
24647 &`LOCAL_PART_PREFIX `&   see below
24648 &`LOCAL_PART_SUFFIX `&   see below
24649 &`LOGNAME           `&   see below
24650 &`MESSAGE_ID        `&   Exim's local ID for the message
24651 &`PATH              `&   as specified by the &%path%& option below
24652 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24653 &`RECIPIENT         `&   the complete recipient address
24654 &`SENDER            `&   the sender of the message (empty if a bounce)
24655 &`SHELL             `&   &`/bin/sh`&
24656 &`TZ                `&   the value of the &%timezone%& option, if set
24657 &`USER              `&   see below
24658 .endd
24659 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24660 router, LOCAL_PART is set to the local part of the address. When it is
24661 called as a result of a forward or alias expansion, LOCAL_PART is set to
24662 the local part of the address that was expanded. In both cases, any affixes are
24663 removed from the local part, and made available in LOCAL_PART_PREFIX and
24664 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24665 same value as LOCAL_PART for compatibility with other MTAs.
24666
24667 .cindex "HOST"
24668 HOST is set only when a &(pipe)& transport is called from a router that
24669 associates hosts with an address, typically when using &(pipe)& as a
24670 pseudo-remote transport. HOST is set to the first host name specified by
24671 the router.
24672
24673 .cindex "HOME"
24674 If the transport's generic &%home_directory%& option is set, its value is used
24675 for the HOME environment variable. Otherwise, a home directory may be set
24676 by the router's &%transport_home_directory%& option, which defaults to the
24677 user's home directory if &%check_local_user%& is set.
24678
24679
24680 .section "Private options for pipe" "SECID142"
24681 .cindex "options" "&(pipe)& transport"
24682
24683
24684
24685 .option allow_commands pipe "string list&!!" unset
24686 .cindex "&(pipe)& transport" "permitted commands"
24687 The string is expanded, and is then interpreted as a colon-separated list of
24688 permitted commands. If &%restrict_to_path%& is not set, the only commands
24689 permitted are those in the &%allow_commands%& list. They need not be absolute
24690 paths; the &%path%& option is still used for relative paths. If
24691 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24692 in the &%allow_commands%& list, or a name without any slashes that is found on
24693 the path. In other words, if neither &%allow_commands%& nor
24694 &%restrict_to_path%& is set, there is no restriction on the command, but
24695 otherwise only commands that are permitted by one or the other are allowed. For
24696 example, if
24697 .code
24698 allow_commands = /usr/bin/vacation
24699 .endd
24700 and &%restrict_to_path%& is not set, the only permitted command is
24701 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24702 &%use_shell%& is set.
24703
24704
24705 .option batch_id pipe string&!! unset
24706 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24707
24708
24709 .option batch_max pipe integer 1
24710 This limits the number of addresses that can be handled in a single delivery.
24711 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24712
24713
24714 .option check_string pipe string unset
24715 As &(pipe)& writes the message, the start of each line is tested for matching
24716 &%check_string%&, and if it does, the initial matching characters are replaced
24717 by the contents of &%escape_string%&, provided both are set. The value of
24718 &%check_string%& is a literal string, not a regular expression, and the case of
24719 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24720 of &%check_string%& and &%escape_string%& are forced to values that implement
24721 the SMTP escaping protocol. Any settings made in the configuration file are
24722 ignored.
24723
24724
24725 .option command pipe string&!! unset
24726 This option need not be set when &(pipe)& is being used to deliver to pipes
24727 obtained directly from address redirections. In other cases, the option must be
24728 set, to provide a command to be run. It need not yield an absolute path (see
24729 the &%path%& option below). The command is split up into separate arguments by
24730 Exim, and each argument is separately expanded, as described in section
24731 &<<SECThowcommandrun>>& above.
24732
24733
24734 .option environment pipe string&!! unset
24735 .cindex "&(pipe)& transport" "environment for command"
24736 .cindex "environment" "&(pipe)& transport"
24737 This option is used to add additional variables to the environment in which the
24738 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24739 a string which is expanded, and then interpreted as a colon-separated list of
24740 environment settings of the form <&'name'&>=<&'value'&>.
24741
24742
24743 .option escape_string pipe string unset
24744 See &%check_string%& above.
24745
24746
24747 .option freeze_exec_fail pipe boolean false
24748 .cindex "exec failure"
24749 .cindex "failure of exec"
24750 .cindex "&(pipe)& transport" "failure of exec"
24751 Failure to exec the command in a pipe transport is by default treated like
24752 any other failure while running the command. However, if &%freeze_exec_fail%&
24753 is set, failure to exec is treated specially, and causes the message to be
24754 frozen, whatever the setting of &%ignore_status%&.
24755
24756
24757 .option freeze_signal pipe boolean false
24758 .cindex "signal exit"
24759 .cindex "&(pipe)& transport", "signal exit"
24760 Normally if the process run by a command in a pipe transport exits on a signal,
24761 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24762 frozen in Exim's queue instead.
24763
24764
24765 .option force_command pipe boolean false
24766 .cindex "force command"
24767 .cindex "&(pipe)& transport", "force command"
24768 Normally when a router redirects an address directly to a pipe command
24769 the &%command%& option on the transport is ignored.  If &%force_command%&
24770 is set, the &%command%& option will used. This is especially
24771 useful for forcing a wrapper or additional argument to be added to the
24772 command. For example:
24773 .code
24774 command = /usr/bin/remote_exec myhost -- $address_pipe
24775 force_command
24776 .endd
24777
24778 Note that &$address_pipe$& is handled specially in &%command%& when
24779 &%force_command%& is set, expanding out to the original argument vector as
24780 separate items, similarly to a Unix shell &`"$@"`& construct.
24781
24782
24783 .option ignore_status pipe boolean false
24784 If this option is true, the status returned by the subprocess that is set up to
24785 run the command is ignored, and Exim behaves as if zero had been returned.
24786 Otherwise, a non-zero status or termination by signal causes an error return
24787 from the transport unless the status value is one of those listed in
24788 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24789
24790 &*Note*&: This option does not apply to timeouts, which do not return a status.
24791 See the &%timeout_defer%& option for how timeouts are handled.
24792
24793
24794 .option log_defer_output pipe boolean false
24795 .cindex "&(pipe)& transport" "logging output"
24796 If this option is set, and the status returned by the command is
24797 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24798 and any output was produced on stdout or stderr, the first line of it is
24799 written to the main log.
24800
24801
24802 .option log_fail_output pipe boolean false
24803 If this option is set, and the command returns any output on stdout or
24804 stderr, and also ends with a return code that is neither zero nor one of
24805 the return codes listed in &%temp_errors%& (that is, the delivery
24806 failed), the first line of output is written to the main log. This
24807 option and &%log_output%& are mutually exclusive.  Only one of them may
24808 be set.
24809
24810
24811 .option log_output pipe boolean false
24812 If this option is set and the command returns any output on stdout or
24813 stderr, the first line of output is written to the main log, whatever
24814 the return code. This option and &%log_fail_output%& are mutually
24815 exclusive. Only one of them may be set.
24816
24817
24818 .option max_output pipe integer 20K
24819 This specifies the maximum amount of output that the command may produce on its
24820 standard output and standard error file combined. If the limit is exceeded, the
24821 process running the command is killed. This is intended as a safety measure to
24822 catch runaway processes. The limit is applied independently of the settings of
24823 the options that control what is done with such output (for example,
24824 &%return_output%&). Because of buffering effects, the amount of output may
24825 exceed the limit by a small amount before Exim notices.
24826
24827
24828 .option message_prefix pipe string&!! "see below"
24829 The string specified here is expanded and output at the start of every message.
24830 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24831 .code
24832 message_prefix = \
24833   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24834   ${tod_bsdinbox}\n
24835 .endd
24836 .cindex "Cyrus"
24837 .cindex "&%tmail%&"
24838 .cindex "&""From""& line"
24839 This is required by the commonly used &_/usr/bin/vacation_& program.
24840 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24841 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24842 setting
24843 .code
24844 message_prefix =
24845 .endd
24846 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24847 &`\n`& to &`\r\n`& in &%message_prefix%&.
24848
24849
24850 .option message_suffix pipe string&!! "see below"
24851 The string specified here is expanded and output at the end of every message.
24852 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24853 The suffix can be suppressed by setting
24854 .code
24855 message_suffix =
24856 .endd
24857 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24858 &`\n`& to &`\r\n`& in &%message_suffix%&.
24859
24860
24861 .option path pipe string&!! "/bin:/usr/bin"
24862 This option is expanded and
24863 specifies the string that is set up in the PATH environment
24864 variable of the subprocess.
24865 If the &%command%& option does not yield an absolute path name, the command is
24866 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24867 apply to a command specified as a transport filter.
24868
24869
24870 .option permit_coredump pipe boolean false
24871 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24872 a core-dump of a pipe command, enable this command.  This enables core-dumps
24873 during delivery and affects both the Exim binary and the pipe command run.
24874 It is recommended that this option remain off unless and until you have a need
24875 for it and that this only be enabled when needed, as the risk of excessive
24876 resource consumption can be quite high.  Note also that Exim is typically
24877 installed as a setuid binary and most operating systems will inhibit coredumps
24878 of these by default, so further OS-specific action may be required.
24879
24880
24881 .option pipe_as_creator pipe boolean false
24882 .cindex "uid (user id)" "local delivery"
24883 If the generic &%user%& option is not set and this option is true, the delivery
24884 process is run under the uid that was in force when Exim was originally called
24885 to accept the message. If the group id is not otherwise set (via the generic
24886 &%group%& option), the gid that was in force when Exim was originally called to
24887 accept the message is used.
24888
24889
24890 .option restrict_to_path pipe boolean false
24891 When this option is set, any command name not listed in &%allow_commands%& must
24892 contain no slashes. The command is searched for only in the directories listed
24893 in the &%path%& option. This option is intended for use in the case when a pipe
24894 command has been generated from a user's &_.forward_& file. This is usually
24895 handled by a &(pipe)& transport called &%address_pipe%&.
24896
24897
24898 .option return_fail_output pipe boolean false
24899 If this option is true, and the command produced any output and ended with a
24900 return code other than zero or one of the codes listed in &%temp_errors%& (that
24901 is, the delivery failed), the output is returned in the bounce message.
24902 However, if the message has a null sender (that is, it is itself a bounce
24903 message), output from the command is discarded. This option and
24904 &%return_output%& are mutually exclusive. Only one of them may be set.
24905
24906
24907
24908 .option return_output pipe boolean false
24909 If this option is true, and the command produced any output, the delivery is
24910 deemed to have failed whatever the return code from the command, and the output
24911 is returned in the bounce message. Otherwise, the output is just discarded.
24912 However, if the message has a null sender (that is, it is a bounce message),
24913 output from the command is always discarded, whatever the setting of this
24914 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24915 of them may be set.
24916
24917
24918
24919 .option temp_errors pipe "string list" "see below"
24920 .cindex "&(pipe)& transport" "temporary failure"
24921 This option contains either a colon-separated list of numbers, or a single
24922 asterisk. If &%ignore_status%& is false
24923 and &%return_output%& is not set,
24924 and the command exits with a non-zero return code, the failure is treated as
24925 temporary and the delivery is deferred if the return code matches one of the
24926 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24927 codes are treated as permanent errors. The default setting contains the codes
24928 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24929 compiled on a system that does not define these macros, it assumes values of 75
24930 and 73, respectively.
24931
24932
24933 .option timeout pipe time 1h
24934 If the command fails to complete within this time, it is killed. This normally
24935 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24936 specifies no timeout. In order to ensure that any subprocesses created by the
24937 command are also killed, Exim makes the initial process a process group leader,
24938 and kills the whole process group on a timeout. However, this can be defeated
24939 if one of the processes starts a new process group.
24940
24941 .option timeout_defer pipe boolean false
24942 A timeout in a &(pipe)& transport, either in the command that the transport
24943 runs, or in a transport filter that is associated with it, is by default
24944 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24945 is set true, both kinds of timeout become temporary errors, causing the
24946 delivery to be deferred.
24947
24948 .option umask pipe "octal integer" 022
24949 This specifies the umask setting for the subprocess that runs the command.
24950
24951
24952 .option use_bsmtp pipe boolean false
24953 .cindex "envelope sender"
24954 If this option is set true, the &(pipe)& transport writes messages in &"batch
24955 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24956 commands. If you want to include a leading HELO command with such messages,
24957 you can do so by setting the &%message_prefix%& option. See section
24958 &<<SECTbatchSMTP>>& for details of batch SMTP.
24959
24960 .option use_classresources pipe boolean false
24961 .cindex "class resources (BSD)"
24962 This option is available only when Exim is running on FreeBSD, NetBSD, or
24963 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24964 resource limits when a &(pipe)& transport is run to perform a delivery. The
24965 limits for the uid under which the pipe is to run are obtained from the login
24966 class database.
24967
24968
24969 .option use_crlf pipe boolean false
24970 .cindex "carriage return"
24971 .cindex "linefeed"
24972 This option causes lines to be terminated with the two-character CRLF sequence
24973 (carriage return, linefeed) instead of just a linefeed character. In the case
24974 of batched SMTP, the byte sequence written to the pipe is then an exact image
24975 of what would be sent down a real SMTP connection.
24976
24977 The contents of the &%message_prefix%& and &%message_suffix%& options are
24978 written verbatim, so must contain their own carriage return characters if these
24979 are needed. When &%use_bsmtp%& is not set, the default values for both
24980 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24981 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24982
24983
24984 .option use_shell pipe boolean false
24985 .vindex "&$pipe_addresses$&"
24986 If this option is set, it causes the command to be passed to &_/bin/sh_&
24987 instead of being run directly from the transport, as described in section
24988 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24989 where the command is expected to be run under a shell and cannot easily be
24990 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24991 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24992 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24993 its &%-c%& option.
24994
24995
24996
24997 .section "Using an external local delivery agent" "SECID143"
24998 .cindex "local delivery" "using an external agent"
24999 .cindex "&'procmail'&"
25000 .cindex "external local delivery"
25001 .cindex "delivery" "&'procmail'&"
25002 .cindex "delivery" "by external agent"
25003 The &(pipe)& transport can be used to pass all messages that require local
25004 delivery to a separate local delivery agent such as &%procmail%&. When doing
25005 this, care must be taken to ensure that the pipe is run under an appropriate
25006 uid and gid. In some configurations one wants this to be a uid that is trusted
25007 by the delivery agent to supply the correct sender of the message. It may be
25008 necessary to recompile or reconfigure the delivery agent so that it trusts an
25009 appropriate user. The following is an example transport and router
25010 configuration for &%procmail%&:
25011 .code
25012 # transport
25013 procmail_pipe:
25014   driver = pipe
25015   command = /usr/local/bin/procmail -d $local_part_data
25016   return_path_add
25017   delivery_date_add
25018   envelope_to_add
25019   check_string = "From "
25020   escape_string = ">From "
25021   umask = 077
25022   user = $local_part_data
25023   group = mail
25024
25025 # router
25026 procmail:
25027   driver = accept
25028   check_local_user
25029   transport = procmail_pipe
25030 .endd
25031 In this example, the pipe is run as the local user, but with the group set to
25032 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
25033 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
25034 user to supply a correct sender address. If you do not specify either a
25035 &%group%& or a &%user%& option, the pipe command is run as the local user. The
25036 home directory is the user's home directory by default.
25037
25038 &*Note*&: The command that the pipe transport runs does &'not'& begin with
25039 .code
25040 IFS=" "
25041 .endd
25042 as shown in some &%procmail%& documentation, because Exim does not by default
25043 use a shell to run pipe commands.
25044
25045 .cindex "Cyrus"
25046 The next example shows a transport and a router for a system where local
25047 deliveries are handled by the Cyrus IMAP server.
25048 .code
25049 # transport
25050 local_delivery_cyrus:
25051   driver = pipe
25052   command = /usr/cyrus/bin/deliver \
25053             -m ${substr_1:$local_part_suffix} -- $local_part
25054   user = cyrus
25055   group = mail
25056   return_output
25057   log_output
25058   message_prefix =
25059   message_suffix =
25060
25061 # router
25062 local_user_cyrus:
25063   driver = accept
25064   check_local_user
25065   local_part_suffix = .*
25066   transport = local_delivery_cyrus
25067 .endd
25068 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
25069 &%return_output%& to cause any text written by Cyrus to be returned to the
25070 sender.
25071 .ecindex IIDpiptra1
25072 .ecindex IIDpiptra2
25073
25074
25075 . ////////////////////////////////////////////////////////////////////////////
25076 . ////////////////////////////////////////////////////////////////////////////
25077
25078 .chapter "The smtp transport" "CHAPsmtptrans"
25079 .scindex IIDsmttra1 "transports" "&(smtp)&"
25080 .scindex IIDsmttra2 "&(smtp)& transport"
25081 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
25082 or LMTP protocol. The list of hosts to try can either be taken from the address
25083 that is being processed (having been set up by the router), or specified
25084 explicitly for the transport. Timeout and retry processing (see chapter
25085 &<<CHAPretry>>&) is applied to each IP address independently.
25086
25087
25088 .section "Multiple messages on a single connection" "SECID144"
25089 The sending of multiple messages over a single TCP/IP connection can arise in
25090 two ways:
25091
25092 .ilist
25093 If a message contains more than &%max_rcpt%& (see below) addresses that are
25094 routed to the same host, more than one copy of the message has to be sent to
25095 that host. In this situation, multiple copies may be sent in a single run of
25096 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
25097 does when it has too many addresses to send in one message also depends on the
25098 value of the global &%remote_max_parallel%& option. Details are given in
25099 section &<<SECToutSMTPTCP>>&.)
25100 .next
25101 .cindex "hints database" "remembering routing"
25102 When a message has been successfully delivered over a TCP/IP connection, Exim
25103 looks in its hints database to see if there are any other messages awaiting a
25104 connection to the same host. If there are, a new delivery process is started
25105 for one of them, and the current TCP/IP connection is passed on to it. The new
25106 process may in turn send multiple copies and possibly create yet another
25107 process.
25108 .endlist
25109
25110
25111 For each copy sent over the same TCP/IP connection, a sequence counter is
25112 incremented, and if it ever gets to the value of &%connection_max_messages%&,
25113 no further messages are sent over that connection.
25114
25115
25116
25117 .section "Use of the $host and $host_address variables" "SECID145"
25118 .vindex "&$host$&"
25119 .vindex "&$host_address$&"
25120 At the start of a run of the &(smtp)& transport, the values of &$host$& and
25121 &$host_address$& are the name and IP address of the first host on the host list
25122 passed by the router. However, when the transport is about to connect to a
25123 specific host, and while it is connected to that host, &$host$& and
25124 &$host_address$& are set to the values for that host. These are the values
25125 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
25126 &%serialize_hosts%&, and the various TLS options are expanded.
25127
25128
25129 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
25130 .vindex &$tls_bits$&
25131 .vindex &$tls_cipher$&
25132 .vindex &$tls_peerdn$&
25133 .vindex &$tls_sni$&
25134 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
25135 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25136 are the values that were set when the message was received.
25137 These are the values that are used for options that are expanded before any
25138 SMTP connections are made. Just before each connection is made, these four
25139 variables are emptied. If TLS is subsequently started, they are set to the
25140 appropriate values for the outgoing connection, and these are the values that
25141 are in force when any authenticators are run and when the
25142 &%authenticated_sender%& option is expanded.
25143
25144 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
25145 and will be removed in a future release.
25146
25147
25148 .section "Private options for smtp" "SECID146"
25149 .cindex "options" "&(smtp)& transport"
25150 The private options of the &(smtp)& transport are as follows:
25151
25152
25153 .option address_retry_include_sender smtp boolean true
25154 .cindex "4&'xx'& responses" "retrying after"
25155 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
25156 is the combination of sender and recipient that is delayed in subsequent queue
25157 runs until the retry time is reached. You can delay the recipient without
25158 reference to the sender (which is what earlier versions of Exim did), by
25159 setting &%address_retry_include_sender%& false. However, this can lead to
25160 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
25161
25162 .option allow_localhost smtp boolean false
25163 .cindex "local host" "sending to"
25164 .cindex "fallback" "hosts specified on transport"
25165 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
25166 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
25167 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
25168 the delivery anyway. This should be used only in special cases when the
25169 configuration ensures that no looping will result (for example, a differently
25170 configured Exim is listening on the port to which the message is sent).
25171
25172
25173 .option authenticated_sender smtp string&!! unset
25174 .cindex "Cyrus"
25175 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
25176 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
25177 overriding any existing authenticated sender value. If the string expansion is
25178 forced to fail, the option is ignored. Other expansion failures cause delivery
25179 to be deferred. If the result of expansion is an empty string, that is also
25180 ignored.
25181
25182 The expansion happens after the outgoing connection has been made and TLS
25183 started, if required. This means that the &$host$&, &$host_address$&,
25184 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
25185 particular connection.
25186
25187 If the SMTP session is not authenticated, the expansion of
25188 &%authenticated_sender%& still happens (and can cause the delivery to be
25189 deferred if it fails), but no AUTH= item is added to MAIL commands
25190 unless &%authenticated_sender_force%& is true.
25191
25192 This option allows you to use the &(smtp)& transport in LMTP mode to
25193 deliver mail to Cyrus IMAP and provide the proper local part as the
25194 &"authenticated sender"&, via a setting such as:
25195 .code
25196 authenticated_sender = $local_part
25197 .endd
25198 This removes the need for IMAP subfolders to be assigned special ACLs to
25199 allow direct delivery to those subfolders.
25200
25201 Because of expected uses such as that just described for Cyrus (when no
25202 domain is involved), there is no checking on the syntax of the provided
25203 value.
25204
25205
25206 .option authenticated_sender_force smtp boolean false
25207 If this option is set true, the &%authenticated_sender%& option's value
25208 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
25209 authenticated as a client.
25210
25211
25212 .option command_timeout smtp time 5m
25213 .cindex timeout "smtp transport command"
25214 This sets a timeout for receiving a response to an SMTP command that has been
25215 sent out. It is also used when waiting for the initial banner line from the
25216 remote host. Its value must not be zero.
25217
25218
25219 .option connect_timeout smtp time 5m
25220 .cindex timeout "smtp transport connect"
25221 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
25222 to a remote host. A setting of zero allows the system timeout (typically
25223 several minutes) to act. To have any effect, the value of this option must be
25224 less than the system timeout. However, it has been observed that on some
25225 systems there is no system timeout, which is why the default value for this
25226 option is 5 minutes, a value recommended by RFC 1123.
25227
25228
25229 .option connection_max_messages smtp integer 500
25230 .cindex "SMTP" "passed connection"
25231 .cindex "SMTP" "multiple deliveries"
25232 .cindex "multiple SMTP deliveries"
25233 This controls the maximum number of separate message deliveries that are sent
25234 over a single TCP/IP connection. If the value is zero, there is no limit.
25235 For testing purposes, this value can be overridden by the &%-oB%& command line
25236 option.
25237
25238
25239 .option dane_require_tls_ciphers smtp string&!! unset
25240 .cindex "TLS" "requiring specific ciphers for DANE"
25241 .cindex "cipher" "requiring specific"
25242 .cindex DANE "TLS ciphers"
25243 This option may be used to override &%tls_require_ciphers%& for connections
25244 where DANE has been determined to be in effect.
25245 If not set, then &%tls_require_ciphers%& will be used.
25246 Normal SMTP delivery is not able to make strong demands of TLS cipher
25247 configuration, because delivery will fall back to plaintext.  Once DANE has
25248 been determined to be in effect, there is no plaintext fallback and making the
25249 TLS cipherlist configuration stronger will increase security, rather than
25250 counter-intuitively decreasing it.
25251 If the option expands to be empty or is forced to fail, then it will
25252 be treated as unset and &%tls_require_ciphers%& will be used instead.
25253
25254
25255 .option data_timeout smtp time 5m
25256 .cindex timeout "for transmitted SMTP data blocks"
25257 This sets a timeout for the transmission of each block in the data portion of
25258 the message. As a result, the overall timeout for a message depends on the size
25259 of the message. Its value must not be zero. See also &%final_timeout%&.
25260
25261
25262 .option dkim_canon smtp string&!! unset
25263 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25264 .option dkim_domain smtp "string list&!!" unset
25265 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25266 .option dkim_hash smtp string&!! sha256
25267 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25268 .option dkim_identity smtp string&!! unset
25269 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25270 .option dkim_private_key smtp string&!! unset
25271 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25272 .option dkim_selector smtp string&!! unset
25273 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25274 .option dkim_strict smtp string&!! unset
25275 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25276 .option dkim_sign_headers smtp string&!! "per RFC"
25277 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25278 .option dkim_timestamps smtp string&!! unset
25279 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25280
25281
25282 .option delay_after_cutoff smtp boolean true
25283 .cindex "final cutoff" "retries, controlling"
25284 .cindex retry "final cutoff"
25285 This option controls what happens when all remote IP addresses for a given
25286 domain have been inaccessible for so long that they have passed their retry
25287 cutoff times.
25288
25289 In the default state, if the next retry time has not been reached for any of
25290 them, the address is bounced without trying any deliveries. In other words,
25291 Exim delays retrying an IP address after the final cutoff time until a new
25292 retry time is reached, and can therefore bounce an address without ever trying
25293 a delivery, when machines have been down for a long time. Some people are
25294 unhappy at this prospect, so...
25295
25296 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25297 addresses are past their final cutoff time, Exim tries to deliver to those
25298 IP addresses that have not been tried since the message arrived. If there are
25299 none, of if they all fail, the address is bounced. In other words, it does not
25300 delay when a new message arrives, but immediately tries those expired IP
25301 addresses that haven't been tried since the message arrived. If there is a
25302 continuous stream of messages for the dead hosts, unsetting
25303 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25304 to them.
25305
25306
25307 .option dns_qualify_single smtp boolean true
25308 If the &%hosts%& or &%fallback_hosts%& option is being used,
25309 and the &%gethostbyname%& option is false,
25310 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25311 in chapter &<<CHAPdnslookup>>& for more details.
25312
25313
25314 .option dns_search_parents smtp boolean false
25315 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25316 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25317 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25318 details.
25319
25320
25321 .option dnssec_request_domains smtp "domain list&!!" *
25322 .cindex "MX record" "security"
25323 .cindex "DNSSEC" "MX lookup"
25324 .cindex "security" "MX lookup"
25325 .cindex "DNS" "DNSSEC"
25326 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25327 the DNSSEC request bit set. Setting this transport option is only useful if the
25328 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25329 router option.
25330
25331
25332
25333 .option dnssec_require_domains smtp "domain list&!!" unset
25334 .cindex "MX record" "security"
25335 .cindex "DNSSEC" "MX lookup"
25336 .cindex "security" "MX lookup"
25337 .cindex "DNS" "DNSSEC"
25338 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25339 the DNSSEC request bit set.  Setting this transport option is only
25340 useful if the transport overrides or sets the host names. See the
25341 &%dnssec_require_domains%& router option.
25342
25343
25344
25345 .option dscp smtp string&!! unset
25346 .cindex "DCSP" "outbound"
25347 This option causes the DSCP value associated with a socket to be set to one
25348 of a number of fixed strings or to numeric value.
25349 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25350 Common values include &`throughput`&, &`mincost`&, and on newer systems
25351 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25352
25353 The outbound packets from Exim will be marked with this value in the header
25354 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25355 that these values will have any effect, not be stripped by networking
25356 equipment, or do much of anything without cooperation with your Network
25357 Engineer and those of all network operators between the source and destination.
25358
25359
25360 .option fallback_hosts smtp "string list" unset
25361 .cindex "fallback" "hosts specified on transport"
25362 String expansion is not applied to this option. The argument must be a
25363 colon-separated list of host names or IP addresses, optionally also including
25364 port numbers, though the separator can be changed, as described in section
25365 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25366 item in a &%route_list%& setting for the &(manualroute)& router, as described
25367 in section &<<SECTformatonehostitem>>&.
25368
25369 Fallback hosts can also be specified on routers, which associate them with the
25370 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25371 &%fallback_hosts%& specified on the transport is used only if the address does
25372 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25373 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25374 However, &%hosts_randomize%& does apply to fallback host lists.
25375
25376 If Exim is unable to deliver to any of the hosts for a particular address, and
25377 the errors are not permanent rejections, the address is put on a separate
25378 transport queue with its host list replaced by the fallback hosts, unless the
25379 address was routed via MX records and the current host was in the original MX
25380 list. In that situation, the fallback host list is not used.
25381
25382 Once normal deliveries are complete, the fallback queue is delivered by
25383 re-running the same transports with the new host lists. If several failing
25384 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25385 copy of the message is sent.
25386
25387 The resolution of the host names on the fallback list is controlled by the
25388 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25389 both to cases when the host list comes with the address and when it is taken
25390 from &%hosts%&. This option provides a &"use a smart host only if delivery
25391 fails"& facility.
25392
25393
25394 .option final_timeout smtp time 10m
25395 .cindex timeout "for transmitted SMTP data accept"
25396 This is the timeout that applies while waiting for the response to the final
25397 line containing just &"."& that terminates a message. Its value must not be
25398 zero.
25399
25400 .option gethostbyname smtp boolean false
25401 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25402 being used, names are looked up using &[gethostbyname()]&
25403 (or &[getipnodebyname()]& when available)
25404 instead of using the DNS. Of course, that function may in fact use the DNS, but
25405 it may also consult other sources of information such as &_/etc/hosts_&.
25406
25407 .option gnutls_compat_mode smtp boolean unset
25408 This option controls whether GnuTLS is used in compatibility mode in an Exim
25409 server. This reduces security slightly, but improves interworking with older
25410 implementations of TLS.
25411
25412 .option helo_data smtp string&!! "see below"
25413 .cindex "HELO" "argument, setting"
25414 .cindex "EHLO" "argument, setting"
25415 .cindex "LHLO argument setting"
25416 The value of this option is expanded after a connection to a another host has
25417 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25418 command that starts the outgoing SMTP or LMTP session. The default value of the
25419 option is:
25420 .code
25421 $primary_hostname
25422 .endd
25423 During the expansion, the variables &$host$& and &$host_address$& are set to
25424 the identity of the remote host, and the variables &$sending_ip_address$& and
25425 &$sending_port$& are set to the local IP address and port number that are being
25426 used. These variables can be used to generate different values for different
25427 servers or different local IP addresses. For example, if you want the string
25428 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25429 interface address, you could use this:
25430 .code
25431 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
25432   {$primary_hostname}}
25433 .endd
25434 The use of &%helo_data%& applies both to sending messages and when doing
25435 callouts.
25436
25437 .option hosts smtp "string list&!!" unset
25438 Hosts are associated with an address by a router such as &(dnslookup)&, which
25439 finds the hosts by looking up the address domain in the DNS, or by
25440 &(manualroute)&, which has lists of hosts in its configuration. However,
25441 email addresses can be passed to the &(smtp)& transport by any router, and not
25442 all of them can provide an associated list of hosts.
25443
25444 The &%hosts%& option specifies a list of hosts to be used if the address being
25445 processed does not have any hosts associated with it. The hosts specified by
25446 &%hosts%& are also used, whether or not the address has its own hosts, if
25447 &%hosts_override%& is set.
25448
25449 The string is first expanded, before being interpreted as a colon-separated
25450 list of host names or IP addresses, possibly including port numbers. The
25451 separator may be changed to something other than colon, as described in section
25452 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25453 item in a &%route_list%& setting for the &(manualroute)& router, as described
25454 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25455 of the &(manualroute)& router is not available here.
25456
25457 If the expansion fails, delivery is deferred. Unless the failure was caused by
25458 the inability to complete a lookup, the error is logged to the panic log as
25459 well as the main log. Host names are looked up either by searching directly for
25460 address records in the DNS or by calling &[gethostbyname()]& (or
25461 &[getipnodebyname()]& when available), depending on the setting of the
25462 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25463 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25464 address are used.
25465
25466 During delivery, the hosts are tried in order, subject to their retry status,
25467 unless &%hosts_randomize%& is set.
25468
25469
25470 .option hosts_avoid_esmtp smtp "host list&!!" unset
25471 .cindex "ESMTP, avoiding use of"
25472 .cindex "HELO" "forcing use of"
25473 .cindex "EHLO" "avoiding use of"
25474 .cindex "PIPELINING" "avoiding the use of"
25475 This option is for use with broken hosts that announce ESMTP facilities (for
25476 example, PIPELINING) and then fail to implement them properly. When a host
25477 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25478 start of the SMTP session. This means that it cannot use any of the ESMTP
25479 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25480
25481
25482 .option hosts_avoid_pipelining smtp "host list&!!" unset
25483 .cindex "PIPELINING" "avoiding the use of"
25484 .cindex "ESMTP extensions" PIPELINING
25485 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25486 that matches this list, even if the server host advertises PIPELINING support.
25487
25488 .option hosts_pipe_connect smtp "host list&!!" unset
25489 .cindex "pipelining" "early connection"
25490 .cindex "pipelining" PIPE_CONNECT
25491 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25492 this option controls which to hosts the facility watched for
25493 and recorded, and used for subsequent connections.
25494
25495 The retry hints database is used for the record,
25496 and records are subject to the &%retry_data_expire%& option.
25497 When used, the pipelining saves on roundtrip times.
25498 It also turns SMTP into a client-first protocol
25499 so combines well with TCP Fast Open.
25500
25501 See also the &%pipelining_connect_advertise_hosts%& main option.
25502
25503 Note:
25504 When the facility is used, the transport &%helo_data%& option
25505 will be expanded before the &$sending_ip_address$& variable
25506 is filled in.
25507 A check is made for the use of that variable, without the
25508 presence of a &"def:"& test on it, but suitably complex coding
25509 can avoid the check and produce unexpected results.
25510 You have been warned.
25511
25512
25513 .option hosts_avoid_tls smtp "host list&!!" unset
25514 .cindex "TLS" "avoiding for certain hosts"
25515 Exim will not try to start a TLS session when delivering to any host that
25516 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25517
25518 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25519 .cindex "TLS" "avoiding for certain hosts"
25520 Exim will not try to start a TLS session for a verify callout,
25521 or when delivering in cutthrough mode,
25522 to any host that matches this list.
25523
25524
25525 .option hosts_max_try smtp integer 5
25526 .cindex "host" "maximum number to try"
25527 .cindex "limit" "number of hosts tried"
25528 .cindex "limit" "number of MX tried"
25529 .cindex "MX record" "maximum tried"
25530 This option limits the number of IP addresses that are tried for any one
25531 delivery in cases where there are temporary delivery errors. Section
25532 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25533
25534
25535 .option hosts_max_try_hardlimit smtp integer 50
25536 This is an additional check on the maximum number of IP addresses that Exim
25537 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25538 why it exists.
25539
25540
25541
25542 .option hosts_nopass_tls smtp "host list&!!" unset
25543 .cindex "TLS" "passing connection"
25544 .cindex "multiple SMTP deliveries"
25545 .cindex "TLS" "multiple message deliveries"
25546 For any host that matches this list, a connection on which a TLS session has
25547 been started will not be passed to a new delivery process for sending another
25548 message on the same connection. See section &<<SECTmulmessam>>& for an
25549 explanation of when this might be needed.
25550
25551 .option hosts_noproxy_tls smtp "host list&!!" unset
25552 .cindex "TLS" "passing connection"
25553 .cindex "multiple SMTP deliveries"
25554 .cindex "TLS" "multiple message deliveries"
25555 For any host that matches this list, a TLS session which has
25556 been started will not be passed to a new delivery process for sending another
25557 message on the same session.
25558
25559 The traditional implementation closes down TLS and re-starts it in the new
25560 process, on the same open TCP connection, for each successive message
25561 sent.  If permitted by this option a pipe to to the new process is set up
25562 instead, and the original process maintains the TLS connection and proxies
25563 the SMTP connection from and to the new process and any subsequents.
25564 The new process has no access to TLS information, so cannot include it in
25565 logging.
25566
25567
25568
25569 .option hosts_override smtp boolean false
25570 If this option is set and the &%hosts%& option is also set, any hosts that are
25571 attached to the address are ignored, and instead the hosts specified by the
25572 &%hosts%& option are always used. This option does not apply to
25573 &%fallback_hosts%&.
25574
25575
25576 .option hosts_randomize smtp boolean false
25577 .cindex "randomized host list"
25578 .cindex "host" "list of; randomized"
25579 .cindex "fallback" "randomized hosts"
25580 If this option is set, and either the list of hosts is taken from the
25581 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25582 were not obtained from MX records (this includes fallback hosts from the
25583 router), and were not randomized by the router, the order of trying the hosts
25584 is randomized each time the transport runs. Randomizing the order of a host
25585 list can be used to do crude load sharing.
25586
25587 When &%hosts_randomize%& is true, a host list may be split into groups whose
25588 order is separately randomized. This makes it possible to set up MX-like
25589 behaviour. The boundaries between groups are indicated by an item that is just
25590 &`+`& in the host list. For example:
25591 .code
25592 hosts = host1:host2:host3:+:host4:host5
25593 .endd
25594 The order of the first three hosts and the order of the last two hosts is
25595 randomized for each use, but the first three always end up before the last two.
25596 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25597
25598 .option hosts_require_auth smtp "host list&!!" unset
25599 .cindex "authentication" "required by client"
25600 This option provides a list of servers for which authentication must succeed
25601 before Exim will try to transfer a message. If authentication fails for
25602 servers which are not in this list, Exim tries to send unauthenticated. If
25603 authentication fails for one of these servers, delivery is deferred. This
25604 temporary error is detectable in the retry rules, so it can be turned into a
25605 hard failure if required. See also &%hosts_try_auth%&, and chapter
25606 &<<CHAPSMTPAUTH>>& for details of authentication.
25607
25608
25609 .option hosts_request_ocsp smtp "host list&!!" *
25610 .cindex "TLS" "requiring for certain servers"
25611 Exim will request a Certificate Status on a
25612 TLS session for any host that matches this list.
25613 &%tls_verify_certificates%& should also be set for the transport.
25614
25615 .option hosts_require_alpn smtp "host list&!!" unset
25616 .cindex ALPN "require negotiation in client"
25617 .cindex TLS ALPN
25618 .cindex TLS "Application Layer Protocol Names"
25619 If the TLS library supports ALPN
25620 then a successful negotiation of ALPN will be required for any host
25621 matching the list, for TLS to be used.
25622 See also the &%tls_alpn%& option.
25623
25624 &*Note*&: prevention of fallback to in-clear connection is not
25625 managed by this option; see &%hosts_require_tls%&.
25626
25627 .option hosts_require_dane smtp "host list&!!" unset
25628 .cindex DANE "transport options"
25629 .cindex DANE "requiring for certain servers"
25630 If built with DANE support, Exim  will require that a DNSSEC-validated
25631 TLSA record is present for any host matching the list,
25632 and that a DANE-verified TLS connection is made.
25633 There will be no fallback to in-clear communication.
25634 See the &%dnssec_request_domains%& router and transport options.
25635 See section &<<SECDANE>>&.
25636
25637 .option hosts_require_helo smtp "host list&!!" *
25638 .cindex "HELO/EHLO" requiring
25639 Exim will require an accepted HELO or EHLO command from a host matching
25640 this list, before accepting a MAIL command.
25641
25642 .option hosts_require_ocsp smtp "host list&!!" unset
25643 .cindex "TLS" "requiring for certain servers"
25644 Exim will request, and check for a valid Certificate Status being given, on a
25645 TLS session for any host that matches this list.
25646 &%tls_verify_certificates%& should also be set for the transport.
25647
25648 .option hosts_require_tls smtp "host list&!!" unset
25649 .cindex "TLS" "requiring for certain servers"
25650 Exim will insist on using a TLS session when delivering to any host that
25651 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25652 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25653 incoming messages, use an appropriate ACL.
25654
25655 .option hosts_try_auth smtp "host list&!!" unset
25656 .cindex "authentication" "optional in client"
25657 This option provides a list of servers to which, provided they announce
25658 authentication support, Exim will attempt to authenticate as a client when it
25659 connects. If authentication fails
25660 and &%hosts_require_auth%& permits,
25661 Exim will try to transfer the message unauthenticated.
25662 See also chapter &<<CHAPSMTPAUTH>>& for details of authentication.
25663
25664 .option hosts_try_chunking smtp "host list&!!" *
25665 .cindex CHUNKING "enabling, in client"
25666 .cindex BDAT "SMTP command"
25667 .cindex "RFC 3030" "CHUNKING"
25668 This option provides a list of servers to which, provided they announce
25669 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25670 Unless DKIM signing is being done,
25671 BDAT will not be used in conjunction with a transport filter.
25672
25673 .option hosts_try_dane smtp "host list&!!" *
25674 .cindex DANE "transport options"
25675 .cindex DANE "attempting for certain servers"
25676 If built with DANE support, Exim  will look up a
25677 TLSA record for any host matching the list,
25678 If one is found and that lookup was DNSSEC-validated,
25679 then Exim requires that a DANE-verified TLS connection is made for that host;
25680 there will be no fallback to in-clear communication.
25681 See the &%dnssec_request_domains%& router and transport options.
25682 See section &<<SECDANE>>&.
25683
25684 .option hosts_try_fastopen smtp "host list&!!" *
25685 .cindex "fast open, TCP" "enabling, in client"
25686 .cindex "TCP Fast Open" "enabling, in client"
25687 .cindex "RFC 7413" "TCP Fast Open"
25688 This option provides a list of servers to which, provided
25689 the facility is supported by this system, Exim will attempt to
25690 perform a TCP Fast Open.
25691 No data is sent on the SYN segment but, if the remote server also
25692 supports the facility, it can send its SMTP banner immediately after
25693 the SYN,ACK segment.  This can save up to one round-trip time.
25694
25695 The facility is only active for previously-contacted servers,
25696 as the initiator must present a cookie in the SYN segment.
25697
25698 On (at least some) current Linux distributions the facility must be enabled
25699 in the kernel by the sysadmin before the support is usable.
25700 There is no option for control of the server side; if the system supports
25701 it it is always enabled.  Note that lengthy operations in the connect ACL,
25702 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25703
25704 .option hosts_try_prdr smtp "host list&!!" *
25705 .cindex "PRDR" "enabling, optional in client"
25706 .cindex "ESMTP extensions" PRDR
25707 This option provides a list of servers to which, provided they announce
25708 PRDR support, Exim will attempt to negotiate PRDR
25709 for multi-recipient messages.
25710 The option can usually be left as default.
25711
25712 .option interface smtp "string list&!!" unset
25713 .cindex "bind IP address"
25714 .cindex "IP address" "binding"
25715 .vindex "&$host$&"
25716 .vindex "&$host_address$&"
25717 This option specifies which interface to bind to when making an outgoing SMTP
25718 call. The value is an IP address, not an interface name such as
25719 &`eth0`&. Do not confuse this with the interface address that was used when a
25720 message was received, which is in &$received_ip_address$&, formerly known as
25721 &$interface_address$&. The name was changed to minimize confusion with the
25722 outgoing interface address. There is no variable that contains an outgoing
25723 interface address because, unless it is set by this option, its value is
25724 unknown.
25725
25726 During the expansion of the &%interface%& option the variables &$host$& and
25727 &$host_address$& refer to the host to which a connection is about to be made
25728 during the expansion of the string. Forced expansion failure, or an empty
25729 string result causes the option to be ignored. Otherwise, after expansion, the
25730 string must be a list of IP addresses, colon-separated by default, but the
25731 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25732 For example:
25733 .code
25734 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25735 .endd
25736 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25737 connection. If none of them are the correct type, the option is ignored. If
25738 &%interface%& is not set, or is ignored, the system's IP functions choose which
25739 interface to use if the host has more than one.
25740
25741
25742 .option keepalive smtp boolean true
25743 .cindex "keepalive" "on outgoing connection"
25744 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25745 connections. When set, it causes the kernel to probe idle connections
25746 periodically, by sending packets with &"old"& sequence numbers. The other end
25747 of the connection should send a acknowledgment if the connection is still okay
25748 or a reset if the connection has been aborted. The reason for doing this is
25749 that it has the beneficial effect of freeing up certain types of connection
25750 that can get stuck when the remote host is disconnected without tidying up the
25751 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25752 unreachable hosts.
25753
25754
25755 .option lmtp_ignore_quota smtp boolean false
25756 .cindex "LMTP" "ignoring quota errors"
25757 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25758 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25759 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25760
25761 .option max_rcpt smtp integer 100
25762 .cindex "RCPT" "maximum number of outgoing"
25763 This option limits the number of RCPT commands that are sent in a single
25764 SMTP message transaction. Each set of addresses is treated independently, and
25765 so can cause parallel connections to the same host if &%remote_max_parallel%&
25766 permits this. A value setting of zero disables the limit.
25767
25768
25769 .option message_linelength_limit smtp integer 998
25770 .cindex "line length" limit
25771 This option sets the maximum line length, in bytes, that the transport
25772 will send.  Any messages with lines exceeding the given value
25773 will fail and a failure-DSN ("bounce") message will if possible be returned
25774 to the sender.
25775 The default value is that defined by the SMTP standards.
25776
25777 It is generally wise to also check in the data ACL so that messages
25778 received via SMTP can be refused without producing a bounce.
25779
25780
25781 .option multi_domain smtp boolean&!! true
25782 .vindex "&$domain$&"
25783 When this option is set, the &(smtp)& transport can handle a number of
25784 addresses containing a mixture of different domains provided they all resolve
25785 to the same list of hosts. Turning the option off restricts the transport to
25786 handling only one domain at a time. This is useful if you want to use
25787 &$domain$& in an expansion for the transport, because it is set only when there
25788 is a single domain involved in a remote delivery.
25789
25790 It is expanded per-address and can depend on any of
25791 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25792 &$host$&, &$host_address$& and &$host_port$&.
25793
25794 If the connection is DANE-enabled then this option is ignored;
25795 only messages having the domain used for the DANE TLSA lookup are
25796 sent on the connection.
25797
25798 .option port smtp string&!! "see below"
25799 .cindex "port" "sending TCP/IP"
25800 .cindex "TCP/IP" "setting outgoing port"
25801 This option specifies the TCP/IP port on the server to which Exim connects.
25802 &*Note:*& Do not confuse this with the port that was used when a message was
25803 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25804 The name was changed to minimize confusion with the outgoing port. There is no
25805 variable that contains an outgoing port.
25806
25807 If the value of this option begins with a digit it is taken as a port number;
25808 otherwise it is looked up using &[getservbyname()]&. The default value is
25809 normally &"smtp"&,
25810 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25811 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25812 If the expansion fails, or if a port number cannot be found, delivery
25813 is deferred.
25814
25815 Note that at least one Linux distribution has been seen failing
25816 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25817
25818
25819
25820 .option protocol smtp string smtp
25821 .cindex "LMTP" "over TCP/IP"
25822 .cindex "ssmtp protocol" "outbound"
25823 .cindex "TLS" "SSL-on-connect outbound"
25824 .vindex "&$port$&"
25825 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25826 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25827 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25828 deliveries into closed message stores. Exim also has support for running LMTP
25829 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25830
25831 If this option is set to &"smtps"&, the default value for the &%port%& option
25832 changes to &"smtps"&, and the transport initiates TLS immediately after
25833 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25834 The Internet standards bodies used to strongly discourage use of this mode,
25835 but as of RFC 8314 it is preferred over STARTTLS for message submission
25836 (as distinct from MTA-MTA communication).
25837
25838
25839 .option retry_include_ip_address smtp boolean&!! true
25840 Exim normally includes both the host name and the IP address in the key it
25841 constructs for indexing retry data after a temporary delivery failure. This
25842 means that when one of several IP addresses for a host is failing, it gets
25843 tried periodically (controlled by the retry rules), but use of the other IP
25844 addresses is not affected.
25845
25846 However, in some dialup environments hosts are assigned a different IP address
25847 each time they connect. In this situation the use of the IP address as part of
25848 the retry key leads to undesirable behaviour. Setting this option false causes
25849 Exim to use only the host name.
25850 Since it is expanded it can be made to depend on the host or domain.
25851
25852
25853 .option serialize_hosts smtp "host list&!!" unset
25854 .cindex "serializing connections"
25855 .cindex "host" "serializing connections"
25856 Because Exim operates in a distributed manner, if several messages for the same
25857 host arrive at around the same time, more than one simultaneous connection to
25858 the remote host can occur. This is not usually a problem except when there is a
25859 slow link between the hosts. In that situation it may be helpful to restrict
25860 Exim to one connection at a time. This can be done by setting
25861 &%serialize_hosts%& to match the relevant hosts.
25862
25863 .cindex "hints database" "serializing deliveries to a host"
25864 Exim implements serialization by means of a hints database in which a record is
25865 written whenever a process connects to one of the restricted hosts. The record
25866 is deleted when the connection is completed. Obviously there is scope for
25867 records to get left lying around if there is a system or program crash. To
25868 guard against this, Exim ignores any records that are more than six hours old.
25869
25870 If you set up this kind of serialization, you should also arrange to delete the
25871 relevant hints database whenever your system reboots. The names of the files
25872 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25873 may be one or two files, depending on the type of DBM in use. The same files
25874 are used for ETRN serialization.
25875
25876 See also the &%max_parallel%& generic transport option.
25877
25878
25879 .option size_addition smtp integer 1024
25880 .cindex "SIZE" "ESMTP extension"
25881 .cindex "message" "size issue for transport filter"
25882 .cindex "size" "of message"
25883 .cindex "transport" "filter"
25884 .cindex "filter" "transport filter"
25885 If a remote SMTP server indicates that it supports the SIZE option of the
25886 MAIL command, Exim uses this to pass over the message size at the start of
25887 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25888 sends, to allow for headers and other text that may be added during delivery by
25889 configuration options or in a transport filter. It may be necessary to increase
25890 this if a lot of text is added to messages.
25891
25892 Alternatively, if the value of &%size_addition%& is set negative, it disables
25893 the use of the SIZE option altogether.
25894
25895
25896 .option socks_proxy smtp string&!! unset
25897 .cindex proxy SOCKS
25898 This option enables use of SOCKS proxies for connections made by the
25899 transport.  For details see section &<<SECTproxySOCKS>>&.
25900
25901
25902 .option tls_alpn smtp string&!! unset
25903 .cindex TLS "Application Layer Protocol Names"
25904 .cindex TLS ALPN
25905 .cindex ALPN "set name in client"
25906 If this option is set
25907 and the TLS library supports ALPN,
25908 the value given is used.
25909
25910 As of writing no value has been standardised for email use.
25911 The authors suggest using &"smtp"&.
25912
25913
25914
25915 .option tls_certificate smtp string&!! unset
25916 .cindex "TLS" "client certificate, location of"
25917 .cindex "certificate" "client, location of"
25918 .vindex "&$host$&"
25919 .vindex "&$host_address$&"
25920 The value of this option must be the absolute path to a file which contains the
25921 client's certificate, for possible use when sending a message over an encrypted
25922 connection. The values of &$host$& and &$host_address$& are set to the name and
25923 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25924 details of TLS.
25925
25926 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25927 certificate when sending messages as a client. The global option of the same
25928 name specifies the certificate for Exim as a server; it is not automatically
25929 assumed that the same certificate should be used when Exim is operating as a
25930 client.
25931
25932
25933 .option tls_crl smtp string&!! unset
25934 .cindex "TLS" "client certificate revocation list"
25935 .cindex "certificate" "revocation list for client"
25936 This option specifies a certificate revocation list. The expanded value must
25937 be the name of a file that contains a CRL in PEM format.
25938
25939
25940 .option tls_dh_min_bits smtp integer 1024
25941 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25942 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25943 key agreement is negotiated, the server will provide a large prime number
25944 for use.  This option establishes the minimum acceptable size of that number.
25945 If the parameter offered by the server is too small, then the TLS handshake
25946 will fail.
25947
25948 Only supported when using GnuTLS.
25949
25950
25951 .option tls_privatekey smtp string&!! unset
25952 .cindex "TLS" "client private key, location of"
25953 .vindex "&$host$&"
25954 .vindex "&$host_address$&"
25955 The value of this option must be the absolute path to a file which contains the
25956 client's private key. This is used when sending a message over an encrypted
25957 connection using a client certificate. The values of &$host$& and
25958 &$host_address$& are set to the name and address of the server during the
25959 expansion. If this option is unset, or the expansion is forced to fail, or the
25960 result is an empty string, the private key is assumed to be in the same file as
25961 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25962
25963
25964 .option tls_require_ciphers smtp string&!! unset
25965 .cindex "TLS" "requiring specific ciphers"
25966 .cindex "cipher" "requiring specific"
25967 .vindex "&$host$&"
25968 .vindex "&$host_address$&"
25969 The value of this option must be a list of permitted cipher suites, for use
25970 when setting up an outgoing encrypted connection. (There is a global option of
25971 the same name for controlling incoming connections.) The values of &$host$& and
25972 &$host_address$& are set to the name and address of the server during the
25973 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25974 is used in different ways by OpenSSL and GnuTLS (see sections
25975 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25976 ciphers is a preference order.
25977
25978
25979 .option tls_resumption_hosts smtp "host list&!!" unset
25980 .cindex TLS resumption
25981 This option controls which connections to use the TLS resumption feature.
25982 See &<<SECTresumption>>& for details.
25983
25984
25985
25986 .option tls_sni smtp string&!! unset
25987 .cindex "TLS" "Server Name Indication"
25988 .cindex "TLS" SNI
25989 .cindex SNI "setting in client"
25990 .vindex "&$tls_sni$&"
25991 If this option is set
25992 and the connection is not DANE-validated
25993 then it sets the $tls_out_sni variable and causes any
25994 TLS session to pass this value as the Server Name Indication extension to
25995 the remote side, which can be used by the remote side to select an appropriate
25996 certificate and private key for the session.
25997
25998 See &<<SECTtlssni>>& for more information.
25999
26000 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
26001 TLS extensions.
26002
26003
26004
26005
26006 .option tls_tempfail_tryclear smtp boolean true
26007 .cindex "4&'xx'& responses" "to STARTTLS"
26008 When the server host is not in &%hosts_require_tls%&, and there is a problem in
26009 setting up a TLS session, this option determines whether or not Exim should try
26010 to deliver the message unencrypted. If it is set false, delivery to the
26011 current host is deferred; if there are other hosts, they are tried. If this
26012 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
26013 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
26014 TLS negotiation fails, Exim closes the current connection (because it is in an
26015 unknown state), opens a new one to the same host, and then tries the delivery
26016 in clear.
26017
26018
26019 .option tls_try_verify_hosts smtp "host list&!!" *
26020 .cindex "TLS" "server certificate verification"
26021 .cindex "certificate" "verification of server"
26022 This option gives a list of hosts for which, on encrypted connections,
26023 certificate verification will be tried but need not succeed.
26024 The &%tls_verify_certificates%& option must also be set.
26025 Note that unless the host is in this list
26026 TLS connections will be denied to hosts using self-signed certificates
26027 when &%tls_verify_certificates%& is matched.
26028 The &$tls_out_certificate_verified$& variable is set when
26029 certificate verification succeeds.
26030
26031
26032 .option tls_verify_cert_hostnames smtp "host list&!!" *
26033 .cindex "TLS" "server certificate hostname verification"
26034 .cindex "certificate" "verification of server"
26035 This option give a list of hosts for which,
26036 while verifying the server certificate,
26037 checks will be included on the host name
26038 (note that this will generally be the result of a DNS MX lookup)
26039 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
26040 limited to being the initial component of a 3-or-more component FQDN.
26041
26042 There is no equivalent checking on client certificates.
26043
26044
26045 .option tls_verify_certificates smtp string&!! system
26046 .cindex "TLS" "server certificate verification"
26047 .cindex "certificate" "verification of server"
26048 .vindex "&$host$&"
26049 .vindex "&$host_address$&"
26050 The value of this option must be either the
26051 word "system"
26052 or the absolute path to
26053 a file or directory containing permitted certificates for servers,
26054 for use when setting up an encrypted connection.
26055
26056 The "system" value for the option will use a location compiled into the SSL library.
26057 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
26058 is taken as empty and an explicit location
26059 must be specified.
26060
26061 The use of a directory for the option value is not available for GnuTLS versions
26062 preceding 3.3.6 and a single file must be used.
26063
26064 With OpenSSL the certificates specified
26065 explicitly
26066 either by file or directory
26067 are added to those given by the system default location.
26068
26069 The values of &$host$& and
26070 &$host_address$& are set to the name and address of the server during the
26071 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
26072
26073 For back-compatibility,
26074 if neither tls_verify_hosts nor tls_try_verify_hosts are set
26075 (a single-colon empty list counts as being set)
26076 and certificate verification fails the TLS connection is closed.
26077
26078
26079 .option tls_verify_hosts smtp "host list&!!" unset
26080 .cindex "TLS" "server certificate verification"
26081 .cindex "certificate" "verification of server"
26082 This option gives a list of hosts for which, on encrypted connections,
26083 certificate verification must succeed.
26084 The &%tls_verify_certificates%& option must also be set.
26085 If both this option and &%tls_try_verify_hosts%& are unset
26086 operation is as if this option selected all hosts.
26087
26088 .option utf8_downconvert smtp integer&!! -1
26089 .cindex utf8 "address downconversion"
26090 .cindex i18n "utf8 address downconversion"
26091 If built with internationalization support,
26092 this option controls conversion of UTF-8 in message envelope addresses
26093 to a-label form.
26094 If, after expansion, the value is 1, 0, or -1 then this value overrides
26095 any value previously set for the message.  Otherwise, any previously
26096 set value is used.  To permit use of a previous value,
26097 set this option to an empty string.
26098 For details on the values see section &<<SECTi18nMTA>>&.
26099
26100
26101
26102
26103 .section "How the limits for the number of hosts to try are used" &&&
26104          "SECTvalhosmax"
26105 .cindex "host" "maximum number to try"
26106 .cindex "limit" "hosts; maximum number tried"
26107 There are two options that are concerned with the number of hosts that are
26108 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
26109 &%hosts_max_try_hardlimit%&.
26110
26111
26112 The &%hosts_max_try%& option limits the number of hosts that are tried
26113 for a single delivery. However, despite the term &"host"& in its name, the
26114 option actually applies to each IP address independently. In other words, a
26115 multihomed host is treated as several independent hosts, just as it is for
26116 retrying.
26117
26118 Many of the larger ISPs have multiple MX records which often point to
26119 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
26120 created as a result of routing one of these domains.
26121
26122 Trying every single IP address on such a long list does not seem sensible; if
26123 several at the top of the list fail, it is reasonable to assume there is some
26124 problem that is likely to affect all of them. Roughly speaking, the value of
26125 &%hosts_max_try%& is the maximum number that are tried before deferring the
26126 delivery. However, the logic cannot be quite that simple.
26127
26128 Firstly, IP addresses that are skipped because their retry times have not
26129 arrived do not count, and in addition, addresses that are past their retry
26130 limits are also not counted, even when they are tried. This means that when
26131 some IP addresses are past their retry limits, more than the value of
26132 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
26133 that all IP addresses are considered before timing out an email address (but
26134 see below for an exception).
26135
26136 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
26137 list to see if there is a subsequent host with a different (higher valued) MX.
26138 If there is, that host is considered next, and the current IP address is used
26139 but not counted. This behaviour helps in the case of a domain with a retry rule
26140 that hardly ever delays any hosts, as is now explained:
26141
26142 Consider the case of a long list of hosts with one MX value, and a few with a
26143 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
26144 hosts at the top of the list are tried at first. With the default retry rule,
26145 which specifies increasing retry times, the higher MX hosts are eventually
26146 tried when those at the top of the list are skipped because they have not
26147 reached their retry times.
26148
26149 However, it is common practice to put a fixed short retry time on domains for
26150 large ISPs, on the grounds that their servers are rarely down for very long.
26151 Unfortunately, these are exactly the domains that tend to resolve to long lists
26152 of hosts. The short retry time means that the lowest MX hosts are tried every
26153 time. The attempts may be in a different order because of random sorting, but
26154 without the special MX check, the higher MX hosts would never be tried until
26155 all the lower MX hosts had timed out (which might be several days), because
26156 there are always some lower MX hosts that have reached their retry times. With
26157 the special check, Exim considers at least one IP address from each MX value at
26158 every delivery attempt, even if the &%hosts_max_try%& limit has already been
26159 reached.
26160
26161 The above logic means that &%hosts_max_try%& is not a hard limit, and in
26162 particular, Exim normally eventually tries all the IP addresses before timing
26163 out an email address. When &%hosts_max_try%& was implemented, this seemed a
26164 reasonable thing to do. Recently, however, some lunatic DNS configurations have
26165 been set up with hundreds of IP addresses for some domains. It can
26166 take a very long time indeed for an address to time out in these cases.
26167
26168 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
26169 Exim never tries more than this number of IP addresses; if it hits this limit
26170 and they are all timed out, the email address is bounced, even though not all
26171 possible IP addresses have been tried.
26172 .ecindex IIDsmttra1
26173 .ecindex IIDsmttra2
26174
26175
26176
26177
26178
26179 . ////////////////////////////////////////////////////////////////////////////
26180 . ////////////////////////////////////////////////////////////////////////////
26181
26182 .chapter "Address rewriting" "CHAPrewrite"
26183 .scindex IIDaddrew "rewriting" "addresses"
26184 There are some circumstances in which Exim automatically rewrites domains in
26185 addresses. The two most common are when an address is given without a domain
26186 (referred to as an &"unqualified address"&) or when an address contains an
26187 abbreviated domain that is expanded by DNS lookup.
26188
26189 Unqualified envelope addresses are accepted only for locally submitted
26190 messages, or for messages that are received from hosts matching
26191 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26192 appropriate. Unqualified addresses in header lines are qualified if they are in
26193 locally submitted messages, or messages from hosts that are permitted to send
26194 unqualified envelope addresses. Otherwise, unqualified addresses in header
26195 lines are neither qualified nor rewritten.
26196
26197 One situation in which Exim does &'not'& automatically rewrite a domain is
26198 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
26199 such a domain should be rewritten using the &"canonical"& name, and some MTAs
26200 do this. The new RFCs do not contain this suggestion.
26201
26202
26203 .section "Explicitly configured address rewriting" "SECID147"
26204 This chapter describes the rewriting rules that can be used in the
26205 main rewrite section of the configuration file, and also in the generic
26206 &%headers_rewrite%& option that can be set on any transport.
26207
26208 Some people believe that configured address rewriting is a Mortal Sin.
26209 Others believe that life is not possible without it. Exim provides the
26210 facility; you do not have to use it.
26211
26212 The main rewriting rules that appear in the &"rewrite"& section of the
26213 configuration file are applied to addresses in incoming messages, both envelope
26214 addresses and addresses in header lines. Each rule specifies the types of
26215 address to which it applies.
26216
26217 Whether or not addresses in header lines are rewritten depends on the origin of
26218 the headers and the type of rewriting. Global rewriting, that is, rewriting
26219 rules from the rewrite section of the configuration file, is applied only to
26220 those headers that were received with the message. Header lines that are added
26221 by ACLs or by a system filter or by individual routers or transports (which
26222 are specific to individual recipient addresses) are not rewritten by the global
26223 rules.
26224
26225 Rewriting at transport time, by means of the &%headers_rewrite%& option,
26226 applies all headers except those added by routers and transports. That is, as
26227 well as the headers that were received with the message, it also applies to
26228 headers that were added by an ACL or a system filter.
26229
26230
26231 In general, rewriting addresses from your own system or domain has some
26232 legitimacy. Rewriting other addresses should be done only with great care and
26233 in special circumstances. The author of Exim believes that rewriting should be
26234 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
26235 Although it can sometimes be used as a routing tool, this is very strongly
26236 discouraged.
26237
26238 There are two commonly encountered circumstances where rewriting is used, as
26239 illustrated by these examples:
26240
26241 .ilist
26242 The company whose domain is &'hitch.fict.example'& has a number of hosts that
26243 exchange mail with each other behind a firewall, but there is only a single
26244 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
26245 &'hitch.fict.example'& when sending mail off-site.
26246 .next
26247 A host rewrites the local parts of its own users so that, for example,
26248 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
26249 .endlist
26250
26251
26252
26253 .section "When does rewriting happen?" "SECID148"
26254 .cindex "rewriting" "timing of"
26255 .cindex "&ACL;" "rewriting addresses in"
26256 Configured address rewriting can take place at several different stages of a
26257 message's processing.
26258
26259 .vindex "&$sender_address$&"
26260 At the start of an ACL for MAIL, the sender address may have been rewritten
26261 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
26262 ordinary rewrite rules have yet been applied. If, however, the sender address
26263 is verified in the ACL, it is rewritten before verification, and remains
26264 rewritten thereafter. The subsequent value of &$sender_address$& is the
26265 rewritten address. This also applies if sender verification happens in a
26266 RCPT ACL. Otherwise, when the sender address is not verified, it is
26267 rewritten as soon as a message's header lines have been received.
26268
26269 .vindex "&$domain$&"
26270 .vindex "&$local_part$&"
26271 Similarly, at the start of an ACL for RCPT, the current recipient's address
26272 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
26273 rewrite rules have yet been applied to it. However, the behaviour is different
26274 from the sender address when a recipient is verified. The address is rewritten
26275 for the verification, but the rewriting is not remembered at this stage. The
26276 value of &$local_part$& and &$domain$& after verification are always the same
26277 as they were before (that is, they contain the unrewritten &-- except for
26278 SMTP-time rewriting &-- address).
26279
26280 As soon as a message's header lines have been received, all the envelope
26281 recipient addresses are permanently rewritten, and rewriting is also applied to
26282 the addresses in the header lines (if configured). This happens before adding
26283 any header lines that were specified in MAIL or RCPT ACLs, and
26284 .cindex "&[local_scan()]& function" "address rewriting; timing of"
26285 before the DATA ACL and &[local_scan()]& functions are run.
26286
26287 When an address is being routed, either for delivery or for verification,
26288 rewriting is applied immediately to child addresses that are generated by
26289 redirection, unless &%no_rewrite%& is set on the router.
26290
26291 .cindex "envelope from"
26292 .cindex "envelope sender" "rewriting at transport time"
26293 .cindex "rewriting" "at transport time"
26294 .cindex "header lines" "rewriting at transport time"
26295 At transport time, additional rewriting of addresses in header lines can be
26296 specified by setting the generic &%headers_rewrite%& option on a transport.
26297 This option contains rules that are identical in form to those in the rewrite
26298 section of the configuration file. They are applied to the original message
26299 header lines and any that were added by ACLs or a system filter. They are not
26300 applied to header lines that are added by routers or the transport.
26301
26302 The outgoing envelope sender can be rewritten by means of the &%return_path%&
26303 transport option. However, it is not possible to rewrite envelope recipients at
26304 transport time.
26305
26306
26307
26308
26309 .section "Testing the rewriting rules that apply on input" "SECID149"
26310 .cindex "rewriting" "testing"
26311 .cindex "testing" "rewriting"
26312 Exim's input rewriting configuration appears in a part of the runtime
26313 configuration file headed by &"begin rewrite"&. It can be tested by the
26314 &%-brw%& command line option. This takes an address (which can be a full RFC
26315 2822 address) as its argument. The output is a list of how the address would be
26316 transformed by the rewriting rules for each of the different places it might
26317 appear in an incoming message, that is, for each different header and for the
26318 envelope sender and recipient fields. For example,
26319 .code
26320 exim -brw ph10@exim.workshop.example
26321 .endd
26322 might produce the output
26323 .code
26324 sender: Philip.Hazel@exim.workshop.example
26325 from: Philip.Hazel@exim.workshop.example
26326 to: ph10@exim.workshop.example
26327 cc: ph10@exim.workshop.example
26328 bcc: ph10@exim.workshop.example
26329 reply-to: Philip.Hazel@exim.workshop.example
26330 env-from: Philip.Hazel@exim.workshop.example
26331 env-to: ph10@exim.workshop.example
26332 .endd
26333 which shows that rewriting has been set up for that address when used in any of
26334 the source fields, but not when it appears as a recipient address. At the
26335 present time, there is no equivalent way of testing rewriting rules that are
26336 set for a particular transport.
26337
26338
26339 .section "Rewriting rules" "SECID150"
26340 .cindex "rewriting" "rules"
26341 The rewrite section of the configuration file consists of lines of rewriting
26342 rules in the form
26343 .display
26344 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26345 .endd
26346 Rewriting rules that are specified for the &%headers_rewrite%& generic
26347 transport option are given as a colon-separated list. Each item in the list
26348 takes the same form as a line in the main rewriting configuration (except that
26349 any colons must be doubled, of course).
26350
26351 The formats of source patterns and replacement strings are described below.
26352 Each is terminated by white space, unless enclosed in double quotes, in which
26353 case normal quoting conventions apply inside the quotes. The flags are single
26354 characters which may appear in any order. Spaces and tabs between them are
26355 ignored.
26356
26357 For each address that could potentially be rewritten, the rules are scanned in
26358 order, and replacements for the address from earlier rules can themselves be
26359 replaced by later rules (but see the &"q"& and &"R"& flags).
26360
26361 The order in which addresses are rewritten is undefined, may change between
26362 releases, and must not be relied on, with one exception: when a message is
26363 received, the envelope sender is always rewritten first, before any header
26364 lines are rewritten. For example, the replacement string for a rewrite of an
26365 address in &'To:'& must not assume that the message's address in &'From:'& has
26366 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26367 that the envelope sender has already been rewritten.
26368
26369 .vindex "&$domain$&"
26370 .vindex "&$local_part$&"
26371 The variables &$local_part$& and &$domain$& can be used in the replacement
26372 string to refer to the address that is being rewritten. Note that lookup-driven
26373 rewriting can be done by a rule of the form
26374 .code
26375 *@*   ${lookup ...
26376 .endd
26377 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26378 refer to the address that is being rewritten.
26379
26380
26381 .section "Rewriting patterns" "SECID151"
26382 .cindex "rewriting" "patterns"
26383 .cindex "address list" "in a rewriting pattern"
26384 The source pattern in a rewriting rule is any item which may appear in an
26385 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26386 single-item address list, which means that it is expanded before being tested
26387 against the address. As always, if you use a regular expression as a pattern,
26388 you must take care to escape dollar and backslash characters, or use the &`\N`&
26389 facility to suppress string expansion within the regular expression.
26390
26391 Domains in patterns should be given in lower case. Local parts in patterns are
26392 case-sensitive. If you want to do case-insensitive matching of local parts, you
26393 can use a regular expression that starts with &`^(?i)`&.
26394
26395 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26396 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26397 depending on the type of match which occurred. These can be used in the
26398 replacement string to insert portions of the incoming address. &$0$& always
26399 refers to the complete incoming address. When a regular expression is used, the
26400 numerical variables are set from its capturing subexpressions. For other types
26401 of pattern they are set as follows:
26402
26403 .ilist
26404 If a local part or domain starts with an asterisk, the numerical variables
26405 refer to the character strings matched by asterisks, with &$1$& associated with
26406 the first asterisk, and &$2$& with the second, if present. For example, if the
26407 pattern
26408 .code
26409 *queen@*.fict.example
26410 .endd
26411 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26412 .code
26413 $0 = hearts-queen@wonderland.fict.example
26414 $1 = hearts-
26415 $2 = wonderland
26416 .endd
26417 Note that if the local part does not start with an asterisk, but the domain
26418 does, it is &$1$& that contains the wild part of the domain.
26419
26420 .next
26421 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26422 of the domain are placed in the next available numerical variables. Suppose,
26423 for example, that the address &'foo@bar.baz.example'& is processed by a
26424 rewriting rule of the form
26425 .display
26426 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26427 .endd
26428 and the key in the file that matches the domain is &`*.baz.example`&. Then
26429 .code
26430 $1 = foo
26431 $2 = bar
26432 $3 = baz.example
26433 .endd
26434 If the address &'foo@baz.example'& is looked up, this matches the same
26435 wildcard file entry, and in this case &$2$& is set to the empty string, but
26436 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26437 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26438 whole domain. For non-partial domain lookups, no numerical variables are set.
26439 .endlist
26440
26441
26442 .section "Rewriting replacements" "SECID152"
26443 .cindex "rewriting" "replacements"
26444 If the replacement string for a rule is a single asterisk, addresses that
26445 match the pattern and the flags are &'not'& rewritten, and no subsequent
26446 rewriting rules are scanned. For example,
26447 .code
26448 hatta@lookingglass.fict.example  *  f
26449 .endd
26450 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26451 &'From:'& headers.
26452
26453 .vindex "&$domain$&"
26454 .vindex "&$local_part$&"
26455 If the replacement string is not a single asterisk, it is expanded, and must
26456 yield a fully qualified address. Within the expansion, the variables
26457 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26458 Any letters they contain retain their original case &-- they are not lower
26459 cased. The numerical variables are set up according to the type of pattern that
26460 matched the address, as described above. If the expansion is forced to fail by
26461 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26462 current rule is abandoned, but subsequent rules may take effect. Any other
26463 expansion failure causes the entire rewriting operation to be abandoned, and an
26464 entry written to the panic log.
26465
26466
26467
26468 .section "Rewriting flags" "SECID153"
26469 There are three different kinds of flag that may appear on rewriting rules:
26470
26471 .ilist
26472 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26473 c, f, h, r, s, t.
26474 .next
26475 A flag that specifies rewriting at SMTP time: S.
26476 .next
26477 Flags that control the rewriting process: Q, q, R, w.
26478 .endlist
26479
26480 For rules that are part of the &%headers_rewrite%& generic transport option,
26481 E, F, T, and S are not permitted.
26482
26483
26484
26485 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
26486          "SECID154"
26487 .cindex "rewriting" "flags"
26488 If none of the following flag letters, nor the &"S"& flag (see section
26489 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26490 and to both the sender and recipient fields of the envelope, whereas a
26491 transport-time rewriting rule just applies to all headers. Otherwise, the
26492 rewriting rule is skipped unless the relevant addresses are being processed.
26493 .display
26494 &`E`&       rewrite all envelope fields
26495 &`F`&       rewrite the envelope From field
26496 &`T`&       rewrite the envelope To field
26497 &`b`&       rewrite the &'Bcc:'& header
26498 &`c`&       rewrite the &'Cc:'& header
26499 &`f`&       rewrite the &'From:'& header
26500 &`h`&       rewrite all headers
26501 &`r`&       rewrite the &'Reply-To:'& header
26502 &`s`&       rewrite the &'Sender:'& header
26503 &`t`&       rewrite the &'To:'& header
26504 .endd
26505 "All headers" means all of the headers listed above that can be selected
26506 individually, plus their &'Resent-'& versions. It does not include
26507 other headers such as &'Subject:'& etc.
26508
26509 You should be particularly careful about rewriting &'Sender:'& headers, and
26510 restrict this to special known cases in your own domains.
26511
26512
26513 .section "The SMTP-time rewriting flag" "SECTrewriteS"
26514 .cindex "SMTP" "rewriting malformed addresses"
26515 .cindex "RCPT" "rewriting argument of"
26516 .cindex "MAIL" "rewriting argument of"
26517 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26518 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26519 before any other processing; even before syntax checking. The pattern is
26520 required to be a regular expression, and it is matched against the whole of the
26521 data for the command, including any surrounding angle brackets.
26522
26523 .vindex "&$domain$&"
26524 .vindex "&$local_part$&"
26525 This form of rewrite rule allows for the handling of addresses that are not
26526 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26527 input). Because the input is not required to be a syntactically valid address,
26528 the variables &$local_part$& and &$domain$& are not available during the
26529 expansion of the replacement string. The result of rewriting replaces the
26530 original address in the MAIL or RCPT command.
26531
26532
26533 .section "Flags controlling the rewriting process" "SECID155"
26534 There are four flags which control the way the rewriting process works. These
26535 take effect only when a rule is invoked, that is, when the address is of the
26536 correct type (matches the flags) and matches the pattern:
26537
26538 .ilist
26539 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26540 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26541 absence of &"Q"& the rewritten address must always include a domain.
26542 .next
26543 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26544 even if no rewriting actually takes place because of a &"fail"& in the
26545 expansion. The &"q"& flag is not effective if the address is of the wrong type
26546 (does not match the flags) or does not match the pattern.
26547 .next
26548 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26549 address, up to ten times. It can be combined with the &"q"& flag, to stop
26550 rewriting once it fails to match (after at least one successful rewrite).
26551 .next
26552 .cindex "rewriting" "whole addresses"
26553 When an address in a header is rewritten, the rewriting normally applies only
26554 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26555 left unchanged. For example, rewriting might change
26556 .code
26557 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26558 .endd
26559 into
26560 .code
26561 From: Ford Prefect <prefectf@hitch.fict.example>
26562 .endd
26563 .cindex "RFC 2047"
26564 Sometimes there is a need to replace the whole address item, and this can be
26565 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26566 causes an address in a header line to be rewritten, the entire address is
26567 replaced, not just the working part. The replacement must be a complete RFC
26568 2822 address, including the angle brackets if necessary. If text outside angle
26569 brackets contains a character whose value is greater than 126 or less than 32
26570 (except for tab), the text is encoded according to RFC 2047. The character set
26571 is taken from &%headers_charset%&, which gets its default at build time.
26572
26573 When the &"w"& flag is set on a rule that causes an envelope address to be
26574 rewritten, all but the working part of the replacement address is discarded.
26575 .endlist
26576
26577
26578 .section "Rewriting examples" "SECID156"
26579 Here is an example of the two common rewriting paradigms:
26580 .code
26581 *@*.hitch.fict.example  $1@hitch.fict.example
26582 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26583                      {$value}fail}@hitch.fict.example bctfrF
26584 .endd
26585 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26586 the string expansion to fail if the lookup does not succeed. In this context it
26587 has the effect of leaving the original address unchanged, but Exim goes on to
26588 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26589 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26590 explicitly, which would cause the rewritten address to be the same as before,
26591 at the cost of a small bit of processing. Not supplying either of these is an
26592 error, since the rewritten address would then contain no local part.
26593
26594 The first example above replaces the domain with a superior, more general
26595 domain. This may not be desirable for certain local parts. If the rule
26596 .code
26597 root@*.hitch.fict.example  *
26598 .endd
26599 were inserted before the first rule, rewriting would be suppressed for the
26600 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26601
26602 Rewriting can be made conditional on a number of tests, by making use of
26603 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26604 messages that originate outside the local host:
26605 .code
26606 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26607                          {$1@hitch.fict.example}fail}"
26608 .endd
26609 The replacement string is quoted in this example because it contains white
26610 space.
26611
26612 .cindex "rewriting" "bang paths"
26613 .cindex "bang paths" "rewriting"
26614 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26615 an address it treats it as an unqualified local part which it qualifies with
26616 the local qualification domain (if the source of the message is local or if the
26617 remote host is permitted to send unqualified addresses). Rewriting can
26618 sometimes be used to handle simple bang paths with a fixed number of
26619 components. For example, the rule
26620 .code
26621 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26622 .endd
26623 rewrites a two-component bang path &'host.name!user'& as the domain address
26624 &'user@host.name'&. However, there is a security implication in using this as
26625 a global rewriting rule for envelope addresses. It can provide a backdoor
26626 method for using your system as a relay, because the incoming addresses appear
26627 to be local. If the bang path addresses are received via SMTP, it is safer to
26628 use the &"S"& flag to rewrite them as they are received, so that relay checking
26629 can be done on the rewritten addresses.
26630 .ecindex IIDaddrew
26631
26632
26633
26634
26635
26636 . ////////////////////////////////////////////////////////////////////////////
26637 . ////////////////////////////////////////////////////////////////////////////
26638
26639 .chapter "Retry configuration" "CHAPretry"
26640 .scindex IIDretconf1 "retry" "configuration, description of"
26641 .scindex IIDregconf2 "configuration file" "retry section"
26642 The &"retry"& section of the runtime configuration file contains a list of
26643 retry rules that control how often Exim tries to deliver messages that cannot
26644 be delivered at the first attempt. If there are no retry rules (the section is
26645 empty or not present), there are no retries. In this situation, temporary
26646 errors are treated as permanent. The default configuration contains a single,
26647 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26648 line option can be used to test which retry rule will be used for a given
26649 address, domain and error.
26650
26651 The most common cause of retries is temporary failure to deliver to a remote
26652 host because the host is down, or inaccessible because of a network problem.
26653 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26654 address) basis, not on a per-message basis. Thus, if one message has recently
26655 been delayed, delivery of a new message to the same host is not immediately
26656 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26657 log selector is set, the message
26658 .cindex "retry" "time not reached"
26659 &"retry time not reached"& is written to the main log whenever a delivery is
26660 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26661 the handling of errors during remote deliveries.
26662
26663 Retry processing applies to routing as well as to delivering, except as covered
26664 in the next paragraph. The retry rules do not distinguish between these
26665 actions. It is not possible, for example, to specify different behaviour for
26666 failures to route the domain &'snark.fict.example'& and failures to deliver to
26667 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26668 added complication, so did not implement it. However, although they share the
26669 same retry rule, the actual retry times for routing and transporting a given
26670 domain are maintained independently.
26671
26672 When a delivery is not part of a queue run (typically an immediate delivery on
26673 receipt of a message), the routers are always run, and local deliveries are
26674 always attempted, even if retry times are set for them. This makes for better
26675 behaviour if one particular message is causing problems (for example, causing
26676 quota overflow, or provoking an error in a filter file). If such a delivery
26677 suffers a temporary failure, the retry data is updated as normal, and
26678 subsequent delivery attempts from queue runs occur only when the retry time for
26679 the local address is reached.
26680
26681 .section "Changing retry rules" "SECID157"
26682 If you change the retry rules in your configuration, you should consider
26683 whether or not to delete the retry data that is stored in Exim's spool area in
26684 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26685 always safe; that is why they are called &"hints"&.
26686
26687 The hints retry data contains suggested retry times based on the previous
26688 rules. In the case of a long-running problem with a remote host, it might
26689 record the fact that the host has timed out. If your new rules increase the
26690 timeout time for such a host, you should definitely remove the old retry data
26691 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26692 messages that it should now be retaining.
26693
26694
26695
26696 .section "Format of retry rules" "SECID158"
26697 .cindex "retry" "rules"
26698 Each retry rule occupies one line and consists of three or four parts,
26699 separated by white space: a pattern, an error name, an optional list of sender
26700 addresses, and a list of retry parameters. The pattern and sender lists must be
26701 enclosed in double quotes if they contain white space. The rules are searched
26702 in order until one is found where the pattern, error name, and sender list (if
26703 present) match the failing host or address, the error that occurred, and the
26704 message's sender, respectively.
26705
26706
26707 The pattern is any single item that may appear in an address list (see section
26708 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26709 which means that it is expanded before being tested against the address that
26710 has been delayed. A negated address list item is permitted. Address
26711 list processing treats a plain domain name as if it were preceded by &"*@"&,
26712 which makes it possible for many retry rules to start with just a domain. For
26713 example,
26714 .code
26715 lookingglass.fict.example        *  F,24h,30m;
26716 .endd
26717 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26718 whereas
26719 .code
26720 alice@lookingglass.fict.example  *  F,24h,30m;
26721 .endd
26722 applies only to temporary failures involving the local part &%alice%&.
26723 In practice, almost all rules start with a domain name pattern without a local
26724 part.
26725
26726 .cindex "regular expressions" "in retry rules"
26727 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26728 must match a complete address, not just a domain, because that is how regular
26729 expressions work in address lists.
26730 .display
26731 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26732 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26733 .endd
26734
26735
26736 .section "Choosing which retry rule to use for address errors" "SECID159"
26737 When Exim is looking for a retry rule after a routing attempt has failed (for
26738 example, after a DNS timeout), each line in the retry configuration is tested
26739 against the complete address only if &%retry_use_local_part%& is set for the
26740 router. Otherwise, only the domain is used, except when matching against a
26741 regular expression, when the local part of the address is replaced with &"*"&.
26742 A domain on its own can match a domain pattern, or a pattern that starts with
26743 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26744 &%check_local_user%& is true, and false for other routers.
26745
26746 Similarly, when Exim is looking for a retry rule after a local delivery has
26747 failed (for example, after a mailbox full error), each line in the retry
26748 configuration is tested against the complete address only if
26749 &%retry_use_local_part%& is set for the transport (it defaults true for all
26750 local transports).
26751
26752 .cindex "4&'xx'& responses" "retry rules for"
26753 However, when Exim is looking for a retry rule after a remote delivery attempt
26754 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26755 whole address is always used as the key when searching the retry rules. The
26756 rule that is found is used to create a retry time for the combination of the
26757 failing address and the message's sender. It is the combination of sender and
26758 recipient that is delayed in subsequent queue runs until its retry time is
26759 reached. You can delay the recipient without regard to the sender by setting
26760 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26761 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26762 commands.
26763
26764
26765
26766 .section "Choosing which retry rule to use for host and message errors" &&&
26767          "SECID160"
26768 For a temporary error that is not related to an individual address (for
26769 example, a connection timeout), each line in the retry configuration is checked
26770 twice. First, the name of the remote host is used as a domain name (preceded by
26771 &"*@"& when matching a regular expression). If this does not match the line,
26772 the domain from the email address is tried in a similar fashion. For example,
26773 suppose the MX records for &'a.b.c.example'& are
26774 .code
26775 a.b.c.example  MX  5  x.y.z.example
26776                MX  6  p.q.r.example
26777                MX  7  m.n.o.example
26778 .endd
26779 and the retry rules are
26780 .code
26781 p.q.r.example    *      F,24h,30m;
26782 a.b.c.example    *      F,4d,45m;
26783 .endd
26784 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26785 first rule matches neither the host nor the domain, so Exim looks at the second
26786 rule. This does not match the host, but it does match the domain, so it is used
26787 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26788 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26789 first retry rule is used, because it matches the host.
26790
26791 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26792 first rule to determine retry times, but for all the other hosts for the domain
26793 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26794 routing to &'a.b.c.example'& suffers a temporary failure.
26795
26796 &*Note*&: The host name is used when matching the patterns, not its IP address.
26797 However, if a message is routed directly to an IP address without the use of a
26798 host name, for example, if a &(manualroute)& router contains a setting such as:
26799 .code
26800 route_list = *.a.example  192.168.34.23
26801 .endd
26802 then the &"host name"& that is used when searching for a retry rule is the
26803 textual form of the IP address.
26804
26805 .section "Retry rules for specific errors" "SECID161"
26806 .cindex "retry" "specific errors; specifying"
26807 The second field in a retry rule is the name of a particular error, or an
26808 asterisk, which matches any error. The errors that can be tested for are:
26809
26810 .vlist
26811 .vitem &%auth_failed%&
26812 Authentication failed when trying to send to a host in the
26813 &%hosts_require_auth%& list in an &(smtp)& transport.
26814
26815 .vitem &%data_4xx%&
26816 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26817 after the command, or after sending the message's data.
26818
26819 .vitem &%mail_4xx%&
26820 A 4&'xx'& error was received for an outgoing MAIL command.
26821
26822 .vitem &%rcpt_4xx%&
26823 A 4&'xx'& error was received for an outgoing RCPT command.
26824 .endlist
26825
26826 For the three 4&'xx'& errors, either the first or both of the x's can be given
26827 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26828 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26829 and have retries every ten minutes with a one-hour timeout, you could set up a
26830 retry rule of this form:
26831 .code
26832 the.domain.name  rcpt_452   F,1h,10m
26833 .endd
26834 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26835 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26836
26837 .vlist
26838 .vitem &%lost_connection%&
26839 A server unexpectedly closed the SMTP connection. There may, of course,
26840 legitimate reasons for this (host died, network died), but if it repeats a lot
26841 for the same host, it indicates something odd.
26842
26843 .vitem &%lookup%&
26844 A DNS lookup for a host failed.
26845 Note that a &%dnslookup%& router will need to have matched
26846 its &%fail_defer_domains%& option for this retry type to be usable.
26847 Also note that a &%manualroute%& router will probably need
26848 its &%host_find_failed%& option set to &%defer%&.
26849
26850 .vitem &%refused_MX%&
26851 A connection to a host obtained from an MX record was refused.
26852
26853 .vitem &%refused_A%&
26854 A connection to a host not obtained from an MX record was refused.
26855
26856 .vitem &%refused%&
26857 A connection was refused.
26858
26859 .vitem &%timeout_connect_MX%&
26860 A connection attempt to a host obtained from an MX record timed out.
26861
26862 .vitem &%timeout_connect_A%&
26863 A connection attempt to a host not obtained from an MX record timed out.
26864
26865 .vitem &%timeout_connect%&
26866 A connection attempt timed out.
26867
26868 .vitem &%timeout_MX%&
26869 There was a timeout while connecting or during an SMTP session with a host
26870 obtained from an MX record.
26871
26872 .vitem &%timeout_A%&
26873 There was a timeout while connecting or during an SMTP session with a host not
26874 obtained from an MX record.
26875
26876 .vitem &%timeout%&
26877 There was a timeout while connecting or during an SMTP session.
26878
26879 .vitem &%tls_required%&
26880 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26881 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26882 to STARTTLS, or there was a problem setting up the TLS connection.
26883
26884 .vitem &%quota%&
26885 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26886 transport.
26887
26888 .vitem &%quota_%&<&'time'&>
26889 .cindex "quota" "error testing in retry rule"
26890 .cindex "retry" "quota error testing"
26891 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26892 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26893 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26894 for four days.
26895 .endlist
26896
26897 .cindex "mailbox" "time of last read"
26898 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26899 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26900 it should be based on the last time that the user accessed the mailbox.
26901 However, it is not always possible to determine this. Exim uses the following
26902 heuristic rules:
26903
26904 .ilist
26905 If the mailbox is a single file, the time of last access (the &"atime"&) is
26906 used. As no new messages are being delivered (because the mailbox is over
26907 quota), Exim does not access the file, so this is the time of last user access.
26908 .next
26909 .cindex "maildir format" "time of last read"
26910 For a maildir delivery, the time of last modification of the &_new_&
26911 subdirectory is used. As the mailbox is over quota, no new files are created in
26912 the &_new_& subdirectory, because no new messages are being delivered. Any
26913 change to the &_new_& subdirectory is therefore assumed to be the result of an
26914 MUA moving a new message to the &_cur_& directory when it is first read. The
26915 time that is used is therefore the last time that the user read a new message.
26916 .next
26917 For other kinds of multi-file mailbox, the time of last access cannot be
26918 obtained, so a retry rule that uses this type of error field is never matched.
26919 .endlist
26920
26921 The quota errors apply both to system-enforced quotas and to Exim's own quota
26922 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26923 when a local delivery is deferred because a partition is full (the ENOSPC
26924 error).
26925
26926
26927
26928 .section "Retry rules for specified senders" "SECID162"
26929 .cindex "retry" "rules; sender-specific"
26930 You can specify retry rules that apply only when the failing message has a
26931 specific sender. In particular, this can be used to define retry rules that
26932 apply only to bounce messages. The third item in a retry rule can be of this
26933 form:
26934 .display
26935 &`senders=`&<&'address list'&>
26936 .endd
26937 The retry timings themselves are then the fourth item. For example:
26938 .code
26939 *   rcpt_4xx   senders=:   F,1h,30m
26940 .endd
26941 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26942 host. If the address list contains white space, it must be enclosed in quotes.
26943 For example:
26944 .code
26945 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26946 .endd
26947 &*Warning*&: This facility can be unhelpful if it is used for host errors
26948 (which do not depend on the recipient). The reason is that the sender is used
26949 only to match the retry rule. Once the rule has been found for a host error,
26950 its contents are used to set a retry time for the host, and this will apply to
26951 all messages, not just those with specific senders.
26952
26953 When testing retry rules using &%-brt%&, you can supply a sender using the
26954 &%-f%& command line option, like this:
26955 .code
26956 exim -f "" -brt user@dom.ain
26957 .endd
26958 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26959 list is never matched.
26960
26961
26962
26963
26964
26965 .section "Retry parameters" "SECID163"
26966 .cindex "retry" "parameters in rules"
26967 The third (or fourth, if a senders list is present) field in a retry rule is a
26968 sequence of retry parameter sets, separated by semicolons. Each set consists of
26969 .display
26970 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26971 .endd
26972 The letter identifies the algorithm for computing a new retry time; the cutoff
26973 time is the time beyond which this algorithm no longer applies, and the
26974 arguments vary the algorithm's action. The cutoff time is measured from the
26975 time that the first failure for the domain (combined with the local part if
26976 relevant) was detected, not from the time the message was received.
26977
26978 .cindex "retry" "algorithms"
26979 .cindex "retry" "fixed intervals"
26980 .cindex "retry" "increasing intervals"
26981 .cindex "retry" "random intervals"
26982 The available algorithms are:
26983
26984 .ilist
26985 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26986 the interval.
26987 .next
26988 &'G'&: retry at geometrically increasing intervals. The first argument
26989 specifies a starting value for the interval, and the second a multiplier, which
26990 is used to increase the size of the interval at each retry.
26991 .next
26992 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26993 retry, the previous interval is multiplied by the factor in order to get a
26994 maximum for the next interval. The minimum interval is the first argument of
26995 the parameter, and an actual interval is chosen randomly between them. Such a
26996 rule has been found to be helpful in cluster configurations when all the
26997 members of the cluster restart at once, and may therefore synchronize their
26998 queue processing times.
26999 .endlist
27000
27001 When computing the next retry time, the algorithm definitions are scanned in
27002 order until one whose cutoff time has not yet passed is reached. This is then
27003 used to compute a new retry time that is later than the current time. In the
27004 case of fixed interval retries, this simply means adding the interval to the
27005 current time. For geometrically increasing intervals, retry intervals are
27006 computed from the rule's parameters until one that is greater than the previous
27007 interval is found. The main configuration variable
27008 .cindex "limit" "retry interval"
27009 .cindex "retry" "interval, maximum"
27010 .oindex "&%retry_interval_max%&"
27011 &%retry_interval_max%& limits the maximum interval between retries. It
27012 cannot be set greater than &`24h`&, which is its default value.
27013
27014 A single remote domain may have a number of hosts associated with it, and each
27015 host may have more than one IP address. Retry algorithms are selected on the
27016 basis of the domain name, but are applied to each IP address independently. If,
27017 for example, a host has two IP addresses and one is unusable, Exim will
27018 generate retry times for it and will not try to use it until its next retry
27019 time comes. Thus the good IP address is likely to be tried first most of the
27020 time.
27021
27022 .cindex "hints database" "use for retrying"
27023 Retry times are hints rather than promises. Exim does not make any attempt to
27024 run deliveries exactly at the computed times. Instead, a queue runner process
27025 starts delivery processes for delayed messages periodically, and these attempt
27026 new deliveries only for those addresses that have passed their next retry time.
27027 If a new message arrives for a deferred address, an immediate delivery attempt
27028 occurs only if the address has passed its retry time. In the absence of new
27029 messages, the minimum time between retries is the interval between queue runner
27030 processes. There is not much point in setting retry times of five minutes if
27031 your queue runners happen only once an hour, unless there are a significant
27032 number of incoming messages (which might be the case on a system that is
27033 sending everything to a smart host, for example).
27034
27035 The data in the retry hints database can be inspected by using the
27036 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
27037 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
27038 &'exinext'& utility script can be used to find out what the next retry times
27039 are for the hosts associated with a particular mail domain, and also for local
27040 deliveries that have been deferred.
27041
27042
27043 .section "Retry rule examples" "SECID164"
27044 Here are some example retry rules:
27045 .code
27046 alice@wonderland.fict.example quota_5d  F,7d,3h
27047 wonderland.fict.example       quota_5d
27048 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
27049 lookingglass.fict.example     *         F,24h,30m;
27050 *                 refused_A   F,2h,20m;
27051 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
27052 .endd
27053 The first rule sets up special handling for mail to
27054 &'alice@wonderland.fict.example'& when there is an over-quota error and the
27055 mailbox has not been read for at least 5 days. Retries continue every three
27056 hours for 7 days. The second rule handles over-quota errors for all other local
27057 parts at &'wonderland.fict.example'&; the absence of a local part has the same
27058 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
27059 fail are bounced immediately if the mailbox has not been read for at least 5
27060 days.
27061
27062 The third rule handles all other errors at &'wonderland.fict.example'&; retries
27063 happen every 15 minutes for an hour, then with geometrically increasing
27064 intervals until two days have passed since a delivery first failed. After the
27065 first hour there is a delay of one hour, then two hours, then four hours, and
27066 so on (this is a rather extreme example).
27067
27068 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
27069 They happen every 30 minutes for 24 hours only. The remaining two rules handle
27070 all other domains, with special action for connection refusal from hosts that
27071 were not obtained from an MX record.
27072
27073 The final rule in a retry configuration should always have asterisks in the
27074 first two fields so as to provide a general catch-all for any addresses that do
27075 not have their own special handling. This example tries every 15 minutes for 2
27076 hours, then with intervals starting at one hour and increasing by a factor of
27077 1.5 up to 16 hours, then every 8 hours up to 5 days.
27078
27079
27080
27081 .section "Timeout of retry data" "SECID165"
27082 .cindex "timeout" "of retry data"
27083 .oindex "&%retry_data_expire%&"
27084 .cindex "hints database" "data expiry"
27085 .cindex "retry" "timeout of data"
27086 Exim timestamps the data that it writes to its retry hints database. When it
27087 consults the data during a delivery it ignores any that is older than the value
27088 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
27089 been tried for 7 days, Exim will try to deliver to it immediately a message
27090 arrives, and if that fails, it will calculate a retry time as if it were
27091 failing for the first time.
27092
27093 This improves the behaviour for messages routed to rarely-used hosts such as MX
27094 backups. If such a host was down at one time, and happens to be down again when
27095 Exim tries a month later, using the old retry data would imply that it had been
27096 down all the time, which is not a justified assumption.
27097
27098 If a host really is permanently dead, this behaviour causes a burst of retries
27099 every now and again, but only if messages routed to it are rare. If there is a
27100 message at least once every 7 days the retry data never expires.
27101
27102
27103
27104
27105 .section "Long-term failures" "SECID166"
27106 .cindex "delivery failure, long-term"
27107 .cindex "retry" "after long-term failure"
27108 Special processing happens when an email address has been failing for so long
27109 that the cutoff time for the last algorithm is reached. For example, using the
27110 default retry rule:
27111 .code
27112 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
27113 .endd
27114 the cutoff time is four days. Reaching the retry cutoff is independent of how
27115 long any specific message has been failing; it is the length of continuous
27116 failure for the recipient address that counts.
27117
27118 When the cutoff time is reached for a local delivery, or for all the IP
27119 addresses associated with a remote delivery, a subsequent delivery failure
27120 causes Exim to give up on the address, and a bounce message is generated.
27121 In order to cater for new messages that use the failing address, a next retry
27122 time is still computed from the final algorithm, and is used as follows:
27123
27124 For local deliveries, one delivery attempt is always made for any subsequent
27125 messages. If this delivery fails, the address fails immediately. The
27126 post-cutoff retry time is not used.
27127
27128 .cindex "final cutoff" "retries, controlling"
27129 .cindex retry "final cutoff"
27130 If the delivery is remote, there are two possibilities, controlled by the
27131 .oindex "&%delay_after_cutoff%&"
27132 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
27133 default. Until the post-cutoff retry time for one of the IP addresses,
27134 as set by the &%retry_data_expire%& option, is
27135 reached, the failing email address is bounced immediately, without a delivery
27136 attempt taking place. After that time, one new delivery attempt is made to
27137 those IP addresses that are past their retry times, and if that still fails,
27138 the address is bounced and new retry times are computed.
27139
27140 In other words, when all the hosts for a given email address have been failing
27141 for a long time, Exim bounces rather then defers until one of the hosts' retry
27142 times is reached. Then it tries once, and bounces if that attempt fails. This
27143 behaviour ensures that few resources are wasted in repeatedly trying to deliver
27144 to a broken destination, but if the host does recover, Exim will eventually
27145 notice.
27146
27147 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
27148 addresses are past their final cutoff time, Exim tries to deliver to those IP
27149 addresses that have not been tried since the message arrived. If there are
27150 no suitable IP addresses, or if they all fail, the address is bounced. In other
27151 words, it does not delay when a new message arrives, but tries the expired
27152 addresses immediately, unless they have been tried since the message arrived.
27153 If there is a continuous stream of messages for the failing domains, setting
27154 &%delay_after_cutoff%& false means that there will be many more attempts to
27155 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
27156 true.
27157
27158 .section "Deliveries that work intermittently" "SECID167"
27159 .cindex "retry" "intermittently working deliveries"
27160 Some additional logic is needed to cope with cases where a host is
27161 intermittently available, or when a message has some attribute that prevents
27162 its delivery when others to the same address get through. In this situation,
27163 because some messages are successfully delivered, the &"retry clock"& for the
27164 host or address keeps getting reset by the successful deliveries, and so
27165 failing messages remain in the queue for ever because the cutoff time is never
27166 reached.
27167
27168 Two exceptional actions are applied to prevent this happening. The first
27169 applies to errors that are related to a message rather than a remote host.
27170 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
27171 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
27172 commands, and quota failures. For this type of error, if a message's arrival
27173 time is earlier than the &"first failed"& time for the error, the earlier time
27174 is used when scanning the retry rules to decide when to try next and when to
27175 time out the address.
27176
27177 The exceptional second action applies in all cases. If a message has been on
27178 the queue for longer than the cutoff time of any applicable retry rule for a
27179 given address, a delivery is attempted for that address, even if it is not yet
27180 time, and if this delivery fails, the address is timed out. A new retry time is
27181 not computed in this case, so that other messages for the same address are
27182 considered immediately.
27183 .ecindex IIDretconf1
27184 .ecindex IIDregconf2
27185
27186
27187
27188
27189
27190
27191 . ////////////////////////////////////////////////////////////////////////////
27192 . ////////////////////////////////////////////////////////////////////////////
27193
27194 .chapter "SMTP authentication" "CHAPSMTPAUTH"
27195 .scindex IIDauthconf1 "SMTP" "authentication configuration"
27196 .scindex IIDauthconf2 "authentication"
27197 The &"authenticators"& section of Exim's runtime configuration is concerned
27198 with SMTP authentication. This facility is an extension to the SMTP protocol,
27199 described in RFC 2554, which allows a client SMTP host to authenticate itself
27200 to a server. This is a common way for a server to recognize clients that are
27201 permitted to use it as a relay. SMTP authentication is not of relevance to the
27202 transfer of mail between servers that have no managerial connection with each
27203 other.
27204
27205 The name of an authenticator is limited to be &drivernamemax; ASCII characters long;
27206 prior to Exim 4.95 names would be silently truncated at this length, but now
27207 it is enforced.
27208
27209 .cindex "AUTH" "description of"
27210 .cindex "ESMTP extensions" AUTH
27211 Very briefly, the way SMTP authentication works is as follows:
27212
27213 .ilist
27214 The server advertises a number of authentication &'mechanisms'& in response to
27215 the client's EHLO command.
27216 .next
27217 The client issues an AUTH command, naming a specific mechanism. The command
27218 may, optionally, contain some authentication data.
27219 .next
27220 The server may issue one or more &'challenges'&, to which the client must send
27221 appropriate responses. In simple authentication mechanisms, the challenges are
27222 just prompts for user names and passwords. The server does not have to issue
27223 any challenges &-- in some mechanisms the relevant data may all be transmitted
27224 with the AUTH command.
27225 .next
27226 The server either accepts or denies authentication.
27227 .next
27228 If authentication succeeds, the client may optionally make use of the AUTH
27229 option on the MAIL command to pass an authenticated sender in subsequent
27230 mail transactions. Authentication lasts for the remainder of the SMTP
27231 connection.
27232 .next
27233 If authentication fails, the client may give up, or it may try a different
27234 authentication mechanism, or it may try transferring mail over the
27235 unauthenticated connection.
27236 .endlist
27237
27238 If you are setting up a client, and want to know which authentication
27239 mechanisms the server supports, you can use Telnet to connect to port 25 (the
27240 SMTP port) on the server, and issue an EHLO command. The response to this
27241 includes the list of supported mechanisms. For example:
27242 .display
27243 &`$ `&&*&`telnet server.example 25`&*&
27244 &`Trying 192.168.34.25...`&
27245 &`Connected to server.example.`&
27246 &`Escape character is &#x0027;^]&#x0027;.`&
27247 &`220 server.example ESMTP Exim 4.20 ...`&
27248 &*&`ehlo client.example`&*&
27249 &`250-server.example Hello client.example [10.8.4.5]`&
27250 &`250-SIZE 52428800`&
27251 &`250-PIPELINING`&
27252 &`250-AUTH PLAIN`&
27253 &`250 HELP`&
27254 .endd
27255 The second-last line of this example output shows that the server supports
27256 authentication using the PLAIN mechanism. In Exim, the different authentication
27257 mechanisms are configured by specifying &'authenticator'& drivers. Like the
27258 routers and transports, which authenticators are included in the binary is
27259 controlled by build-time definitions. The following are currently available,
27260 included by setting
27261 .code
27262 AUTH_CRAM_MD5=yes
27263 AUTH_CYRUS_SASL=yes
27264 AUTH_DOVECOT=yes
27265 AUTH_EXTERNAL=yes
27266 AUTH_GSASL=yes
27267 AUTH_HEIMDAL_GSSAPI=yes
27268 AUTH_PLAINTEXT=yes
27269 AUTH_SPA=yes
27270 AUTH_TLS=yes
27271 .endd
27272 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
27273 authentication mechanism (RFC 2195), and the second provides an interface to
27274 the Cyrus SASL authentication library.
27275 The third is an interface to Dovecot's authentication system, delegating the
27276 work via a socket interface.
27277 The fourth provides for negotiation of authentication done via non-SMTP means,
27278 as defined by RFC 4422 Appendix A.
27279 The fifth provides an interface to the GNU SASL authentication library, which
27280 provides mechanisms but typically not data sources.
27281 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
27282 supporting setting a server keytab.
27283 The seventh can be configured to support
27284 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
27285 not formally documented, but used by several MUAs.
27286 The eighth authenticator
27287 supports Microsoft's &'Secure Password Authentication'& mechanism.
27288 The last is an Exim authenticator but not an SMTP one;
27289 instead it can use information from a TLS negotiation.
27290
27291 The authenticators are configured using the same syntax as other drivers (see
27292 section &<<SECTfordricon>>&). If no authenticators are required, no
27293 authentication section need be present in the configuration file. Each
27294 authenticator can in principle have both server and client functions. When Exim
27295 is receiving SMTP mail, it is acting as a server; when it is sending out
27296 messages over SMTP, it is acting as a client. Authenticator configuration
27297 options are provided for use in both these circumstances.
27298
27299 To make it clear which options apply to which situation, the prefixes
27300 &%server_%& and &%client_%& are used on option names that are specific to
27301 either the server or the client function, respectively. Server and client
27302 functions are disabled if none of their options are set. If an authenticator is
27303 to be used for both server and client functions, a single definition, using
27304 both sets of options, is required. For example:
27305 .code
27306 cram:
27307   driver = cram_md5
27308   public_name = CRAM-MD5
27309   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
27310   client_name = ph10
27311   client_secret = secret2
27312 .endd
27313 The &%server_%& option is used when Exim is acting as a server, and the
27314 &%client_%& options when it is acting as a client.
27315
27316 Descriptions of the individual authenticators are given in subsequent chapters.
27317 The remainder of this chapter covers the generic options for the
27318 authenticators, followed by general discussion of the way authentication works
27319 in Exim.
27320
27321 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27322 per-mechanism basis.  Please read carefully to determine which variables hold
27323 account labels such as usercodes and which hold passwords or other
27324 authenticating data.
27325
27326 Note that some mechanisms support two different identifiers for accounts: the
27327 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27328 and &'authz'& are commonly encountered.  The American spelling is standard here.
27329 Conceptually, authentication data such as passwords are tied to the identifier
27330 used to authenticate; servers may have rules to permit one user to act as a
27331 second user, so that after login the session is treated as though that second
27332 user had logged in.  That second user is the &'authorization id'&.  A robust
27333 configuration might confirm that the &'authz'& field is empty or matches the
27334 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27335 as verified data, the &'authz'& as an unverified request which the server might
27336 choose to honour.
27337
27338 A &'realm'& is a text string, typically a domain name, presented by a server
27339 to a client to help it select an account and credentials to use.  In some
27340 mechanisms, the client and server provably agree on the realm, but clients
27341 typically can not treat the realm as secure data to be blindly trusted.
27342
27343
27344
27345 .section "Generic options for authenticators" "SECID168"
27346 .cindex "authentication" "generic options"
27347 .cindex "options" "generic; for authenticators"
27348
27349 .option client_condition authenticators string&!! unset
27350 When Exim is authenticating as a client, it skips any authenticator whose
27351 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27352 used, for example, to skip plain text authenticators when the connection is not
27353 encrypted by a setting such as:
27354 .code
27355 client_condition = ${if !eq{$tls_out_cipher}{}}
27356 .endd
27357
27358
27359 .option client_set_id authenticators string&!! unset
27360 When client authentication succeeds, this condition is expanded; the
27361 result is used in the log lines for outbound messages.
27362 Typically it will be the user name used for authentication.
27363
27364
27365 .option driver authenticators string unset
27366 This option must always be set. It specifies which of the available
27367 authenticators is to be used.
27368
27369
27370 .option public_name authenticators string unset
27371 This option specifies the name of the authentication mechanism that the driver
27372 implements, and by which it is known to the outside world. These names should
27373 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27374 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27375 defaults to the driver's instance name.
27376
27377
27378 .option server_advertise_condition authenticators string&!! unset
27379 When a server is about to advertise an authentication mechanism, the condition
27380 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27381 mechanism is not advertised.
27382 If the expansion fails, the mechanism is not advertised. If the failure was not
27383 forced, and was not caused by a lookup defer, the incident is logged.
27384 See section &<<SECTauthexiser>>& below for further discussion.
27385
27386
27387 .option server_condition authenticators string&!! unset
27388 This option must be set for a &%plaintext%& server authenticator, where it
27389 is used directly to control authentication. See section &<<SECTplainserver>>&
27390 for details.
27391
27392 For the &(gsasl)& authenticator, this option is required for various
27393 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27394
27395 For the other authenticators, &%server_condition%& can be used as an additional
27396 authentication or authorization mechanism that is applied after the other
27397 authenticator conditions succeed. If it is set, it is expanded when the
27398 authenticator would otherwise return a success code. If the expansion is forced
27399 to fail, authentication fails. Any other expansion failure causes a temporary
27400 error code to be returned. If the result of a successful expansion is an empty
27401 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27402 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27403 other result, a temporary error code is returned, with the expanded string as
27404 the error text.
27405
27406
27407 .option server_debug_print authenticators string&!! unset
27408 If this option is set and authentication debugging is enabled (see the &%-d%&
27409 command line option), the string is expanded and included in the debugging
27410 output when the authenticator is run as a server. This can help with checking
27411 out the values of variables.
27412 If expansion of the string fails, the error message is written to the debugging
27413 output, and Exim carries on processing.
27414
27415
27416 .option server_set_id authenticators string&!! unset
27417 .vindex "&$authenticated_id$&"
27418 .vindex "&$authenticated_fail_id$&"
27419 When an Exim server successfully authenticates a client, this string is
27420 expanded using data from the authentication, and preserved for any incoming
27421 messages in the variable &$authenticated_id$&. It is also included in the log
27422 lines for incoming messages. For example, a user/password authenticator
27423 configuration might preserve the user name that was used to authenticate, and
27424 refer to it subsequently during delivery of the message.
27425 On a failing authentication the expansion result is instead saved in
27426 the &$authenticated_fail_id$& variable.
27427 If expansion fails, the option is ignored.
27428
27429
27430 .option server_mail_auth_condition authenticators string&!! unset
27431 This option allows a server to discard authenticated sender addresses supplied
27432 as part of MAIL commands in SMTP connections that are authenticated by the
27433 driver on which &%server_mail_auth_condition%& is set. The option is not used
27434 as part of the authentication process; instead its (unexpanded) value is
27435 remembered for later use.
27436 How it is used is described in the following section.
27437
27438
27439
27440
27441
27442 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27443 .cindex "authentication" "sender; authenticated"
27444 .cindex "AUTH" "on MAIL command"
27445 When a client supplied an AUTH= item on a MAIL command, Exim applies
27446 the following checks before accepting it as the authenticated sender of the
27447 message:
27448
27449 .ilist
27450 If the connection is not using extended SMTP (that is, HELO was used rather
27451 than EHLO), the use of AUTH= is a syntax error.
27452 .next
27453 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27454 .next
27455 .vindex "&$authenticated_sender$&"
27456 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27457 running, the value of &$authenticated_sender$& is set to the value obtained
27458 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27459 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27460 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27461 given for the MAIL command.
27462 .next
27463 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27464 is accepted and placed in &$authenticated_sender$& only if the client has
27465 authenticated.
27466 .next
27467 If the AUTH= value was accepted by either of the two previous rules, and
27468 the client has authenticated, and the authenticator has a setting for the
27469 &%server_mail_auth_condition%&, the condition is checked at this point. The
27470 valued that was saved from the authenticator is expanded. If the expansion
27471 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27472 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27473 the value of &$authenticated_sender$& is retained and passed on with the
27474 message.
27475 .endlist
27476
27477
27478 When &$authenticated_sender$& is set for a message, it is passed on to other
27479 hosts to which Exim authenticates as a client. Do not confuse this value with
27480 &$authenticated_id$&, which is a string obtained from the authentication
27481 process, and which is not usually a complete email address.
27482
27483 .vindex "&$sender_address$&"
27484 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27485 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27486 therefore make use of &$authenticated_sender$&. The converse is not true: the
27487 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27488 ACL is run.
27489
27490
27491
27492 .section "Authentication on an Exim server" "SECTauthexiser"
27493 .cindex "authentication" "on an Exim server"
27494 When Exim receives an EHLO command, it advertises the public names of those
27495 authenticators that are configured as servers, subject to the following
27496 conditions:
27497
27498 .ilist
27499 The client host must match &%auth_advertise_hosts%& (default *).
27500 .next
27501 If the &%server_advertise_condition%& option is set, its expansion must not
27502 yield the empty string, &"0"&, &"no"&, or &"false"&.
27503 .endlist
27504
27505 The order in which the authenticators are defined controls the order in which
27506 the mechanisms are advertised.
27507
27508 Some mail clients (for example, some versions of Netscape) require the user to
27509 provide a name and password for authentication whenever AUTH is advertised,
27510 even though authentication may not in fact be needed (for example, Exim may be
27511 set up to allow unconditional relaying from the client by an IP address check).
27512 You can make such clients more friendly by not advertising AUTH to them.
27513 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27514 that runs for RCPT) to relay without authentication, you should set
27515 .code
27516 auth_advertise_hosts = ! 10.9.8.0/24
27517 .endd
27518 so that no authentication mechanisms are advertised to them.
27519
27520 The &%server_advertise_condition%& controls the advertisement of individual
27521 authentication mechanisms. For example, it can be used to restrict the
27522 advertisement of a particular mechanism to encrypted connections, by a setting
27523 such as:
27524 .code
27525 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27526 .endd
27527 .vindex "&$tls_in_cipher$&"
27528 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27529 yields &"yes"&, which allows the advertisement to happen.
27530
27531 When an Exim server receives an AUTH command from a client, it rejects it
27532 immediately if AUTH was not advertised in response to an earlier EHLO
27533 command. This is the case if
27534
27535 .ilist
27536 The client host does not match &%auth_advertise_hosts%&; or
27537 .next
27538 No authenticators are configured with server options; or
27539 .next
27540 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27541 server authenticators.
27542 .endlist
27543
27544
27545 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27546 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27547 AUTH is accepted from any client host.
27548
27549 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27550 server authentication mechanism that was advertised in response to EHLO and
27551 that matches the one named in the AUTH command. If it finds one, it runs
27552 the appropriate authentication protocol, and authentication either succeeds or
27553 fails. If there is no matching advertised mechanism, the AUTH command is
27554 rejected with a 504 error.
27555
27556 .vindex "&$received_protocol$&"
27557 .vindex "&$sender_host_authenticated$&"
27558 When a message is received from an authenticated host, the value of
27559 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27560 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27561 public name) of the authenticator driver that successfully authenticated the
27562 client from which the message was received. This variable is empty if there was
27563 no successful authentication.
27564
27565 .cindex authentication "expansion item"
27566 Successful authentication sets up information used by the
27567 &%authresults%& expansion item.
27568
27569
27570
27571
27572 .section "Testing server authentication" "SECID169"
27573 .cindex "authentication" "testing a server"
27574 .cindex "AUTH" "testing a server"
27575 .cindex "base64 encoding" "creating authentication test data"
27576 Exim's &%-bh%& option can be useful for testing server authentication
27577 configurations. The data for the AUTH command has to be sent using base64
27578 encoding. A quick way to produce such data for testing is the following Perl
27579 script:
27580 .code
27581 use MIME::Base64;
27582 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27583 .endd
27584 .cindex "binary zero" "in authentication data"
27585 This interprets its argument as a Perl string, and then encodes it. The
27586 interpretation as a Perl string allows binary zeros, which are required for
27587 some kinds of authentication, to be included in the data. For example, a
27588 command line to run this script on such data might be
27589 .code
27590 encode '\0user\0password'
27591 .endd
27592 Note the use of single quotes to prevent the shell interpreting the
27593 backslashes, so that they can be interpreted by Perl to specify characters
27594 whose code value is zero.
27595
27596 &*Warning 1*&: If either of the user or password strings starts with an octal
27597 digit, you must use three zeros instead of one after the leading backslash. If
27598 you do not, the octal digit that starts your string will be incorrectly
27599 interpreted as part of the code for the first character.
27600
27601 &*Warning 2*&: If there are characters in the strings that Perl interprets
27602 specially, you must use a Perl escape to prevent them being misinterpreted. For
27603 example, a command such as
27604 .code
27605 encode '\0user@domain.com\0pas$$word'
27606 .endd
27607 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27608
27609 If you have the &%mimencode%& command installed, another way to produce
27610 base64-encoded strings is to run the command
27611 .code
27612 echo -e -n `\0user\0password' | mimencode
27613 .endd
27614 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27615 in the argument, and the &%-n%& option specifies no newline at the end of its
27616 output. However, not all versions of &%echo%& recognize these options, so you
27617 should check your version before relying on this suggestion.
27618
27619
27620
27621 .section "Authentication by an Exim client" "SECID170"
27622 .cindex "authentication" "on an Exim client"
27623 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27624 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27625 announces support for authentication, and the host matches an entry in either
27626 of these options, Exim (as a client) tries to authenticate as follows:
27627
27628 .ilist
27629 For each authenticator that is configured as a client, in the order in which
27630 they are defined in the configuration, it searches the authentication
27631 mechanisms announced by the server for one whose name matches the public name
27632 of the authenticator.
27633 .next
27634 .vindex "&$host$&"
27635 .vindex "&$host_address$&"
27636 When it finds one that matches, it runs the authenticator's client code. The
27637 variables &$host$& and &$host_address$& are available for any string expansions
27638 that the client might do. They are set to the server's name and IP address. If
27639 any expansion is forced to fail, the authentication attempt is abandoned, and
27640 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27641 delivery to be deferred.
27642 .next
27643 If the result of the authentication attempt is a temporary error or a timeout,
27644 Exim abandons trying to send the message to the host for the moment. It will
27645 try again later. If there are any backup hosts available, they are tried in the
27646 usual way.
27647 .next
27648 If the response to authentication is a permanent error (5&'xx'& code), Exim
27649 carries on searching the list of authenticators and tries another one if
27650 possible. If all authentication attempts give permanent errors, or if there are
27651 no attempts because no mechanisms match (or option expansions force failure),
27652 what happens depends on whether the host matches &%hosts_require_auth%& or
27653 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27654 delivery is deferred. The error can be detected in the retry rules, and thereby
27655 turned into a permanent error if you wish. In the second case, Exim tries to
27656 deliver the message unauthenticated.
27657 .endlist
27658
27659 Note that the hostlist test for whether to do authentication can be
27660 confused if name-IP lookups change between the time the peer is decided
27661 upon and the time that the transport runs.  For example, with a manualroute
27662 router given a host name, and with DNS "round-robin" used by that name: if
27663 the local resolver cache times out between the router and the transport
27664 running, the transport may get an IP for the name for its authentication
27665 check which does not match the connection peer IP.
27666 No authentication will then be done, despite the names being identical.
27667
27668 For such cases use a separate transport which always authenticates.
27669
27670 .cindex "AUTH" "on MAIL command"
27671 When Exim has authenticated itself to a remote server, it adds the AUTH
27672 parameter to the MAIL commands it sends, if it has an authenticated sender for
27673 the message. If the message came from a remote host, the authenticated sender
27674 is the one that was receiving on an incoming MAIL command, provided that the
27675 incoming connection was authenticated and the &%server_mail_auth%& condition
27676 allowed the authenticated sender to be retained. If a local process calls Exim
27677 to send a message, the sender address that is built from the login name and
27678 &%qualify_domain%& is treated as authenticated. However, if the
27679 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27680 the authenticated sender that was received with the message.
27681 .ecindex IIDauthconf1
27682 .ecindex IIDauthconf2
27683
27684
27685
27686
27687
27688
27689 . ////////////////////////////////////////////////////////////////////////////
27690 . ////////////////////////////////////////////////////////////////////////////
27691
27692 .chapter "The plaintext authenticator" "CHAPplaintext"
27693 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27694 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27695 The &(plaintext)& authenticator can be configured to support the PLAIN and
27696 LOGIN authentication mechanisms, both of which transfer authentication data as
27697 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27698 security risk; you are strongly advised to insist on the use of SMTP encryption
27699 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27700 use unencrypted plain text, you should not use the same passwords for SMTP
27701 connections as you do for login accounts.
27702
27703 .section "Avoiding cleartext use" "SECTplain_TLS"
27704 The following generic option settings will disable &(plaintext)& authenticators when
27705 TLS is not being used:
27706 .code
27707   server_advertise_condition = ${if def:tls_in_cipher }
27708   client_condition =           ${if def:tls_out_cipher}
27709 .endd
27710
27711 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27712 but is still vulnerable to a Man In The Middle attack unless certificates
27713 (including their names) have been properly verified.
27714
27715 .section "Plaintext server options" "SECID171"
27716 .cindex "options" "&(plaintext)& authenticator (server)"
27717 When configured as a server, &(plaintext)& uses the following options:
27718
27719 .option server_condition authenticators string&!! unset
27720 This is actually a global authentication option, but it must be set in order to
27721 configure the &(plaintext)& driver as a server. Its use is described below.
27722
27723 .option server_prompts plaintext "string list&!!" unset
27724 The contents of this option, after expansion, must be a colon-separated list of
27725 prompt strings. If expansion fails, a temporary authentication rejection is
27726 given.
27727
27728 .section "Using plaintext in a server" "SECTplainserver"
27729 .cindex "AUTH" "in &(plaintext)& authenticator"
27730 .cindex "binary zero" "in &(plaintext)& authenticator"
27731 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27732         "in &(plaintext)& authenticator"
27733 .vindex "&$auth1$&, &$auth2$&, etc"
27734 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27735
27736 When running as a server, &(plaintext)& performs the authentication test by
27737 expanding a string. The data sent by the client with the AUTH command, or in
27738 response to subsequent prompts, is base64 encoded, and so may contain any byte
27739 values when decoded. If any data is supplied with the command, it is treated as
27740 a list of strings, separated by NULs (binary zeros), the first three of which
27741 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27742 (neither LOGIN nor PLAIN uses more than three strings).
27743
27744 For compatibility with previous releases of Exim, the values are also placed in
27745 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27746 variables for this purpose is now deprecated, as it can lead to confusion in
27747 string expansions that also use them for other things.
27748
27749 If there are more strings in &%server_prompts%& than the number of strings
27750 supplied with the AUTH command, the remaining prompts are used to obtain more
27751 data. Each response from the client may be a list of NUL-separated strings.
27752
27753 .vindex "&$authenticated_id$&"
27754 Once a sufficient number of data strings have been received,
27755 &%server_condition%& is expanded. If the expansion is forced to fail,
27756 authentication fails. Any other expansion failure causes a temporary error code
27757 to be returned. If the result of a successful expansion is an empty string,
27758 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27759 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27760 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27761 For any other result, a temporary error code is returned, with the expanded
27762 string as the error text.
27763
27764 &*Warning*&: If you use a lookup in the expansion to find the user's
27765 password, be sure to make the authentication fail if the user is unknown.
27766 There are good and bad examples at the end of the next section.
27767
27768
27769
27770 .section "The PLAIN authentication mechanism" "SECID172"
27771 .cindex "PLAIN authentication mechanism"
27772 .cindex authentication PLAIN
27773 .cindex "binary zero" "in &(plaintext)& authenticator"
27774 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27775 sent as one item of data (that is, one combined string containing two NUL
27776 separators). The data is sent either as part of the AUTH command, or
27777 subsequently in response to an empty prompt from the server.
27778
27779 The second and third strings are a user name and a corresponding password.
27780 Using a single fixed user name and password as an example, this could be
27781 configured as follows:
27782 .code
27783 fixed_plain:
27784   driver = plaintext
27785   public_name = PLAIN
27786   server_prompts = :
27787   server_condition = \
27788     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27789   server_set_id = $auth2
27790 .endd
27791 Note that the default result strings from &%if%& (&"true"& or an empty string)
27792 are exactly what we want here, so they need not be specified. Obviously, if the
27793 password contains expansion-significant characters such as dollar, backslash,
27794 or closing brace, they have to be escaped.
27795
27796 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27797 the end of a string list are ignored). If all the data comes as part of the
27798 AUTH command, as is commonly the case, the prompt is not used. This
27799 authenticator is advertised in the response to EHLO as
27800 .code
27801 250-AUTH PLAIN
27802 .endd
27803 and a client host can authenticate itself by sending the command
27804 .code
27805 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27806 .endd
27807 As this contains three strings (more than the number of prompts), no further
27808 data is required from the client. Alternatively, the client may just send
27809 .code
27810 AUTH PLAIN
27811 .endd
27812 to initiate authentication, in which case the server replies with an empty
27813 prompt. The client must respond with the combined data string.
27814
27815 The data string is base64 encoded, as required by the RFC. This example,
27816 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27817 represents a zero byte. This is split up into three strings, the first of which
27818 is empty. The &%server_condition%& option in the authenticator checks that the
27819 second two are &`username`& and &`mysecret`& respectively.
27820
27821 Having just one fixed user name and password, as in this example, is not very
27822 realistic, though for a small organization with only a handful of
27823 authenticating clients it could make sense.
27824
27825 A more sophisticated instance of this authenticator could use the user name in
27826 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27827 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27828 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27829 This is an incorrect example:
27830 .code
27831 server_condition = \
27832   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27833 .endd
27834 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27835 which it then compares to the supplied password (&$auth3$&). Why is this example
27836 incorrect? It works fine for existing users, but consider what happens if a
27837 non-existent user name is given. The lookup fails, but as no success/failure
27838 strings are given for the lookup, it yields an empty string. Thus, to defeat
27839 the authentication, all a client has to do is to supply a non-existent user
27840 name and an empty password. The correct way of writing this test is:
27841 .code
27842 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27843   {${if eq{$value}{$auth3}}} {false}}
27844 .endd
27845 In this case, if the lookup succeeds, the result is checked; if the lookup
27846 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27847 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27848 always fails if its second argument is empty. However, the second way of
27849 writing the test makes the logic clearer.
27850
27851
27852 .section "The LOGIN authentication mechanism" "SECID173"
27853 .cindex "LOGIN authentication mechanism"
27854 .cindex authentication LOGIN
27855 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27856 in a number of programs. No data is sent with the AUTH command. Instead, a
27857 user name and password are supplied separately, in response to prompts. The
27858 plaintext authenticator can be configured to support this as in this example:
27859 .code
27860 fixed_login:
27861   driver = plaintext
27862   public_name = LOGIN
27863   server_prompts = User Name : Password
27864   server_condition = \
27865     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27866   server_set_id = $auth1
27867 .endd
27868 Because of the way plaintext operates, this authenticator accepts data supplied
27869 with the AUTH command (in contravention of the specification of LOGIN), but
27870 if the client does not supply it (as is the case for LOGIN clients), the prompt
27871 strings are used to obtain two data items.
27872
27873 Some clients are very particular about the precise text of the prompts. For
27874 example, Outlook Express is reported to recognize only &"Username:"& and
27875 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27876 strings. It uses the &%ldapauth%& expansion condition to check the user
27877 name and password by binding to an LDAP server:
27878 .code
27879 login:
27880   driver = plaintext
27881   public_name = LOGIN
27882   server_prompts = Username:: : Password::
27883   server_condition = ${if and{{ \
27884     !eq{}{$auth1} }{ \
27885     ldapauth{\
27886       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27887       pass=${quote:$auth2} \
27888       ldap://ldap.example.org/} }} }
27889   server_set_id = uid=$auth1,ou=people,o=example.org
27890 .endd
27891 We have to check that the username is not empty before using it, because LDAP
27892 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27893 operator to correctly quote the DN for authentication. However, the basic
27894 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27895 correct one to use for the password, because quoting is needed only to make
27896 the password conform to the Exim syntax. At the LDAP level, the password is an
27897 uninterpreted string.
27898
27899
27900 .section "Support for different kinds of authentication" "SECID174"
27901 A number of string expansion features are provided for the purpose of
27902 interfacing to different ways of user authentication. These include checking
27903 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27904 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27905 &<<SECTexpcond>>&.
27906
27907
27908
27909
27910 .section "Using plaintext in a client" "SECID175"
27911 .cindex "options" "&(plaintext)& authenticator (client)"
27912 The &(plaintext)& authenticator has two client options:
27913
27914 .option client_ignore_invalid_base64 plaintext boolean false
27915 If the client receives a server prompt that is not a valid base64 string,
27916 authentication is abandoned by default. However, if this option is set true,
27917 the error in the challenge is ignored and the client sends the response as
27918 usual.
27919
27920 .option client_send plaintext string&!! unset
27921 The string is a colon-separated list of authentication data strings. Each
27922 string is independently expanded before being sent to the server. The first
27923 string is sent with the AUTH command; any more strings are sent in response
27924 to prompts from the server. Before each string is expanded, the value of the
27925 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27926 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27927 way. Thus, the prompt that is received in response to sending the first string
27928 (with the AUTH command) can be used in the expansion of the second string, and
27929 so on. If an invalid base64 string is received when
27930 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27931 &$auth$&<&'n'&> variable.
27932
27933 &*Note*&: You cannot use expansion to create multiple strings, because
27934 splitting takes priority and happens first.
27935
27936 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27937 the data, further processing is applied to each string before it is sent. If
27938 there are any single circumflex characters in the string, they are converted to
27939 NULs. Should an actual circumflex be required as data, it must be doubled in
27940 the string.
27941
27942 This is an example of a client configuration that implements the PLAIN
27943 authentication mechanism with a fixed user name and password:
27944 .code
27945 fixed_plain:
27946   driver = plaintext
27947   public_name = PLAIN
27948   client_send = ^username^mysecret
27949 .endd
27950 The lack of colons means that the entire text is sent with the AUTH
27951 command, with the circumflex characters converted to NULs.
27952 Note that due to the ambiguity of parsing three consectutive circumflex characters
27953 there is no way to provide a password having a leading circumflex.
27954
27955
27956 A similar example
27957 that uses the LOGIN mechanism is:
27958 .code
27959 fixed_login:
27960   driver = plaintext
27961   public_name = LOGIN
27962   client_send = : username : mysecret
27963 .endd
27964 The initial colon means that the first string is empty, so no data is sent with
27965 the AUTH command itself. The remaining strings are sent in response to
27966 prompts.
27967 .ecindex IIDplaiauth1
27968 .ecindex IIDplaiauth2
27969
27970
27971
27972
27973 . ////////////////////////////////////////////////////////////////////////////
27974 . ////////////////////////////////////////////////////////////////////////////
27975
27976 .chapter "The cram_md5 authenticator" "CHID9"
27977 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27978 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27979 .cindex "CRAM-MD5 authentication mechanism"
27980 .cindex authentication CRAM-MD5
27981 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27982 sends a challenge string to the client, and the response consists of a user
27983 name and the CRAM-MD5 digest of the challenge string combined with a secret
27984 string (password) which is known to both server and client. Thus, the secret
27985 is not sent over the network as plain text, which makes this authenticator more
27986 secure than &(plaintext)&. However, the downside is that the secret has to be
27987 available in plain text at either end.
27988
27989
27990 .section "Using cram_md5 as a server" "SECID176"
27991 .cindex "options" "&(cram_md5)& authenticator (server)"
27992 This authenticator has one server option, which must be set to configure the
27993 authenticator as a server:
27994
27995 .option server_secret cram_md5 string&!! unset
27996 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27997 When the server receives the client's response, the user name is placed in
27998 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27999 obtain the password for that user. The server then computes the CRAM-MD5 digest
28000 that the client should have sent, and checks that it received the correct
28001 string. If the expansion of &%server_secret%& is forced to fail, authentication
28002 fails. If the expansion fails for some other reason, a temporary error code is
28003 returned to the client.
28004
28005 For compatibility with previous releases of Exim, the user name is also placed
28006 in &$1$&. However, the use of this variables for this purpose is now
28007 deprecated, as it can lead to confusion in string expansions that also use
28008 numeric variables for other things.
28009
28010 For example, the following authenticator checks that the user name given by the
28011 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
28012 user name, authentication fails.
28013 .code
28014 fixed_cram:
28015   driver = cram_md5
28016   public_name = CRAM-MD5
28017   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
28018   server_set_id = $auth1
28019 .endd
28020 .vindex "&$authenticated_id$&"
28021 If authentication succeeds, the setting of &%server_set_id%& preserves the user
28022 name in &$authenticated_id$&. A more typical configuration might look up the
28023 secret string in a file, using the user name as the key. For example:
28024 .code
28025 lookup_cram:
28026   driver = cram_md5
28027   public_name = CRAM-MD5
28028   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
28029                   {$value}fail}
28030   server_set_id = $auth1
28031 .endd
28032 Note that this expansion explicitly forces failure if the lookup fails
28033 because &$auth1$& contains an unknown user name.
28034
28035 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
28036 using the relevant libraries, you need to know the realm to specify in the
28037 lookup and then ask for the &"userPassword"& attribute for that user in that
28038 realm, with:
28039 .code
28040 cyrusless_crammd5:
28041   driver = cram_md5
28042   public_name = CRAM-MD5
28043   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
28044                   dbmjz{/etc/sasldb2}{$value}fail}
28045   server_set_id = $auth1
28046 .endd
28047
28048 .section "Using cram_md5 as a client" "SECID177"
28049 .cindex "options" "&(cram_md5)& authenticator (client)"
28050 When used as a client, the &(cram_md5)& authenticator has two options:
28051
28052
28053
28054 .option client_name cram_md5 string&!! "the primary host name"
28055 This string is expanded, and the result used as the user name data when
28056 computing the response to the server's challenge.
28057
28058
28059 .option client_secret cram_md5 string&!! unset
28060 This option must be set for the authenticator to work as a client. Its value is
28061 expanded and the result used as the secret string when computing the response.
28062
28063
28064 .vindex "&$host$&"
28065 .vindex "&$host_address$&"
28066 Different user names and secrets can be used for different servers by referring
28067 to &$host$& or &$host_address$& in the options. Forced failure of either
28068 expansion string is treated as an indication that this authenticator is not
28069 prepared to handle this case. Exim moves on to the next configured client
28070 authenticator. Any other expansion failure causes Exim to give up trying to
28071 send the message to the current server.
28072
28073 A simple example configuration of a &(cram_md5)& authenticator, using fixed
28074 strings, is:
28075 .code
28076 fixed_cram:
28077   driver = cram_md5
28078   public_name = CRAM-MD5
28079   client_name = ph10
28080   client_secret = secret
28081 .endd
28082 .ecindex IIDcramauth1
28083 .ecindex IIDcramauth2
28084
28085
28086
28087 . ////////////////////////////////////////////////////////////////////////////
28088 . ////////////////////////////////////////////////////////////////////////////
28089
28090 .chapter "The cyrus_sasl authenticator" "CHID10"
28091 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
28092 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
28093 .cindex "Cyrus" "SASL library"
28094 .cindex "Kerberos"
28095 The code for this authenticator was provided by Matthew Byng-Maddick while
28096 at A L Digital Ltd.
28097
28098 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
28099 library implementation of the RFC 2222 (&"Simple Authentication and Security
28100 Layer"&). This library supports a number of authentication mechanisms,
28101 including PLAIN and LOGIN, but also several others that Exim does not support
28102 directly. In particular, there is support for Kerberos authentication.
28103
28104 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
28105 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
28106 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
28107 name of the driver to determine which mechanism to support.
28108
28109 Where access to some kind of secret file is required, for example, in GSSAPI
28110 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
28111 user, and that the Cyrus SASL library has no way of escalating privileges
28112 by default. You may also find you need to set environment variables,
28113 depending on the driver you are using.
28114
28115 The application name provided by Exim is &"exim"&, so various SASL options may
28116 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
28117 Kerberos, note that because of limitations in the GSSAPI interface,
28118 changing the server keytab might need to be communicated down to the Kerberos
28119 layer independently. The mechanism for doing so is dependent upon the Kerberos
28120 implementation.
28121
28122 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
28123 may be set to point to an alternative keytab file. Exim will pass this
28124 variable through from its own inherited environment when started as root or the
28125 Exim user. The keytab file needs to be readable by the Exim user.
28126 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
28127 environment variable.  In practice, for those releases, the Cyrus authenticator
28128 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
28129 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
28130
28131
28132 .section "Using cyrus_sasl as a server" "SECID178"
28133 The &(cyrus_sasl)& authenticator has four private options. It puts the username
28134 (on a successful authentication) into &$auth1$&. For compatibility with
28135 previous releases of Exim, the username is also placed in &$1$&. However, the
28136 use of this variable for this purpose is now deprecated, as it can lead to
28137 confusion in string expansions that also use numeric variables for other
28138 things.
28139
28140
28141 .option server_hostname cyrus_sasl string&!! "see below"
28142 This option selects the hostname that is used when communicating with the
28143 library. The default value is &`$primary_hostname`&. It is up to the underlying
28144 SASL plug-in what it does with this data.
28145
28146
28147 .option server_mech cyrus_sasl string "see below"
28148 This option selects the authentication mechanism this driver should use. The
28149 default is the value of the generic &%public_name%& option. This option allows
28150 you to use a different underlying mechanism from the advertised name. For
28151 example:
28152 .code
28153 sasl:
28154   driver = cyrus_sasl
28155   public_name = X-ANYTHING
28156   server_mech = CRAM-MD5
28157   server_set_id = $auth1
28158 .endd
28159
28160 .option server_realm cyrus_sasl string&!! unset
28161 This specifies the SASL realm that the server claims to be in.
28162
28163
28164 .option server_service cyrus_sasl string &`smtp`&
28165 This is the SASL service that the server claims to implement.
28166
28167
28168 For straightforward cases, you do not need to set any of the authenticator's
28169 private options. All you need to do is to specify an appropriate mechanism as
28170 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
28171 PLAIN, you could have two authenticators as follows:
28172 .code
28173 sasl_cram_md5:
28174   driver = cyrus_sasl
28175   public_name = CRAM-MD5
28176   server_set_id = $auth1
28177
28178 sasl_plain:
28179   driver = cyrus_sasl
28180   public_name = PLAIN
28181   server_set_id = $auth2
28182 .endd
28183 Cyrus SASL does implement the LOGIN authentication method, even though it is
28184 not a standard method. It is disabled by default in the source distribution,
28185 but it is present in many binary distributions.
28186 .ecindex IIDcyrauth1
28187 .ecindex IIDcyrauth2
28188
28189
28190
28191
28192 . ////////////////////////////////////////////////////////////////////////////
28193 . ////////////////////////////////////////////////////////////////////////////
28194 .chapter "The dovecot authenticator" "CHAPdovecot"
28195 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
28196 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
28197 This authenticator is an interface to the authentication facility of the
28198 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
28199 Note that Dovecot must be configured to use auth-client not auth-userdb.
28200 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
28201 to use the same mechanisms for SMTP authentication. This is a server
28202 authenticator only. There is only one option:
28203
28204 .option server_socket dovecot string unset
28205
28206 This option must specify the UNIX socket that is the interface to Dovecot
28207 authentication. The &%public_name%& option must specify an authentication
28208 mechanism that Dovecot is configured to support. You can have several
28209 authenticators for different mechanisms. For example:
28210 .code
28211 dovecot_plain:
28212   driver = dovecot
28213   public_name = PLAIN
28214   server_socket = /var/run/dovecot/auth-client
28215   server_set_id = $auth1
28216
28217 dovecot_ntlm:
28218   driver = dovecot
28219   public_name = NTLM
28220   server_socket = /var/run/dovecot/auth-client
28221   server_set_id = $auth1
28222 .endd
28223 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
28224 &$received_ip_address$& (that is, the connection is local), the &"secured"&
28225 option is passed in the Dovecot authentication command. If, for a TLS
28226 connection, a client certificate has been verified, the &"valid-client-cert"&
28227 option is passed. When authentication succeeds, the identity of the user
28228 who authenticated is placed in &$auth1$&.
28229
28230 The Dovecot configuration to match the above will look
28231 something like:
28232 .code
28233 conf.d/10-master.conf :-
28234
28235 service auth {
28236 ...
28237 #SASL
28238   unix_listener auth-client {
28239     mode = 0660
28240     user = mail
28241   }
28242 ...
28243 }
28244
28245 conf.d/10-auth.conf :-
28246
28247 auth_mechanisms = plain login ntlm
28248 .endd
28249
28250 .ecindex IIDdcotauth1
28251 .ecindex IIDdcotauth2
28252
28253
28254 . ////////////////////////////////////////////////////////////////////////////
28255 . ////////////////////////////////////////////////////////////////////////////
28256 .chapter "The gsasl authenticator" "CHAPgsasl"
28257 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
28258 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
28259 .cindex "authentication" "GNU SASL"
28260 .cindex "authentication" "SASL"
28261 .cindex "authentication" "EXTERNAL"
28262 .cindex "authentication" "ANONYMOUS"
28263 .cindex "authentication" "PLAIN"
28264 .cindex "authentication" "LOGIN"
28265 .cindex "authentication" "DIGEST-MD5"
28266 .cindex "authentication" "CRAM-MD5"
28267 .cindex "authentication" "SCRAM family"
28268 The &(gsasl)& authenticator provides integration for the GNU SASL
28269 library and the mechanisms it provides.  This is new as of the 4.80 release
28270 and there are a few areas where the library does not let Exim smoothly
28271 scale to handle future authentication mechanisms, so no guarantee can be
28272 made that any particular new authentication mechanism will be supported
28273 without code changes in Exim.
28274
28275 The library is expected to add support in an upcoming
28276 realease for the SCRAM-SHA-256 method.
28277 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
28278 when this happens.
28279
28280 To see the list of mechanisms supported by the library run Exim with "auth" debug
28281 enabled and look for a line containing "GNU SASL supports".
28282 Note however that some may not have been tested from Exim.
28283
28284
28285 .option client_authz gsasl string&!! unset
28286 This option can be used to supply an &'authorization id'&
28287 which is different to the &'authentication_id'& provided
28288 by &%client_username%& option.
28289 If unset or (after expansion) empty it is not used,
28290 which is the common case.
28291
28292 .option client_channelbinding gsasl boolean false
28293 See &%server_channelbinding%& below.
28294
28295 .option client_password gsasl string&!! unset
28296 This option is exapanded before use, and should result in
28297 the password to be used, in clear.
28298
28299 .option client_username gsasl string&!! unset
28300 This option is exapanded before use, and should result in
28301 the account name to be used.
28302
28303
28304 .option client_spassword gsasl string&!! unset
28305 This option is only supported for library versions 1.9.1 and greater.
28306 The macro _HAVE_AUTH_GSASL_SCRAM_S_KEY will be defined when this is so.
28307
28308 If a SCRAM mechanism is being used and this option is set
28309 and correctly sized
28310 it is used in preference to &%client_password%&.
28311 The value after expansion should be
28312 a 40 (for SHA-1) or 64 (for SHA-256) character string
28313 with the PBKDF2-prepared password, hex-encoded.
28314
28315 Note that this value will depend on the salt and iteration-count
28316 supplied by the server.
28317 The option is expanded before use.
28318 During the expansion &$auth1$& is set with the client username,
28319 &$auth2$& with the iteration count, and
28320 &$auth3$& with the salt.
28321
28322 The intent of this option
28323 is to support clients that can cache thes salted password
28324 to save on recalculation costs.
28325 The cache lookup should return an unusable value
28326 (eg. an empty string)
28327 if the salt or iteration count has changed
28328
28329 If the authentication succeeds then the above variables are set,
28330 .vindex "&$auth4$&"
28331 plus the calculated salted password value value in &$auth4$&,
28332 during the expansion of the &%client_set_id%& option.
28333 A side-effect of this expansion can be used to prime the cache.
28334
28335
28336 .option server_channelbinding gsasl boolean false
28337 Some authentication mechanisms are able to use external context at both ends
28338 of the session to bind the authentication to that context, and fail the
28339 authentication process if that context differs.  Specifically, some TLS
28340 ciphersuites can provide identifying information about the cryptographic
28341 context.
28342
28343 This should have meant that certificate identity and verification becomes a
28344 non-issue, as a man-in-the-middle attack will cause the correct client and
28345 server to see different identifiers and authentication will fail.
28346
28347 This is
28348 only usable by mechanisms which support "channel binding"; at time of
28349 writing, that's the SCRAM family.
28350 When using this feature the "-PLUS" variants of the method names need to be used.
28351
28352 This defaults off to ensure smooth upgrade across Exim releases, in case
28353 this option causes some clients to start failing.  Some future release
28354 of Exim might have switched the default to be true.
28355
28356 . However, Channel Binding in TLS has proven to be vulnerable in current versions.
28357 . Do not plan to rely upon this feature for security, ever, without consulting
28358 . with a subject matter expert (a cryptographic engineer).
28359
28360 This option was deprecated in previous releases due to doubts over
28361 the "Triple Handshake" vulnerability.
28362 Exim takes suitable precausions (requiring Extended Master Secret if TLS
28363 Session Resumption was used) for safety.
28364
28365
28366 .option server_hostname gsasl string&!! "see below"
28367 This option selects the hostname that is used when communicating with the
28368 library. The default value is &`$primary_hostname`&.
28369 Some mechanisms will use this data.
28370
28371
28372 .option server_mech gsasl string "see below"
28373 This option selects the authentication mechanism this driver should use. The
28374 default is the value of the generic &%public_name%& option. This option allows
28375 you to use a different underlying mechanism from the advertised name. For
28376 example:
28377 .code
28378 sasl:
28379   driver = gsasl
28380   public_name = X-ANYTHING
28381   server_mech = CRAM-MD5
28382   server_set_id = $auth1
28383 .endd
28384
28385
28386 .option server_password gsasl string&!! unset
28387 Various mechanisms need access to the cleartext password on the server, so
28388 that proof-of-possession can be demonstrated on the wire, without sending
28389 the password itself.
28390
28391 The data available for lookup varies per mechanism.
28392 In all cases, &$auth1$& is set to the &'authentication id'&.
28393 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28394 if available, else the empty string.
28395 The &$auth3$& variable will always be the &'realm'& if available,
28396 else the empty string.
28397
28398 A forced failure will cause authentication to defer.
28399
28400 If using this option, it may make sense to set the &%server_condition%&
28401 option to be simply "true".
28402
28403
28404 .option server_realm gsasl string&!! unset
28405 This specifies the SASL realm that the server claims to be in.
28406 Some mechanisms will use this data.
28407
28408
28409 .option server_scram_iter gsasl string&!! 4096
28410 This option provides data for the SCRAM family of mechanisms.
28411 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28412 when this option is expanded.
28413
28414 The result of expansion should be a decimal number,
28415 and represents both a lower-bound on the security, and
28416 a compute cost factor imposed on the client
28417 (if it does not cache results, or the server changes
28418 either the iteration count or the salt).
28419 A minimum value of 4096 is required by the standards
28420 for all current SCRAM mechanism variants.
28421
28422 .option server_scram_salt gsasl string&!! unset
28423 This option provides data for the SCRAM family of mechanisms.
28424 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28425 when this option is expanded.
28426 The value should be a base64-encoded string,
28427 of random data typically 4-to-16 bytes long.
28428 If unset or empty after expansion the library will provides a value for the
28429 protocol conversation.
28430
28431
28432 .option server_key gsasl string&!! unset
28433 .option server_skey gsasl string&!! unset
28434 These options can be used for the SCRAM family of mechanisms
28435 to provide stored information related to a password,
28436 the storage of which is preferable to plaintext.
28437
28438 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28439 &%server_skey%& is StoredKey.
28440
28441 They are only available for version 1.9.0 (or later) of the gsasl library.
28442 When this is so, the macros
28443 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28444 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28445 will be defined.
28446
28447 The &$authN$& variables are available when these options are expanded.
28448
28449 If set, the results of expansion should for each
28450 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28451 of base64-coded data, and will be used in preference to the
28452 &%server_password%& option.
28453 If unset or not of the right length, &%server_password%& will be used.
28454
28455 The libgsasl library release includes a utility &'gsasl'& which can be used
28456 to generate these values.
28457
28458
28459 .option server_service gsasl string &`smtp`&
28460 This is the SASL service that the server claims to implement.
28461 Some mechanisms will use this data.
28462
28463
28464 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28465 .vindex "&$auth1$&, &$auth2$&, etc"
28466 These may be set when evaluating specific options, as detailed above.
28467 They will also be set when evaluating &%server_condition%&.
28468
28469 Unless otherwise stated below, the &(gsasl)& integration will use the following
28470 meanings for these variables:
28471
28472 .ilist
28473 .vindex "&$auth1$&"
28474 &$auth1$&: the &'authentication id'&
28475 .next
28476 .vindex "&$auth2$&"
28477 &$auth2$&: the &'authorization id'&
28478 .next
28479 .vindex "&$auth3$&"
28480 &$auth3$&: the &'realm'&
28481 .endlist
28482
28483 On a per-mechanism basis:
28484
28485 .ilist
28486 .cindex "authentication" "EXTERNAL"
28487 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28488 the &%server_condition%& option must be present.
28489 .next
28490 .cindex "authentication" "ANONYMOUS"
28491 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28492 the &%server_condition%& option must be present.
28493 .next
28494 .cindex "authentication" "GSSAPI"
28495 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28496 &$auth2$& will be set to the &'authorization id'&,
28497 the &%server_condition%& option must be present.
28498 .endlist
28499
28500 An &'anonymous token'& is something passed along as an unauthenticated
28501 identifier; this is analogous to FTP anonymous authentication passing an
28502 email address, or software-identifier@, as the "password".
28503
28504
28505 An example showing the password having the realm specified in the callback
28506 and demonstrating a Cyrus SASL to GSASL migration approach is:
28507 .code
28508 gsasl_cyrusless_crammd5:
28509   driver = gsasl
28510   public_name = CRAM-MD5
28511   server_realm = imap.example.org
28512   server_password = ${lookup{$auth1:$auth3:userPassword}\
28513                     dbmjz{/etc/sasldb2}{$value}fail}
28514   server_set_id = ${quote:$auth1}
28515   server_condition = yes
28516 .endd
28517
28518
28519 . ////////////////////////////////////////////////////////////////////////////
28520 . ////////////////////////////////////////////////////////////////////////////
28521
28522 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28523 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28524 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28525 .cindex "authentication" "GSSAPI"
28526 .cindex "authentication" "Kerberos"
28527 The &(heimdal_gssapi)& authenticator provides server integration for the
28528 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28529 reliably.
28530
28531 .option server_hostname heimdal_gssapi string&!! "see below"
28532 This option selects the hostname that is used, with &%server_service%&,
28533 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28534 identifier.  The default value is &`$primary_hostname`&.
28535
28536 .option server_keytab heimdal_gssapi string&!! unset
28537 If set, then Heimdal will not use the system default keytab (typically
28538 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28539 The value should be a pathname, with no &"file:"& prefix.
28540
28541 .option server_service heimdal_gssapi string&!! "smtp"
28542 This option specifies the service identifier used, in conjunction with
28543 &%server_hostname%&, for building the identifier for finding credentials
28544 from the keytab.
28545
28546
28547 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28548 Beware that these variables will typically include a realm, thus will appear
28549 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28550 not verified, so a malicious client can set it to anything.
28551
28552 The &$auth1$& field should be safely trustable as a value from the Key
28553 Distribution Center.  Note that these are not quite email addresses.
28554 Each identifier is for a role, and so the left-hand-side may include a
28555 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28556
28557 .vindex "&$auth1$&, &$auth2$&, etc"
28558 .ilist
28559 .vindex "&$auth1$&"
28560 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28561 .next
28562 .vindex "&$auth2$&"
28563 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28564 authentication.  If that was empty, this will also be set to the
28565 GSS Display Name.
28566 .endlist
28567
28568
28569 . ////////////////////////////////////////////////////////////////////////////
28570 . ////////////////////////////////////////////////////////////////////////////
28571
28572 .chapter "The spa authenticator" "CHAPspa"
28573 .scindex IIDspaauth1 "&(spa)& authenticator"
28574 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28575 .cindex "authentication" "Microsoft Secure Password"
28576 .cindex "authentication" "NTLM"
28577 .cindex "Microsoft Secure Password Authentication"
28578 .cindex "NTLM authentication"
28579 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28580 Password Authentication'& mechanism,
28581 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28582 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28583 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28584 server side was subsequently contributed by Tom Kistner. The mechanism works as
28585 follows:
28586
28587 .ilist
28588 After the AUTH command has been accepted, the client sends an SPA
28589 authentication request based on the user name and optional domain.
28590 .next
28591 The server sends back a challenge.
28592 .next
28593 The client builds a challenge response which makes use of the user's password
28594 and sends it to the server, which then accepts or rejects it.
28595 .endlist
28596
28597 Encryption is used to protect the password in transit.
28598
28599
28600
28601 .section "Using spa as a server" "SECID179"
28602 .cindex "options" "&(spa)& authenticator (server)"
28603 The &(spa)& authenticator has just one server option:
28604
28605 .option server_password spa string&!! unset
28606 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28607 This option is expanded, and the result must be the cleartext password for the
28608 authenticating user, whose name is at this point in &$auth1$&. For
28609 compatibility with previous releases of Exim, the user name is also placed in
28610 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28611 it can lead to confusion in string expansions that also use numeric variables
28612 for other things. For example:
28613 .code
28614 spa:
28615   driver = spa
28616   public_name = NTLM
28617   server_password = \
28618     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28619 .endd
28620 If the expansion is forced to fail, authentication fails. Any other expansion
28621 failure causes a temporary error code to be returned.
28622
28623
28624
28625
28626
28627 .section "Using spa as a client" "SECID180"
28628 .cindex "options" "&(spa)& authenticator (client)"
28629 The &(spa)& authenticator has the following client options:
28630
28631
28632
28633 .option client_domain spa string&!! unset
28634 This option specifies an optional domain for the authentication.
28635
28636
28637 .option client_password spa string&!! unset
28638 This option specifies the user's password, and must be set.
28639
28640
28641 .option client_username spa string&!! unset
28642 This option specifies the user name, and must be set. Here is an example of a
28643 configuration of this authenticator for use with the mail servers at
28644 &'msn.com'&:
28645 .code
28646 msn:
28647   driver = spa
28648   public_name = MSN
28649   client_username = msn/msn_username
28650   client_password = msn_plaintext_password
28651   client_domain = DOMAIN_OR_UNSET
28652 .endd
28653 .ecindex IIDspaauth1
28654 .ecindex IIDspaauth2
28655
28656
28657
28658
28659
28660 . ////////////////////////////////////////////////////////////////////////////
28661 . ////////////////////////////////////////////////////////////////////////////
28662
28663 .chapter "The external authenticator" "CHAPexternauth"
28664 .scindex IIDexternauth1 "&(external)& authenticator"
28665 .scindex IIDexternauth2 "authenticators" "&(external)&"
28666 .cindex "authentication" "Client Certificate"
28667 .cindex "authentication" "X509"
28668 .cindex "Certificate-based authentication"
28669 The &(external)& authenticator provides support for
28670 authentication based on non-SMTP information.
28671 The specification is in RFC 4422 Appendix A
28672 (&url(https://tools.ietf.org/html/rfc4422)).
28673 It is only a transport and negotiation mechanism;
28674 the process of authentication is entirely controlled
28675 by the server configuration.
28676
28677 The client presents an identity in-clear.
28678 It is probably wise for a server to only advertise,
28679 and for clients to only attempt,
28680 this authentication method on a secure (eg. under TLS) connection.
28681
28682 One possible use, compatible with the
28683 K-9 Mail Android client (&url(https://k9mail.github.io/)),
28684 is for using X509 client certificates.
28685
28686 It thus overlaps in function with the TLS authenticator
28687 (see &<<CHAPtlsauth>>&)
28688 but is a full SMTP SASL authenticator
28689 rather than being implicit for TLS-connection carried
28690 client certificates only.
28691
28692 The examples and discussion in this chapter assume that
28693 client-certificate authentication is being done.
28694
28695 The client must present a certificate,
28696 for which it must have been requested via the
28697 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28698 (see &<<CHAPTLS>>&).
28699 For authentication to be effective the certificate should be
28700 verifiable against a trust-anchor certificate known to the server.
28701
28702 .section "External options" "SECTexternsoptions"
28703 .cindex "options" "&(external)& authenticator (server)"
28704 The &(external)& authenticator has two server options:
28705
28706 .option server_param2 external string&!! unset
28707 .option server_param3 external string&!! unset
28708 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28709 These options are expanded before the &%server_condition%& option
28710 and the result are placed in &$auth2$& and &$auth3$& resectively.
28711 If the expansion is forced to fail, authentication fails. Any other expansion
28712 failure causes a temporary error code to be returned.
28713
28714 They can be used to clarify the coding of a complex &%server_condition%&.
28715
28716 .section "Using external in a server" "SECTexternserver"
28717 .cindex "AUTH" "in &(external)& authenticator"
28718 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28719         "in &(external)& authenticator"
28720 .vindex "&$auth1$&, &$auth2$&, etc"
28721 .cindex "base64 encoding" "in &(external)& authenticator"
28722
28723 When running as a server, &(external)& performs the authentication test by
28724 expanding a string. The data sent by the client with the AUTH command, or in
28725 response to subsequent prompts, is base64 encoded, and so may contain any byte
28726 values when decoded. The decoded value is treated as
28727 an identity for authentication and
28728 placed in the expansion variable &$auth1$&.
28729
28730 For compatibility with previous releases of Exim, the value is also placed in
28731 the expansion variable &$1$&. However, the use of this
28732 variable for this purpose is now deprecated, as it can lead to confusion in
28733 string expansions that also use them for other things.
28734
28735 .vindex "&$authenticated_id$&"
28736 Once an identity has been received,
28737 &%server_condition%& is expanded. If the expansion is forced to fail,
28738 authentication fails. Any other expansion failure causes a temporary error code
28739 to be returned. If the result of a successful expansion is an empty string,
28740 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28741 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28742 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28743 For any other result, a temporary error code is returned, with the expanded
28744 string as the error text.
28745
28746 Example:
28747 .code
28748 ext_ccert_san_mail:
28749   driver =            external
28750   public_name =       EXTERNAL
28751
28752   server_advertise_condition = $tls_in_certificate_verified
28753   server_param2 =     ${certextract {subj_altname,mail,>:} \
28754                                     {$tls_in_peercert}}
28755   server_condition =  ${if forany {$auth2} \
28756                             {eq {$item}{$auth1}}}
28757   server_set_id =     $auth1
28758 .endd
28759 This accepts a client certificate that is verifiable against any
28760 of your configured trust-anchors
28761 (which usually means the full set of public CAs)
28762 and which has a mail-SAN matching the claimed identity sent by the client.
28763
28764 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28765 The account name is therefore guessable by an opponent.
28766 TLS 1.3 protects both server and client certificates, and is not vulnerable
28767 in this way.
28768
28769
28770 .section "Using external in a client" "SECTexternclient"
28771 .cindex "options" "&(external)& authenticator (client)"
28772 The &(external)& authenticator has one client option:
28773
28774 .option client_send external string&!! unset
28775 This option is expanded and sent with the AUTH command as the
28776 identity being asserted.
28777
28778 Example:
28779 .code
28780 ext_ccert:
28781   driver =      external
28782   public_name = EXTERNAL
28783
28784   client_condition = ${if !eq{$tls_out_cipher}{}}
28785   client_send = myaccount@smarthost.example.net
28786 .endd
28787
28788
28789 .ecindex IIDexternauth1
28790 .ecindex IIDexternauth2
28791
28792
28793
28794
28795
28796 . ////////////////////////////////////////////////////////////////////////////
28797 . ////////////////////////////////////////////////////////////////////////////
28798
28799 .chapter "The tls authenticator" "CHAPtlsauth"
28800 .scindex IIDtlsauth1 "&(tls)& authenticator"
28801 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28802 .cindex "authentication" "Client Certificate"
28803 .cindex "authentication" "X509"
28804 .cindex "Certificate-based authentication"
28805 The &(tls)& authenticator provides server support for
28806 authentication based on client certificates.
28807
28808 It is not an SMTP authentication mechanism and is not
28809 advertised by the server as part of the SMTP EHLO response.
28810 It is an Exim authenticator in the sense that it affects
28811 the protocol element of the log line, can be tested for
28812 by the &%authenticated%& ACL condition, and can set
28813 the &$authenticated_id$& variable.
28814
28815 The client must present a verifiable certificate,
28816 for which it must have been requested via the
28817 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28818 (see &<<CHAPTLS>>&).
28819
28820 If an authenticator of this type is configured it is
28821 run before any SMTP-level communication is done,
28822 and can authenticate the connection.
28823 If it does, SMTP authentication is not offered.
28824
28825 A maximum of one authenticator of this type may be present.
28826
28827
28828 .cindex "options" "&(tls)& authenticator (server)"
28829 The &(tls)& authenticator has three server options:
28830
28831 .option server_param1 tls string&!! unset
28832 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28833 This option is expanded after the TLS negotiation and
28834 the result is placed in &$auth1$&.
28835 If the expansion is forced to fail, authentication fails. Any other expansion
28836 failure causes a temporary error code to be returned.
28837
28838 .option server_param2 tls string&!! unset
28839 .option server_param3 tls string&!! unset
28840 As above, for &$auth2$& and &$auth3$&.
28841
28842 &%server_param1%& may also be spelled &%server_param%&.
28843
28844
28845 Example:
28846 .code
28847 tls:
28848   driver = tls
28849   server_param1 =     ${certextract {subj_altname,mail,>:} \
28850                                     {$tls_in_peercert}}
28851   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28852                                  {forany {$auth1} \
28853                             {!= {0} \
28854                                 {${lookup ldap{ldap:///\
28855                          mailname=${quote_ldap_dn:${lc:$item}},\
28856                          ou=users,LDAP_DC?mailid} {$value}{0} \
28857                        }    }  } }}}
28858   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28859 .endd
28860 This accepts a client certificate that is verifiable against any
28861 of your configured trust-anchors
28862 (which usually means the full set of public CAs)
28863 and which has a SAN with a good account name.
28864
28865 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28866 The account name is therefore guessable by an opponent.
28867 TLS 1.3 protects both server and client certificates, and is not vulnerable
28868 in this way.
28869 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28870
28871 . An alternative might use
28872 . .code
28873 .   server_param1 = ${sha256:$tls_in_peercert}
28874 . .endd
28875 . to require one of a set of specific certs that define a given account
28876 . (the verification is still required, but mostly irrelevant).
28877 . This would help for per-device use.
28878 .
28879 . However, for the future we really need support for checking a
28880 . user cert in LDAP - which probably wants a base-64 DER.
28881
28882 .ecindex IIDtlsauth1
28883 .ecindex IIDtlsauth2
28884
28885
28886 Note that because authentication is traditionally an SMTP operation,
28887 the &%authenticated%& ACL condition cannot be used in
28888 a connect- or helo-ACL.
28889
28890
28891
28892 . ////////////////////////////////////////////////////////////////////////////
28893 . ////////////////////////////////////////////////////////////////////////////
28894
28895 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28896          "Encrypted SMTP connections"
28897 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
28898 .scindex IIDencsmtp2 "SMTP" "encryption"
28899 .cindex "TLS" "on SMTP connection"
28900 .cindex "OpenSSL"
28901 .cindex "GnuTLS"
28902 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
28903 Sockets Layer), is implemented by making use of the OpenSSL library or the
28904 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
28905 cryptographic code in the Exim distribution itself for implementing TLS. In
28906 order to use this feature you must install OpenSSL or GnuTLS, and then build a
28907 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
28908 You also need to understand the basic concepts of encryption at a managerial
28909 level, and in particular, the way that public keys, private keys, and
28910 certificates are used.
28911
28912 RFC 3207 defines how SMTP connections can make use of encryption. Once a
28913 connection is established, the client issues a STARTTLS command. If the
28914 server accepts this, the client and the server negotiate an encryption
28915 mechanism. If the negotiation succeeds, the data that subsequently passes
28916 between them is encrypted.
28917
28918 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
28919 and if so, what cipher suite is in use, whether the client supplied a
28920 certificate, and whether or not that certificate was verified. This makes it
28921 possible for an Exim server to deny or accept certain commands based on the
28922 encryption state.
28923
28924 &*Warning*&: Certain types of firewall and certain anti-virus products can
28925 disrupt TLS connections. You need to turn off SMTP scanning for these products
28926 in order to get TLS to work.
28927
28928
28929
28930 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28931          "SECID284"
28932 .cindex "submissions protocol"
28933 .cindex "ssmtp protocol"
28934 .cindex "smtps protocol"
28935 .cindex "SMTP" "submissions protocol"
28936 .cindex "SMTP" "ssmtp protocol"
28937 .cindex "SMTP" "smtps protocol"
28938 The history of port numbers for TLS in SMTP is a little messy and has been
28939 contentious.  As of RFC 8314, the common practice of using the historically
28940 allocated port 465 for "email submission but with TLS immediately upon connect
28941 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28942 by them in preference to STARTTLS.
28943
28944 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28945 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28946 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28947
28948 This approach was, for a while, officially abandoned when encrypted SMTP was
28949 standardized, but many clients kept using it, even as the TCP port number was
28950 reassigned for other use.
28951 Thus you may encounter guidance claiming that you shouldn't enable use of
28952 this port.
28953 In practice, a number of mail-clients have only ever supported submissions,
28954 not submission with STARTTLS upgrade.
28955 Ideally, offer both submission (587) and submissions (465) service.
28956
28957 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28958 global option. Its value must be a list of port numbers;
28959 the most common use is expected to be:
28960 .code
28961 tls_on_connect_ports = 465
28962 .endd
28963 The port numbers specified by this option apply to all SMTP connections, both
28964 via the daemon and via &'inetd'&. You still need to specify all the ports that
28965 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28966 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28967 an extra port &-- rather, it specifies different behaviour on a port that is
28968 defined elsewhere.
28969
28970 There is also a &%-tls-on-connect%& command line option. This overrides
28971 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28972
28973
28974
28975
28976
28977
28978 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28979 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28980 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
28981 To build Exim to use OpenSSL you need to set
28982 .code
28983 USE_OPENSSL=yes
28984 .endd
28985 in Local/Makefile.
28986
28987 To build Exim to use GnuTLS, you need to set
28988 .code
28989 USE_GNUTLS=yes
28990 .endd
28991 in Local/Makefile.
28992
28993 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28994 include files and libraries for GnuTLS can be found.
28995
28996 There are some differences in usage when using GnuTLS instead of OpenSSL:
28997
28998 .ilist
28999 The &%tls_verify_certificates%& option
29000 cannot be the path of a directory
29001 for GnuTLS versions before 3.3.6
29002 (for later versions, or OpenSSL, it can be either).
29003 .next
29004 The default value for &%tls_dhparam%& differs for historical reasons.
29005 .next
29006 .vindex "&$tls_in_peerdn$&"
29007 .vindex "&$tls_out_peerdn$&"
29008 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
29009 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
29010 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
29011 .next
29012 OpenSSL identifies cipher suites using hyphens as separators, for example:
29013 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
29014 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
29015 in a cipher list. To make life simpler, Exim changes underscores to hyphens
29016 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
29017 to handle its own older variants) when processing lists of cipher suites in the
29018 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
29019 option).
29020 .next
29021 The &%tls_require_ciphers%& options operate differently, as described in the
29022 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
29023 .next
29024 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
29025 When using OpenSSL, this option is ignored.
29026 (If an API is found to let OpenSSL be configured in this way,
29027 let the Exim Maintainers know and we'll likely use it).
29028 .next
29029 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
29030 main option, it must be ordered to match the &%tls_certificate%& list.
29031 .next
29032 Some other recently added features may only be available in one or the other.
29033 This should be documented with the feature.  If the documentation does not
29034 explicitly state that the feature is infeasible in the other TLS
29035 implementation, then patches are welcome.
29036 .next
29037 The output from "exim -bV" will show which (if any) support was included
29038 in the build.
29039 Also, the macro "_HAVE_OPENSSL" or "_HAVE_GNUTLS" will be defined.
29040 .endlist
29041
29042
29043 .section "GnuTLS parameter computation" "SECTgnutlsparam"
29044 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
29045 an explicit path; if the latter, then the text about generation still applies,
29046 but not the chosen filename.
29047 By default, as of Exim 4.80 a hard-coded D-H prime is used.
29048 See the documentation of &%tls_dhparam%& for more information.
29049
29050 GnuTLS uses D-H parameters that may take a substantial amount of time
29051 to compute. It is unreasonable to re-compute them for every TLS session.
29052 Therefore, Exim keeps this data in a file in its spool directory, called
29053 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
29054 of bits requested.
29055 The file is owned by the Exim user and is readable only by
29056 its owner. Every Exim process that start up GnuTLS reads the D-H
29057 parameters from this file. If the file does not exist, the first Exim process
29058 that needs it computes the data and writes it to a temporary file which is
29059 renamed once it is complete. It does not matter if several Exim processes do
29060 this simultaneously (apart from wasting a few resources). Once a file is in
29061 place, new Exim processes immediately start using it.
29062
29063 For maximum security, the parameters that are stored in this file should be
29064 recalculated periodically, the frequency depending on your paranoia level.
29065 If you are avoiding using the fixed D-H primes published in RFCs, then you
29066 are concerned about some advanced attacks and will wish to do this; if you do
29067 not regenerate then you might as well stick to the standard primes.
29068
29069 Arranging this is easy in principle; just delete the file when you want new
29070 values to be computed. However, there may be a problem. The calculation of new
29071 parameters needs random numbers, and these are obtained from &_/dev/random_&.
29072 If the system is not very active, &_/dev/random_& may delay returning data
29073 until enough randomness (entropy) is available. This may cause Exim to hang for
29074 a substantial amount of time, causing timeouts on incoming connections.
29075
29076 The solution is to generate the parameters externally to Exim. They are stored
29077 in &_gnutls-params-N_& in PEM format, which means that they can be
29078 generated externally using the &(certtool)& command that is part of GnuTLS.
29079
29080 To replace the parameters with new ones, instead of deleting the file
29081 and letting Exim re-create it, you can generate new parameters using
29082 &(certtool)& and, when this has been done, replace Exim's cache file by
29083 renaming. The relevant commands are something like this:
29084 .code
29085 # ls
29086 [ look for file; assume gnutls-params-2236 is the most recent ]
29087 # rm -f new-params
29088 # touch new-params
29089 # chown exim:exim new-params
29090 # chmod 0600 new-params
29091 # certtool --generate-dh-params --bits 2236 >>new-params
29092 # openssl dhparam -noout -text -in new-params | head
29093 [ check the first line, make sure it's not more than 2236;
29094   if it is, then go back to the start ("rm") and repeat
29095   until the size generated is at most the size requested ]
29096 # chmod 0400 new-params
29097 # mv new-params gnutls-params-2236
29098 .endd
29099 If Exim never has to generate the parameters itself, the possibility of
29100 stalling is removed.
29101
29102 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
29103 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
29104 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
29105 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
29106 and Exim does so.  This attempt to remove Exim from TLS policy decisions
29107 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
29108 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
29109 which applies to all D-H usage, client or server.  If the value returned by
29110 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
29111 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
29112 limit, which is still much higher than Exim historically used.
29113
29114 The filename and bits used will change as the GnuTLS maintainers change the
29115 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
29116 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
29117 2432 bits, while NSS is limited to 2236 bits.
29118
29119 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
29120 increase the chance of the generated prime actually being within acceptable
29121 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
29122 procedure above.  There is no sane procedure available to Exim to double-check
29123 the size of the generated prime, so it might still be too large.
29124
29125
29126 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
29127 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
29128 .oindex "&%tls_require_ciphers%&" "OpenSSL"
29129 There is a function in the OpenSSL library that can be passed a list of cipher
29130 suites before the cipher negotiation takes place. This specifies which ciphers
29131 are acceptable for TLS versions prior to 1.3.
29132 The list is colon separated and may contain names like
29133 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
29134 directly to this function call.
29135 Many systems will install the OpenSSL manual-pages, so you may have
29136 &'ciphers(1)'& available to you.
29137 The following quotation from the OpenSSL
29138 documentation specifies what forms of item are allowed in the cipher string:
29139
29140 .ilist
29141 It can consist of a single cipher suite such as RC4-SHA.
29142 .next
29143 It can represent a list of cipher suites containing a certain algorithm,
29144 or cipher suites of a certain type. For example SHA1 represents all
29145 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
29146 SSL v3 algorithms.
29147 .next
29148 Lists of cipher suites can be combined in a single cipher string using
29149 the + character. This is used as a logical and operation. For example
29150 SHA1+DES represents all cipher suites containing the SHA1 and the DES
29151 algorithms.
29152 .endlist
29153
29154 Each cipher string can be optionally preceded by one of the characters &`!`&,
29155 &`-`& or &`+`&.
29156 .ilist
29157 If &`!`& is used, the ciphers are permanently deleted from the list. The
29158 ciphers deleted can never reappear in the list even if they are explicitly
29159 stated.
29160 .next
29161 If &`-`& is used, the ciphers are deleted from the list, but some or all
29162 of the ciphers can be added again by later options.
29163 .next
29164 If &`+`& is used, the ciphers are moved to the end of the list. This
29165 option does not add any new ciphers; it just moves matching existing ones.
29166 .endlist
29167
29168 If none of these characters is present, the string is interpreted as
29169 a list of ciphers to be appended to the current preference list. If the list
29170 includes any ciphers already present they will be ignored: that is, they will
29171 not be moved to the end of the list.
29172 .endlist
29173
29174 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
29175 string:
29176 .code
29177 # note single-quotes to get ! past any shell history expansion
29178 $ openssl ciphers 'HIGH:!MD5:!SHA1'
29179 .endd
29180
29181 This example will let the library defaults be permitted on the MX port, where
29182 there's probably no identity verification anyway, but ups the ante on the
29183 submission ports where the administrator might have some influence on the
29184 choice of clients used:
29185 .code
29186 # OpenSSL variant; see man ciphers(1)
29187 tls_require_ciphers = ${if =={$received_port}{25}\
29188                            {DEFAULT}\
29189                            {HIGH:!MD5:!SHA1}}
29190 .endd
29191
29192 This example will prefer ECDSA-authenticated ciphers over RSA ones:
29193 .code
29194 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
29195 .endd
29196
29197 For TLS version 1.3 the control available is less fine-grained
29198 and Exim does not provide access to it at present.
29199 The value of the &%tls_require_ciphers%& option is ignored when
29200 TLS version 1.3 is negotiated.
29201
29202 As of writing the library default cipher suite list for TLSv1.3 is
29203 .code
29204 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
29205 .endd
29206
29207
29208 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
29209          "SECTreqciphgnu"
29210 .cindex "GnuTLS" "specifying parameters for"
29211 .cindex "TLS" "specifying ciphers (GnuTLS)"
29212 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
29213 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
29214 .cindex "TLS" "specifying protocols (GnuTLS)"
29215 .cindex "TLS" "specifying priority string (GnuTLS)"
29216 .oindex "&%tls_require_ciphers%&" "GnuTLS"
29217 The GnuTLS library allows the caller to provide a "priority string", documented
29218 as part of the &[gnutls_priority_init]& function.  This is very similar to the
29219 ciphersuite specification in OpenSSL.
29220
29221 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
29222 and controls both protocols and ciphers.
29223
29224 The &%tls_require_ciphers%& option is available both as an global option,
29225 controlling how Exim behaves as a server, and also as an option of the
29226 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
29227 the value is string expanded.  The resulting string is not an Exim list and
29228 the string is given to the GnuTLS library, so that Exim does not need to be
29229 aware of future feature enhancements of GnuTLS.
29230
29231 Documentation of the strings accepted may be found in the GnuTLS manual, under
29232 "Priority strings".  This is online as
29233 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
29234 but beware that this relates to GnuTLS 3, which may be newer than the version
29235 installed on your system.  If you are using GnuTLS 3,
29236 then the example code
29237 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
29238 on that site can be used to test a given string.
29239
29240 For example:
29241 .code
29242 # Disable older versions of protocols
29243 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
29244 .endd
29245
29246 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
29247 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
29248 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
29249
29250 This example will let the library defaults be permitted on the MX port, where
29251 there's probably no identity verification anyway, and lowers security further
29252 by increasing compatibility; but this ups the ante on the submission ports
29253 where the administrator might have some influence on the choice of clients
29254 used:
29255 .code
29256 # GnuTLS variant
29257 tls_require_ciphers = ${if =={$received_port}{25}\
29258                            {NORMAL:%COMPAT}\
29259                            {SECURE128}}
29260 .endd
29261
29262
29263 .section "Configuring an Exim server to use TLS" "SECID182"
29264 .cindex "TLS" "configuring an Exim server"
29265 .cindex "ESMTP extensions" STARTTLS
29266 When Exim has been built with TLS support, it advertises the availability of
29267 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
29268 but not to any others. The default value of this option is *, which means
29269 that STARTTLS is always advertised.  Set it to blank to never advertise;
29270 this is reasonable for systems that want to use TLS only as a client.
29271
29272 If STARTTLS is to be used you
29273 need to set some other options in order to make TLS available.
29274
29275 If a client issues a STARTTLS command and there is some configuration
29276 problem in the server, the command is rejected with a 454 error. If the client
29277 persists in trying to issue SMTP commands, all except QUIT are rejected
29278 with the error
29279 .code
29280 554 Security failure
29281 .endd
29282 If a STARTTLS command is issued within an existing TLS session, it is
29283 rejected with a 554 error code.
29284
29285 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
29286 must be set to match some hosts. The default is * which matches all hosts.
29287
29288 If this is all you do, TLS encryption will be enabled but not authentication -
29289 meaning that the peer has no assurance it is actually you he is talking to.
29290 You gain protection from a passive sniffer listening on the wire but not
29291 from someone able to intercept the communication.
29292
29293 Further protection requires some further configuration at the server end.
29294
29295 To make TLS work you need to set, in the server,
29296 .code
29297 tls_certificate = /some/file/name
29298 tls_privatekey = /some/file/name
29299 .endd
29300 These options are, in fact, expanded strings, so you can make them depend on
29301 the identity of the client that is connected if you wish. The first file
29302 contains the server's X509 certificate, and the second contains the private key
29303 that goes with it. These files need to be
29304 PEM format and readable by the Exim user, and must
29305 always be given as full path names.
29306 The key must not be password-protected.
29307 They can be the same file if both the
29308 certificate and the key are contained within it. If &%tls_privatekey%& is not
29309 set, or if its expansion is forced to fail or results in an empty string, this
29310 is assumed to be the case. The certificate file may also contain intermediate
29311 certificates that need to be sent to the client to enable it to authenticate
29312 the server's certificate.
29313
29314 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
29315 colon-separated lists of file paths.  Ciphers using given authentication
29316 algorithms require the presence of a suitable certificate to supply the
29317 public-key.  The server selects among the certificates to present to the
29318 client depending on the selected cipher, hence the priority ordering for
29319 ciphers will affect which certificate is used.
29320
29321 If you do not understand about certificates and keys, please try to find a
29322 source of this background information, which is not Exim-specific. (There are a
29323 few comments below in section &<<SECTcerandall>>&.)
29324
29325 &*Note*&: These options do not apply when Exim is operating as a client &--
29326 they apply only in the case of a server. If you need to use a certificate in an
29327 Exim client, you must set the options of the same names in an &(smtp)&
29328 transport.
29329
29330 With just these options, an Exim server will be able to use TLS. It does not
29331 require the client to have a certificate (but see below for how to insist on
29332 this). There is one other option that may be needed in other situations. If
29333 .code
29334 tls_dhparam = /some/file/name
29335 .endd
29336 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
29337 with the parameters contained in the file.
29338 Set this to &`none`& to disable use of DH entirely, by making no prime
29339 available:
29340 .code
29341 tls_dhparam = none
29342 .endd
29343 This may also be set to a string identifying a standard prime to be used for
29344 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
29345 used is &`ike23`&.  There are a few standard primes available, see the
29346 documentation for &%tls_dhparam%& for the complete list.
29347
29348 See the command
29349 .code
29350 openssl dhparam
29351 .endd
29352 for a way of generating file data.
29353
29354 The strings supplied for these three options are expanded every time a client
29355 host connects. It is therefore possible to use different certificates and keys
29356 for different hosts, if you so wish, by making use of the client's IP address
29357 in &$sender_host_address$& to control the expansion. If a string expansion is
29358 forced to fail, Exim behaves as if the option is not set.
29359
29360 .cindex "cipher" "logging"
29361 .cindex "log" "TLS cipher"
29362 .vindex "&$tls_in_cipher$&"
29363 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29364 an incoming TLS connection. It is included in the &'Received:'& header of an
29365 incoming message (by default &-- you can, of course, change this), and it is
29366 also included in the log line that records a message's arrival, keyed by
29367 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29368 condition can be used to test for specific cipher suites in ACLs.
29369
29370 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29371 can check the name of the cipher suite and vary their actions accordingly. The
29372 cipher suite names vary, depending on which TLS library is being used. For
29373 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29374 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29375 documentation for more details.
29376
29377 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29378 (again depending on the &%tls_cipher%& log selector).
29379
29380
29381 .section "Requesting and verifying client certificates" "SECID183"
29382 .cindex "certificate" "verification of client"
29383 .cindex "TLS" "client certificate verification"
29384 If you want an Exim server to request a certificate when negotiating a TLS
29385 session with a client, you must set either &%tls_verify_hosts%& or
29386 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29387 apply to all TLS connections. For any host that matches one of these options,
29388 Exim requests a certificate as part of the setup of the TLS session. The
29389 contents of the certificate are verified by comparing it with a list of
29390 expected trust-anchors or certificates.
29391 These may be the system default set (depending on library version),
29392 an explicit file or,
29393 depending on library version, a directory, identified by
29394 &%tls_verify_certificates%&.
29395
29396 A file can contain multiple certificates, concatenated end to end. If a
29397 directory is used
29398 (OpenSSL only),
29399 each certificate must be in a separate file, with a name (or a symbolic link)
29400 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29401 certificate. You can compute the relevant hash by running the command
29402 .code
29403 openssl x509 -hash -noout -in /cert/file
29404 .endd
29405 where &_/cert/file_& contains a single certificate.
29406
29407 There is no checking of names of the client against the certificate
29408 Subject Name or Subject Alternate Names.
29409
29410 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29411 what happens if the client does not supply a certificate, or if the certificate
29412 does not match any of the certificates in the collection named by
29413 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29414 attempt to set up a TLS session is aborted, and the incoming connection is
29415 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29416 session continues. ACLs that run for subsequent SMTP commands can detect the
29417 fact that no certificate was verified, and vary their actions accordingly. For
29418 example, you can insist on a certificate before accepting a message for
29419 relaying, but not when the message is destined for local delivery.
29420
29421 .vindex "&$tls_in_peerdn$&"
29422 When a client supplies a certificate (whether it verifies or not), the value of
29423 the Distinguished Name of the certificate is made available in the variable
29424 &$tls_in_peerdn$& during subsequent processing of the message.
29425
29426 .cindex "log" "distinguished name"
29427 Because it is often a long text string, it is not included in the log line or
29428 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29429 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29430 &%received_header_text%& to change the &'Received:'& header. When no
29431 certificate is supplied, &$tls_in_peerdn$& is empty.
29432
29433
29434 .section "Revoked certificates" "SECID184"
29435 .cindex "TLS" "revoked certificates"
29436 .cindex "revocation list"
29437 .cindex "certificate" "revocation list"
29438 .cindex "OCSP" "stapling"
29439 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
29440 certificates are revoked. If you have such a list, you can pass it to an Exim
29441 server using the global option called &%tls_crl%& and to an Exim client using
29442 an identically named option for the &(smtp)& transport. In each case, the value
29443 of the option is expanded and must then be the name of a file that contains a
29444 CRL in PEM format.
29445 The downside is that clients have to periodically re-download a potentially huge
29446 file from every certificate authority they know of.
29447
29448 The way with most moving parts at query time is Online Certificate
29449 Status Protocol (OCSP), where the client verifies the certificate
29450 against an OCSP server run by the CA.  This lets the CA track all
29451 usage of the certs.  It requires running software with access to the
29452 private key of the CA, to sign the responses to the OCSP queries.  OCSP
29453 is based on HTTP and can be proxied accordingly.
29454
29455 The only widespread OCSP server implementation (known to this writer)
29456 comes as part of OpenSSL and aborts on an invalid request, such as
29457 connecting to the port and then disconnecting.  This requires
29458 re-entering the passphrase each time some random client does this.
29459
29460 The third way is OCSP Stapling; in this, the server using a certificate
29461 issued by the CA periodically requests an OCSP proof of validity from
29462 the OCSP server, then serves it up inline as part of the TLS
29463 negotiation.   This approach adds no extra round trips, does not let the
29464 CA track users, scales well with number of certs issued by the CA and is
29465 resilient to temporary OCSP server failures, as long as the server
29466 starts retrying to fetch an OCSP proof some time before its current
29467 proof expires.  The downside is that it requires server support.
29468
29469 Unless Exim is built with the support disabled,
29470 or with GnuTLS earlier than version 3.3.16 / 3.4.8
29471 support for OCSP stapling is included.
29472
29473 There is a global option called &%tls_ocsp_file%&.
29474 The file specified therein is expected to be in DER format, and contain
29475 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
29476 option will be re-expanded for SNI, if the &%tls_certificate%& option
29477 contains &`tls_in_sni`&, as per other TLS options.
29478
29479 Exim does not at this time implement any support for fetching a new OCSP
29480 proof.  The burden is on the administrator to handle this, outside of
29481 Exim.  The file specified should be replaced atomically, so that the
29482 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
29483 on each connection, so a new file will be handled transparently on the
29484 next connection.
29485
29486 When built with OpenSSL Exim will check for a valid next update timestamp
29487 in the OCSP proof; if not present, or if the proof has expired, it will be
29488 ignored.
29489
29490 For the client to be able to verify the stapled OCSP the server must
29491 also supply, in its stapled information, any intermediate
29492 certificates for the chain leading to the OCSP proof from the signer
29493 of the server certificate.  There may be zero or one such. These
29494 intermediate certificates should be added to the server OCSP stapling
29495 file named by &%tls_ocsp_file%&.
29496
29497 Note that the proof only covers the terminal server certificate,
29498 not any of the chain from CA to it.
29499
29500 There is no current way to staple a proof for a client certificate.
29501
29502 .code
29503   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
29504   OCSP server is supplied.  The server URL may be included in the
29505   server certificate, if the CA is helpful.
29506
29507   One failure mode seen was the OCSP Signer cert expiring before the end
29508   of validity of the OCSP proof. The checking done by Exim/OpenSSL
29509   noted this as invalid overall, but the re-fetch script did not.
29510 .endd
29511
29512
29513 .section "Caching of static server configuration items" "SECTserverTLScache"
29514 .cindex certificate caching
29515 .cindex privatekey caching
29516 .cindex crl caching
29517 .cindex ocsp caching
29518 .cindex ciphers caching
29519 .cindex "CA bundle" caching
29520 .cindex "certificate authorities" caching
29521 .cindex tls_certificate caching
29522 .cindex tls_privatekey caching
29523 .cindex tls_crl caching
29524 .cindex tls_ocsp_file caching
29525 .cindex tls_require_ciphers caching
29526 .cindex tls_verify_certificate caching
29527 .cindex caching certificate
29528 .cindex caching privatekey
29529 .cindex caching crl
29530 .cindex caching ocsp
29531 .cindex caching ciphers
29532 .cindex caching "certificate authorities
29533 If any of the main configuration options &%tls_certificate%&, &%tls_privatekey%&,
29534 &%tls_crl%& and &%tls_ocsp_file%& have values with no
29535 expandable elements,
29536 then the associated information is loaded at daemon startup.
29537 It is made available
29538 to child processes forked for handling received SMTP connections.
29539
29540 This caching is currently only supported under Linux and FreeBSD.
29541
29542 If caching is not possible, for example if an item has to be dependent
29543 on the peer host so contains a &$sender_host_name$& expansion, the load
29544 of the associated information is done at the startup of the TLS connection.
29545
29546 The cache is invalidated and reloaded after any changes to the directories
29547 containing files specified by these options.
29548
29549 The information specified by the main option &%tls_verify_certificates%&
29550 is similarly cached so long as it specifies files explicitly
29551 or (under GnuTLS) is the string &"system,cache"&.
29552 The latter case is not automatically invalidated;
29553 it is the operator's responsibility to arrange for a daemon restart
29554 any time the system certificate authority bundle is updated.
29555 A HUP signal is sufficient for this.
29556 The value &"system"& results in no caching under GnuTLS.
29557
29558 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29559 is acceptable in configurations for the Exim executavble.
29560
29561 Caching of the system Certificate Authorities bundle can
29562 save siginificant time and processing on every TLS connection
29563 accepted by Exim.
29564
29565
29566
29567
29568 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29569 .cindex "cipher" "logging"
29570 .cindex "log" "TLS cipher"
29571 .cindex "log" "distinguished name"
29572 .cindex "TLS" "configuring an Exim client"
29573 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29574 deliveries as well as to incoming, the latter one causing logging of the
29575 server certificate's DN. The remaining client configuration for TLS is all
29576 within the &(smtp)& transport.
29577
29578 .cindex "ESMTP extensions" STARTTLS
29579 It is not necessary to set any options to have TLS work in the &(smtp)&
29580 transport. If Exim is built with TLS support, and TLS is advertised by a
29581 server, the &(smtp)& transport always tries to start a TLS session. However,
29582 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29583 transport) to a list of server hosts for which TLS should not be used.
29584
29585 If you do not want Exim to attempt to send messages unencrypted when an attempt
29586 to set up an encrypted connection fails in any way, you can set
29587 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29588 those hosts, delivery is always deferred if an encrypted connection cannot be
29589 set up. If there are any other hosts for the address, they are tried in the
29590 usual way.
29591
29592 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29593 the message unencrypted. It always does this if the response to STARTTLS is
29594 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29595 session after a success response code, what happens is controlled by the
29596 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29597 delivery to this host is deferred, and other hosts (if available) are tried. If
29598 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29599 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29600 negotiation fails, Exim closes the current connection (because it is in an
29601 unknown state), opens a new one to the same host, and then tries the delivery
29602 unencrypted.
29603
29604 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29605 transport provide the client with a certificate, which is passed to the server
29606 if it requests it.
29607 This is an optional thing for TLS connections, although either end
29608 may insist on it.
29609 If the server is Exim, it will request a certificate only if
29610 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29611
29612 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29613 for client use (they are usable for server use).
29614 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29615 in failed connections.
29616
29617 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29618 specifies a collection of expected server certificates.
29619 These may be
29620 the system default set (depending on library version),
29621 a file,
29622 or (depending on library version) a directory.
29623 The client verifies the server's certificate
29624 against this collection, taking into account any revoked certificates that are
29625 in the list defined by &%tls_crl%&.
29626 Failure to verify fails the TLS connection unless either of the
29627 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29628
29629 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29630 certificate verification to the listed servers.  Verification either must
29631 or need not succeed respectively.
29632
29633 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29634 name checks are made on the server certificate.
29635 The match against this list is, as per other Exim usage, the
29636 IP for the host.  That is most closely associated with the
29637 name on the DNS A (or AAAA) record for the host.
29638 However, the name that needs to be in the certificate
29639 is the one at the head of any CNAME chain leading to the A record.
29640 The option defaults to always checking.
29641
29642 The &(smtp)& transport has two OCSP-related options:
29643 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29644 is requested and required for the connection to proceed.  The default
29645 value is empty.
29646 &%hosts_request_ocsp%&; a host-list for which (additionally)
29647 a Certificate Status is requested (but not necessarily verified).  The default
29648 value is "*" meaning that requests are made unless configured
29649 otherwise.
29650
29651 The host(s) should also be in &%hosts_require_tls%&, and
29652 &%tls_verify_certificates%& configured for the transport,
29653 for OCSP to be relevant.
29654
29655 If
29656 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29657 list of permitted cipher suites. If either of these checks fails, delivery to
29658 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29659 alternative hosts, if any.
29660
29661  &*Note*&:
29662 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29663 is operating as a client. Exim does not assume that a server certificate (set
29664 by the global options of the same name) should also be used when operating as a
29665 client.
29666
29667 .vindex "&$host$&"
29668 .vindex "&$host_address$&"
29669 All the TLS options in the &(smtp)& transport are expanded before use, with
29670 &$host$& and &$host_address$& containing the name and address of the server to
29671 which the client is connected. Forced failure of an expansion causes Exim to
29672 behave as if the relevant option were unset.
29673
29674 .vindex &$tls_out_bits$&
29675 .vindex &$tls_out_cipher$&
29676 .vindex &$tls_out_peerdn$&
29677 .vindex &$tls_out_sni$&
29678 Before an SMTP connection is established, the
29679 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29680 variables are emptied. (Until the first connection, they contain the values
29681 that were set when the message was received.) If STARTTLS is subsequently
29682 successfully obeyed, these variables are set to the relevant values for the
29683 outgoing connection.
29684
29685
29686
29687 .section "Caching of static client configuration items" "SECTclientTLScache"
29688 .cindex certificate caching
29689 .cindex privatekey caching
29690 .cindex crl caching
29691 .cindex ciphers caching
29692 .cindex "CA bundle" caching
29693 .cindex "certificate authorities" caching
29694 .cindex tls_certificate caching
29695 .cindex tls_privatekey caching
29696 .cindex tls_crl caching
29697 .cindex tls_require_ciphers caching
29698 .cindex tls_verify_certificate caching
29699 .cindex caching certificate
29700 .cindex caching privatekey
29701 .cindex caching crl
29702 .cindex caching ciphers
29703 .cindex caching "certificate authorities
29704 If any of the transport configuration options &%tls_certificate%&, &%tls_privatekey%&
29705 and &%tls_crl%& have values with no
29706 expandable elements,
29707 then the associated information is loaded per smtp transport
29708 at daemon startup, at the start of a queue run, or on a
29709 command-line specified message delivery.
29710 It is made available
29711 to child processes forked for handling making SMTP connections.
29712
29713 This caching is currently only supported under Linux.
29714
29715 If caching is not possible, the load
29716 of the associated information is done at the startup of the TLS connection.
29717
29718 The cache is invalidated in the daemon
29719 and reloaded after any changes to the directories
29720 containing files specified by these options.
29721
29722 The information specified by the main option &%tls_verify_certificates%&
29723 is similarly cached so long as it specifies files explicitly
29724 or (under GnuTLS) is the string &"system,cache"&.
29725 The latter case is not automatically invaludated;
29726 it is the operator's responsibility to arrange for a daemon restart
29727 any time the system certificate authority bundle is updated.
29728 A HUP signal is sufficient for this.
29729 The value &"system"& results in no caching under GnuTLS.
29730
29731 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29732 is acceptable in configurations for the Exim executavble.
29733
29734 Caching of the system Certificate Authorities bundle can
29735 save siginificant time and processing on every TLS connection
29736 initiated by Exim.
29737
29738
29739
29740
29741 .section "Use of TLS Server Name Indication" "SECTtlssni"
29742 .cindex "TLS" "Server Name Indication"
29743 .cindex "TLS" SNI
29744 .cindex SNI
29745 .vindex "&$tls_in_sni$&"
29746 .oindex "&%tls_in_sni%&"
29747 With TLS1.0 or above, there is an extension mechanism by which extra
29748 information can be included at various points in the protocol.  One of these
29749 extensions, documented in RFC 6066 (and before that RFC 4366) is
29750 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29751 client in the initial handshake, so that the server can examine the servername
29752 within and possibly choose to use different certificates and keys (and more)
29753 for this session.
29754
29755 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29756 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29757 address.
29758
29759 With SMTP to MX, there are the same problems here as in choosing the identity
29760 against which to validate a certificate: you can't rely on insecure DNS to
29761 provide the identity which you then cryptographically verify.  So this will
29762 be of limited use in that environment.
29763
29764 With SMTP to Submission, there is a well-defined hostname which clients are
29765 connecting to and can validate certificates against.  Thus clients &*can*&
29766 choose to include this information in the TLS negotiation.  If this becomes
29767 wide-spread, then hosters can choose to present different certificates to
29768 different clients.  Or even negotiate different cipher suites.
29769
29770 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29771 if not empty, will be sent on a TLS session as part of the handshake.  There's
29772 nothing more to it.  Choosing a sensible value not derived insecurely is the
29773 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29774 for the lifetime of the client connection (including during authentication).
29775
29776 If DANE validated the connection attempt then the value of the &%tls_sni%& option
29777 is forced to the domain part of the recipient address.
29778
29779 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29780 received from a client.
29781 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29782
29783 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29784 option (prior to expansion) then the following options will be re-expanded
29785 during TLS session handshake, to permit alternative values to be chosen:
29786
29787 .ilist
29788 &%tls_certificate%&
29789 .next
29790 &%tls_crl%&
29791 .next
29792 &%tls_privatekey%&
29793 .next
29794 &%tls_verify_certificates%&
29795 .next
29796 &%tls_ocsp_file%&
29797 .endlist
29798
29799 Great care should be taken to deal with matters of case, various injection
29800 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29801 can always be referenced; it is important to remember that &$tls_in_sni$& is
29802 arbitrary unverified data provided prior to authentication.
29803 Further, the initial certificate is loaded before SNI has arrived, so
29804 an expansion for &%tls_certificate%& must have a default which is used
29805 when &$tls_in_sni$& is empty.
29806
29807 The Exim developers are proceeding cautiously and so far no other TLS options
29808 are re-expanded.
29809
29810 When Exim is built against OpenSSL, OpenSSL must have been built with support
29811 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29812 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29813 see &`-servername`& in the output, then OpenSSL has support.
29814
29815 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29816 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29817 built, then you have SNI support).
29818
29819 .cindex TLS ALPN
29820 .cindex ALPN "general information"
29821 .cindex TLS "Application Layer Protocol Names"
29822 There is a TLS feature related to SNI
29823 called Application Layer Protocol Name (ALPN).
29824 This is intended to declare, or select, what protocol layer will be using a TLS
29825 connection.
29826 The client for the connection proposes a set of protocol names, and
29827 the server responds with a selected one.
29828 It is not, as of 2021, commonly used for SMTP connections.
29829 However, to guard against misirected or malicious use of web clients
29830 (which often do use ALPN) against MTA ports, Exim by default check that
29831 there is no incompatible ALPN specified by a client for a TLS connection.
29832 If there is, the connection is rejected.
29833
29834 As a client Exim does not supply ALPN by default.
29835 The behaviour of both client and server can be configured using the options
29836 &%tls_alpn%& and &%hosts_require_alpn%&.
29837 There are no variables providing observability.
29838 Some feature-specific logging may appear on denied connections, but this
29839 depends on the behavious of the peer
29840 (not all peers can send a feature-specific TLS Alert).
29841
29842 This feature is available when Exim is built with
29843 OpenSSL 1.1.0 or later or GnuTLS 3.2.0 or later;
29844 the macro _HAVE_TLS_ALPN will be defined when this is so.
29845
29846
29847
29848 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29849          "SECTmulmessam"
29850 .cindex "multiple SMTP deliveries with TLS"
29851 .cindex "TLS" "multiple message deliveries"
29852 Exim sends multiple messages down the same TCP/IP connection by starting up
29853 an entirely new delivery process for each message, passing the socket from
29854 one process to the next. This implementation does not fit well with the use
29855 of TLS, because there is quite a lot of state information associated with a TLS
29856 connection, not just a socket identification. Passing all the state information
29857 to a new process is not feasible. Consequently, for sending using TLS Exim
29858 starts an additional proxy process for handling the encryption, piping the
29859 unencrypted data stream from and to the delivery processes.
29860
29861 An older mode of operation can be enabled on a per-host basis by the
29862 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29863 this list the proxy process described above is not used; instead Exim
29864 shuts down an existing TLS session being run by the delivery process
29865 before passing the socket to a new process. The new process may then
29866 try to start a new TLS session, and if successful, may try to re-authenticate
29867 if AUTH is in use, before sending the next message.
29868
29869 The RFC is not clear as to whether or not an SMTP session continues in clear
29870 after TLS has been shut down, or whether TLS may be restarted again later, as
29871 just described. However, if the server is Exim, this shutdown and
29872 reinitialization works. It is not known which (if any) other servers operate
29873 successfully if the client closes a TLS session and continues with unencrypted
29874 SMTP, but there are certainly some that do not work. For such servers, Exim
29875 should not pass the socket to another process, because the failure of the
29876 subsequent attempt to use it would cause Exim to record a temporary host error,
29877 and delay other deliveries to that host.
29878
29879 To test for this case, Exim sends an EHLO command to the server after
29880 closing down the TLS session. If this fails in any way, the connection is
29881 closed instead of being passed to a new delivery process, but no retry
29882 information is recorded.
29883
29884 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29885 &(smtp)& transport to match those hosts for which Exim should not pass
29886 connections to new processes if TLS has been used.
29887
29888
29889
29890
29891 .section "Certificates and all that" "SECTcerandall"
29892 .cindex "certificate" "references to discussion"
29893 In order to understand fully how TLS works, you need to know about
29894 certificates, certificate signing, and certificate authorities.
29895 This is a large topic and an introductory guide is unsuitable for the Exim
29896 reference manual, so instead we provide pointers to existing documentation.
29897
29898 The Apache web-server was for a long time the canonical guide, so their
29899 documentation is a good place to start; their SSL module's Introduction
29900 document is currently at
29901 .display
29902 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
29903 .endd
29904 and their FAQ is at
29905 .display
29906 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
29907 .endd
29908
29909 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
29910 0-201-61598-3) in 2001, contains both introductory and more in-depth
29911 descriptions.
29912 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
29913 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
29914 Ivan is the author of the popular TLS testing tools at
29915 &url(https://www.ssllabs.com/).
29916
29917
29918 .section "Certificate chains" "SECID186"
29919 A file named by &%tls_certificate%& may contain more than one
29920 certificate. This is useful in the case where the certificate that is being
29921 sent is validated by an intermediate certificate which the other end does
29922 not have. Multiple certificates must be in the correct order in the file.
29923 First the host's certificate itself, then the first intermediate
29924 certificate to validate the issuer of the host certificate, then the next
29925 intermediate certificate to validate the issuer of the first intermediate
29926 certificate, and so on, until finally (optionally) the root certificate.
29927 The root certificate must already be trusted by the recipient for
29928 validation to succeed, of course, but if it's not preinstalled, sending the
29929 root certificate along with the rest makes it available for the user to
29930 install if the receiving end is a client MUA that can interact with a user.
29931
29932 Note that certificates using MD5 are unlikely to work on today's Internet;
29933 even if your libraries allow loading them for use in Exim when acting as a
29934 server, increasingly clients will not accept such certificates.  The error
29935 diagnostics in such a case can be frustratingly vague.
29936
29937
29938
29939 .section "Self-signed certificates" "SECID187"
29940 .cindex "certificate" "self-signed"
29941 You can create a self-signed certificate using the &'req'& command provided
29942 with OpenSSL, like this:
29943 . ==== Do not shorten the duration here without reading and considering
29944 . ==== the text below.  Please leave it at 9999 days.
29945 .code
29946 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
29947             -days 9999 -nodes
29948 .endd
29949 &_file1_& and &_file2_& can be the same file; the key and the certificate are
29950 delimited and so can be identified independently. The &%-days%& option
29951 specifies a period for which the certificate is valid. The &%-nodes%& option is
29952 important: if you do not set it, the key is encrypted with a passphrase
29953 that you are prompted for, and any use that is made of the key causes more
29954 prompting for the passphrase. This is not helpful if you are going to use
29955 this certificate and key in an MTA, where prompting is not possible.
29956
29957 . ==== I expect to still be working 26 years from now.  The less technical
29958 . ==== debt I create, in terms of storing up trouble for my later years, the
29959 . ==== happier I will be then.  We really have reached the point where we
29960 . ==== should start, at the very least, provoking thought and making folks
29961 . ==== pause before proceeding, instead of leaving all the fixes until two
29962 . ==== years before 2^31 seconds after the 1970 Unix epoch.
29963 . ==== -pdp, 2012
29964 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
29965 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
29966 the above command might produce a date in the past.  Think carefully about
29967 the lifetime of the systems you're deploying, and either reduce the duration
29968 of the certificate or reconsider your platform deployment.  (At time of
29969 writing, reducing the duration is the most likely choice, but the inexorable
29970 progression of time takes us steadily towards an era where this will not
29971 be a sensible resolution).
29972
29973 A self-signed certificate made in this way is sufficient for testing, and
29974 may be adequate for all your requirements if you are mainly interested in
29975 encrypting transfers, and not in secure identification.
29976
29977 However, many clients require that the certificate presented by the server be a
29978 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
29979 certificate. In this situation, the self-signed certificate described above
29980 must be installed on the client host as a trusted root &'certification
29981 authority'& (CA), and the certificate used by Exim must be a user certificate
29982 signed with that self-signed certificate.
29983
29984 For information on creating self-signed CA certificates and using them to sign
29985 user certificates, see the &'General implementation overview'& chapter of the
29986 Open-source PKI book, available online at
29987 &url(https://sourceforge.net/projects/ospkibook/).
29988 .ecindex IIDencsmtp1
29989 .ecindex IIDencsmtp2
29990
29991
29992 .section "TLS Resumption" "SECTresumption"
29993 .cindex TLS resumption
29994 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
29995 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
29996 (or later).
29997
29998 Session resumption (this is the "stateless" variant) involves the server sending
29999 a "session ticket" to the client on one connection, which can be stored by the
30000 client and used for a later session.  The ticket contains sufficient state for
30001 the server to reconstruct the TLS session, avoiding some expensive crypto
30002 calculation and (on TLS1.2) one full packet roundtrip time.
30003
30004 .ilist
30005 Operational cost/benefit:
30006
30007  The extra data being transmitted costs a minor amount, and the client has
30008  extra costs in storing and retrieving the data.
30009
30010  In the Exim/Gnutls implementation the extra cost on an initial connection
30011  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
30012  The saved cost on a subsequent connection is about 4ms; three or more
30013  connections become a net win.  On longer network paths, two or more
30014  connections will have an average lower startup time thanks to the one
30015  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
30016  packet roundtrips.
30017
30018 .cindex "hints database" tls
30019  Since a new hints DB is used on the TLS client,
30020  the hints DB maintenance should be updated to additionally handle "tls".
30021
30022 .next
30023 Security aspects:
30024
30025  The session ticket is encrypted, but is obviously an additional security
30026  vulnarability surface.  An attacker able to decrypt it would have access
30027  all connections using the resumed session.
30028  The session ticket encryption key is not committed to storage by the server
30029  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
30030  overlap; GnuTLS 6hr but does not specify any overlap).
30031  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
30032  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
30033
30034  There is a question-mark over the security of the Diffie-Helman parameters
30035  used for session negotiation.
30036
30037 .next
30038 Observability:
30039
30040  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
30041  element.
30042
30043  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
30044  have bits 0-4 indicating respectively
30045  support built, client requested ticket, client offered session,
30046  server issued ticket, resume used.  A suitable decode list is provided
30047  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
30048
30049 .next
30050 Control:
30051
30052 The &%tls_resumption_hosts%& main option specifies a hostlist for which
30053 exim, operating as a server, will offer resumption to clients.
30054 Current best practice is to not offer the feature to MUA connection.
30055 Commonly this can be done like this:
30056 .code
30057 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
30058 .endd
30059 If the peer host matches the list after expansion then resumption
30060 is offered and/or accepted.
30061
30062 The &%tls_resumption_hosts%& smtp transport option performs the
30063 equivalent function for operation as a client.
30064 If the peer host matches the list after expansion then resumption
30065 is attempted (if a stored session is available) or the information
30066 stored (if supplied by the peer).
30067
30068
30069 .next
30070 Issues:
30071
30072  In a resumed session:
30073 .ilist
30074   The variables &$tls_{in,out}_cipher$& will have values different
30075  to the original (under GnuTLS).
30076 .next
30077   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
30078  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
30079 . XXX need to do something with that hosts_require_ocsp
30080 .endlist
30081
30082 .endlist
30083
30084
30085 .section DANE "SECDANE"
30086 .cindex DANE
30087 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
30088 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
30089 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
30090 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
30091 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
30092 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
30093
30094 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
30095 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
30096 by (a) is thought to be smaller than that of the set of root CAs.
30097
30098 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
30099 fail to pass on a server's STARTTLS.
30100
30101 DANE scales better than having to maintain (and communicate via side-channel) copies of server certificates
30102 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
30103 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
30104
30105 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
30106 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
30107 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
30108 DNSSEC.
30109 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
30110 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
30111
30112 There are no changes to Exim specific to server-side operation of DANE.
30113 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
30114 in &_Local/Makefile_&.
30115 If it has been included, the macro "_HAVE_DANE" will be defined.
30116
30117 A TLSA record consist of 4 fields, the "Certificate Usage", the
30118 "Selector", the "Matching type", and the "Certificate Association Data".
30119 For a detailed description of the TLSA record see
30120 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
30121
30122 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
30123 These are the "Trust Anchor" and "End Entity" variants.
30124 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
30125 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
30126 this is appropriate for a single system, using a self-signed certificate.
30127 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
30128 well-known one.
30129 A private CA at simplest is just a self-signed certificate (with certain
30130 attributes) which is used to sign server certificates, but running one securely
30131 does require careful arrangement.
30132 With DANE-TA, as implemented in Exim and commonly in other MTAs,
30133 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
30134 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
30135 all of which point to a single TLSA record.
30136 DANE-TA and DANE-EE can both be used together.
30137
30138 Our recommendation is to use DANE with a certificate from a public CA,
30139 because this enables a variety of strategies for remote clients to verify
30140 your certificate.
30141 You can then publish information both via DANE and another technology,
30142 "MTA-STS", described below.
30143
30144 When you use DANE-TA to publish trust anchor information, you ask entities
30145 outside your administrative control to trust the Certificate Authority for
30146 connections to you.
30147 If using a private CA then you should expect others to still apply the
30148 technical criteria they'd use for a public CA to your certificates.
30149 In particular, you should probably try to follow current best practices for CA
30150 operation around hash algorithms and key sizes.
30151 Do not expect other organizations to lower their security expectations just
30152 because a particular profile might be reasonable for your own internal use.
30153
30154 When this text was last updated, this in practice means to avoid use of SHA-1
30155 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
30156 than 4096, for interoperability); to use keyUsage fields correctly; to use
30157 random serial numbers.
30158 The list of requirements is subject to change as best practices evolve.
30159 If you're not already using a private CA, or it doesn't meet these
30160 requirements, then we encourage you to avoid all these issues and use a public
30161 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
30162
30163 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
30164 a "Matching Type" (3rd) field of SHA2-512(2).
30165
30166 For the "Certificate Authority Data" (4th) field, commands like
30167
30168 .code
30169   openssl x509 -pubkey -noout <certificate.pem \
30170   | openssl rsa -outform der -pubin 2>/dev/null \
30171   | openssl sha512 \
30172   | awk '{print $2}'
30173 .endd
30174
30175 are workable to create a hash of the certificate's public key.
30176
30177 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
30178
30179 .code
30180   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
30181 .endd
30182
30183 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
30184 is useful for quickly generating TLSA records.
30185
30186
30187 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
30188
30189 The Certificate issued by the CA published in the DANE-TA model should be
30190 issued using a strong hash algorithm.
30191 Exim, and importantly various other MTAs sending to you, will not
30192 re-enable hash algorithms which have been disabled by default in TLS
30193 libraries.
30194 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
30195 interoperability (and probably the maximum too, in 2018).
30196
30197 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
30198 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
30199 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
30200
30201 .code
30202   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
30203                                  {= {4}{$tls_out_tlsa_usage}} } \
30204                          {*}{}}
30205 .endd
30206
30207 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
30208 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
30209 found. If the definition of &%hosts_request_ocsp%& includes the
30210 string "tls_out_tlsa_usage", they are re-expanded in time to
30211 control the OCSP request.
30212
30213 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
30214 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
30215
30216
30217 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
30218 and &%dane_require_tls_ciphers%&.
30219 The &"require"& variant will result in failure if the target host is not
30220 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
30221 the &%dnssec_request_domains%& router or transport option.
30222
30223 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
30224
30225 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using DNSSEC.
30226 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
30227 will be required for the host.  If it does not, the host will not
30228 be used; there is no fallback to non-DANE or non-TLS.
30229
30230 If DANE is requested and usable, then the TLS cipher list configuration
30231 prefers to use the option &%dane_require_tls_ciphers%& and falls
30232 back to &%tls_require_ciphers%& only if that is unset.
30233 This lets you configure "decent crypto" for DANE and "better than nothing
30234 crypto" as the default.  Note though that while GnuTLS lets the string control
30235 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
30236 limited to ciphersuite constraints.
30237
30238 If DANE is requested and useable (see above) the following transport options are ignored:
30239 .code
30240   hosts_require_tls
30241   tls_verify_hosts
30242   tls_try_verify_hosts
30243   tls_verify_certificates
30244   tls_crl
30245   tls_verify_cert_hostnames
30246   tls_sni
30247 .endd
30248
30249 If DANE is not usable, whether requested or not, and CA-anchored
30250 verification evaluation is wanted, the above variables should be set appropriately.
30251
30252 The router and transport option &%dnssec_request_domains%& must not be
30253 set to &"never"&, and &%dnssec_require_domains%& is ignored.
30254
30255 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
30256
30257 There is a new variable &$tls_out_dane$& which will have "yes" if
30258 verification succeeded using DANE and "no" otherwise (only useful
30259 in combination with events; see &<<CHAPevents>>&),
30260 and a new variable &$tls_out_tlsa_usage$& (detailed above).
30261
30262 .cindex DANE reporting
30263 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
30264 to achieve DANE-verified connection, if one was either requested and offered, or
30265 required.  This is intended to support TLS-reporting as defined in
30266 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
30267 The &$event_data$& will be one of the Result Types defined in
30268 Section 4.3 of that document.
30269
30270 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
30271
30272 DANE is specified in published RFCs and decouples certificate authority trust
30273 selection from a "race to the bottom" of "you must trust everything for mail
30274 to get through".  There is an alternative technology called MTA-STS, which
30275 instead publishes MX trust anchor information on an HTTPS website.  At the
30276 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
30277 Exim has no support for MTA-STS as a client, but Exim mail server operators
30278 can choose to publish information describing their TLS configuration using
30279 MTA-STS to let those clients who do use that protocol derive trust
30280 information.
30281
30282 The MTA-STS design requires a certificate from a public Certificate Authority
30283 which is recognized by clients sending to you.
30284 That selection of which CAs are trusted by others is outside your control.
30285
30286 The most interoperable course of action is probably to use
30287 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
30288 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
30289 records for DANE clients (such as Exim and Postfix) and to publish anchor
30290 information for MTA-STS as well.  This is what is done for the &'exim.org'&
30291 domain itself (with caveats around occasionally broken MTA-STS because of
30292 incompatible specification changes prior to reaching RFC status).
30293
30294
30295
30296 . ////////////////////////////////////////////////////////////////////////////
30297 . ////////////////////////////////////////////////////////////////////////////
30298
30299 .chapter "Access control lists" "CHAPACL"
30300 .scindex IIDacl "&ACL;" "description"
30301 .cindex "control of incoming mail"
30302 .cindex "message" "controlling incoming"
30303 .cindex "policy control" "access control lists"
30304 Access Control Lists (ACLs) are defined in a separate section of the runtime
30305 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
30306 name, terminated by a colon. Here is a complete ACL section that contains just
30307 one very small ACL:
30308 .code
30309 begin acl
30310 small_acl:
30311   accept   hosts = one.host.only
30312 .endd
30313 You can have as many lists as you like in the ACL section, and the order in
30314 which they appear does not matter. The lists are self-terminating.
30315
30316 The majority of ACLs are used to control Exim's behaviour when it receives
30317 certain SMTP commands. This applies both to incoming TCP/IP connections, and
30318 when a local process submits a message using SMTP by specifying the &%-bs%&
30319 option. The most common use is for controlling which recipients are accepted
30320 in incoming messages. In addition, you can define an ACL that is used to check
30321 local non-SMTP messages. The default configuration file contains an example of
30322 a realistic ACL for checking RCPT commands. This is discussed in chapter
30323 &<<CHAPdefconfil>>&.
30324
30325
30326 .section "Testing ACLs" "SECID188"
30327 The &%-bh%& command line option provides a way of testing your ACL
30328 configuration locally by running a fake SMTP session with which you interact.
30329
30330
30331 .section "Specifying when ACLs are used" "SECID189"
30332 .cindex "&ACL;" "options for specifying"
30333 In order to cause an ACL to be used, you have to name it in one of the relevant
30334 options in the main part of the configuration. These options are:
30335 .cindex "AUTH" "ACL for"
30336 .cindex "DATA" "ACLs for"
30337 .cindex "ETRN" "ACL for"
30338 .cindex "EXPN" "ACL for"
30339 .cindex "HELO" "ACL for"
30340 .cindex "EHLO" "ACL for"
30341 .cindex "DKIM" "ACL for"
30342 .cindex "MAIL" "ACL for"
30343 .cindex "QUIT, ACL for"
30344 .cindex "RCPT" "ACL for"
30345 .cindex "STARTTLS, ACL for"
30346 .cindex "VRFY" "ACL for"
30347 .cindex "SMTP" "connection, ACL for"
30348 .cindex "non-SMTP messages" "ACLs for"
30349 .cindex "MIME content scanning" "ACL for"
30350 .cindex "PRDR" "ACL for"
30351
30352 .table2 140pt
30353 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
30354 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
30355 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
30356 .irow &%acl_smtp_auth%&        "ACL for AUTH"
30357 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
30358 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
30359 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
30360 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
30361 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
30362 .irow &%acl_smtp_expn%&        "ACL for EXPN"
30363 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
30364 .irow &%acl_smtp_mail%&        "ACL for MAIL"
30365 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
30366 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
30367 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
30368 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
30369 .irow &%acl_smtp_quit%&        "ACL for QUIT"
30370 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
30371 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
30372 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
30373 .endtable
30374
30375 For example, if you set
30376 .code
30377 acl_smtp_rcpt = small_acl
30378 .endd
30379 the little ACL defined above is used whenever Exim receives a RCPT command
30380 in an SMTP dialogue. The majority of policy tests on incoming messages can be
30381 done when RCPT commands arrive. A rejection of RCPT should cause the
30382 sending MTA to give up on the recipient address contained in the RCPT
30383 command, whereas rejection at other times may cause the client MTA to keep on
30384 trying to deliver the message. It is therefore recommended that you do as much
30385 testing as possible at RCPT time.
30386
30387
30388 .section "The non-SMTP ACLs" "SECID190"
30389 .cindex "non-SMTP messages" "ACLs for"
30390 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
30391 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
30392 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
30393 the state of the SMTP connection such as encryption and authentication) are not
30394 relevant and are forbidden in these ACLs. However, the sender and recipients
30395 are known, so the &%senders%& and &%sender_domains%& conditions and the
30396 &$sender_address$& and &$recipients$& variables can be used. Variables such as
30397 &$authenticated_sender$& are also available. You can specify added header lines
30398 in any of these ACLs.
30399
30400 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
30401 non-SMTP message, before any of the message has been read. (This is the
30402 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
30403 batched SMTP input, it runs after the DATA command has been reached. The
30404 result of this ACL is ignored; it cannot be used to reject a message. If you
30405 really need to, you could set a value in an ACL variable here and reject based
30406 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
30407 controls, and in particular, it can be used to set
30408 .code
30409 control = suppress_local_fixups
30410 .endd
30411 This cannot be used in the other non-SMTP ACLs because by the time they are
30412 run, it is too late.
30413
30414 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
30415 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30416
30417 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
30418 kind of rejection is treated as permanent, because there is no way of sending a
30419 temporary error for these kinds of message.
30420
30421
30422 .section "The SMTP connect ACL" "SECID191"
30423 .cindex "SMTP" "connection, ACL for"
30424 .oindex &%smtp_banner%&
30425 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
30426 session, after the test specified by &%host_reject_connection%& (which is now
30427 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
30428 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
30429 the message override the banner message that is otherwise specified by the
30430 &%smtp_banner%& option.
30431
30432
30433 .section "The EHLO/HELO ACL" "SECID192"
30434 .cindex "EHLO" "ACL for"
30435 .cindex "HELO" "ACL for"
30436 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
30437 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
30438 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
30439 Note that a client may issue more than one EHLO or HELO command in an SMTP
30440 session, and indeed is required to issue a new EHLO or HELO after successfully
30441 setting up encryption following a STARTTLS command.
30442
30443 Note also that a deny neither forces the client to go away nor means that
30444 mail will be refused on the connection.  Consider checking for
30445 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
30446
30447 If the command is accepted by an &%accept%& verb that has a &%message%&
30448 modifier, the message may not contain more than one line (it will be truncated
30449 at the first newline and a panic logged if it does). Such a message cannot
30450 affect the EHLO options that are listed on the second and subsequent lines of
30451 an EHLO response.
30452
30453
30454 .section "The DATA ACLs" "SECID193"
30455 .cindex "DATA" "ACLs for"
30456 Two ACLs are associated with the DATA command, because it is two-stage
30457 command, with two responses being sent to the client.
30458 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
30459 is obeyed. This gives you control after all the RCPT commands, but before
30460 the message itself is received. It offers the opportunity to give a negative
30461 response to the DATA command before the data is transmitted. Header lines
30462 added by MAIL or RCPT ACLs are not visible at this time, but any that
30463 are defined here are visible when the &%acl_smtp_data%& ACL is run.
30464
30465 You cannot test the contents of the message, for example, to verify addresses
30466 in the headers, at RCPT time or when the DATA command is received. Such
30467 tests have to appear in the ACL that is run after the message itself has been
30468 received, before the final response to the DATA command is sent. This is
30469 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
30470 associated with the DATA command.
30471
30472 .cindex CHUNKING "BDAT command"
30473 .cindex BDAT "SMTP command"
30474 .cindex "RFC 3030" CHUNKING
30475 If CHUNKING was advertised and a BDAT command sequence is received,
30476 the &%acl_smtp_predata%& ACL is not run.
30477 . XXX why not?  It should be possible, for the first BDAT.
30478 The &%acl_smtp_data%& is run after the last BDAT command and all of
30479 the data specified is received.
30480
30481 For both of these ACLs, it is not possible to reject individual recipients. An
30482 error response rejects the entire message. Unfortunately, it is known that some
30483 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
30484 before or after the data) correctly &-- they keep the message on their queues
30485 and try again later, but that is their problem, though it does waste some of
30486 your resources.
30487
30488 The &%acl_smtp_data%& ACL is run after
30489 the &%acl_smtp_data_prdr%&,
30490 the &%acl_smtp_dkim%&
30491 and the &%acl_smtp_mime%& ACLs.
30492
30493 .section "The SMTP DKIM ACL" "SECTDKIMACL"
30494 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
30495 enabled (which is the default).
30496
30497 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30498 received, and is executed for each DKIM signature found in a message.  If not
30499 otherwise specified, the default action is to accept.
30500
30501 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30502
30503 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30504
30505
30506 .section "The SMTP MIME ACL" "SECID194"
30507 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30508 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30509
30510 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30511
30512
30513 .section "The SMTP PRDR ACL" "SECTPRDRACL"
30514 .cindex "PRDR" "ACL for"
30515 .oindex "&%prdr_enable%&"
30516 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30517 with PRDR support enabled (which is the default).
30518 It becomes active only when the PRDR feature is negotiated between
30519 client and server for a message, and more than one recipient
30520 has been accepted.
30521
30522 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30523 has been received, and is executed once for each recipient of the message
30524 with &$local_part$& and &$domain$& valid.
30525 The test may accept, defer or deny for individual recipients.
30526 The &%acl_smtp_data%& will still be called after this ACL and
30527 can reject the message overall, even if this ACL has accepted it
30528 for some or all recipients.
30529
30530 PRDR may be used to support per-user content filtering.  Without it
30531 one must defer any recipient after the first that has a different
30532 content-filter configuration.  With PRDR, the RCPT-time check
30533 .cindex "PRDR" "variable for"
30534 for this can be disabled when the variable &$prdr_requested$&
30535 is &"yes"&.
30536 Any required difference in behaviour of the main DATA-time
30537 ACL should however depend on the PRDR-time ACL having run, as Exim
30538 will avoid doing so in some situations (e.g. single-recipient mails).
30539
30540 See also the &%prdr_enable%& global option
30541 and the &%hosts_try_prdr%& smtp transport option.
30542
30543 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30544 If the ACL is not defined, processing completes as if
30545 the feature was not requested by the client.
30546
30547 .section "The QUIT ACL" "SECTQUITACL"
30548 .cindex "QUIT, ACL for"
30549 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30550 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30551 does not in fact control any access.
30552 For this reason, it may only accept
30553 or warn as its final result.
30554
30555 This ACL can be used for tasks such as custom logging at the end of an SMTP
30556 session. For example, you can use ACL variables in other ACLs to count
30557 messages, recipients, etc., and log the totals at QUIT time using one or
30558 more &%logwrite%& modifiers on a &%warn%& verb.
30559
30560 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
30561 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
30562
30563 You do not need to have a final &%accept%&, but if you do, you can use a
30564 &%message%& modifier to specify custom text that is sent as part of the 221
30565 response to QUIT.
30566
30567 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
30568 failure (for example, failure to open a log file, or when Exim is bombing out
30569 because it has detected an unrecoverable error), all SMTP commands from the
30570 client are given temporary error responses until QUIT is received or the
30571 connection is closed. In these special cases, the QUIT ACL does not run.
30572
30573
30574 .section "The not-QUIT ACL" "SECTNOTQUITACL"
30575 .vindex &$acl_smtp_notquit$&
30576 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
30577 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
30578 trouble, such as being unable to write to its log files, this ACL is not run,
30579 because it might try to do things (such as write to log files) that make the
30580 situation even worse.
30581
30582 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30583 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30584 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30585 and &%warn%&.
30586
30587 .vindex &$smtp_notquit_reason$&
30588 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30589 to a string that indicates the reason for the termination of the SMTP
30590 connection. The possible values are:
30591 .table2
30592 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30593 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30594 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30595 .irow &`connection-lost`&          "The SMTP connection has been lost"
30596 .irow &`data-timeout`&             "Timeout while reading message data"
30597 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30598 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30599 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30600 .irow &`synchronization-error`&    "SMTP synchronization error"
30601 .irow &`tls-failed`&               "TLS failed to start"
30602 .endtable
30603 In most cases when an SMTP connection is closed without having received QUIT,
30604 Exim sends an SMTP response message before actually closing the connection.
30605 With the exception of the &`acl-drop`& case, the default message can be
30606 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30607 &%drop%& verb in another ACL, it is the message from the other ACL that is
30608 used.
30609
30610
30611 .section "Finding an ACL to use" "SECID195"
30612 .cindex "&ACL;" "finding which to use"
30613 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30614 you can use different ACLs in different circumstances. For example,
30615 .code
30616 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30617                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30618 .endd
30619 In the default configuration file there are some example settings for
30620 providing an RFC 4409 message &"submission"& service on port 587 and
30621 an RFC 8314 &"submissions"& service on port 465. You can use a string
30622 expansion like this to choose an ACL for MUAs on these ports which is
30623 more appropriate for this purpose than the default ACL on port 25.
30624
30625 The expanded string does not have to be the name of an ACL in the
30626 configuration file; there are other possibilities. Having expanded the
30627 string, Exim searches for an ACL as follows:
30628
30629 .ilist
30630 If the string begins with a slash, Exim uses it as a filename, and reads its
30631 contents as an ACL. The lines are processed in the same way as lines in the
30632 Exim configuration file. In particular, continuation lines are supported, blank
30633 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30634 If the file does not exist or cannot be read, an error occurs (typically
30635 causing a temporary failure of whatever caused the ACL to be run). For example:
30636 .code
30637 acl_smtp_data = /etc/acls/\
30638   ${lookup{$sender_host_address}lsearch\
30639   {/etc/acllist}{$value}{default}}
30640 .endd
30641 This looks up an ACL file to use on the basis of the host's IP address, falling
30642 back to a default if the lookup fails. If an ACL is successfully read from a
30643 file, it is retained in memory for the duration of the Exim process, so that it
30644 can be re-used without having to re-read the file.
30645 .next
30646 If the string does not start with a slash, and does not contain any spaces,
30647 Exim searches the ACL section of the configuration for an ACL whose name
30648 matches the string.
30649 .next
30650 If no named ACL is found, or if the string contains spaces, Exim parses
30651 the string as an inline ACL. This can save typing in cases where you just
30652 want to have something like
30653 .code
30654 acl_smtp_vrfy = accept
30655 .endd
30656 in order to allow free use of the VRFY command. Such a string may contain
30657 newlines; it is processed in the same way as an ACL that is read from a file.
30658 .endlist
30659
30660
30661
30662
30663 .section "ACL return codes" "SECID196"
30664 .cindex "&ACL;" "return codes"
30665 Except for the QUIT ACL, which does not affect the SMTP return code (see
30666 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30667 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30668 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30669 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30670 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30671 This also causes a 4&'xx'& return code.
30672
30673 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30674 &"deny"&, because there is no mechanism for passing temporary errors to the
30675 submitters of non-SMTP messages.
30676
30677
30678 ACLs that are relevant to message reception may also return &"discard"&. This
30679 has the effect of &"accept"&, but causes either the entire message or an
30680 individual recipient address to be discarded. In other words, it is a
30681 blackholing facility. Use it with care.
30682
30683 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30684 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30685 RCPT ACL is to discard just the one recipient address. If there are no
30686 recipients left when the message's data is received, the DATA ACL is not
30687 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30688 remaining recipients. The &"discard"& return is not permitted for the
30689 &%acl_smtp_predata%& ACL.
30690
30691 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30692 is done on the address and the result determines the SMTP response.
30693
30694
30695 .cindex "&[local_scan()]& function" "when all recipients discarded"
30696 The &[local_scan()]& function is always run, even if there are no remaining
30697 recipients; it may create new recipients.
30698
30699
30700
30701 .section "Unset ACL options" "SECID197"
30702 .cindex "&ACL;" "unset options"
30703 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30704 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30705 not defined at all. For any defined ACL, the default action when control
30706 reaches the end of the ACL statements is &"deny"&.
30707
30708 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30709 these two are ACLs that are used only for their side effects. They cannot be
30710 used to accept or reject anything.
30711
30712 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30713 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30714 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30715 when the ACL is not defined is &"accept"&.
30716
30717 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30718 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30719 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30720 messages over an SMTP connection. For an example, see the ACL in the default
30721 configuration file.
30722
30723
30724
30725
30726 .section "Data for message ACLs" "SECID198"
30727 .cindex "&ACL;" "data for message ACL"
30728 .vindex &$domain$&
30729 .vindex &$local_part$&
30730 .vindex &$sender_address$&
30731 .vindex &$sender_host_address$&
30732 .vindex &$smtp_command$&
30733 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30734 that contain information about the host and the message's sender (for example,
30735 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30736 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30737 &$local_part$& are set from the argument address. The entire SMTP command
30738 is available in &$smtp_command$&.
30739
30740 When an ACL for the AUTH parameter of MAIL is running, the variables that
30741 contain information about the host are set, but &$sender_address$& is not yet
30742 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30743 how it is used.
30744
30745 .vindex "&$message_size$&"
30746 The &$message_size$& variable is set to the value of the SIZE parameter on
30747 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30748 that parameter is not given. The value is updated to the true message size by
30749 the time the final DATA ACL is run (after the message data has been
30750 received).
30751
30752 .vindex "&$rcpt_count$&"
30753 .vindex "&$recipients_count$&"
30754 The &$rcpt_count$& variable increases by one for each RCPT command received.
30755 The &$recipients_count$& variable increases by one each time a RCPT command is
30756 accepted, so while an ACL for RCPT is being processed, it contains the number
30757 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30758 &$rcpt_count$& contains the total number of RCPT commands, and
30759 &$recipients_count$& contains the total number of accepted recipients.
30760
30761
30762
30763
30764
30765 .section "Data for non-message ACLs" "SECTdatfornon"
30766 .cindex "&ACL;" "data for non-message ACL"
30767 .vindex &$smtp_command_argument$&
30768 .vindex &$smtp_command$&
30769 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30770 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30771 and the entire SMTP command is available in &$smtp_command$&.
30772 These variables can be tested using a &%condition%& condition. For example,
30773 here is an ACL for use with AUTH, which insists that either the session is
30774 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
30775 does not permit authentication methods that use cleartext passwords on
30776 unencrypted connections.
30777 .code
30778 acl_check_auth:
30779   accept encrypted = *
30780   accept condition = ${if eq{${uc:$smtp_command_argument}}\
30781                      {CRAM-MD5}}
30782   deny   message   = TLS encryption or CRAM-MD5 required
30783 .endd
30784 (Another way of applying this restriction is to arrange for the authenticators
30785 that use cleartext passwords not to be advertised when the connection is not
30786 encrypted. You can use the generic &%server_advertise_condition%& authenticator
30787 option to do this.)
30788
30789
30790
30791 .section "Format of an ACL" "SECID199"
30792 .cindex "&ACL;" "format of"
30793 .cindex "&ACL;" "verbs, definition of"
30794 An individual ACL consists of a number of statements. Each statement starts
30795 with a verb, optionally followed by a number of conditions and &"modifiers"&.
30796 Modifiers can change the way the verb operates, define error and log messages,
30797 set variables, insert delays, and vary the processing of accepted messages.
30798
30799 If all the conditions are met, the verb is obeyed. The same condition may be
30800 used (with different arguments) more than once in the same statement. This
30801 provides a means of specifying an &"and"& conjunction between conditions. For
30802 example:
30803 .code
30804 deny  dnslists = list1.example
30805       dnslists = list2.example
30806 .endd
30807 If there are no conditions, the verb is always obeyed. Exim stops evaluating
30808 the conditions and modifiers when it reaches a condition that fails. What
30809 happens then depends on the verb (and in one case, on a special modifier). Not
30810 all the conditions make sense at every testing point. For example, you cannot
30811 test a sender address in the ACL that is run for a VRFY command.
30812
30813
30814 .section "ACL verbs" "SECID200"
30815 The ACL verbs are as follows:
30816
30817 .ilist
30818 .cindex "&%accept%& ACL verb"
30819 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
30820 of the conditions are not met, what happens depends on whether &%endpass%&
30821 appears among the conditions (for syntax see below). If the failing condition
30822 is before &%endpass%&, control is passed to the next ACL statement; if it is
30823 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
30824 check a RCPT command:
30825 .code
30826 accept domains = +local_domains
30827        endpass
30828        verify = recipient
30829 .endd
30830 If the recipient domain does not match the &%domains%& condition, control
30831 passes to the next statement. If it does match, the recipient is verified, and
30832 the command is accepted if verification succeeds. However, if verification
30833 fails, the ACL yields &"deny"&, because the failing condition is after
30834 &%endpass%&.
30835
30836 The &%endpass%& feature has turned out to be confusing to many people, so its
30837 use is not recommended nowadays. It is always possible to rewrite an ACL so
30838 that &%endpass%& is not needed, and it is no longer used in the default
30839 configuration.
30840
30841 .cindex "&%message%& ACL modifier" "with &%accept%&"
30842 If a &%message%& modifier appears on an &%accept%& statement, its action
30843 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
30844 (when an &%accept%& verb either accepts or passes control to the next
30845 statement), &%message%& can be used to vary the message that is sent when an
30846 SMTP command is accepted. For example, in a RCPT ACL you could have:
30847 .display
30848 &`accept  `&<&'some conditions'&>
30849 &`        message = OK, I will allow you through today`&
30850 .endd
30851 You can specify an SMTP response code, optionally followed by an &"extended
30852 response code"& at the start of the message, but the first digit must be the
30853 same as would be sent by default, which is 2 for an &%accept%& verb.
30854
30855 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
30856 an error message that is used when access is denied. This behaviour is retained
30857 for backward compatibility, but current &"best practice"& is to avoid the use
30858 of &%endpass%&.
30859
30860
30861 .next
30862 .cindex "&%defer%& ACL verb"
30863 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
30864 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
30865 &%defer%& is the same as &%deny%&, because there is no way of sending a
30866 temporary error. For a RCPT command, &%defer%& is much the same as using a
30867 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
30868 be used in any ACL, and even for a recipient it might be a simpler approach.
30869
30870
30871 .next
30872 .cindex "&%deny%& ACL verb"
30873 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
30874 the conditions are not met, control is passed to the next ACL statement. For
30875 example,
30876 .code
30877 deny dnslists = blackholes.mail-abuse.org
30878 .endd
30879 rejects commands from hosts that are on a DNS black list.
30880
30881
30882 .next
30883 .cindex "&%discard%& ACL verb"
30884 &%discard%&: This verb behaves like &%accept%&, except that it returns
30885 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
30886 that are concerned with receiving messages. When all the conditions are true,
30887 the sending entity receives a &"success"& response. However, &%discard%& causes
30888 recipients to be discarded. If it is used in an ACL for RCPT, just the one
30889 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
30890 message's recipients are discarded. Recipients that are discarded before DATA
30891 do not appear in the log line when the &%received_recipients%& log selector is set.
30892
30893 If the &%log_message%& modifier is set when &%discard%& operates,
30894 its contents are added to the line that is automatically written to the log.
30895 The &%message%& modifier operates exactly as it does for &%accept%&.
30896
30897
30898 .next
30899 .cindex "&%drop%& ACL verb"
30900 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
30901 forcibly closed after the 5&'xx'& error message has been sent. For example:
30902 .code
30903 drop   condition = ${if > {$rcpt_count}{20}}
30904        message   = I don't take more than 20 RCPTs
30905 .endd
30906 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
30907 The connection is always dropped after sending a 550 response.
30908
30909 .next
30910 .cindex "&%require%& ACL verb"
30911 &%require%&: If all the conditions are met, control is passed to the next ACL
30912 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
30913 example, when checking a RCPT command,
30914 .code
30915 require message = Sender did not verify
30916         verify  = sender
30917 .endd
30918 passes control to subsequent statements only if the message's sender can be
30919 verified. Otherwise, it rejects the command. Note the positioning of the
30920 &%message%& modifier, before the &%verify%& condition. The reason for this is
30921 discussed in section &<<SECTcondmodproc>>&.
30922
30923 .next
30924 .cindex "&%warn%& ACL verb"
30925 &%warn%&: If all the conditions are true, a line specified by the
30926 &%log_message%& modifier is written to Exim's main log. Control always passes
30927 to the next ACL statement. If any condition is false, the log line is not
30928 written. If an identical log line is requested several times in the same
30929 message, only one copy is actually written to the log. If you want to force
30930 duplicates to be written, use the &%logwrite%& modifier instead.
30931
30932 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
30933 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
30934 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
30935 first failing condition. There is more about adding header lines in section
30936 &<<SECTaddheadacl>>&.
30937
30938 If any condition on a &%warn%& statement cannot be completed (that is, there is
30939 some sort of defer), the log line specified by &%log_message%& is not written.
30940 This does not include the case of a forced failure from a lookup, which
30941 is considered to be a successful completion. After a defer, no further
30942 conditions or modifiers in the &%warn%& statement are processed. The incident
30943 is logged, and the ACL continues to be processed, from the next statement
30944 onwards.
30945
30946
30947 .vindex "&$acl_verify_message$&"
30948 When one of the &%warn%& conditions is an address verification that fails, the
30949 text of the verification failure message is in &$acl_verify_message$&. If you
30950 want this logged, you must set it up explicitly. For example:
30951 .code
30952 warn   !verify = sender
30953        log_message = sender verify failed: $acl_verify_message
30954 .endd
30955 .endlist
30956
30957 At the end of each ACL there is an implicit unconditional &%deny%&.
30958
30959 As you can see from the examples above, the conditions and modifiers are
30960 written one to a line, with the first one on the same line as the verb, and
30961 subsequent ones on following lines. If you have a very long condition, you can
30962 continue it onto several physical lines by the usual backslash continuation
30963 mechanism. It is conventional to align the conditions vertically.
30964
30965
30966
30967 .section "ACL variables" "SECTaclvariables"
30968 .cindex "&ACL;" "variables"
30969 There are some special variables that can be set during ACL processing. They
30970 can be used to pass information between different ACLs, different invocations
30971 of the same ACL in the same SMTP connection, and between ACLs and the routers,
30972 transports, and filters that are used to deliver a message. The names of these
30973 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
30974 an underscore, but the remainder of the name can be any sequence of
30975 alphanumeric characters and underscores that you choose. There is no limit on
30976 the number of ACL variables. The two sets act as follows:
30977 .ilist
30978 The values of those variables whose names begin with &$acl_c$& persist
30979 throughout an SMTP connection. They are never reset. Thus, a value that is set
30980 while receiving one message is still available when receiving the next message
30981 on the same SMTP connection.
30982 .next
30983 The values of those variables whose names begin with &$acl_m$& persist only
30984 while a message is being received. They are reset afterwards. They are also
30985 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
30986 .endlist
30987
30988 When a message is accepted, the current values of all the ACL variables are
30989 preserved with the message and are subsequently made available at delivery
30990 time. The ACL variables are set by a modifier called &%set%&. For example:
30991 .code
30992 accept hosts = whatever
30993        set acl_m4 = some value
30994 accept authenticated = *
30995        set acl_c_auth = yes
30996 .endd
30997 &*Note*&: A leading dollar sign is not used when naming a variable that is to
30998 be set. If you want to set a variable without taking any action, you can use a
30999 &%warn%& verb without any other modifiers or conditions.
31000
31001 .oindex &%strict_acl_vars%&
31002 What happens if a syntactically valid but undefined ACL variable is
31003 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
31004 false (the default), an empty string is substituted; if it is true, an
31005 error is generated.
31006
31007 Versions of Exim before 4.64 have a limited set of numbered variables, but
31008 their names are compatible, so there is no problem with upgrading.
31009
31010
31011 .section "Condition and modifier processing" "SECTcondmodproc"
31012 .cindex "&ACL;" "conditions; processing"
31013 .cindex "&ACL;" "modifiers; processing"
31014 An exclamation mark preceding a condition negates its result. For example:
31015 .code
31016 deny   domains = *.dom.example
31017       !verify  = recipient
31018 .endd
31019 causes the ACL to return &"deny"& if the recipient domain ends in
31020 &'dom.example'& and the recipient address cannot be verified. Sometimes
31021 negation can be used on the right-hand side of a condition. For example, these
31022 two statements are equivalent:
31023 .code
31024 deny  hosts = !192.168.3.4
31025 deny !hosts =  192.168.3.4
31026 .endd
31027 However, for many conditions (&%verify%& being a good example), only left-hand
31028 side negation of the whole condition is possible.
31029
31030 The arguments of conditions and modifiers are expanded. A forced failure
31031 of an expansion causes a condition to be ignored, that is, it behaves as if the
31032 condition is true. Consider these two statements:
31033 .code
31034 accept  senders = ${lookup{$host_name}lsearch\
31035                   {/some/file}{$value}fail}
31036 accept  senders = ${lookup{$host_name}lsearch\
31037                   {/some/file}{$value}{}}
31038 .endd
31039 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
31040 the returned list is searched, but if the lookup fails the behaviour is
31041 different in the two cases. The &%fail%& in the first statement causes the
31042 condition to be ignored, leaving no further conditions. The &%accept%& verb
31043 therefore succeeds. The second statement, however, generates an empty list when
31044 the lookup fails. No sender can match an empty list, so the condition fails,
31045 and therefore the &%accept%& also fails.
31046
31047 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
31048 specify actions that are taken as the conditions for a statement are checked;
31049 others specify text for messages that are used when access is denied or a
31050 warning is generated. The &%control%& modifier affects the way an incoming
31051 message is handled.
31052
31053 The positioning of the modifiers in an ACL statement is important, because the
31054 processing of a verb ceases as soon as its outcome is known. Only those
31055 modifiers that have already been encountered will take effect. For example,
31056 consider this use of the &%message%& modifier:
31057 .code
31058 require message = Can't verify sender
31059         verify  = sender
31060         message = Can't verify recipient
31061         verify  = recipient
31062         message = This message cannot be used
31063 .endd
31064 If sender verification fails, Exim knows that the result of the statement is
31065 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
31066 so its text is used as the error message. If sender verification succeeds, but
31067 recipient verification fails, the second message is used. If recipient
31068 verification succeeds, the third message becomes &"current"&, but is never used
31069 because there are no more conditions to cause failure.
31070
31071 For the &%deny%& verb, on the other hand, it is always the last &%message%&
31072 modifier that is used, because all the conditions must be true for rejection to
31073 happen. Specifying more than one &%message%& modifier does not make sense, and
31074 the message can even be specified after all the conditions. For example:
31075 .code
31076 deny   hosts = ...
31077       !senders = *@my.domain.example
31078        message = Invalid sender from client host
31079 .endd
31080 The &"deny"& result does not happen until the end of the statement is reached,
31081 by which time Exim has set up the message.
31082
31083
31084
31085 .section "ACL modifiers" "SECTACLmodi"
31086 .cindex "&ACL;" "modifiers; list of"
31087 The ACL modifiers are as follows:
31088
31089 .vlist
31090 .vitem &*add_header*&&~=&~<&'text'&>
31091 This modifier specifies one or more header lines that are to be added to an
31092 incoming message, assuming, of course, that the message is ultimately
31093 accepted. For details, see section &<<SECTaddheadacl>>&.
31094
31095 .vitem &*continue*&&~=&~<&'text'&>
31096 .cindex "&%continue%& ACL modifier"
31097 .cindex "database" "updating in ACL"
31098 This modifier does nothing of itself, and processing of the ACL always
31099 continues with the next condition or modifier. The value of &%continue%& is in
31100 the side effects of expanding its argument. Typically this could be used to
31101 update a database. It is really just a syntactic tidiness, to avoid having to
31102 write rather ugly lines like this:
31103 .display
31104 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
31105 .endd
31106 Instead, all you need is
31107 .display
31108 &`continue = `&<&'some expansion'&>
31109 .endd
31110
31111 .vitem &*control*&&~=&~<&'text'&>
31112 .cindex "&%control%& ACL modifier"
31113 This modifier affects the subsequent processing of the SMTP connection or of an
31114 incoming message that is accepted. The effect of the first type of control
31115 lasts for the duration of the connection, whereas the effect of the second type
31116 lasts only until the current message has been received. The message-specific
31117 controls always apply to the whole message, not to individual recipients,
31118 even if the &%control%& modifier appears in a RCPT ACL.
31119
31120 As there are now quite a few controls that can be applied, they are described
31121 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
31122 in several different ways. For example:
31123
31124 . ==== As this is a nested list, any displays it contains must be indented
31125 . ==== as otherwise they are too far to the left. That comment applies only
31126 . ==== when xmlto and fop are used; formatting with sdop gets it right either
31127 . ==== way.
31128
31129 .ilist
31130 It can be at the end of an &%accept%& statement:
31131 .code
31132     accept  ...some conditions
31133             control = queue
31134 .endd
31135 In this case, the control is applied when this statement yields &"accept"&, in
31136 other words, when the conditions are all true.
31137
31138 .next
31139 It can be in the middle of an &%accept%& statement:
31140 .code
31141     accept  ...some conditions...
31142             control = queue
31143             ...some more conditions...
31144 .endd
31145 If the first set of conditions are true, the control is applied, even if the
31146 statement does not accept because one of the second set of conditions is false.
31147 In this case, some subsequent statement must yield &"accept"& for the control
31148 to be relevant.
31149
31150 .next
31151 It can be used with &%warn%& to apply the control, leaving the
31152 decision about accepting or denying to a subsequent verb. For
31153 example:
31154 .code
31155     warn    ...some conditions...
31156             control = freeze
31157     accept  ...
31158 .endd
31159 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
31160 &%logwrite%&, so it does not add anything to the message and does not write a
31161 log entry.
31162
31163 .next
31164 If you want to apply a control unconditionally, you can use it with a
31165 &%require%& verb. For example:
31166 .code
31167     require  control = no_multiline_responses
31168 .endd
31169 .endlist
31170
31171 .vitem &*delay*&&~=&~<&'time'&>
31172 .cindex "&%delay%& ACL modifier"
31173 .oindex "&%-bh%&"
31174 This modifier may appear in any ACL except notquit. It causes Exim to wait for
31175 the time interval before proceeding. However, when testing Exim using the
31176 &%-bh%& option, the delay is not actually imposed (an appropriate message is
31177 output instead). The time is given in the usual Exim notation, and the delay
31178 happens as soon as the modifier is processed. In an SMTP session, pending
31179 output is flushed before the delay is imposed.
31180
31181 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
31182 example:
31183 .code
31184 deny    ...some conditions...
31185         delay = 30s
31186 .endd
31187 The delay happens if all the conditions are true, before the statement returns
31188 &"deny"&. Compare this with:
31189 .code
31190 deny    delay = 30s
31191         ...some conditions...
31192 .endd
31193 which waits for 30s before processing the conditions. The &%delay%& modifier
31194 can also be used with &%warn%& and together with &%control%&:
31195 .code
31196 warn    ...some conditions...
31197         delay = 2m
31198         control = freeze
31199 accept  ...
31200 .endd
31201
31202 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
31203 responses to several commands are no longer buffered and sent in one packet (as
31204 they would normally be) because all output is flushed before imposing the
31205 delay. This optimization is disabled so that a number of small delays do not
31206 appear to the client as one large aggregated delay that might provoke an
31207 unwanted timeout. You can, however, disable output flushing for &%delay%& by
31208 using a &%control%& modifier to set &%no_delay_flush%&.
31209
31210
31211 .vitem &*endpass*&
31212 .cindex "&%endpass%& ACL modifier"
31213 This modifier, which has no argument, is recognized only in &%accept%& and
31214 &%discard%& statements. It marks the boundary between the conditions whose
31215 failure causes control to pass to the next statement, and the conditions whose
31216 failure causes the ACL to return &"deny"&. This concept has proved to be
31217 confusing to some people, so the use of &%endpass%& is no longer recommended as
31218 &"best practice"&. See the description of &%accept%& above for more details.
31219
31220
31221 .vitem &*log_message*&&~=&~<&'text'&>
31222 .cindex "&%log_message%& ACL modifier"
31223 This modifier sets up a message that is used as part of the log message if the
31224 ACL denies access or a &%warn%& statement's conditions are true. For example:
31225 .code
31226 require log_message = wrong cipher suite $tls_in_cipher
31227         encrypted   = DES-CBC3-SHA
31228 .endd
31229 &%log_message%& is also used when recipients are discarded by &%discard%&. For
31230 example:
31231 .display
31232 &`discard `&<&'some conditions'&>
31233 &`        log_message = Discarded $local_part@$domain because...`&
31234 .endd
31235 When access is denied, &%log_message%& adds to any underlying error message
31236 that may exist because of a condition failure. For example, while verifying a
31237 recipient address, a &':fail:'& redirection might have already set up a
31238 message.
31239
31240 The message may be defined before the conditions to which it applies, because
31241 the string expansion does not happen until Exim decides that access is to be
31242 denied. This means that any variables that are set by the condition are
31243 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
31244 variables are set after a DNS black list lookup succeeds. If the expansion of
31245 &%log_message%& fails, or if the result is an empty string, the modifier is
31246 ignored.
31247
31248 .vindex "&$acl_verify_message$&"
31249 If you want to use a &%warn%& statement to log the result of an address
31250 verification, you can use &$acl_verify_message$& to include the verification
31251 error message.
31252
31253 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
31254 the start of the logged message. If the same warning log message is requested
31255 more than once while receiving  a single email message, only one copy is
31256 actually logged. If you want to log multiple copies, use &%logwrite%& instead
31257 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
31258 is logged for a successful &%warn%& statement.
31259
31260 If &%log_message%& is not present and there is no underlying error message (for
31261 example, from the failure of address verification), but &%message%& is present,
31262 the &%message%& text is used for logging rejections. However, if any text for
31263 logging contains newlines, only the first line is logged. In the absence of
31264 both &%log_message%& and &%message%&, a default built-in message is used for
31265 logging rejections.
31266
31267
31268 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
31269 .cindex "&%log_reject_target%& ACL modifier"
31270 .cindex "logging in ACL" "specifying which log"
31271 This modifier makes it possible to specify which logs are used for messages
31272 about ACL rejections. Its argument is a colon-separated list of words that can
31273 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
31274 may be empty, in which case a rejection is not logged at all. For example, this
31275 ACL fragment writes no logging information when access is denied:
31276 .display
31277 &`deny `&<&'some conditions'&>
31278 &`     log_reject_target =`&
31279 .endd
31280 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
31281 permanent and temporary rejections. Its effect lasts for the rest of the
31282 current ACL.
31283
31284
31285 .vitem &*logwrite*&&~=&~<&'text'&>
31286 .cindex "&%logwrite%& ACL modifier"
31287 .cindex "logging in ACL" "immediate"
31288 This modifier writes a message to a log file as soon as it is encountered when
31289 processing an ACL. (Compare &%log_message%&, which, except in the case of
31290 &%warn%& and &%discard%&, is used only if the ACL statement denies
31291 access.) The &%logwrite%& modifier can be used to log special incidents in
31292 ACLs. For example:
31293 .display
31294 &`accept `&<&'some special conditions'&>
31295 &`       control  = freeze`&
31296 &`       logwrite = froze message because ...`&
31297 .endd
31298 By default, the message is written to the main log. However, it may begin
31299 with a colon, followed by a comma-separated list of log names, and then
31300 another colon, to specify exactly which logs are to be written. For
31301 example:
31302 .code
31303 logwrite = :main,reject: text for main and reject logs
31304 logwrite = :panic: text for panic log only
31305 .endd
31306
31307
31308 .vitem &*message*&&~=&~<&'text'&>
31309 .cindex "&%message%& ACL modifier"
31310 This modifier sets up a text string that is expanded and used as a response
31311 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
31312 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
31313 there is some complication if &%endpass%& is involved; see the description of
31314 &%accept%& for details.)
31315
31316 The expansion of the message happens at the time Exim decides that the ACL is
31317 to end, not at the time it processes &%message%&. If the expansion fails, or
31318 generates an empty string, the modifier is ignored. Here is an example where
31319 &%message%& must be specified first, because the ACL ends with a rejection if
31320 the &%hosts%& condition fails:
31321 .code
31322 require  message = Host not recognized
31323          hosts = 10.0.0.0/8
31324 .endd
31325 (Once a condition has failed, no further conditions or modifiers are
31326 processed.)
31327
31328 .cindex "SMTP" "error codes"
31329 .oindex "&%smtp_banner%&
31330 For ACLs that are triggered by SMTP commands, the message is returned as part
31331 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
31332 is meaningful only for SMTP, as no message is returned when a non-SMTP message
31333 is accepted. In the case of the connect ACL, accepting with a message modifier
31334 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
31335 accept message may not contain more than one line (otherwise it will be
31336 truncated at the first newline and a panic logged), and it cannot affect the
31337 EHLO options.
31338
31339 When SMTP is involved, the message may begin with an overriding response code,
31340 consisting of three digits optionally followed by an &"extended response code"&
31341 of the form &'n.n.n'&, each code being followed by a space. For example:
31342 .code
31343 deny  message = 599 1.2.3 Host not welcome
31344       hosts = 192.168.34.0/24
31345 .endd
31346 The first digit of the supplied response code must be the same as would be sent
31347 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
31348 access, but for the predata ACL, note that the default success code is 354, not
31349 2&'xx'&.
31350
31351 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
31352 the message modifier cannot override the 221 response code.
31353
31354 The text in a &%message%& modifier is literal; any quotes are taken as
31355 literals, but because the string is expanded, backslash escapes are processed
31356 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
31357 response.
31358
31359 .vindex "&$acl_verify_message$&"
31360 While the text is being expanded, the &$acl_verify_message$& variable
31361 contains any message previously set.
31362 Afterwards, &$acl_verify_message$& is cleared.
31363
31364 If &%message%& is used on a statement that verifies an address, the message
31365 specified overrides any message that is generated by the verification process.
31366 However, the original message is available in the variable
31367 &$acl_verify_message$&, so you can incorporate it into your message if you
31368 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
31369 routers to be passed back as part of the SMTP response, you should either not
31370 use a &%message%& modifier, or make use of &$acl_verify_message$&.
31371
31372 For compatibility with previous releases of Exim, a &%message%& modifier that
31373 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
31374 modifier, but this usage is now deprecated. However, &%message%& acts only when
31375 all the conditions are true, wherever it appears in an ACL command, whereas
31376 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
31377 &%warn%& in an ACL that is not concerned with receiving a message, it has no
31378 effect.
31379
31380
31381 .vitem &*queue*&&~=&~<&'text'&>
31382 .cindex "&%queue%& ACL modifier"
31383 .cindex "named queues" "selecting in ACL"
31384 This modifier specifies the use of a named queue for spool files
31385 for the message.
31386 It can only be used before the message is received (i.e. not in
31387 the DATA ACL).
31388 This could be used, for example, for known high-volume burst sources
31389 of traffic, or for quarantine of messages.
31390 Separate queue-runner processes will be needed for named queues.
31391 If the text after expansion is empty, the default queue is used.
31392
31393
31394 .vitem &*remove_header*&&~=&~<&'text'&>
31395 This modifier specifies one or more header names in a colon-separated list
31396  that are to be removed from an incoming message, assuming, of course, that
31397 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
31398
31399
31400 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
31401 .cindex "&%set%& ACL modifier"
31402 This modifier puts a value into one of the ACL variables (see section
31403 &<<SECTaclvariables>>&).
31404
31405
31406 .vitem &*udpsend*&&~=&~<&'parameters'&>
31407 .cindex "UDP communications"
31408 This modifier sends a UDP packet, for purposes such as statistics
31409 collection or behaviour monitoring. The parameters are expanded, and
31410 the result of the expansion must be a colon-separated list consisting
31411 of a destination server, port number, and the packet contents. The
31412 server can be specified as a host name or IPv4 or IPv6 address. The
31413 separator can be changed with the usual angle bracket syntax. For
31414 example, you might want to collect information on which hosts connect
31415 when:
31416 .code
31417 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
31418              $tod_zulu $sender_host_address
31419 .endd
31420 .endlist
31421
31422
31423
31424
31425 .section "Use of the control modifier" "SECTcontrols"
31426 .cindex "&%control%& ACL modifier"
31427 The &%control%& modifier supports the following settings:
31428
31429 .vlist
31430 .vitem &*control&~=&~allow_auth_unadvertised*&
31431 This modifier allows a client host to use the SMTP AUTH command even when it
31432 has not been advertised in response to EHLO. Furthermore, because there are
31433 apparently some really broken clients that do this, Exim will accept AUTH after
31434 HELO (rather than EHLO) when this control is set. It should be used only if you
31435 really need it, and you should limit its use to those broken clients that do
31436 not work without it. For example:
31437 .code
31438 warn hosts   = 192.168.34.25
31439      control = allow_auth_unadvertised
31440 .endd
31441 Normally, when an Exim server receives an AUTH command, it checks the name of
31442 the authentication mechanism that is given in the command to ensure that it
31443 matches an advertised mechanism. When this control is set, the check that a
31444 mechanism has been advertised is bypassed. Any configured mechanism can be used
31445 by the client. This control is permitted only in the connection and HELO ACLs.
31446
31447
31448 .vitem &*control&~=&~caseful_local_part*& &&&
31449        &*control&~=&~caselower_local_part*&
31450 .cindex "&ACL;" "case of local part in"
31451 .cindex "case of local parts"
31452 .vindex "&$local_part$&"
31453 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
31454 (that is, during RCPT processing). By default, the contents of &$local_part$&
31455 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
31456 any uppercase letters in the original local part are restored in &$local_part$&
31457 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
31458 is encountered.
31459
31460 These controls affect only the current recipient. Moreover, they apply only to
31461 local part handling that takes place directly in the ACL (for example, as a key
31462 in lookups). If a test to verify the recipient is obeyed, the case-related
31463 handling of the local part during the verification is controlled by the router
31464 configuration (see the &%caseful_local_part%& generic router option).
31465
31466 This facility could be used, for example, to add a spam score to local parts
31467 containing upper case letters. For example, using &$acl_m4$& to accumulate the
31468 spam score:
31469 .code
31470 warn  control = caseful_local_part
31471       set acl_m4 = ${eval:\
31472                      $acl_m4 + \
31473                      ${if match{$local_part}{[A-Z]}{1}{0}}\
31474                     }
31475       control = caselower_local_part
31476 .endd
31477 Notice that we put back the lower cased version afterwards, assuming that
31478 is what is wanted for subsequent tests.
31479
31480
31481 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
31482 .cindex "&ACL;" "cutthrough routing"
31483 .cindex "cutthrough" "requesting"
31484 This option requests delivery be attempted while the item is being received.
31485
31486 The option is usable in the RCPT ACL.
31487 If enabled for a message received via smtp and routed to an smtp transport,
31488 and only one transport, interface, destination host and port combination
31489 is used for all recipients of the message,
31490 then the delivery connection is made while the receiving connection is open
31491 and data is copied from one to the other.
31492
31493 An attempt to set this option for any recipient but the first
31494 for a mail will be quietly ignored.
31495 If a recipient-verify callout
31496 (with use_sender)
31497 connection is subsequently
31498 requested in the same ACL it is held open and used for
31499 any subsequent recipients and the data,
31500 otherwise one is made after the initial RCPT ACL completes.
31501
31502 Note that routers are used in verify mode,
31503 and cannot depend on content of received headers.
31504 Note also that headers cannot be
31505 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31506 Headers may be modified by routers (subject to the above) and transports.
31507 The &'Received-By:'& header is generated as soon as the body reception starts,
31508 rather than the traditional time after the full message is received;
31509 this will affect the timestamp.
31510
31511 All the usual ACLs are called; if one results in the message being
31512 rejected, all effort spent in delivery (including the costs on
31513 the ultimate destination) will be wasted.
31514 Note that in the case of data-time ACLs this includes the entire
31515 message body.
31516
31517 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31518 of outgoing messages is done, because it sends data to the ultimate destination
31519 before the entire message has been received from the source.
31520 It is not supported for messages received with the SMTP PRDR
31521 or CHUNKING
31522 options in use.
31523
31524 Should the ultimate destination system positively accept or reject the mail,
31525 a corresponding indication is given to the source system and nothing is queued.
31526 If the item is successfully delivered in cutthrough mode
31527 the delivery log lines are tagged with ">>" rather than "=>" and appear
31528 before the acceptance "<=" line.
31529
31530 If there is a temporary error the item is queued for later delivery in the
31531 usual fashion.
31532 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31533 to the control; the default value is &"spool"& and the alternate value
31534 &"pass"& copies an SMTP defer response from the target back to the initiator
31535 and does not queue the message.
31536 Note that this is independent of any recipient verify conditions in the ACL.
31537
31538 Delivery in this mode avoids the generation of a bounce mail to a
31539 (possibly faked)
31540 sender when the destination system is doing content-scan based rejection.
31541
31542
31543 .vitem &*control&~=&~debug/*&<&'options'&>
31544 .cindex "&ACL;" "enabling debug logging"
31545 .cindex "debugging" "enabling from an ACL"
31546 This control turns on debug logging, almost as though Exim had been invoked
31547 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31548 by default called &'debuglog'&.
31549 The filename can be adjusted with the &'tag'& option, which
31550 may access any variables already defined.  The logging may be adjusted with
31551 the &'opts'& option, which takes the same values as the &`-d`& command-line
31552 option.
31553 Logging started this way may be stopped, and the file removed,
31554 with the &'kill'& option.
31555 Some examples (which depend on variables that don't exist in all
31556 contexts):
31557 .code
31558       control = debug
31559       control = debug/tag=.$sender_host_address
31560       control = debug/opts=+expand+acl
31561       control = debug/tag=.$message_exim_id/opts=+expand
31562       control = debug/kill
31563 .endd
31564
31565
31566 .vitem &*control&~=&~dkim_disable_verify*&
31567 .cindex "disable DKIM verify"
31568 .cindex "DKIM" "disable verify"
31569 This control turns off DKIM verification processing entirely.  For details on
31570 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
31571
31572
31573 .vitem &*control&~=&~dmarc_disable_verify*&
31574 .cindex "disable DMARC verify"
31575 .cindex "DMARC" "disable verify"
31576 This control turns off DMARC verification processing entirely.  For details on
31577 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
31578
31579
31580 .vitem &*control&~=&~dscp/*&<&'value'&>
31581 .cindex "&ACL;" "setting DSCP value"
31582 .cindex "DSCP" "inbound"
31583 This option causes the DSCP value associated with the socket for the inbound
31584 connection to be adjusted to a given value, given as one of a number of fixed
31585 strings or to numeric value.
31586 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
31587 Common values include &`throughput`&, &`mincost`&, and on newer systems
31588 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
31589
31590 The outbound packets from Exim will be marked with this value in the header
31591 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
31592 that these values will have any effect, not be stripped by networking
31593 equipment, or do much of anything without cooperation with your Network
31594 Engineer and those of all network operators between the source and destination.
31595
31596
31597 .vitem &*control&~=&~enforce_sync*& &&&
31598        &*control&~=&~no_enforce_sync*&
31599 .cindex "SMTP" "synchronization checking"
31600 .cindex "synchronization checking in SMTP"
31601 These controls make it possible to be selective about when SMTP synchronization
31602 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
31603 state of the switch (it is true by default). See the description of this option
31604 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
31605
31606 The effect of these two controls lasts for the remainder of the SMTP
31607 connection. They can appear in any ACL except the one for the non-SMTP
31608 messages. The most straightforward place to put them is in the ACL defined by
31609 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31610 before the first synchronization check. The expected use is to turn off the
31611 synchronization checks for badly-behaved hosts that you nevertheless need to
31612 work with.
31613
31614
31615 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31616 .cindex "fake defer"
31617 .cindex "defer, fake"
31618 This control works in exactly the same way as &%fakereject%& (described below)
31619 except that it causes an SMTP 450 response after the message data instead of a
31620 550 response. You must take care when using &%fakedefer%& because it causes the
31621 messages to be duplicated when the sender retries. Therefore, you should not
31622 use &%fakedefer%& if the message is to be delivered normally.
31623
31624 .vitem &*control&~=&~fakereject/*&<&'message'&>
31625 .cindex "fake rejection"
31626 .cindex "rejection, fake"
31627 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31628 words, only when an SMTP message is being received. If Exim accepts the
31629 message, instead the final 250 response, a 550 rejection message is sent.
31630 However, Exim proceeds to deliver the message as normal. The control applies
31631 only to the current message, not to any subsequent ones that may be received in
31632 the same SMTP connection.
31633
31634 The text for the 550 response is taken from the &%control%& modifier. If no
31635 message is supplied, the following is used:
31636 .code
31637 550-Your message has been rejected but is being
31638 550-kept for evaluation.
31639 550-If it was a legitimate message, it may still be
31640 550 delivered to the target recipient(s).
31641 .endd
31642 This facility should be used with extreme caution.
31643
31644 .vitem &*control&~=&~freeze*&
31645 .cindex "frozen messages" "forcing in ACL"
31646 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31647 other words, only when a message is being received. If the message is accepted,
31648 it is placed on Exim's queue and frozen. The control applies only to the
31649 current message, not to any subsequent ones that may be received in the same
31650 SMTP connection.
31651
31652 This modifier can optionally be followed by &`/no_tell`&. If the global option
31653 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31654 is told about the freezing), provided all the &*control=freeze*& modifiers that
31655 are obeyed for the current message have the &`/no_tell`& option.
31656
31657 .vitem &*control&~=&~no_delay_flush*&
31658 .cindex "SMTP" "output flushing, disabling for delay"
31659 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31660 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31661 use. This control, as long as it is encountered before the &%delay%& modifier,
31662 disables such output flushing.
31663
31664 .vitem &*control&~=&~no_callout_flush*&
31665 .cindex "SMTP" "output flushing, disabling for callout"
31666 Exim normally flushes SMTP output before performing a callout in an ACL, to
31667 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31668 use. This control, as long as it is encountered before the &%verify%& condition
31669 that causes the callout, disables such output flushing.
31670
31671 .vitem &*control&~=&~no_mbox_unspool*&
31672 This control is available when Exim is compiled with the content scanning
31673 extension. Content scanning may require a copy of the current message, or parts
31674 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31675 or spam scanner. Normally, such copies are deleted when they are no longer
31676 needed. If this control is set, the copies are not deleted. The control applies
31677 only to the current message, not to any subsequent ones that may be received in
31678 the same SMTP connection. It is provided for debugging purposes and is unlikely
31679 to be useful in production.
31680
31681 .vitem &*control&~=&~no_multiline_responses*&
31682 .cindex "multiline responses, suppressing"
31683 This control is permitted for any ACL except the one for non-SMTP messages.
31684 It seems that there are broken clients in use that cannot handle multiline
31685 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31686
31687 If this control is set, multiline SMTP responses from ACL rejections are
31688 suppressed. One way of doing this would have been to put out these responses as
31689 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31690 (&"use multiline responses for more"& it says &-- ha!), and some of the
31691 responses might get close to that. So this facility, which is after all only a
31692 sop to broken clients, is implemented by doing two very easy things:
31693
31694 .ilist
31695 Extra information that is normally output as part of a rejection caused by
31696 sender verification failure is omitted. Only the final line (typically &"sender
31697 verification failed"&) is sent.
31698 .next
31699 If a &%message%& modifier supplies a multiline response, only the first
31700 line is output.
31701 .endlist
31702
31703 The setting of the switch can, of course, be made conditional on the
31704 calling host. Its effect lasts until the end of the SMTP connection.
31705
31706 .vitem &*control&~=&~no_pipelining*&
31707 .cindex "PIPELINING" "suppressing advertising"
31708 .cindex "ESMTP extensions" PIPELINING
31709 This control turns off the advertising of the PIPELINING extension to SMTP in
31710 the current session. To be useful, it must be obeyed before Exim sends its
31711 response to an EHLO command. Therefore, it should normally appear in an ACL
31712 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31713 &%pipelining_advertise_hosts%&.
31714
31715 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31716        &*control&~=&~queue_only*&
31717 .oindex "&%queue%&"
31718 .oindex "&%queue_only%&"
31719 .cindex "queueing incoming messages"
31720 .cindex queueing "forcing in ACL"
31721 .cindex "first pass routing"
31722 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31723 other words, only when a message is being received. If the message is accepted,
31724 it is placed on Exim's queue and left there for delivery by a subsequent queue
31725 runner.
31726 If used with no options set,
31727 no immediate delivery process is started. In other words, it has the
31728 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31729
31730 If the &'first_pass_route'& option is given then
31731 the behaviour is like the command-line &'-oqds'& option;
31732 a delivery process is started which stops short of making
31733 any SMTP delivery.  The benefit is that the hints database will be updated for
31734 the message being waiting for a specific host, and a later queue run will be
31735 able to send all such messages on a single connection.
31736
31737 The control only applies to the current message, not to any subsequent ones that
31738  may be received in the same SMTP connection.
31739
31740 .vitem &*control&~=&~submission/*&<&'options'&>
31741 .cindex "message" "submission"
31742 .cindex "submission mode"
31743 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
31744 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
31745 the current message is a submission from a local MUA. In this case, Exim
31746 operates in &"submission mode"&, and applies certain fixups to the message if
31747 necessary. For example, it adds a &'Date:'& header line if one is not present.
31748 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
31749 late (the message has already been created).
31750
31751 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
31752 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
31753 submission mode; the available options for this control are described there.
31754 The control applies only to the current message, not to any subsequent ones
31755 that may be received in the same SMTP connection.
31756
31757 .vitem &*control&~=&~suppress_local_fixups*&
31758 .cindex "submission fixups, suppressing"
31759 This control applies to locally submitted (non TCP/IP) messages, and is the
31760 complement of &`control = submission`&. It disables the fixups that are
31761 normally applied to locally-submitted messages. Specifically:
31762
31763 .ilist
31764 Any &'Sender:'& header line is left alone (in this respect, it is a
31765 dynamic version of &%local_sender_retain%&).
31766 .next
31767 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
31768 .next
31769 There is no check that &'From:'& corresponds to the actual sender.
31770 .endlist ilist
31771
31772 This control may be useful when a remotely-originated message is accepted,
31773 passed to some scanning program, and then re-submitted for delivery. It can be
31774 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31775 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
31776 data is read.
31777
31778 &*Note:*& This control applies only to the current message, not to any others
31779 that are being submitted at the same time using &%-bs%& or &%-bS%&.
31780
31781 .vitem &*control&~=&~utf8_downconvert*&
31782 This control enables conversion of UTF-8 in message envelope addresses
31783 to a-label form.
31784 For details see section &<<SECTi18nMTA>>&.
31785 .endlist vlist
31786
31787
31788 .section "Summary of message fixup control" "SECTsummesfix"
31789 All four possibilities for message fixups can be specified:
31790
31791 .ilist
31792 Locally submitted, fixups applied: the default.
31793 .next
31794 Locally submitted, no fixups applied: use
31795 &`control = suppress_local_fixups`&.
31796 .next
31797 Remotely submitted, no fixups applied: the default.
31798 .next
31799 Remotely submitted, fixups applied: use &`control = submission`&.
31800 .endlist
31801
31802
31803
31804 .section "Adding header lines in ACLs" "SECTaddheadacl"
31805 .cindex "header lines" "adding in an ACL"
31806 .cindex "header lines" "position of added lines"
31807 .cindex "&%add_header%& ACL modifier"
31808 The &%add_header%& modifier can be used to add one or more extra header lines
31809 to an incoming message, as in this example:
31810 .code
31811 warn dnslists = sbl.spamhaus.org : \
31812                 dialup.mail-abuse.org
31813      add_header = X-blacklisted-at: $dnslist_domain
31814 .endd
31815 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31816 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31817 receiving a message). The message must ultimately be accepted for
31818 &%add_header%& to have any significant effect. You can use &%add_header%& with
31819 any ACL verb, including &%deny%& (though this is potentially useful only in a
31820 RCPT ACL).
31821
31822 Headers will not be added to the message if the modifier is used in
31823 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31824
31825 Leading and trailing newlines are removed from
31826 the data for the &%add_header%& modifier; if it then
31827 contains one or more newlines that
31828 are not followed by a space or a tab, it is assumed to contain multiple header
31829 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
31830 front of any line that is not a valid header line.
31831
31832 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
31833 They are added to the message before processing the DATA and MIME ACLs.
31834 However, if an identical header line is requested more than once, only one copy
31835 is actually added to the message. Further header lines may be accumulated
31836 during the DATA and MIME ACLs, after which they are added to the message, again
31837 with duplicates suppressed. Thus, it is possible to add two identical header
31838 lines to an SMTP message, but only if one is added before DATA and one after.
31839 In the case of non-SMTP messages, new headers are accumulated during the
31840 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
31841 message is rejected after DATA or by the non-SMTP ACL, all added header lines
31842 are included in the entry that is written to the reject log.
31843
31844 .cindex "header lines" "added; visibility of"
31845 Header lines are not visible in string expansions
31846 of message headers
31847 until they are added to the
31848 message. It follows that header lines defined in the MAIL, RCPT, and predata
31849 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
31850 header lines that are added by the DATA or MIME ACLs are not visible in those
31851 ACLs. Because of this restriction, you cannot use header lines as a way of
31852 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
31853 this, you can use ACL variables, as described in section
31854 &<<SECTaclvariables>>&.
31855
31856 The list of headers yet to be added is given by the &%$headers_added%& variable.
31857
31858 The &%add_header%& modifier acts immediately as it is encountered during the
31859 processing of an ACL. Notice the difference between these two cases:
31860 .display
31861 &`accept add_header = ADDED: some text`&
31862 &`       `&<&'some condition'&>
31863
31864 &`accept `&<&'some condition'&>
31865 &`       add_header = ADDED: some text`&
31866 .endd
31867 In the first case, the header line is always added, whether or not the
31868 condition is true. In the second case, the header line is added only if the
31869 condition is true. Multiple occurrences of &%add_header%& may occur in the same
31870 ACL statement. All those that are encountered before a condition fails are
31871 honoured.
31872
31873 .cindex "&%warn%& ACL verb"
31874 For compatibility with previous versions of Exim, a &%message%& modifier for a
31875 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
31876 effect only if all the conditions are true, even if it appears before some of
31877 them. Furthermore, only the last occurrence of &%message%& is honoured. This
31878 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
31879 are present on a &%warn%& verb, both are processed according to their
31880 specifications.
31881
31882 By default, new header lines are added to a message at the end of the existing
31883 header lines. However, you can specify that any particular header line should
31884 be added right at the start (before all the &'Received:'& lines), immediately
31885 after the first block of &'Received:'& lines, or immediately before any line
31886 that is not a &'Received:'& or &'Resent-something:'& header.
31887
31888 This is done by specifying &":at_start:"&, &":after_received:"&, or
31889 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
31890 header line, respectively. (Header text cannot start with a colon, as there has
31891 to be a header name first.) For example:
31892 .code
31893 warn add_header = \
31894        :after_received:X-My-Header: something or other...
31895 .endd
31896 If more than one header line is supplied in a single &%add_header%& modifier,
31897 each one is treated independently and can therefore be placed differently. If
31898 you add more than one line at the start, or after the Received: block, they end
31899 up in reverse order.
31900
31901 &*Warning*&: This facility currently applies only to header lines that are
31902 added in an ACL. It does NOT work for header lines that are added in a
31903 system filter or in a router or transport.
31904
31905
31906
31907 .section "Removing header lines in ACLs" "SECTremoveheadacl"
31908 .cindex "header lines" "removing in an ACL"
31909 .cindex "header lines" "position of removed lines"
31910 .cindex "&%remove_header%& ACL modifier"
31911 The &%remove_header%& modifier can be used to remove one or more header lines
31912 from an incoming message, as in this example:
31913 .code
31914 warn   message        = Remove internal headers
31915        remove_header  = x-route-mail1 : x-route-mail2
31916 .endd
31917 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31918 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31919 receiving a message). The message must ultimately be accepted for
31920 &%remove_header%& to have any significant effect. You can use &%remove_header%&
31921 with any ACL verb, including &%deny%&, though this is really not useful for
31922 any verb that doesn't result in a delivered message.
31923
31924 Headers will not be removed from the message if the modifier is used in
31925 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31926
31927 More than one header can be removed at the same time by using a colon separated
31928 list of header names. The header matching is case insensitive. Wildcards are
31929 not permitted, nor is list expansion performed, so you cannot use hostlists to
31930 create a list of headers, however both connection and message variable expansion
31931 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
31932 .code
31933 warn   hosts           = +internal_hosts
31934        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
31935 warn   message         = Remove internal headers
31936        remove_header   = $acl_c_ihdrs
31937 .endd
31938 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
31939 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
31940 If multiple header lines match, all are removed.
31941 There is no harm in attempting to remove the same header twice nor in removing
31942 a non-existent header. Further header lines to be removed may be accumulated
31943 during the DATA and MIME ACLs, after which they are removed from the message,
31944 if present. In the case of non-SMTP messages, headers to be removed are
31945 accumulated during the non-SMTP ACLs, and are removed from the message after
31946 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
31947 ACL, there really is no effect because there is no logging of what headers
31948 would have been removed.
31949
31950 .cindex "header lines" "removed; visibility of"
31951 Header lines are not visible in string expansions until the DATA phase when it
31952 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
31953 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
31954 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
31955 this restriction, you cannot use header lines as a way of controlling data
31956 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
31957 you should instead use ACL variables, as described in section
31958 &<<SECTaclvariables>>&.
31959
31960 The &%remove_header%& modifier acts immediately as it is encountered during the
31961 processing of an ACL. Notice the difference between these two cases:
31962 .display
31963 &`accept remove_header = X-Internal`&
31964 &`       `&<&'some condition'&>
31965
31966 &`accept `&<&'some condition'&>
31967 &`       remove_header = X-Internal`&
31968 .endd
31969 In the first case, the header line is always removed, whether or not the
31970 condition is true. In the second case, the header line is removed only if the
31971 condition is true. Multiple occurrences of &%remove_header%& may occur in the
31972 same ACL statement. All those that are encountered before a condition fails
31973 are honoured.
31974
31975 &*Warning*&: This facility currently applies only to header lines that are
31976 present during ACL processing. It does NOT remove header lines that are added
31977 in a system filter or in a router or transport.
31978
31979
31980
31981
31982 .section "ACL conditions" "SECTaclconditions"
31983 .cindex "&ACL;" "conditions; list of"
31984 Some of the conditions listed in this section are available only when Exim is
31985 compiled with the content-scanning extension. They are included here briefly
31986 for completeness. More detailed descriptions can be found in the discussion on
31987 content scanning in chapter &<<CHAPexiscan>>&.
31988
31989 Not all conditions are relevant in all circumstances. For example, testing
31990 senders and recipients does not make sense in an ACL that is being run as the
31991 result of the arrival of an ETRN command, and checks on message headers can be
31992 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
31993 can use the same condition (with different parameters) more than once in the
31994 same ACL statement. This provides a way of specifying an &"and"& conjunction.
31995 The conditions are as follows:
31996
31997
31998 .vlist
31999 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
32000 .cindex "&ACL;" "nested"
32001 .cindex "&ACL;" "indirect"
32002 .cindex "&ACL;" "arguments"
32003 .cindex "&%acl%& ACL condition"
32004 The possible values of the argument are the same as for the
32005 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
32006 &"accept"& the condition is true; if it returns &"deny"& the condition is
32007 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
32008 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
32009 condition false. This means that further processing of the &%warn%& verb
32010 ceases, but processing of the ACL continues.
32011
32012 If the argument is a named ACL, up to nine space-separated optional values
32013 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
32014 and $acl_narg is set to the count of values.
32015 Previous values of these variables are restored after the call returns.
32016 The name and values are expanded separately.
32017 Note that spaces in complex expansions which are used as arguments
32018 will act as argument separators.
32019
32020 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
32021 the connection is dropped. If it returns &"discard"&, the verb must be
32022 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
32023 conditions are tested.
32024
32025 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
32026 loops. This condition allows you to use different ACLs in different
32027 circumstances. For example, different ACLs can be used to handle RCPT commands
32028 for different local users or different local domains.
32029
32030 .vitem &*authenticated&~=&~*&<&'string&~list'&>
32031 .cindex "&%authenticated%& ACL condition"
32032 .cindex "authentication" "ACL checking"
32033 .cindex "&ACL;" "testing for authentication"
32034 If the SMTP connection is not authenticated, the condition is false. Otherwise,
32035 the name of the authenticator is tested against the list. To test for
32036 authentication by any authenticator, you can set
32037 .code
32038 authenticated = *
32039 .endd
32040
32041 .vitem &*condition&~=&~*&<&'string'&>
32042 .cindex "&%condition%& ACL condition"
32043 .cindex "customizing" "ACL condition"
32044 .cindex "&ACL;" "customized test"
32045 .cindex "&ACL;" "testing, customized"
32046 This feature allows you to make up custom conditions. If the result of
32047 expanding the string is an empty string, the number zero, or one of the strings
32048 &"no"& or &"false"&, the condition is false. If the result is any non-zero
32049 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
32050 any other value, some error is assumed to have occurred, and the ACL returns
32051 &"defer"&. However, if the expansion is forced to fail, the condition is
32052 ignored. The effect is to treat it as true, whether it is positive or
32053 negative.
32054
32055 .vitem &*decode&~=&~*&<&'location'&>
32056 .cindex "&%decode%& ACL condition"
32057 This condition is available only when Exim is compiled with the
32058 content-scanning extension, and it is allowed only in the ACL defined by
32059 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
32060 If all goes well, the condition is true. It is false only if there are
32061 problems such as a syntax error or a memory shortage. For more details, see
32062 chapter &<<CHAPexiscan>>&.
32063
32064 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
32065 .cindex "&%dnslists%& ACL condition"
32066 .cindex "DNS list" "in ACL"
32067 .cindex "black list (DNS)"
32068 .cindex "&ACL;" "testing a DNS list"
32069 This condition checks for entries in DNS black lists. These are also known as
32070 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
32071 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
32072 different variants of this condition to describe briefly here. See sections
32073 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
32074
32075 .vitem &*domains&~=&~*&<&'domain&~list'&>
32076 .cindex "&%domains%& ACL condition"
32077 .cindex "domain" "ACL checking"
32078 .cindex "&ACL;" "testing a recipient domain"
32079 .vindex "&$domain_data$&"
32080 This condition is relevant only after a RCPT command. It checks that the domain
32081 of the recipient address is in the domain list. If percent-hack processing is
32082 enabled, it is done before this test is done. If the check succeeds with a
32083 lookup, the result of the lookup is placed in &$domain_data$& until the next
32084 &%domains%& test.
32085
32086 &*Note carefully*& (because many people seem to fall foul of this): you cannot
32087 use &%domains%& in a DATA ACL.
32088
32089
32090 .vitem &*encrypted&~=&~*&<&'string&~list'&>
32091 .cindex "&%encrypted%& ACL condition"
32092 .cindex "encryption" "checking in an ACL"
32093 .cindex "&ACL;" "testing for encryption"
32094 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
32095 name of the cipher suite in use is tested against the list. To test for
32096 encryption without testing for any specific cipher suite(s), set
32097 .code
32098 encrypted = *
32099 .endd
32100
32101
32102 .vitem &*hosts&~=&~*&<&'host&~list'&>
32103 .cindex "&%hosts%& ACL condition"
32104 .cindex "host" "ACL checking"
32105 .cindex "&ACL;" "testing the client host"
32106 This condition tests that the calling host matches the host list. If you have
32107 name lookups or wildcarded host names and IP addresses in the same host list,
32108 you should normally put the IP addresses first. For example, you could have:
32109 .code
32110 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
32111 .endd
32112 The lookup in this example uses the host name for its key. This is implied by
32113 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
32114 and it wouldn't matter which way round you had these two items.)
32115
32116 The reason for the problem with host names lies in the left-to-right way that
32117 Exim processes lists. It can test IP addresses without doing any DNS lookups,
32118 but when it reaches an item that requires a host name, it fails if it cannot
32119 find a host name to compare with the pattern. If the above list is given in the
32120 opposite order, the &%accept%& statement fails for a host whose name cannot be
32121 found, even if its IP address is 10.9.8.7.
32122
32123 If you really do want to do the name check first, and still recognize the IP
32124 address even if the name lookup fails, you can rewrite the ACL like this:
32125 .code
32126 accept hosts = dbm;/etc/friendly/hosts
32127 accept hosts = 10.9.8.7
32128 .endd
32129 The default action on failing to find the host name is to assume that the host
32130 is not in the list, so the first &%accept%& statement fails. The second
32131 statement can then check the IP address.
32132
32133 .vindex "&$host_data$&"
32134 If a &%hosts%& condition is satisfied by means of a lookup, the result
32135 of the lookup is made available in the &$host_data$& variable. This
32136 allows you, for example, to set up a statement like this:
32137 .code
32138 deny  hosts = net-lsearch;/some/file
32139       message = $host_data
32140 .endd
32141 which gives a custom error message for each denied host.
32142
32143 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
32144 .cindex "&%local_parts%& ACL condition"
32145 .cindex "local part" "ACL checking"
32146 .cindex "&ACL;" "testing a local part"
32147 .vindex "&$local_part_data$&"
32148 This condition is relevant only after a RCPT command. It checks that the local
32149 part of the recipient address is in the list. If percent-hack processing is
32150 enabled, it is done before this test. If the check succeeds with a lookup, the
32151 result of the lookup is placed in &$local_part_data$&, which remains set until
32152 the next &%local_parts%& test.
32153
32154 .vitem &*malware&~=&~*&<&'option'&>
32155 .cindex "&%malware%& ACL condition"
32156 .cindex "&ACL;" "virus scanning"
32157 .cindex "&ACL;" "scanning for viruses"
32158 This condition is available only when Exim is compiled with the
32159 content-scanning extension
32160 and only after a DATA command.
32161 It causes the incoming message to be scanned for
32162 viruses. For details, see chapter &<<CHAPexiscan>>&.
32163
32164 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32165 .cindex "&%mime_regex%& ACL condition"
32166 .cindex "&ACL;" "testing by regex matching"
32167 This condition is available only when Exim is compiled with the
32168 content-scanning extension, and it is allowed only in the ACL defined by
32169 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
32170 with any of the regular expressions. For details, see chapter
32171 &<<CHAPexiscan>>&.
32172
32173 .vitem &*ratelimit&~=&~*&<&'parameters'&>
32174 .cindex "rate limiting"
32175 This condition can be used to limit the rate at which a user or host submits
32176 messages. Details are given in section &<<SECTratelimiting>>&.
32177
32178 .vitem &*recipients&~=&~*&<&'address&~list'&>
32179 .cindex "&%recipients%& ACL condition"
32180 .cindex "recipient" "ACL checking"
32181 .cindex "&ACL;" "testing a recipient"
32182 This condition is relevant only after a RCPT command. It checks the entire
32183 recipient address against a list of recipients.
32184
32185 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32186 .cindex "&%regex%& ACL condition"
32187 .cindex "&ACL;" "testing by regex matching"
32188 This condition is available only when Exim is compiled with the
32189 content-scanning extension, and is available only in the DATA, MIME, and
32190 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
32191 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
32192
32193 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
32194 .cindex "&%sender_domains%& ACL condition"
32195 .cindex "sender" "ACL checking"
32196 .cindex "&ACL;" "testing a sender domain"
32197 .vindex "&$domain$&"
32198 .vindex "&$sender_address_domain$&"
32199 This condition tests the domain of the sender of the message against the given
32200 domain list. &*Note*&: The domain of the sender address is in
32201 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
32202 of this condition. This is an exception to the general rule for testing domain
32203 lists. It is done this way so that, if this condition is used in an ACL for a
32204 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
32205 influence the sender checking.
32206
32207 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32208 relaying, because sender addresses are easily, and commonly, forged.
32209
32210 .vitem &*senders&~=&~*&<&'address&~list'&>
32211 .cindex "&%senders%& ACL condition"
32212 .cindex "sender" "ACL checking"
32213 .cindex "&ACL;" "testing a sender"
32214 This condition tests the sender of the message against the given list. To test
32215 for a bounce message, which has an empty sender, set
32216 .code
32217 senders = :
32218 .endd
32219 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32220 relaying, because sender addresses are easily, and commonly, forged.
32221
32222 .vitem &*spam&~=&~*&<&'username'&>
32223 .cindex "&%spam%& ACL condition"
32224 .cindex "&ACL;" "scanning for spam"
32225 This condition is available only when Exim is compiled with the
32226 content-scanning extension. It causes the incoming message to be scanned by
32227 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
32228
32229 .vitem &*verify&~=&~certificate*&
32230 .cindex "&%verify%& ACL condition"
32231 .cindex "TLS" "client certificate verification"
32232 .cindex "certificate" "verification of client"
32233 .cindex "&ACL;" "certificate verification"
32234 .cindex "&ACL;" "testing a TLS certificate"
32235 This condition is true in an SMTP session if the session is encrypted, and a
32236 certificate was received from the client, and the certificate was verified. The
32237 server requests a certificate only if the client matches &%tls_verify_hosts%&
32238 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
32239
32240 .vitem &*verify&~=&~csa*&
32241 .cindex "CSA verification"
32242 This condition checks whether the sending host (the client) is authorized to
32243 send email. Details of how this works are given in section
32244 &<<SECTverifyCSA>>&.
32245
32246 .vitem &*verify&~=&~header_names_ascii*&
32247 .cindex "&%verify%& ACL condition"
32248 .cindex "&ACL;" "verifying header names only ASCII"
32249 .cindex "header lines" "verifying header names only ASCII"
32250 .cindex "verifying" "header names only ASCII"
32251 This condition is relevant only in an ACL that is run after a message has been
32252 received.
32253 This usually means an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&.
32254 It checks all header names (not the content) to make sure
32255 there are no non-ASCII characters, also excluding control characters.  The
32256 allowable characters are decimal ASCII values 33 through 126.
32257
32258 Exim itself will handle headers with non-ASCII characters, but it can cause
32259 problems for downstream applications, so this option will allow their
32260 detection and rejection in the DATA ACL's.
32261
32262 .vitem &*verify&~=&~header_sender/*&<&'options'&>
32263 .cindex "&%verify%& ACL condition"
32264 .cindex "&ACL;" "verifying sender in the header"
32265 .cindex "header lines" "verifying the sender in"
32266 .cindex "sender" "verifying in header"
32267 .cindex "verifying" "sender in header"
32268 This condition is relevant only in an ACL that is run after a message has been
32269 received, that is, in an ACL specified by &%acl_smtp_data%& or
32270 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
32271 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
32272 is loosely thought of as a &"sender"& address (hence the name of the test).
32273 However, an address that appears in one of these headers need not be an address
32274 that accepts bounce messages; only sender addresses in envelopes are required
32275 to accept bounces. Therefore, if you use the callout option on this check, you
32276 might want to arrange for a non-empty address in the MAIL command.
32277
32278 Details of address verification and the options are given later, starting at
32279 section &<<SECTaddressverification>>& (callouts are described in section
32280 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
32281 condition to restrict it to bounce messages only:
32282 .code
32283 deny    senders = :
32284        !verify  = header_sender
32285         message = A valid sender header is required for bounces
32286 .endd
32287
32288 .vitem &*verify&~=&~header_syntax*&
32289 .cindex "&%verify%& ACL condition"
32290 .cindex "&ACL;" "verifying header syntax"
32291 .cindex "header lines" "verifying syntax"
32292 .cindex "verifying" "header syntax"
32293 This condition is relevant only in an ACL that is run after a message has been
32294 received, that is, in an ACL specified by &%acl_smtp_data%& or
32295 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
32296 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
32297 and &'Bcc:'&), returning true if there are no problems.
32298 Unqualified addresses (local parts without domains) are
32299 permitted only in locally generated messages and from hosts that match
32300 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
32301 appropriate.
32302
32303 Note that this condition is a syntax check only. However, a common spamming
32304 ploy used to be to send syntactically invalid headers such as
32305 .code
32306 To: @
32307 .endd
32308 and this condition can be used to reject such messages, though they are not as
32309 common as they used to be.
32310
32311 .vitem &*verify&~=&~helo*&
32312 .cindex "&%verify%& ACL condition"
32313 .cindex "&ACL;" "verifying HELO/EHLO"
32314 .cindex "HELO" "verifying"
32315 .cindex "EHLO" "verifying"
32316 .cindex "verifying" "EHLO"
32317 .cindex "verifying" "HELO"
32318 This condition is true if a HELO or EHLO command has been received from the
32319 client host, and its contents have been verified. If there has been no previous
32320 attempt to verify the HELO/EHLO contents, it is carried out when this
32321 condition is encountered. See the description of the &%helo_verify_hosts%& and
32322 &%helo_try_verify_hosts%& options for details of how to request verification
32323 independently of this condition, and for detail of the verification.
32324
32325 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
32326 option), this condition is always true.
32327
32328
32329 .vitem &*verify&~=&~not_blind/*&<&'options'&>
32330 .cindex "verifying" "not blind"
32331 .cindex "bcc recipients, verifying none"
32332 This condition checks that there are no blind (bcc) recipients in the message.
32333 Every envelope recipient must appear either in a &'To:'& header line or in a
32334 &'Cc:'& header line for this condition to be true. Local parts are checked
32335 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
32336 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
32337 used only in a DATA or non-SMTP ACL.
32338
32339 There is one possible option, &`case_insensitive`&.  If this is present then
32340 local parts are checked case-insensitively.
32341
32342 There are, of course, many legitimate messages that make use of blind (bcc)
32343 recipients. This check should not be used on its own for blocking messages.
32344
32345
32346 .vitem &*verify&~=&~recipient/*&<&'options'&>
32347 .cindex "&%verify%& ACL condition"
32348 .cindex "&ACL;" "verifying recipient"
32349 .cindex "recipient" "verifying"
32350 .cindex "verifying" "recipient"
32351 .vindex "&$address_data$&"
32352 This condition is relevant only after a RCPT command. It verifies the current
32353 recipient. Details of address verification are given later, starting at section
32354 &<<SECTaddressverification>>&. After a recipient has been verified, the value
32355 of &$address_data$& is the last value that was set while routing the address.
32356 This applies even if the verification fails. When an address that is being
32357 verified is redirected to a single address, verification continues with the new
32358 address, and in that case, the subsequent value of &$address_data$& is the
32359 value for the child address.
32360
32361 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
32362 .cindex "&%verify%& ACL condition"
32363 .cindex "&ACL;" "verifying host reverse lookup"
32364 .cindex "host" "verifying reverse lookup"
32365 This condition ensures that a verified host name has been looked up from the IP
32366 address of the client host. (This may have happened already if the host name
32367 was needed for checking a host list, or if the host matched &%host_lookup%&.)
32368 Verification ensures that the host name obtained from a reverse DNS lookup, or
32369 one of its aliases, does, when it is itself looked up in the DNS, yield the
32370 original IP address.
32371
32372 There is one possible option, &`defer_ok`&.  If this is present and a
32373 DNS operation returns a temporary error, the verify condition succeeds.
32374
32375 If this condition is used for a locally generated message (that is, when there
32376 is no client host involved), it always succeeds.
32377
32378 .vitem &*verify&~=&~sender/*&<&'options'&>
32379 .cindex "&%verify%& ACL condition"
32380 .cindex "&ACL;" "verifying sender"
32381 .cindex "sender" "verifying"
32382 .cindex "verifying" "sender"
32383 This condition is relevant only after a MAIL or RCPT command, or after a
32384 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
32385 the message's sender is empty (that is, this is a bounce message), the
32386 condition is true. Otherwise, the sender address is verified.
32387
32388 .vindex "&$address_data$&"
32389 .vindex "&$sender_address_data$&"
32390 If there is data in the &$address_data$& variable at the end of routing, its
32391 value is placed in &$sender_address_data$& at the end of verification. This
32392 value can be used in subsequent conditions and modifiers in the same ACL
32393 statement. It does not persist after the end of the current statement. If you
32394 want to preserve the value for longer, you can save it in an ACL variable.
32395
32396 Details of verification are given later, starting at section
32397 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
32398 to avoid doing it more than once per message.
32399
32400 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
32401 .cindex "&%verify%& ACL condition"
32402 This is a variation of the previous option, in which a modified address is
32403 verified as a sender.
32404
32405 Note that '/' is legal in local-parts; if the address may have such
32406 (eg. is generated from the received message)
32407 they must be protected from the options parsing by doubling:
32408 .code
32409 verify = sender=${listquote{/}{${address:$h_sender:}}}
32410 .endd
32411 .endlist
32412
32413
32414
32415 .section "Using DNS lists" "SECTmorednslists"
32416 .cindex "DNS list" "in ACL"
32417 .cindex "black list (DNS)"
32418 .cindex "&ACL;" "testing a DNS list"
32419 In its simplest form, the &%dnslists%& condition tests whether the calling host
32420 is on at least one of a number of DNS lists by looking up the inverted IP
32421 address in one or more DNS domains. (Note that DNS list domains are not mail
32422 domains, so the &`+`& syntax for named lists doesn't work - it is used for
32423 special options instead.) For example, if the calling host's IP
32424 address is 192.168.62.43, and the ACL statement is
32425 .code
32426 deny dnslists = blackholes.mail-abuse.org : \
32427                 dialups.mail-abuse.org
32428 .endd
32429 the following records are looked up:
32430 .code
32431 43.62.168.192.blackholes.mail-abuse.org
32432 43.62.168.192.dialups.mail-abuse.org
32433 .endd
32434 As soon as Exim finds an existing DNS record, processing of the list stops.
32435 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
32436 to test that a host is on more than one list (an &"and"& conjunction), you can
32437 use two separate conditions:
32438 .code
32439 deny dnslists = blackholes.mail-abuse.org
32440      dnslists = dialups.mail-abuse.org
32441 .endd
32442 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
32443 behaves as if the host does not match the list item, that is, as if the DNS
32444 record does not exist. If there are further items in the DNS list, they are
32445 processed.
32446
32447 This is usually the required action when &%dnslists%& is used with &%deny%&
32448 (which is the most common usage), because it prevents a DNS failure from
32449 blocking mail. However, you can change this behaviour by putting one of the
32450 following special items in the list:
32451 .display
32452 &`+include_unknown `&   behave as if the item is on the list
32453 &`+exclude_unknown `&   behave as if the item is not on the list (default)
32454 &`+defer_unknown   `&   give a temporary error
32455 .endd
32456 .cindex "&`+include_unknown`&"
32457 .cindex "&`+exclude_unknown`&"
32458 .cindex "&`+defer_unknown`&"
32459 Each of these applies to any subsequent items on the list. For example:
32460 .code
32461 deny dnslists = +defer_unknown : foo.bar.example
32462 .endd
32463 Testing the list of domains stops as soon as a match is found. If you want to
32464 warn for one list and block for another, you can use two different statements:
32465 .code
32466 deny  dnslists = blackholes.mail-abuse.org
32467 warn  dnslists = dialups.mail-abuse.org
32468       message  = X-Warn: sending host is on dialups list
32469 .endd
32470 .cindex caching "of dns lookup"
32471 .cindex DNS TTL
32472 DNS list lookups are cached by Exim for the duration of the SMTP session
32473 (but limited by the DNS return TTL value),
32474 so a lookup based on the IP address is done at most once for any incoming
32475 connection (assuming long-enough TTL).
32476 Exim does not share information between multiple incoming
32477 connections (but your local name server cache should be active).
32478
32479 There are a number of DNS lists to choose from, some commercial, some free,
32480 or free for small deployments.  An overview can be found at
32481 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
32482
32483
32484
32485 .section "Specifying the IP address for a DNS list lookup" "SECID201"
32486 .cindex "DNS list" "keyed by explicit IP address"
32487 By default, the IP address that is used in a DNS list lookup is the IP address
32488 of the calling host. However, you can specify another IP address by listing it
32489 after the domain name, introduced by a slash. For example:
32490 .code
32491 deny dnslists = black.list.tld/192.168.1.2
32492 .endd
32493 This feature is not very helpful with explicit IP addresses; it is intended for
32494 use with IP addresses that are looked up, for example, the IP addresses of the
32495 MX hosts or nameservers of an email sender address. For an example, see section
32496 &<<SECTmulkeyfor>>& below.
32497
32498
32499
32500
32501 .section "DNS lists keyed on domain names" "SECID202"
32502 .cindex "DNS list" "keyed by domain name"
32503 There are some lists that are keyed on domain names rather than inverted IP
32504 addresses (see, e.g., the &'domain based zones'& link at
32505 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
32506 with these lists. You can change the name that is looked up in a DNS list by
32507 listing it after the domain name, introduced by a slash. For example,
32508 .code
32509 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
32510       message  = Sender's domain is listed at $dnslist_domain
32511 .endd
32512 This particular example is useful only in ACLs that are obeyed after the
32513 RCPT or DATA commands, when a sender address is available. If (for
32514 example) the message's sender is &'user@tld.example'& the name that is looked
32515 up by this example is
32516 .code
32517 tld.example.dsn.rfc-ignorant.org
32518 .endd
32519 A single &%dnslists%& condition can contain entries for both names and IP
32520 addresses. For example:
32521 .code
32522 deny dnslists = sbl.spamhaus.org : \
32523                 dsn.rfc-ignorant.org/$sender_address_domain
32524 .endd
32525 The first item checks the sending host's IP address; the second checks a domain
32526 name. The whole condition is true if either of the DNS lookups succeeds.
32527
32528
32529
32530
32531 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
32532 .cindex "DNS list" "multiple keys for"
32533 The syntax described above for looking up explicitly-defined values (either
32534 names or IP addresses) in a DNS blacklist is a simplification. After the domain
32535 name for the DNS list, what follows the slash can in fact be a list of items.
32536 As with all lists in Exim, the default separator is a colon. However, because
32537 this is a sublist within the list of DNS blacklist domains, it is necessary
32538 either to double the separators like this:
32539 .code
32540 dnslists = black.list.tld/name.1::name.2
32541 .endd
32542 or to change the separator character, like this:
32543 .code
32544 dnslists = black.list.tld/<;name.1;name.2
32545 .endd
32546 If an item in the list is an IP address, it is inverted before the DNS
32547 blacklist domain is appended. If it is not an IP address, no inversion
32548 occurs. Consider this condition:
32549 .code
32550 dnslists = black.list.tld/<;192.168.1.2;a.domain
32551 .endd
32552 The DNS lookups that occur are:
32553 .code
32554 2.1.168.192.black.list.tld
32555 a.domain.black.list.tld
32556 .endd
32557 Once a DNS record has been found (that matches a specific IP return
32558 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
32559 are done. If there is a temporary DNS error, the rest of the sublist of domains
32560 or IP addresses is tried. A temporary error for the whole dnslists item occurs
32561 only if no other DNS lookup in this sublist succeeds. In other words, a
32562 successful lookup for any of the items in the sublist overrides a temporary
32563 error for a previous item.
32564
32565 The ability to supply a list of items after the slash is in some sense just a
32566 syntactic convenience. These two examples have the same effect:
32567 .code
32568 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
32569 dnslists = black.list.tld/a.domain::b.domain
32570 .endd
32571 However, when the data for the list is obtained from a lookup, the second form
32572 is usually much more convenient. Consider this example:
32573 .code
32574 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
32575                                    ${lookup dnsdb {>|mxh=\
32576                                    $sender_address_domain} }} }
32577      message  = The mail servers for the domain \
32578                 $sender_address_domain \
32579                 are listed at $dnslist_domain ($dnslist_value); \
32580                 see $dnslist_text.
32581 .endd
32582 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
32583 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
32584 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
32585 of expanding the condition might be something like this:
32586 .code
32587 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
32588 .endd
32589 Thus, this example checks whether or not the IP addresses of the sender
32590 domain's mail servers are on the Spamhaus black list.
32591
32592 The key that was used for a successful DNS list lookup is put into the variable
32593 &$dnslist_matched$& (see section &<<SECID204>>&).
32594
32595
32596
32597
32598 .section "Data returned by DNS lists" "SECID203"
32599 .cindex "DNS list" "data returned from"
32600 DNS lists are constructed using address records in the DNS. The original RBL
32601 just used the address 127.0.0.1 on the right hand side of each record, but the
32602 RBL+ list and some other lists use a number of values with different meanings.
32603 The values used on the RBL+ list are:
32604 .display
32605 127.1.0.1  RBL
32606 127.1.0.2  DUL
32607 127.1.0.3  DUL and RBL
32608 127.1.0.4  RSS
32609 127.1.0.5  RSS and RBL
32610 127.1.0.6  RSS and DUL
32611 127.1.0.7  RSS and DUL and RBL
32612 .endd
32613 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32614 different values. Some DNS lists may return more than one address record;
32615 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32616
32617 Values returned by a properly running DBSBL should be in the 127.0.0.0/8
32618 range. If a DNSBL operator loses control of the domain, lookups on it
32619 may start returning other addresses.  Because of this, Exim now ignores
32620 returned values outside the 127/8 region.
32621
32622
32623 .section "Variables set from DNS lists" "SECID204"
32624 .cindex "expansion" "variables, set from DNS list"
32625 .cindex "DNS list" "variables set from"
32626 .vindex "&$dnslist_domain$&"
32627 .vindex "&$dnslist_matched$&"
32628 .vindex "&$dnslist_text$&"
32629 .vindex "&$dnslist_value$&"
32630 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32631 the name of the overall domain that matched (for example,
32632 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32633 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32634 the DNS record. When the key is an IP address, it is not reversed in
32635 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32636 cases, for example:
32637 .code
32638 deny dnslists = spamhaus.example
32639 .endd
32640 the key is also available in another variable (in this case,
32641 &$sender_host_address$&). In more complicated cases, however, this is not true.
32642 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32643 might generate a dnslists lookup like this:
32644 .code
32645 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32646 .endd
32647 If this condition succeeds, the value in &$dnslist_matched$& might be
32648 &`192.168.6.7`& (for example).
32649
32650 If more than one address record is returned by the DNS lookup, all the IP
32651 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32652 The variable &$dnslist_text$& contains the contents of any associated TXT
32653 record. For lists such as RBL+ the TXT record for a merged entry is often not
32654 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32655 information.
32656
32657 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32658 &-- even if these appear before the condition in the ACL, they are not
32659 expanded until after it has failed. For example:
32660 .code
32661 deny    hosts = !+local_networks
32662         message = $sender_host_address is listed \
32663                   at $dnslist_domain
32664         dnslists = rbl-plus.mail-abuse.example
32665 .endd
32666
32667
32668
32669 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
32670 .cindex "DNS list" "matching specific returned data"
32671 You can add an equals sign and an IP address after a &%dnslists%& domain name
32672 in order to restrict its action to DNS records with a matching right hand side.
32673 For example,
32674 .code
32675 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
32676 .endd
32677 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32678 any address record is considered to be a match. For the moment, we assume
32679 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32680 describes how multiple records are handled.
32681
32682 More than one IP address may be given for checking, using a comma as a
32683 separator. These are alternatives &-- if any one of them matches, the
32684 &%dnslists%& condition is true. For example:
32685 .code
32686 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32687 .endd
32688 If you want to specify a constraining address list and also specify names or IP
32689 addresses to be looked up, the constraining address list must be specified
32690 first. For example:
32691 .code
32692 deny dnslists = dsn.rfc-ignorant.org\
32693                 =127.0.0.2/$sender_address_domain
32694 .endd
32695
32696 If the character &`&&`& is used instead of &`=`&, the comparison for each
32697 listed IP address is done by a bitwise &"and"& instead of by an equality test.
32698 In other words, the listed addresses are used as bit masks. The comparison is
32699 true if all the bits in the mask are present in the address that is being
32700 tested. For example:
32701 .code
32702 dnslists = a.b.c&0.0.0.3
32703 .endd
32704 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
32705 want to test whether one bit or another bit is present (as opposed to both
32706 being present), you must use multiple values. For example:
32707 .code
32708 dnslists = a.b.c&0.0.0.1,0.0.0.2
32709 .endd
32710 matches if the final component of the address is an odd number or two times
32711 an odd number.
32712
32713
32714
32715 .section "Negated DNS matching conditions" "SECID205"
32716 You can supply a negative list of IP addresses as part of a &%dnslists%&
32717 condition. Whereas
32718 .code
32719 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32720 .endd
32721 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32722 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
32723 .code
32724 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
32725 .endd
32726 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32727 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
32728 words, the result of the test is inverted if an exclamation mark appears before
32729 the &`=`& (or the &`&&`&) sign.
32730
32731 &*Note*&: This kind of negation is not the same as negation in a domain,
32732 host, or address list (which is why the syntax is different).
32733
32734 If you are using just one list, the negation syntax does not gain you much. The
32735 previous example is precisely equivalent to
32736 .code
32737 deny  dnslists = a.b.c
32738      !dnslists = a.b.c=127.0.0.2,127.0.0.3
32739 .endd
32740 However, if you are using multiple lists, the negation syntax is clearer.
32741 Consider this example:
32742 .code
32743 deny  dnslists = sbl.spamhaus.org : \
32744                  list.dsbl.org : \
32745                  dnsbl.njabl.org!=127.0.0.3 : \
32746                  relays.ordb.org
32747 .endd
32748 Using only positive lists, this would have to be:
32749 .code
32750 deny  dnslists = sbl.spamhaus.org : \
32751                  list.dsbl.org
32752 deny  dnslists = dnsbl.njabl.org
32753      !dnslists = dnsbl.njabl.org=127.0.0.3
32754 deny  dnslists = relays.ordb.org
32755 .endd
32756 which is less clear, and harder to maintain.
32757
32758 Negation can also be used with a bitwise-and restriction.
32759 The dnslists condition with only be trus if a result is returned
32760 by the lookup which, anded with the restriction, is all zeroes.
32761 For example:
32762 .code
32763 deny dnslists = zen.spamhaus.org!&0.255.255.0
32764 .endd
32765
32766
32767
32768
32769 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
32770 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
32771 thereby providing more than one IP address. When an item in a &%dnslists%& list
32772 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
32773 the match to specific results from the DNS lookup, there are two ways in which
32774 the checking can be handled. For example, consider the condition:
32775 .code
32776 dnslists = a.b.c=127.0.0.1
32777 .endd
32778 What happens if the DNS lookup for the incoming IP address yields both
32779 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
32780 condition true because at least one given value was found, or is it false
32781 because at least one of the found values was not listed? And how does this
32782 affect negated conditions? Both possibilities are provided for with the help of
32783 additional separators &`==`& and &`=&&`&.
32784
32785 .ilist
32786 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
32787 IP addresses matches one of the listed addresses. For the example above, the
32788 condition is true because 127.0.0.1 matches.
32789 .next
32790 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
32791 looked up IP addresses matches one of the listed addresses. If the condition is
32792 changed to:
32793 .code
32794 dnslists = a.b.c==127.0.0.1
32795 .endd
32796 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32797 false because 127.0.0.2 is not listed. You would need to have:
32798 .code
32799 dnslists = a.b.c==127.0.0.1,127.0.0.2
32800 .endd
32801 for the condition to be true.
32802 .endlist
32803
32804 When &`!`& is used to negate IP address matching, it inverts the result, giving
32805 the precise opposite of the behaviour above. Thus:
32806 .ilist
32807 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
32808 addresses matches one of the listed addresses. Consider:
32809 .code
32810 dnslists = a.b.c!&0.0.0.1
32811 .endd
32812 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32813 false because 127.0.0.1 matches.
32814 .next
32815 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
32816 looked up IP address that does not match. Consider:
32817 .code
32818 dnslists = a.b.c!=&0.0.0.1
32819 .endd
32820 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32821 true, because 127.0.0.2 does not match. You would need to have:
32822 .code
32823 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
32824 .endd
32825 for the condition to be false.
32826 .endlist
32827 When the DNS lookup yields only a single IP address, there is no difference
32828 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
32829
32830
32831
32832
32833 .section "Detailed information from merged DNS lists" "SECTmordetinf"
32834 .cindex "DNS list" "information from merged"
32835 When the facility for restricting the matching IP values in a DNS list is used,
32836 the text from the TXT record that is set in &$dnslist_text$& may not reflect
32837 the true reason for rejection. This happens when lists are merged and the IP
32838 address in the A record is used to distinguish them; unfortunately there is
32839 only one TXT record. One way round this is not to use merged lists, but that
32840 can be inefficient because it requires multiple DNS lookups where one would do
32841 in the vast majority of cases when the host of interest is not on any of the
32842 lists.
32843
32844 A less inefficient way of solving this problem is available. If
32845 two domain names, comma-separated, are given, the second is used first to
32846 do an initial check, making use of any IP value restrictions that are set.
32847 If there is a match, the first domain is used, without any IP value
32848 restrictions, to get the TXT record. As a byproduct of this, there is also
32849 a check that the IP being tested is indeed on the first list. The first
32850 domain is the one that is put in &$dnslist_domain$&. For example:
32851 .code
32852 deny   dnslists = \
32853          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
32854          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32855        message  = \
32856          rejected because $sender_host_address is blacklisted \
32857          at $dnslist_domain\n$dnslist_text
32858 .endd
32859 For the first blacklist item, this starts by doing a lookup in
32860 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
32861 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
32862 value, and as long as something is found, it looks for the corresponding TXT
32863 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
32864 The second blacklist item is processed similarly.
32865
32866 If you are interested in more than one merged list, the same list must be
32867 given several times, but because the results of the DNS lookups are cached,
32868 the DNS calls themselves are not repeated. For example:
32869 .code
32870 deny dnslists = \
32871          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
32872          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
32873          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
32874          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32875 .endd
32876 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
32877 values matches (or if no record is found), this is the only lookup that is
32878 done. Only if there is a match is one of the more specific lists consulted.
32879
32880
32881
32882 .section "DNS lists and IPv6" "SECTmorednslistslast"
32883 .cindex "IPv6" "DNS black lists"
32884 .cindex "DNS list" "IPv6 usage"
32885 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
32886 nibble by nibble. For example, if the calling host's IP address is
32887 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
32888 .code
32889 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
32890   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
32891 .endd
32892 (split over two lines here to fit on the page). Unfortunately, some of the DNS
32893 lists contain wildcard records, intended for IPv4, that interact badly with
32894 IPv6. For example, the DNS entry
32895 .code
32896 *.3.some.list.example.    A    127.0.0.1
32897 .endd
32898 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
32899 Unfortunately, it also matches the entire 3::/4 IPv6 network.
32900
32901 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
32902 &%condition%& condition, as in this example:
32903 .code
32904 deny   condition = ${if isip4{$sender_host_address}}
32905        dnslists  = some.list.example
32906 .endd
32907
32908 If an explicit key is being used for a DNS lookup and it may be an IPv6
32909 address you should specify alternate list separators for both the outer
32910 (DNS list name) list and inner (lookup keys) list:
32911 .code
32912        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
32913 .endd
32914
32915 .section "Rate limiting incoming messages" "SECTratelimiting"
32916 .cindex "rate limiting" "client sending"
32917 .cindex "limiting client sending rates"
32918 .oindex "&%smtp_ratelimit_*%&"
32919 The &%ratelimit%& ACL condition can be used to measure and control the rate at
32920 which clients can send email. This is more powerful than the
32921 &%smtp_ratelimit_*%& options, because those options control the rate of
32922 commands in a single SMTP session only, whereas the &%ratelimit%& condition
32923 works across all connections (concurrent and sequential) from the same client
32924 host. The syntax of the &%ratelimit%& condition is:
32925 .display
32926 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
32927 .endd
32928 If the average client sending rate is less than &'m'& messages per time
32929 period &'p'& then the condition is false; otherwise it is true.
32930
32931 As a side-effect, the &%ratelimit%& condition sets the expansion variable
32932 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
32933 configured value of &'m'&, and &$sender_rate_period$& to the configured value
32934 of &'p'&.
32935
32936 The parameter &'p'& is the smoothing time constant, in the form of an Exim
32937 time interval, for example, &`8h`& for eight hours. A larger time constant
32938 means that it takes Exim longer to forget a client's past behaviour. The
32939 parameter &'m'& is the maximum number of messages that a client is permitted to
32940 send in each time interval. It also specifies the number of messages permitted
32941 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
32942 constant, you can allow a client to send more messages in a burst without
32943 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
32944 both small, messages must be sent at an even rate.
32945
32946 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
32947 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
32948 when deploying the &%ratelimit%& ACL condition. The script prints usage
32949 instructions when it is run with no arguments.
32950
32951 The key is used to look up the data for calculating the client's average
32952 sending rate. This data is stored in Exim's spool directory, alongside the
32953 retry and other hints databases. The default key is &$sender_host_address$&,
32954 which means Exim computes the sending rate of each client host IP address.
32955 By changing the key you can change how Exim identifies clients for the purpose
32956 of ratelimiting. For example, to limit the sending rate of each authenticated
32957 user, independent of the computer they are sending from, set the key to
32958 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
32959 example, &$authenticated_id$& is only meaningful if the client has
32960 authenticated (which you can check with the &%authenticated%& ACL condition).
32961
32962 The lookup key does not have to identify clients: If you want to limit the
32963 rate at which a recipient receives messages, you can use the key
32964 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
32965 ACL.
32966
32967 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
32968 specifies what Exim measures the rate of, for example, messages or recipients
32969 or bytes. You can adjust the measurement using the &%unique=%& and/or
32970 &%count=%& options. You can also control when Exim updates the recorded rate
32971 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
32972 separated by a slash, like the other parameters. They may appear in any order.
32973
32974 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
32975 any options that alter the meaning of the stored data. The limit &'m'& is not
32976 stored, so you can alter the configured maximum rate and Exim will still
32977 remember clients' past behaviour. If you change the &%per_*%& mode or add or
32978 remove the &%unique=%& option, the lookup key changes so Exim will forget past
32979 behaviour. The lookup key is not affected by changes to the update mode and
32980 the &%count=%& option.
32981
32982
32983 .section "Ratelimit options for what is being measured" "ratoptmea"
32984 .cindex "rate limiting" "per_* options"
32985 The &%per_conn%& option limits the client's connection rate. It is not
32986 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
32987 &%acl_not_smtp_start%& ACLs.
32988
32989 The &%per_mail%& option limits the client's rate of sending messages. This is
32990 the default if none of the &%per_*%& options is specified. It can be used in
32991 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
32992 &%acl_smtp_data%&, or &%acl_not_smtp%&.
32993
32994 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
32995 the same ACLs as the &%per_mail%& option, though it is best to use this option
32996 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
32997 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
32998 in its MAIL command, which may be inaccurate or completely missing. You can
32999 follow the limit &'m'& in the configuration with K, M, or G to specify limits
33000 in kilobytes, megabytes, or gigabytes, respectively.
33001
33002 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
33003 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
33004 &%acl_smtp_mime%&, or &%acl_smtp_data%& ACLs. In
33005 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
33006 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
33007 in either case the rate limiting engine will see a message with many
33008 recipients as a large high-speed burst.
33009
33010 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
33011 number of different recipients that the client has sent messages to in the
33012 last time period. That is, if the client repeatedly sends messages to the same
33013 recipient, its measured rate is not increased. This option can only be used in
33014 &%acl_smtp_rcpt%&.
33015
33016 The &%per_cmd%& option causes Exim to recompute the rate every time the
33017 condition is processed. This can be used to limit the rate of any SMTP
33018 command. If it is used in multiple ACLs it can limit the aggregate rate of
33019 multiple different commands.
33020
33021 The &%count=%& option can be used to alter how much Exim adds to the client's
33022 measured rate. For example, the &%per_byte%& option is equivalent to
33023 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
33024 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
33025 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
33026
33027 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
33028
33029
33030 .section "Ratelimit update modes" "ratoptupd"
33031 .cindex "rate limiting" "reading data without updating"
33032 You can specify one of three options with the &%ratelimit%& condition to
33033 control when its database is updated. This section describes the &%readonly%&
33034 mode, and the next section describes the &%strict%& and &%leaky%& modes.
33035
33036 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
33037 previously-computed rate to check against the limit.
33038
33039 For example, you can test the client's sending rate and deny it access (when
33040 it is too fast) in the connect ACL. If the client passes this check then it
33041 can go on to send a message, in which case its recorded rate will be updated
33042 in the MAIL ACL. Subsequent connections from the same client will check this
33043 new rate.
33044 .code
33045 acl_check_connect:
33046  deny ratelimit = 100 / 5m / readonly
33047       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
33048                   (max $sender_rate_limit)
33049 # ...
33050 acl_check_mail:
33051  warn ratelimit = 100 / 5m / strict
33052       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
33053                   (max $sender_rate_limit)
33054 .endd
33055
33056 If Exim encounters multiple &%ratelimit%& conditions with the same key when
33057 processing a message then it may increase the client's measured rate more than
33058 it should. For example, this will happen if you check the &%per_rcpt%& option
33059 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
33060 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
33061 multiple update problems by using the &%readonly%& option on later ratelimit
33062 checks.
33063
33064 The &%per_*%& options described above do not make sense in some ACLs. If you
33065 use a &%per_*%& option in an ACL where it is not normally permitted then the
33066 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
33067 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
33068 next section) so you must specify the &%readonly%& option explicitly.
33069
33070
33071 .section "Ratelimit options for handling fast clients" "ratoptfast"
33072 .cindex "rate limiting" "strict and leaky modes"
33073 If a client's average rate is greater than the maximum, the rate limiting
33074 engine can react in two possible ways, depending on the presence of the
33075 &%strict%& or &%leaky%& update modes. This is independent of the other
33076 counter-measures (such as rejecting the message) that may be specified by the
33077 rest of the ACL.
33078
33079 The &%leaky%& (default) option means that the client's recorded rate is not
33080 updated if it is above the limit. The effect of this is that Exim measures the
33081 client's average rate of successfully sent email,
33082 up to the given limit.
33083 This is appropriate if the countermeasure when the condition is true
33084 consists of refusing the message, and
33085 is generally the better choice if you have clients that retry automatically.
33086 If the action when true is anything more complex then this option is
33087 likely not what is wanted.
33088
33089 The &%strict%& option means that the client's recorded rate is always
33090 updated. The effect of this is that Exim measures the client's average rate
33091 of attempts to send email, which can be much higher than the maximum it is
33092 actually allowed. If the client is over the limit it may be subjected to
33093 counter-measures by the ACL. It must slow down and allow sufficient time to
33094 pass that its computed rate falls below the maximum before it can send email
33095 again. The time (the number of smoothing periods) it must wait and not
33096 attempt to send mail can be calculated with this formula:
33097 .code
33098         ln(peakrate/maxrate)
33099 .endd
33100
33101
33102 .section "Limiting the rate of different events" "ratoptuniq"
33103 .cindex "rate limiting" "counting unique events"
33104 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
33105 rate of different events. For example, the &%per_addr%& option uses this
33106 mechanism to count the number of different recipients that the client has
33107 sent messages to in the last time period; it is equivalent to
33108 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
33109 measure the rate that a client uses different sender addresses with the
33110 options &`per_mail/unique=$sender_address`&.
33111
33112 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
33113 has seen for that key. The whole set is thrown away when it is older than the
33114 rate smoothing period &'p'&, so each different event is counted at most once
33115 per period. In the &%leaky%& update mode, an event that causes the client to
33116 go over the limit is not added to the set, in the same way that the client's
33117 recorded rate is not updated in the same situation.
33118
33119 When you combine the &%unique=%& and &%readonly%& options, the specific
33120 &%unique=%& value is ignored, and Exim just retrieves the client's stored
33121 rate.
33122
33123 The &%unique=%& mechanism needs more space in the ratelimit database than the
33124 other &%ratelimit%& options in order to store the event set. The number of
33125 unique values is potentially as large as the rate limit, so the extra space
33126 required increases with larger limits.
33127
33128 The uniqueification is not perfect: there is a small probability that Exim
33129 will think a new event has happened before. If the sender's rate is less than
33130 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
33131 the measured rate can go above the limit, in which case Exim may under-count
33132 events by a significant margin. Fortunately, if the rate is high enough (2.7
33133 times the limit) that the false positive rate goes above 9%, then Exim will
33134 throw away the over-full event set before the measured rate falls below the
33135 limit. Therefore the only harm should be that exceptionally high sending rates
33136 are logged incorrectly; any countermeasures you configure will be as effective
33137 as intended.
33138
33139
33140 .section "Using rate limiting" "useratlim"
33141 Exim's other ACL facilities are used to define what counter-measures are taken
33142 when the rate limit is exceeded. This might be anything from logging a warning
33143 (for example, while measuring existing sending rates in order to define
33144 policy), through time delays to slow down fast senders, up to rejecting the
33145 message. For example:
33146 .code
33147 # Log all senders' rates
33148 warn ratelimit = 0 / 1h / strict
33149      log_message = Sender rate $sender_rate / $sender_rate_period
33150
33151 # Slow down fast senders; note the need to truncate $sender_rate
33152 # at the decimal point.
33153 warn ratelimit = 100 / 1h / per_rcpt / strict
33154      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
33155                    $sender_rate_limit }s
33156
33157 # Keep authenticated users under control
33158 deny authenticated = *
33159      ratelimit = 100 / 1d / strict / $authenticated_id
33160
33161 # System-wide rate limit
33162 defer ratelimit = 10 / 1s / $primary_hostname
33163       message = Sorry, too busy. Try again later.
33164
33165 # Restrict incoming rate from each host, with a default
33166 # set using a macro and special cases looked up in a table.
33167 defer ratelimit = ${lookup {$sender_host_address} \
33168                    cdb {DB/ratelimits.cdb} \
33169                    {$value} {RATELIMIT} }
33170       message = Sender rate exceeds $sender_rate_limit \
33171                messages per $sender_rate_period
33172 .endd
33173 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
33174 especially with the &%per_rcpt%& option, you may suffer from a performance
33175 bottleneck caused by locking on the ratelimit hints database. Apart from
33176 making your ACLs less complicated, you can reduce the problem by using a
33177 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
33178 this means that Exim will lose its hints data after a reboot (including retry
33179 hints, the callout cache, and ratelimit data).
33180
33181
33182
33183 .section "Address verification" "SECTaddressverification"
33184 .cindex "verifying address" "options for"
33185 .cindex "policy control" "address verification"
33186 Several of the &%verify%& conditions described in section
33187 &<<SECTaclconditions>>& cause addresses to be verified. Section
33188 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
33189 The verification conditions can be followed by options that modify the
33190 verification process. The options are separated from the keyword and from each
33191 other by slashes, and some of them contain parameters. For example:
33192 .code
33193 verify = sender/callout
33194 verify = recipient/defer_ok/callout=10s,defer_ok
33195 .endd
33196 The first stage of address verification, which always happens, is to run the
33197 address through the routers, in &"verify mode"&. Routers can detect the
33198 difference between verification and routing for delivery, and their actions can
33199 be varied by a number of generic options such as &%verify%& and &%verify_only%&
33200 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
33201 The available options are as follows:
33202
33203 .ilist
33204 If the &%callout%& option is specified, successful routing to one or more
33205 remote hosts is followed by a &"callout"& to those hosts as an additional
33206 check. Callouts and their sub-options are discussed in the next section.
33207 .next
33208 If there is a defer error while doing verification routing, the ACL
33209 normally returns &"defer"&. However, if you include &%defer_ok%& in the
33210 options, the condition is forced to be true instead. Note that this is a main
33211 verification option as well as a suboption for callouts.
33212 .next
33213 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
33214 discusses the reporting of sender address verification failures.
33215 .next
33216 The &%success_on_redirect%& option causes verification always to succeed
33217 immediately after a successful redirection. By default, if a redirection
33218 generates just one address, that address is also verified. See further
33219 discussion in section &<<SECTredirwhilveri>>&.
33220 .next
33221 If the &%quota%& option is specified for recipient verify,
33222 successful routing to an appendfile transport is followed by a call into
33223 the transport to evaluate the quota status for the recipient.
33224 No actual delivery is done, but verification will succeed if the quota
33225 is sufficient for the message (if the sender gave a message size) or
33226 not already exceeded (otherwise).
33227 .endlist
33228
33229 .cindex "verifying address" "differentiating failures"
33230 .vindex "&$recipient_verify_failure$&"
33231 .vindex "&$sender_verify_failure$&"
33232 .vindex "&$acl_verify_message$&"
33233 After an address verification failure, &$acl_verify_message$& contains the
33234 error message that is associated with the failure. It can be preserved by
33235 coding like this:
33236 .code
33237 warn  !verify = sender
33238        set acl_m0 = $acl_verify_message
33239 .endd
33240 If you are writing your own custom rejection message or log message when
33241 denying access, you can use this variable to include information about the
33242 verification failure.
33243 This variable is cleared at the end of processing the ACL verb.
33244
33245 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
33246 appropriate) contains one of the following words:
33247
33248 .ilist
33249 &%qualify%&: The address was unqualified (no domain), and the message
33250 was neither local nor came from an exempted host.
33251 .next
33252 &%route%&: Routing failed.
33253 .next
33254 &%mail%&: Routing succeeded, and a callout was attempted; rejection
33255 occurred at or before the MAIL command (that is, on initial
33256 connection, HELO, or MAIL).
33257 .next
33258 &%recipient%&: The RCPT command in a callout was rejected.
33259 .next
33260 &%postmaster%&: The postmaster check in a callout was rejected.
33261 .next
33262 &%quota%&: The quota check for a local recipient did non pass.
33263 .endlist
33264
33265 The main use of these variables is expected to be to distinguish between
33266 rejections of MAIL and rejections of RCPT in callouts.
33267
33268 The above variables may also be set after a &*successful*&
33269 address verification to:
33270
33271 .ilist
33272 &%random%&: A random local-part callout succeeded
33273 .endlist
33274
33275
33276
33277
33278 .section "Callout verification" "SECTcallver"
33279 .cindex "verifying address" "by callout"
33280 .cindex "callout" "verification"
33281 .cindex "SMTP" "callout verification"
33282 For non-local addresses, routing verifies the domain, but is unable to do any
33283 checking of the local part. There are situations where some means of verifying
33284 the local part is desirable. One way this can be done is to make an SMTP
33285 &'callback'& to a delivery host for the sender address or a &'callforward'& to
33286 a subsequent host for a recipient address, to see if the host accepts the
33287 address. We use the term &'callout'& to cover both cases. Note that for a
33288 sender address, the callback is not to the client host that is trying to
33289 deliver the message, but to one of the hosts that accepts incoming mail for the
33290 sender's domain.
33291
33292 Exim does not do callouts by default. If you want them to happen, you must
33293 request them by setting appropriate options on the &%verify%& condition, as
33294 described below. This facility should be used with care, because it can add a
33295 lot of resource usage to the cost of verifying an address. However, Exim does
33296 cache the results of callouts, which helps to reduce the cost. Details of
33297 caching are in section &<<SECTcallvercache>>&.
33298
33299 Recipient callouts are usually used only between hosts that are controlled by
33300 the same administration. For example, a corporate gateway host could use
33301 callouts to check for valid recipients on an internal mailserver. A successful
33302 callout does not guarantee that a real delivery to the address would succeed;
33303 on the other hand, a failing callout does guarantee that a delivery would fail.
33304
33305 If the &%callout%& option is present on a condition that verifies an address, a
33306 second stage of verification occurs if the address is successfully routed to
33307 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
33308 &(manualroute)& router, where the router specifies the hosts. However, if a
33309 router that does not set up hosts routes to an &(smtp)& transport with a
33310 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
33311 &%hosts_override%& set, its hosts are always used, whether or not the router
33312 supplies a host list.
33313 Callouts are only supported on &(smtp)& transports.
33314
33315 The port that is used is taken from the transport, if it is specified and is a
33316 remote transport. (For routers that do verification only, no transport need be
33317 specified.) Otherwise, the default SMTP port is used. If a remote transport
33318 specifies an outgoing interface, this is used; otherwise the interface is not
33319 specified. Likewise, the text that is used for the HELO command is taken from
33320 the transport's &%helo_data%& option; if there is no transport, the value of
33321 &$smtp_active_hostname$& is used.
33322
33323 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
33324 test whether a bounce message could be delivered to the sender address. The
33325 following SMTP commands are sent:
33326 .display
33327 &`HELO `&<&'local host name'&>
33328 &`MAIL FROM:<>`&
33329 &`RCPT TO:`&<&'the address to be tested'&>
33330 &`QUIT`&
33331 .endd
33332 LHLO is used instead of HELO if the transport's &%protocol%& option is
33333 set to &"lmtp"&.
33334
33335 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
33336 settings.
33337
33338 A recipient callout check is similar. By default, it also uses an empty address
33339 for the sender. This default is chosen because most hosts do not make use of
33340 the sender address when verifying a recipient. Using the same address means
33341 that a single cache entry can be used for each recipient. Some sites, however,
33342 do make use of the sender address when verifying. These are catered for by the
33343 &%use_sender%& and &%use_postmaster%& options, described in the next section.
33344
33345 If the response to the RCPT command is a 2&'xx'& code, the verification
33346 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
33347 Exim tries the next host, if any. If there is a problem with all the remote
33348 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
33349 &%callout%& option is given, in which case the condition is forced to succeed.
33350
33351 .cindex "SMTP" "output flushing, disabling for callout"
33352 A callout may take a little time. For this reason, Exim normally flushes SMTP
33353 output before performing a callout in an ACL, to avoid unexpected timeouts in
33354 clients when the SMTP PIPELINING extension is in use. The flushing can be
33355 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
33356
33357
33358
33359
33360 .section "Additional parameters for callouts" "CALLaddparcall"
33361 .cindex "callout" "additional parameters for"
33362 The &%callout%& option can be followed by an equals sign and a number of
33363 optional parameters, separated by commas. For example:
33364 .code
33365 verify = recipient/callout=10s,defer_ok
33366 .endd
33367 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
33368 separate verify options, is retained for backwards compatibility, but is now
33369 deprecated. The additional parameters for &%callout%& are as follows:
33370
33371
33372 .vlist
33373 .vitem <&'a&~time&~interval'&>
33374 .cindex "callout" "timeout, specifying"
33375 This specifies the timeout that applies for the callout attempt to each host.
33376 For example:
33377 .code
33378 verify = sender/callout=5s
33379 .endd
33380 The default is 30 seconds. The timeout is used for each response from the
33381 remote host. It is also used for the initial connection, unless overridden by
33382 the &%connect%& parameter.
33383
33384
33385 .vitem &*connect&~=&~*&<&'time&~interval'&>
33386 .cindex "callout" "connection timeout, specifying"
33387 This parameter makes it possible to set a different (usually smaller) timeout
33388 for making the SMTP connection. For example:
33389 .code
33390 verify = sender/callout=5s,connect=1s
33391 .endd
33392 If not specified, this timeout defaults to the general timeout value.
33393
33394 .vitem &*defer_ok*&
33395 .cindex "callout" "defer, action on"
33396 When this parameter is present, failure to contact any host, or any other kind
33397 of temporary error, is treated as success by the ACL. However, the cache is not
33398 updated in this circumstance.
33399
33400 .vitem &*fullpostmaster*&
33401 .cindex "callout" "full postmaster check"
33402 This operates like the &%postmaster%& option (see below), but if the check for
33403 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
33404 accordance with the specification in RFC 2821. The RFC states that the
33405 unqualified address &'postmaster'& should be accepted.
33406
33407
33408 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
33409 .cindex "callout" "sender when verifying header"
33410 When verifying addresses in header lines using the &%header_sender%&
33411 verification option, Exim behaves by default as if the addresses are envelope
33412 sender addresses from a message. Callout verification therefore tests to see
33413 whether a bounce message could be delivered, by using an empty address in the
33414 MAIL command. However, it is arguable that these addresses might never be used
33415 as envelope senders, and could therefore justifiably reject bounce messages
33416 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
33417 address to use in the MAIL command. For example:
33418 .code
33419 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
33420 .endd
33421 This parameter is available only for the &%header_sender%& verification option.
33422
33423
33424 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
33425 .cindex "callout" "overall timeout, specifying"
33426 This parameter sets an overall timeout for performing a callout verification.
33427 For example:
33428 .code
33429 verify = sender/callout=5s,maxwait=30s
33430 .endd
33431 This timeout defaults to four times the callout timeout for individual SMTP
33432 commands. The overall timeout applies when there is more than one host that can
33433 be tried. The timeout is checked before trying the next host. This prevents
33434 very long delays if there are a large number of hosts and all are timing out
33435 (for example, when network connections are timing out).
33436
33437
33438 .vitem &*no_cache*&
33439 .cindex "callout" "cache, suppressing"
33440 .cindex "caching callout, suppressing"
33441 When this parameter is given, the callout cache is neither read nor updated.
33442
33443 .vitem &*postmaster*&
33444 .cindex "callout" "postmaster; checking"
33445 When this parameter is set, a successful callout check is followed by a similar
33446 check for the local part &'postmaster'& at the same domain. If this address is
33447 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
33448 the postmaster check is recorded in a cache record; if it is a failure, this is
33449 used to fail subsequent callouts for the domain without a connection being
33450 made, until the cache record expires.
33451
33452 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
33453 The postmaster check uses an empty sender in the MAIL command by default.
33454 You can use this parameter to do a postmaster check using a different address.
33455 For example:
33456 .code
33457 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
33458 .endd
33459 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
33460 one overrides. The &%postmaster%& parameter is equivalent to this example:
33461 .code
33462 require  verify = sender/callout=postmaster_mailfrom=
33463 .endd
33464 &*Warning*&: The caching arrangements for postmaster checking do not take
33465 account of the sender address. It is assumed that either the empty address or
33466 a fixed non-empty address will be used. All that Exim remembers is that the
33467 postmaster check for the domain succeeded or failed.
33468
33469
33470 .vitem &*random*&
33471 .cindex "callout" "&""random""& check"
33472 When this parameter is set, before doing the normal callout check, Exim does a
33473 check for a &"random"& local part at the same domain. The local part is not
33474 really random &-- it is defined by the expansion of the option
33475 &%callout_random_local_part%&, which defaults to
33476 .code
33477 $primary_hostname-$tod_epoch-testing
33478 .endd
33479 The idea here is to try to determine whether the remote host accepts all local
33480 parts without checking. If it does, there is no point in doing callouts for
33481 specific local parts. If the &"random"& check succeeds, the result is saved in
33482 a cache record, and used to force the current and subsequent callout checks to
33483 succeed without a connection being made, until the cache record expires.
33484
33485 .vitem &*use_postmaster*&
33486 .cindex "callout" "sender for recipient check"
33487 This parameter applies to recipient callouts only. For example:
33488 .code
33489 deny  !verify = recipient/callout=use_postmaster
33490 .endd
33491 .vindex "&$qualify_domain$&"
33492 It causes a non-empty postmaster address to be used in the MAIL command when
33493 performing the callout for the recipient, and also for a &"random"& check if
33494 that is configured. The local part of the address is &`postmaster`& and the
33495 domain is the contents of &$qualify_domain$&.
33496
33497 .vitem &*use_sender*&
33498 This option applies to recipient callouts only. For example:
33499 .code
33500 require  verify = recipient/callout=use_sender
33501 .endd
33502 It causes the message's actual sender address to be used in the MAIL
33503 command when performing the callout, instead of an empty address. There is no
33504 need to use this option unless you know that the called hosts make use of the
33505 sender when checking recipients. If used indiscriminately, it reduces the
33506 usefulness of callout caching.
33507
33508 .vitem &*hold*&
33509 This option applies to recipient callouts only. For example:
33510 .code
33511 require  verify = recipient/callout=use_sender,hold
33512 .endd
33513 It causes the connection to be held open and used for any further recipients
33514 and for eventual delivery (should that be done quickly).
33515 Doing this saves on TCP and SMTP startup costs, and TLS costs also
33516 when that is used for the connections.
33517 The advantage is only gained if there are no callout cache hits
33518 (which could be enforced by the no_cache option),
33519 if the use_sender option is used,
33520 if neither the random nor the use_postmaster option is used,
33521 and if no other callouts intervene.
33522 .endlist
33523
33524 If you use any of the parameters that set a non-empty sender for the MAIL
33525 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
33526 &%use_sender%&), you should think about possible loops. Recipient checking is
33527 usually done between two hosts that are under the same management, and the host
33528 that receives the callouts is not normally configured to do callouts itself.
33529 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
33530 these circumstances.
33531
33532 However, if you use a non-empty sender address for a callout to an arbitrary
33533 host, there is the likelihood that the remote host will itself initiate a
33534 callout check back to your host. As it is checking what appears to be a message
33535 sender, it is likely to use an empty address in MAIL, thus avoiding a
33536 callout loop. However, to be on the safe side it would be best to set up your
33537 own ACLs so that they do not do sender verification checks when the recipient
33538 is the address you use for header sender or postmaster callout checking.
33539
33540 Another issue to think about when using non-empty senders for callouts is
33541 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
33542 by the sender/recipient combination; thus, for any given recipient, many more
33543 actual callouts are performed than when an empty sender or postmaster is used.
33544
33545
33546
33547
33548 .section "Callout caching" "SECTcallvercache"
33549 .cindex "hints database" "callout cache"
33550 .cindex "callout" "cache, description of"
33551 .cindex "caching" "callout"
33552 Exim caches the results of callouts in order to reduce the amount of resources
33553 used, unless you specify the &%no_cache%& parameter with the &%callout%&
33554 option. A hints database called &"callout"& is used for the cache. Two
33555 different record types are used: one records the result of a callout check for
33556 a specific address, and the other records information that applies to the
33557 entire domain (for example, that it accepts the local part &'postmaster'&).
33558
33559 When an original callout fails, a detailed SMTP error message is given about
33560 the failure. However, for subsequent failures use the cache data, this message
33561 is not available.
33562
33563 The expiry times for negative and positive address cache records are
33564 independent, and can be set by the global options &%callout_negative_expire%&
33565 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
33566
33567 If a host gives a negative response to an SMTP connection, or rejects any
33568 commands up to and including
33569 .code
33570 MAIL FROM:<>
33571 .endd
33572 (but not including the MAIL command with a non-empty address),
33573 any callout attempt is bound to fail. Exim remembers such failures in a
33574 domain cache record, which it uses to fail callouts for the domain without
33575 making new connections, until the domain record times out. There are two
33576 separate expiry times for domain cache records:
33577 &%callout_domain_negative_expire%& (default 3h) and
33578 &%callout_domain_positive_expire%& (default 7d).
33579
33580 Domain records expire when the negative expiry time is reached if callouts
33581 cannot be made for the domain, or if the postmaster check failed.
33582 Otherwise, they expire when the positive expiry time is reached. This
33583 ensures that, for example, a host that stops accepting &"random"& local parts
33584 will eventually be noticed.
33585
33586 The callout caching mechanism is based on the domain of the address that is
33587 being tested. If the domain routes to several hosts, it is assumed that their
33588 behaviour will be the same.
33589
33590
33591
33592 .section "Quota caching" "SECTquotacache"
33593 .cindex "hints database" "quota cache"
33594 .cindex "quota" "cache, description of"
33595 .cindex "caching" "quota"
33596 Exim caches the results of quota verification
33597 in order to reduce the amount of resources used.
33598 The &"callout"& hints database is used.
33599
33600 The default cache periods are five minutes for a positive (good) result
33601 and one hour for a negative result.
33602 To change the periods the &%quota%& option can be followed by an equals sign
33603 and a number of optional paramemters, separated by commas.
33604 For example:
33605 .code
33606 verify = recipient/quota=cachepos=1h,cacheneg=1d
33607 .endd
33608 Possible parameters are:
33609 .vlist
33610 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
33611 .cindex "quota cache" "positive entry expiry, specifying"
33612 Set the lifetime for a positive cache entry.
33613 A value of zero seconds is legitimate.
33614
33615 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
33616 .cindex "quota cache" "negative entry expiry, specifying"
33617 As above, for a negative entry.
33618
33619 .vitem &*no_cache*&
33620 Set both positive and negative lifetimes to zero.
33621
33622 .section "Sender address verification reporting" "SECTsenaddver"
33623 .cindex "verifying" "suppressing error details"
33624 See section &<<SECTaddressverification>>& for a general discussion of
33625 verification. When sender verification fails in an ACL, the details of the
33626 failure are given as additional output lines before the 550 response to the
33627 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
33628 you might see:
33629 .code
33630 MAIL FROM:<xyz@abc.example>
33631 250 OK
33632 RCPT TO:<pqr@def.example>
33633 550-Verification failed for <xyz@abc.example>
33634 550-Called:   192.168.34.43
33635 550-Sent:     RCPT TO:<xyz@abc.example>
33636 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
33637 550 Sender verification failed
33638 .endd
33639 If more than one RCPT command fails in the same way, the details are given
33640 only for the first of them. However, some administrators do not want to send
33641 out this much information. You can suppress the details by adding
33642 &`/no_details`& to the ACL statement that requests sender verification. For
33643 example:
33644 .code
33645 verify = sender/no_details
33646 .endd
33647
33648 .section "Redirection while verifying" "SECTredirwhilveri"
33649 .cindex "verifying" "redirection while"
33650 .cindex "address redirection" "while verifying"
33651 A dilemma arises when a local address is redirected by aliasing or forwarding
33652 during verification: should the generated addresses themselves be verified,
33653 or should the successful expansion of the original address be enough to verify
33654 it? By default, Exim takes the following pragmatic approach:
33655
33656 .ilist
33657 When an incoming address is redirected to just one child address, verification
33658 continues with the child address, and if that fails to verify, the original
33659 verification also fails.
33660 .next
33661 When an incoming address is redirected to more than one child address,
33662 verification does not continue. A success result is returned.
33663 .endlist
33664
33665 This seems the most reasonable behaviour for the common use of aliasing as a
33666 way of redirecting different local parts to the same mailbox. It means, for
33667 example, that a pair of alias entries of the form
33668 .code
33669 A.Wol:   aw123
33670 aw123:   :fail: Gone away, no forwarding address
33671 .endd
33672 work as expected, with both local parts causing verification failure. When a
33673 redirection generates more than one address, the behaviour is more like a
33674 mailing list, where the existence of the alias itself is sufficient for
33675 verification to succeed.
33676
33677 It is possible, however, to change the default behaviour so that all successful
33678 redirections count as successful verifications, however many new addresses are
33679 generated. This is specified by the &%success_on_redirect%& verification
33680 option. For example:
33681 .code
33682 require verify = recipient/success_on_redirect/callout=10s
33683 .endd
33684 In this example, verification succeeds if a router generates a new address, and
33685 the callout does not occur, because no address was routed to a remote host.
33686
33687 When verification is being tested via the &%-bv%& option, the treatment of
33688 redirections is as just described, unless the &%-v%& or any debugging option is
33689 also specified. In that case, full verification is done for every generated
33690 address and a report is output for each of them.
33691
33692
33693
33694 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
33695 .cindex "CSA" "verifying"
33696 Client SMTP Authorization is a system that allows a site to advertise
33697 which machines are and are not permitted to send email. This is done by placing
33698 special SRV records in the DNS; these are looked up using the client's HELO
33699 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
33700 Authorization checks in Exim are performed by the ACL condition:
33701 .code
33702 verify = csa
33703 .endd
33704 This fails if the client is not authorized. If there is a DNS problem, or if no
33705 valid CSA SRV record is found, or if the client is authorized, the condition
33706 succeeds. These three cases can be distinguished using the expansion variable
33707 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
33708 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
33709 be likely to cause problems for legitimate email.
33710
33711 The error messages produced by the CSA code include slightly more
33712 detail. If &$csa_status$& is &"defer"&, this may be because of problems
33713 looking up the CSA SRV record, or problems looking up the CSA target
33714 address record. There are four reasons for &$csa_status$& being &"fail"&:
33715
33716 .ilist
33717 The client's host name is explicitly not authorized.
33718 .next
33719 The client's IP address does not match any of the CSA target IP addresses.
33720 .next
33721 The client's host name is authorized but it has no valid target IP addresses
33722 (for example, the target's addresses are IPv6 and the client is using IPv4).
33723 .next
33724 The client's host name has no CSA SRV record but a parent domain has asserted
33725 that all subdomains must be explicitly authorized.
33726 .endlist
33727
33728 The &%csa%& verification condition can take an argument which is the domain to
33729 use for the DNS query. The default is:
33730 .code
33731 verify = csa/$sender_helo_name
33732 .endd
33733 This implementation includes an extension to CSA. If the query domain
33734 is an address literal such as [192.0.2.95], or if it is a bare IP
33735 address, Exim searches for CSA SRV records in the reverse DNS as if
33736 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
33737 meaningful to say:
33738 .code
33739 verify = csa/$sender_host_address
33740 .endd
33741 In fact, this is the check that Exim performs if the client does not say HELO.
33742 This extension can be turned off by setting the main configuration option
33743 &%dns_csa_use_reverse%& to be false.
33744
33745 If a CSA SRV record is not found for the domain itself, a search
33746 is performed through its parent domains for a record which might be
33747 making assertions about subdomains. The maximum depth of this search is limited
33748 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
33749 default. Exim does not look for CSA SRV records in a top level domain, so the
33750 default settings handle HELO domains as long as seven
33751 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
33752 of legitimate HELO domains.
33753
33754 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
33755 direct SRV lookups, this is not sufficient because of the extra parent domain
33756 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
33757 addresses into lookups in the reverse DNS space. The result of a successful
33758 lookup such as:
33759 .code
33760 ${lookup dnsdb {csa=$sender_helo_name}}
33761 .endd
33762 has two space-separated fields: an authorization code and a target host name.
33763 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
33764 authorization required but absent, or &"?"& for unknown.
33765
33766
33767
33768
33769 .section "Bounce address tag validation" "SECTverifyPRVS"
33770 .cindex "BATV, verifying"
33771 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
33772 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
33773 Genuine incoming bounce messages should therefore always be addressed to
33774 recipients that have a valid tag. This scheme is a way of detecting unwanted
33775 bounce messages caused by sender address forgeries (often called &"collateral
33776 spam"&), because the recipients of such messages do not include valid tags.
33777
33778 There are two expansion items to help with the implementation of the BATV
33779 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
33780 the original envelope sender address by using a simple key to add a hash of the
33781 address and some time-based randomizing information. The &%prvs%& expansion
33782 item creates a signed address, and the &%prvscheck%& expansion item checks one.
33783 The syntax of these expansion items is described in section
33784 &<<SECTexpansionitems>>&.
33785 The validity period on signed addresses is seven days.
33786
33787 As an example, suppose the secret per-address keys are stored in an MySQL
33788 database. A query to look up the key for an address could be defined as a macro
33789 like this:
33790 .code
33791 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
33792                 WHERE sender='${quote_mysql:$prvscheck_address}'\
33793                 }{$value}}
33794 .endd
33795 Suppose also that the senders who make use of BATV are defined by an address
33796 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
33797 use this:
33798 .code
33799 # Bounces: drop unsigned addresses for BATV senders
33800 deny senders = :
33801      recipients = +batv_senders
33802      message = This address does not send an unsigned reverse path
33803
33804 # Bounces: In case of prvs-signed address, check signature.
33805 deny senders = :
33806      condition  = ${prvscheck {$local_part@$domain}\
33807                   {PRVSCHECK_SQL}{1}}
33808      !condition = $prvscheck_result
33809      message = Invalid reverse path signature.
33810 .endd
33811 The first statement rejects recipients for bounce messages that are addressed
33812 to plain BATV sender addresses, because it is known that BATV senders do not
33813 send out messages with plain sender addresses. The second statement rejects
33814 recipients that are prvs-signed, but with invalid signatures (either because
33815 the key is wrong, or the signature has timed out).
33816
33817 A non-prvs-signed address is not rejected by the second statement, because the
33818 &%prvscheck%& expansion yields an empty string if its first argument is not a
33819 prvs-signed address, thus causing the &%condition%& condition to be false. If
33820 the first argument is a syntactically valid prvs-signed address, the yield is
33821 the third string (in this case &"1"&), whether or not the cryptographic and
33822 timeout checks succeed. The &$prvscheck_result$& variable contains the result
33823 of the checks (empty for failure, &"1"& for success).
33824
33825 There is one more issue you must consider when implementing prvs-signing:
33826 you have to ensure that the routers accept prvs-signed addresses and
33827 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
33828 router to remove the signature with a configuration along these lines:
33829 .code
33830 batv_redirect:
33831   driver = redirect
33832   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
33833 .endd
33834 This works because, if the third argument of &%prvscheck%& is empty, the result
33835 of the expansion of a prvs-signed address is the decoded value of the original
33836 address. This router should probably be the first of your routers that handles
33837 local addresses.
33838
33839 To create BATV-signed addresses in the first place, a transport of this form
33840 can be used:
33841 .code
33842 external_smtp_batv:
33843   driver = smtp
33844   return_path = ${prvs {$return_path} \
33845                        {${lookup mysql{SELECT \
33846                        secret FROM batv_prvs WHERE \
33847                        sender='${quote_mysql:$sender_address}'} \
33848                        {$value}fail}}}
33849 .endd
33850 If no key can be found for the existing return path, no signing takes place.
33851
33852
33853
33854 .section "Using an ACL to control relaying" "SECTrelaycontrol"
33855 .cindex "&ACL;" "relay control"
33856 .cindex "relaying" "control by ACL"
33857 .cindex "policy control" "relay control"
33858 An MTA is said to &'relay'& a message if it receives it from some host and
33859 delivers it directly to another host as a result of a remote address contained
33860 within it. Redirecting a local address via an alias or forward file and then
33861 passing the message on to another host is not relaying,
33862 .cindex "&""percent hack""&"
33863 but a redirection as a result of the &"percent hack"& is.
33864
33865 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
33866 A host which is acting as a gateway or an MX backup is concerned with incoming
33867 relaying from arbitrary hosts to a specific set of domains. On the other hand,
33868 a host which is acting as a smart host for a number of clients is concerned
33869 with outgoing relaying from those clients to the Internet at large. Often the
33870 same host is fulfilling both functions,
33871 . ///
33872 . as illustrated in the diagram below,
33873 . ///
33874 but in principle these two kinds of relaying are entirely independent. What is
33875 not wanted is the transmission of mail from arbitrary remote hosts through your
33876 system to arbitrary domains.
33877
33878
33879 You can implement relay control by means of suitable statements in the ACL that
33880 runs for each RCPT command. For convenience, it is often easiest to use
33881 Exim's named list facility to define the domains and hosts involved. For
33882 example, suppose you want to do the following:
33883
33884 .ilist
33885 Deliver a number of domains to mailboxes on the local host (or process them
33886 locally in some other way). Let's say these are &'my.dom1.example'& and
33887 &'my.dom2.example'&.
33888 .next
33889 Relay mail for a number of other domains for which you are the secondary MX.
33890 These might be &'friend1.example'& and &'friend2.example'&.
33891 .next
33892 Relay mail from the hosts on your local LAN, to whatever domains are involved.
33893 Suppose your LAN is 192.168.45.0/24.
33894 .endlist
33895
33896
33897 In the main part of the configuration, you put the following definitions:
33898 .code
33899 domainlist local_domains    = my.dom1.example : my.dom2.example
33900 domainlist relay_to_domains = friend1.example : friend2.example
33901 hostlist   relay_from_hosts = 192.168.45.0/24
33902 .endd
33903 Now you can use these definitions in the ACL that is run for every RCPT
33904 command:
33905 .code
33906 acl_check_rcpt:
33907   accept domains = +local_domains : +relay_to_domains
33908   accept hosts   = +relay_from_hosts
33909 .endd
33910 The first statement accepts any RCPT command that contains an address in
33911 the local or relay domains. For any other domain, control passes to the second
33912 statement, which accepts the command only if it comes from one of the relay
33913 hosts. In practice, you will probably want to make your ACL more sophisticated
33914 than this, for example, by including sender and recipient verification. The
33915 default configuration includes a more comprehensive example, which is described
33916 in chapter &<<CHAPdefconfil>>&.
33917
33918
33919
33920 .section "Checking a relay configuration" "SECTcheralcon"
33921 .cindex "relaying" "checking control of"
33922 You can check the relay characteristics of your configuration in the same way
33923 that you can test any ACL behaviour for an incoming SMTP connection, by using
33924 the &%-bh%& option to run a fake SMTP session with which you interact.
33925 .ecindex IIDacl
33926
33927
33928
33929 . ////////////////////////////////////////////////////////////////////////////
33930 . ////////////////////////////////////////////////////////////////////////////
33931
33932 .chapter "Content scanning at ACL time" "CHAPexiscan"
33933 .scindex IIDcosca "content scanning" "at ACL time"
33934 The extension of Exim to include content scanning at ACL time, formerly known
33935 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
33936 was integrated into the main source for Exim release 4.50, and Tom continues to
33937 maintain it. Most of the wording of this chapter is taken from Tom's
33938 specification.
33939
33940 It is also possible to scan the content of messages at other times. The
33941 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
33942 scanning after all the ACLs have run. A transport filter can be used to scan
33943 messages at delivery time (see the &%transport_filter%& option, described in
33944 chapter &<<CHAPtransportgeneric>>&).
33945
33946 If you want to include the ACL-time content-scanning features when you compile
33947 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
33948 &_Local/Makefile_&. When you do that, the Exim binary is built with:
33949
33950 .ilist
33951 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
33952 for all MIME parts for SMTP and non-SMTP messages, respectively.
33953 .next
33954 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
33955 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
33956 run at the end of message reception (the &%acl_smtp_data%& ACL).
33957 .next
33958 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
33959 of messages, or parts of messages, for debugging purposes.
33960 .next
33961 Additional expansion variables that are set in the new ACL and by the new
33962 conditions.
33963 .next
33964 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
33965 .endlist
33966
33967 Content-scanning is continually evolving, and new features are still being
33968 added. While such features are still unstable and liable to incompatible
33969 changes, they are made available in Exim by setting options whose names begin
33970 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
33971 this manual. You can find out about them by reading the file called
33972 &_doc/experimental.txt_&.
33973
33974 All the content-scanning facilities work on a MBOX copy of the message that is
33975 temporarily created in a file called:
33976 .display
33977 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
33978 .endd
33979 The &_.eml_& extension is a friendly hint to virus scanners that they can
33980 expect an MBOX-like structure inside that file. The file is created when the
33981 first content scanning facility is called. Subsequent calls to content
33982 scanning conditions open the same file again. The directory is recursively
33983 removed when the &%acl_smtp_data%& ACL has finished running, unless
33984 .code
33985 control = no_mbox_unspool
33986 .endd
33987 has been encountered. When the MIME ACL decodes files, they are put into the
33988 same directory by default.
33989
33990
33991
33992 .section "Scanning for viruses" "SECTscanvirus"
33993 .cindex "virus scanning"
33994 .cindex "content scanning" "for viruses"
33995 .cindex "content scanning" "the &%malware%& condition"
33996 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
33997 It supports a &"generic"& interface to scanners called via the shell, and
33998 specialized interfaces for &"daemon"& type virus scanners, which are resident
33999 in memory and thus are much faster.
34000
34001 Since message data needs to have arrived,
34002 the condition may be only called in ACL defined by
34003 &%acl_smtp_data%&,
34004 &%acl_smtp_data_prdr%&,
34005 &%acl_smtp_mime%& or
34006 &%acl_smtp_dkim%&
34007
34008 A timeout of 2 minutes is applied to a scanner call (by default);
34009 if it expires then a defer action is taken.
34010
34011 .oindex "&%av_scanner%&"
34012 You can set the &%av_scanner%& option in the main part of the configuration
34013 to specify which scanner to use, together with any additional options that
34014 are needed. The basic syntax is as follows:
34015 .display
34016 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
34017 .endd
34018 If you do not set &%av_scanner%&, it defaults to
34019 .code
34020 av_scanner = sophie:/var/run/sophie
34021 .endd
34022 If the value of &%av_scanner%& starts with a dollar character, it is expanded
34023 before use.
34024 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
34025 The following scanner types are supported in this release,
34026 though individual ones can be included or not at build time:
34027
34028 .vlist
34029 .vitem &%avast%&
34030 .cindex "virus scanners" "avast"
34031 This is the scanner daemon of Avast. It has been tested with Avast Core
34032 Security (currently at version 2.2.0).
34033 You can get a trial version at &url(https://www.avast.com) or for Linux
34034 at &url(https://www.avast.com/linux-server-antivirus).
34035 This scanner type takes one option,
34036 which can be either a full path to a UNIX socket,
34037 or host and port specifiers separated by white space.
34038 The host may be a name or an IP address; the port is either a
34039 single number or a pair of numbers with a dash between.
34040 A list of options may follow. These options are interpreted on the
34041 Exim's side of the malware scanner, or are given on separate lines to
34042 the daemon as options before the main scan command.
34043
34044 .cindex &`pass_unscanned`& "avast"
34045 If &`pass_unscanned`&
34046 is set, any files the Avast scanner can't scan (e.g.
34047 decompression bombs, or invalid archives) are considered clean. Use with
34048 care.
34049
34050 For example:
34051 .code
34052 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
34053 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
34054 av_scanner = avast:192.168.2.22 5036
34055 .endd
34056 If you omit the argument, the default path
34057 &_/var/run/avast/scan.sock_&
34058 is used.
34059 If you use a remote host,
34060 you need to make Exim's spool directory available to it,
34061 as the scanner is passed a file path, not file contents.
34062 For information about available commands and their options you may use
34063 .code
34064 $ socat UNIX:/var/run/avast/scan.sock STDIO:
34065     FLAGS
34066     SENSITIVITY
34067     PACK
34068 .endd
34069
34070 If the scanner returns a temporary failure (e.g. license issues, or
34071 permission problems), the message is deferred and a paniclog entry is
34072 written.  The usual &`defer_ok`& option is available.
34073
34074 .vitem &%aveserver%&
34075 .cindex "virus scanners" "Kaspersky"
34076 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
34077 at &url(https://www.kaspersky.com/). This scanner type takes one option,
34078 which is the path to the daemon's UNIX socket. The default is shown in this
34079 example:
34080 .code
34081 av_scanner = aveserver:/var/run/aveserver
34082 .endd
34083
34084
34085 .vitem &%clamd%&
34086 .cindex "virus scanners" "clamd"
34087 This daemon-type scanner is GPL and free. You can get it at
34088 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
34089 unpack MIME containers, so it used to be recommended to unpack MIME attachments
34090 in the MIME ACL. This is no longer believed to be necessary.
34091
34092 The options are a list of server specifiers, which may be
34093 a UNIX socket specification,
34094 a TCP socket specification,
34095 or a (global) option.
34096
34097 A socket specification consists of a space-separated list.
34098 For a Unix socket the first element is a full path for the socket,
34099 for a TCP socket the first element is the IP address
34100 and the second a port number,
34101 Any further elements are per-server (non-global) options.
34102 These per-server options are supported:
34103 .code
34104 retry=<timespec>        Retry on connect fail
34105 .endd
34106
34107 The &`retry`& option specifies a time after which a single retry for
34108 a failed connect is made.  The default is to not retry.
34109
34110 If a Unix socket file is specified, only one server is supported.
34111
34112 Examples:
34113 .code
34114 av_scanner = clamd:/opt/clamd/socket
34115 av_scanner = clamd:192.0.2.3 1234
34116 av_scanner = clamd:192.0.2.3 1234:local
34117 av_scanner = clamd:192.0.2.3 1234 retry=10s
34118 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
34119 .endd
34120 If the value of av_scanner points to a UNIX socket file or contains the
34121 &`local`&
34122 option, then the ClamAV interface will pass a filename containing the data
34123 to be scanned, which should normally result in less I/O happening and be
34124 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
34125 Exim does not assume that there is a common filesystem with the remote host.
34126
34127 The final example shows that multiple TCP targets can be specified.  Exim will
34128 randomly use one for each incoming email (i.e. it load balances them).  Note
34129 that only TCP targets may be used if specifying a list of scanners; a UNIX
34130 socket cannot be mixed in with TCP targets.  If one of the servers becomes
34131 unavailable, Exim will try the remaining one(s) until it finds one that works.
34132 When a clamd server becomes unreachable, Exim will log a message.  Exim does
34133 not keep track of scanner state between multiple messages, and the scanner
34134 selection is random, so the message will get logged in the mainlog for each
34135 email that the down scanner gets chosen first (message wrapped to be readable):
34136 .code
34137 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
34138    clamd: connection to localhost, port 3310 failed
34139    (Connection refused)
34140 .endd
34141
34142 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
34143 contributing the code for this scanner.
34144
34145 .vitem &%cmdline%&
34146 .cindex "virus scanners" "command line interface"
34147 This is the keyword for the generic command line scanner interface. It can be
34148 used to attach virus scanners that are invoked from the shell. This scanner
34149 type takes 3 mandatory options:
34150
34151 .olist
34152 The full path and name of the scanner binary, with all command line options,
34153 and a placeholder (&`%s`&) for the directory to scan.
34154
34155 .next
34156 A regular expression to match against the STDOUT and STDERR output of the
34157 virus scanner. If the expression matches, a virus was found. You must make
34158 absolutely sure that this expression matches on &"virus found"&. This is called
34159 the &"trigger"& expression.
34160
34161 .next
34162 Another regular expression, containing exactly one pair of parentheses, to
34163 match the name of the virus found in the scanners output. This is called the
34164 &"name"& expression.
34165 .endlist olist
34166
34167 For example, Sophos Sweep reports a virus on a line like this:
34168 .code
34169 Virus 'W32/Magistr-B' found in file ./those.bat
34170 .endd
34171 For the trigger expression, we can match the phrase &"found in file"&. For the
34172 name expression, we want to extract the W32/Magistr-B string, so we can match
34173 for the single quotes left and right of it. Altogether, this makes the
34174 configuration setting:
34175 .code
34176 av_scanner = cmdline:\
34177              /path/to/sweep -ss -all -rec -archive %s:\
34178              found in file:'(.+)'
34179 .endd
34180 .vitem &%drweb%&
34181 .cindex "virus scanners" "DrWeb"
34182 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
34183 takes one option,
34184 either a full path to a UNIX socket,
34185 or host and port specifiers separated by white space.
34186 The host may be a name or an IP address; the port is either a
34187 single number or a pair of numbers with a dash between.
34188 For example:
34189 .code
34190 av_scanner = drweb:/var/run/drwebd.sock
34191 av_scanner = drweb:192.168.2.20 31337
34192 .endd
34193 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
34194 is used. Thanks to Alex Miller for contributing the code for this scanner.
34195
34196 .vitem &%f-protd%&
34197 .cindex "virus scanners" "f-protd"
34198 The f-protd scanner is accessed via HTTP over TCP.
34199 One argument is taken, being a space-separated hostname and port number
34200 (or port-range).
34201 For example:
34202 .code
34203 av_scanner = f-protd:localhost 10200-10204
34204 .endd
34205 If you omit the argument, the default values shown above are used.
34206
34207 .vitem &%f-prot6d%&
34208 .cindex "virus scanners" "f-prot6d"
34209 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
34210 One argument is taken, being a space-separated hostname and port number.
34211 For example:
34212 .code
34213 av_scanner = f-prot6d:localhost 10200
34214 .endd
34215 If you omit the argument, the default values show above are used.
34216
34217 .vitem &%fsecure%&
34218 .cindex "virus scanners" "F-Secure"
34219 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
34220 argument which is the path to a UNIX socket. For example:
34221 .code
34222 av_scanner = fsecure:/path/to/.fsav
34223 .endd
34224 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
34225 Thelmen for contributing the code for this scanner.
34226
34227 .vitem &%kavdaemon%&
34228 .cindex "virus scanners" "Kaspersky"
34229 This is the scanner daemon of Kaspersky Version 4. This version of the
34230 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
34231 scanner type takes one option, which is the path to the daemon's UNIX socket.
34232 For example:
34233 .code
34234 av_scanner = kavdaemon:/opt/AVP/AvpCtl
34235 .endd
34236 The default path is &_/var/run/AvpCtl_&.
34237
34238 .vitem &%mksd%&
34239 .cindex "virus scanners" "mksd"
34240 This was a daemon type scanner that is aimed mainly at Polish users,
34241 though some documentation was available in English.
34242 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
34243 and this appears to be a candidate for removal from Exim, unless
34244 we are informed of other virus scanners which use the same protocol
34245 to integrate.
34246 The only option for this scanner type is
34247 the maximum number of processes used simultaneously to scan the attachments,
34248 provided that mksd has
34249 been run with at least the same number of child processes. For example:
34250 .code
34251 av_scanner = mksd:2
34252 .endd
34253 You can safely omit this option (the default value is 1).
34254
34255 .vitem &%sock%&
34256 .cindex "virus scanners" "simple socket-connected"
34257 This is a general-purpose way of talking to simple scanner daemons
34258 running on the local machine.
34259 There are four options:
34260 an address (which may be an IP address and port, or the path of a Unix socket),
34261 a commandline to send (may include a single %s which will be replaced with
34262 the path to the mail file to be scanned),
34263 an RE to trigger on from the returned data,
34264 and an RE to extract malware_name from the returned data.
34265 For example:
34266 .code
34267 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
34268 .endd
34269 Note that surrounding whitespace is stripped from each option, meaning
34270 there is no way to specify a trailing newline.
34271 The socket specifier and both regular-expressions are required.
34272 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
34273 specify an empty element to get this.
34274
34275 .vitem &%sophie%&
34276 .cindex "virus scanners" "Sophos and Sophie"
34277 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
34278 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
34279 for this scanner type is the path to the UNIX socket that Sophie uses for
34280 client communication. For example:
34281 .code
34282 av_scanner = sophie:/tmp/sophie
34283 .endd
34284 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
34285 the option.
34286 .endlist
34287
34288 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
34289 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
34290 ACL.
34291
34292 The &%av_scanner%& option is expanded each time &%malware%& is called. This
34293 makes it possible to use different scanners. See further below for an example.
34294 The &%malware%& condition caches its results, so when you use it multiple times
34295 for the same message, the actual scanning process is only carried out once.
34296 However, using expandable items in &%av_scanner%& disables this caching, in
34297 which case each use of the &%malware%& condition causes a new scan of the
34298 message.
34299
34300 The &%malware%& condition takes a right-hand argument that is expanded before
34301 use and taken as a list, slash-separated by default.
34302 The first element can then be one of
34303
34304 .ilist
34305 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
34306 The condition succeeds if a virus was found, and fail otherwise. This is the
34307 recommended usage.
34308 .next
34309 &"false"& or &"0"& or an empty string, in which case no scanning is done and
34310 the condition fails immediately.
34311 .next
34312 A regular expression, in which case the message is scanned for viruses. The
34313 condition succeeds if a virus is found and its name matches the regular
34314 expression. This allows you to take special actions on certain types of virus.
34315 Note that &"/"& characters in the RE must be doubled due to the list-processing,
34316 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
34317 .endlist
34318
34319 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
34320 messages even if there is a problem with the virus scanner.
34321 Otherwise, such a problem causes the ACL to defer.
34322
34323 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
34324 specify a non-default timeout.  The default is two minutes.
34325 For example:
34326 .code
34327 malware = * / defer_ok / tmo=10s
34328 .endd
34329 A timeout causes the ACL to defer.
34330
34331 .vindex "&$callout_address$&"
34332 When a connection is made to the scanner the expansion variable &$callout_address$&
34333 is set to record the actual address used.
34334
34335 .vindex "&$malware_name$&"
34336 When a virus is found, the condition sets up an expansion variable called
34337 &$malware_name$& that contains the name of the virus. You can use it in a
34338 &%message%& modifier that specifies the error returned to the sender, and/or in
34339 logging data.
34340
34341 Beware the interaction of Exim's &%message_size_limit%& with any size limits
34342 imposed by your anti-virus scanner.
34343
34344 Here is a very simple scanning example:
34345 .code
34346 deny malware = *
34347      message = This message contains malware ($malware_name)
34348 .endd
34349 The next example accepts messages when there is a problem with the scanner:
34350 .code
34351 deny malware = */defer_ok
34352      message = This message contains malware ($malware_name)
34353 .endd
34354 The next example shows how to use an ACL variable to scan with both sophie and
34355 aveserver. It assumes you have set:
34356 .code
34357 av_scanner = $acl_m0
34358 .endd
34359 in the main Exim configuration.
34360 .code
34361 deny set acl_m0 = sophie
34362      malware = *
34363      message = This message contains malware ($malware_name)
34364
34365 deny set acl_m0 = aveserver
34366      malware = *
34367      message = This message contains malware ($malware_name)
34368 .endd
34369
34370
34371 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
34372 .cindex "content scanning" "for spam"
34373 .cindex "spam scanning"
34374 .cindex "SpamAssassin"
34375 .cindex "Rspamd"
34376 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
34377 score and a report for the message.
34378 Support is also provided for Rspamd.
34379
34380 For more information about installation and configuration of SpamAssassin or
34381 Rspamd refer to their respective websites at
34382 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
34383
34384 SpamAssassin can be installed with CPAN by running:
34385 .code
34386 perl -MCPAN -e 'install Mail::SpamAssassin'
34387 .endd
34388 SpamAssassin has its own set of configuration files. Please review its
34389 documentation to see how you can tweak it. The default installation should work
34390 nicely, however.
34391
34392 .oindex "&%spamd_address%&"
34393 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
34394 intend to use an instance running on the local host you do not need to set
34395 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
34396 you must set the &%spamd_address%& option in the global part of the Exim
34397 configuration as follows (example):
34398 .code
34399 spamd_address = 192.168.99.45 783
34400 .endd
34401 The SpamAssassin protocol relies on a TCP half-close from the client.
34402 If your SpamAssassin client side is running a Linux system with an
34403 iptables firewall, consider setting
34404 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
34405 timeout, Exim uses when waiting for a response from the SpamAssassin
34406 server (currently defaulting to 120s).  With a lower value the Linux
34407 connection tracking may consider your half-closed connection as dead too
34408 soon.
34409
34410
34411 To use Rspamd (which by default listens on all local addresses
34412 on TCP port 11333)
34413 you should add &%variant=rspamd%& after the address/port pair, for example:
34414 .code
34415 spamd_address = 127.0.0.1 11333 variant=rspamd
34416 .endd
34417
34418 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
34419 sockets. If you want to us these, supply &%spamd_address%& with an absolute
34420 filename instead of an address/port pair:
34421 .code
34422 spamd_address = /var/run/spamd_socket
34423 .endd
34424 You can have multiple &%spamd%& servers to improve scalability. These can
34425 reside on other hardware reachable over the network. To specify multiple
34426 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
34427 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
34428 .code
34429 spamd_address = 192.168.2.10 783 : \
34430                 192.168.2.11 783 : \
34431                 192.168.2.12 783
34432 .endd
34433 Up to 32 &%spamd%& servers are supported.
34434 When a server fails to respond to the connection attempt, all other
34435 servers are tried until one succeeds. If no server responds, the &%spam%&
34436 condition defers.
34437
34438 Unix and TCP socket specifications may be mixed in any order.
34439 Each element of the list is a list itself, space-separated by default
34440 and changeable in the usual way (&<<SECTlistsepchange>>&);
34441 take care to not double the separator.
34442
34443 For TCP socket specifications a host name or IP (v4 or v6, but
34444 subject to list-separator quoting rules) address can be used,
34445 and the port can be one or a dash-separated pair.
34446 In the latter case, the range is tried in strict order.
34447
34448 Elements after the first for Unix sockets, or second for TCP socket,
34449 are options.
34450 The supported options are:
34451 .code
34452 pri=<priority>      Selection priority
34453 weight=<value>      Selection bias
34454 time=<start>-<end>  Use only between these times of day
34455 retry=<timespec>    Retry on connect fail
34456 tmo=<timespec>      Connection time limit
34457 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
34458 .endd
34459
34460 The &`pri`& option specifies a priority for the server within the list,
34461 higher values being tried first.
34462 The default priority is 1.
34463
34464 The &`weight`& option specifies a selection bias.
34465 Within a priority set
34466 servers are queried in a random fashion, weighted by this value.
34467 The default value for selection bias is 1.
34468
34469 Time specifications for the &`time`& option are <hour>.<minute>.<second>
34470 in the local time zone; each element being one or more digits.
34471 Either the seconds or both minutes and seconds, plus the leading &`.`&
34472 characters, may be omitted and will be taken as zero.
34473
34474 Timeout specifications for the &`retry`& and &`tmo`& options
34475 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
34476
34477 The &`tmo`& option specifies an overall timeout for communication.
34478 The default value is two minutes.
34479
34480 The &`retry`& option specifies a time after which a single retry for
34481 a failed connect is made.
34482 The default is to not retry.
34483
34484 The &%spamd_address%& variable is expanded before use if it starts with
34485 a dollar sign. In this case, the expansion may return a string that is
34486 used as the list so that multiple spamd servers can be the result of an
34487 expansion.
34488
34489 .vindex "&$callout_address$&"
34490 When a connection is made to the server the expansion variable &$callout_address$&
34491 is set to record the actual address used.
34492
34493 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
34494 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
34495 .code
34496 deny spam = joe
34497      message = This message was classified as SPAM
34498 .endd
34499 The right-hand side of the &%spam%& condition specifies a name. This is
34500 relevant if you have set up multiple SpamAssassin profiles. If you do not want
34501 to scan using a specific profile, but rather use the SpamAssassin system-wide
34502 default profile, you can scan for an unknown name, or simply use &"nobody"&.
34503 Rspamd does not use this setting. However, you must put something on the
34504 right-hand side.
34505
34506 The name allows you to use per-domain or per-user antispam profiles in
34507 principle, but this is not straightforward in practice, because a message may
34508 have multiple recipients, not necessarily all in the same domain. Because the
34509 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
34510 read the contents of the message, the variables &$local_part$& and &$domain$&
34511 are not set.
34512 Careful enforcement of single-recipient messages
34513 (e.g. by responding with defer in the recipient ACL for all recipients
34514 after the first),
34515 or the use of PRDR,
34516 .cindex "PRDR" "use for per-user SpamAssassin profiles"
34517 are needed to use this feature.
34518
34519 The right-hand side of the &%spam%& condition is expanded before being used, so
34520 you can put lookups or conditions there. When the right-hand side evaluates to
34521 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
34522
34523
34524 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
34525 large ones may cause significant performance degradation. As most spam messages
34526 are quite small, it is recommended that you do not scan the big ones. For
34527 example:
34528 .code
34529 deny condition = ${if < {$message_size}{10K}}
34530      spam = nobody
34531      message = This message was classified as SPAM
34532 .endd
34533
34534 The &%spam%& condition returns true if the threshold specified in the user's
34535 SpamAssassin profile has been matched or exceeded. If you want to use the
34536 &%spam%& condition for its side effects (see the variables below), you can make
34537 it always return &"true"& by appending &`:true`& to the username.
34538
34539 .cindex "spam scanning" "returned variables"
34540 When the &%spam%& condition is run, it sets up a number of expansion
34541 variables.
34542 Except for &$spam_report$&,
34543 these variables are saved with the received message so are
34544 available for use at delivery time.
34545
34546 .vlist
34547 .vitem &$spam_score$&
34548 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
34549 for inclusion in log or reject messages.
34550
34551 .vitem &$spam_score_int$&
34552 The spam score of the message, multiplied by ten, as an integer value. For
34553 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
34554 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
34555 The integer value is useful for numeric comparisons in conditions.
34556
34557 .vitem &$spam_bar$&
34558 A string consisting of a number of &"+"& or &"-"& characters, representing the
34559 integer part of the spam score value. A spam score of 4.4 would have a
34560 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
34561 headers, since MUAs can match on such strings. The maximum length of the
34562 spam bar is 50 characters.
34563
34564 .vitem &$spam_report$&
34565 A multiline text table, containing the full SpamAssassin report for the
34566 message. Useful for inclusion in headers or reject messages.
34567 This variable is only usable in a DATA-time ACL.
34568 Beware that SpamAssassin may return non-ASCII characters, especially
34569 when running in country-specific locales, which are not legal
34570 unencoded in headers.
34571
34572 .vitem &$spam_action$&
34573 For SpamAssassin either 'reject' or 'no action' depending on the
34574 spam score versus threshold.
34575 For Rspamd, the recommended action.
34576
34577 .endlist
34578
34579 The &%spam%& condition caches its results unless expansion in
34580 spamd_address was used. If you call it again with the same user name, it
34581 does not scan again, but rather returns the same values as before.
34582
34583 The &%spam%& condition returns DEFER if there is any error while running
34584 the message through SpamAssassin or if the expansion of spamd_address
34585 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
34586 statement block), append &`/defer_ok`& to the right-hand side of the
34587 spam condition, like this:
34588 .code
34589 deny spam    = joe/defer_ok
34590      message = This message was classified as SPAM
34591 .endd
34592 This causes messages to be accepted even if there is a problem with &%spamd%&.
34593
34594 Here is a longer, commented example of the use of the &%spam%&
34595 condition:
34596 .code
34597 # put headers in all messages (no matter if spam or not)
34598 warn  spam = nobody:true
34599       add_header = X-Spam-Score: $spam_score ($spam_bar)
34600       add_header = X-Spam-Report: $spam_report
34601
34602 # add second subject line with *SPAM* marker when message
34603 # is over threshold
34604 warn  spam = nobody
34605       add_header = Subject: *SPAM* $h_Subject:
34606
34607 # reject spam at high scores (> 12)
34608 deny  spam = nobody:true
34609       condition = ${if >{$spam_score_int}{120}{1}{0}}
34610       message = This message scored $spam_score spam points.
34611 .endd
34612
34613
34614
34615 .section "Scanning MIME parts" "SECTscanmimepart"
34616 .cindex "content scanning" "MIME parts"
34617 .cindex "MIME content scanning"
34618 .oindex "&%acl_smtp_mime%&"
34619 .oindex "&%acl_not_smtp_mime%&"
34620 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
34621 each MIME part of an SMTP message, including multipart types, in the sequence
34622 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
34623 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
34624 options may both refer to the same ACL if you want the same processing in both
34625 cases.
34626
34627 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
34628 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
34629 the case of a non-SMTP message. However, a MIME ACL is called only if the
34630 message contains a &'Content-Type:'& header line. When a call to a MIME
34631 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
34632 result code is sent to the client. In the case of an SMTP message, the
34633 &%acl_smtp_data%& ACL is not called when this happens.
34634
34635 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
34636 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
34637 condition to match against the raw MIME part. You can also use the
34638 &%mime_regex%& condition to match against the decoded MIME part (see section
34639 &<<SECTscanregex>>&).
34640
34641 At the start of a MIME ACL, a number of variables are set from the header
34642 information for the relevant MIME part. These are described below. The contents
34643 of the MIME part are not by default decoded into a disk file except for MIME
34644 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
34645 part into a disk file, you can use the &%decode%& condition. The general
34646 syntax is:
34647 .display
34648 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
34649 .endd
34650 The right hand side is expanded before use. After expansion,
34651 the value can be:
34652
34653 .olist
34654 &"0"& or &"false"&, in which case no decoding is done.
34655 .next
34656 The string &"default"&. In that case, the file is put in the temporary
34657 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
34658 a sequential filename consisting of the message id and a sequence number. The
34659 full path and name is available in &$mime_decoded_filename$& after decoding.
34660 .next
34661 A full path name starting with a slash. If the full name is an existing
34662 directory, it is used as a replacement for the default directory. The filename
34663 is then sequentially assigned. If the path does not exist, it is used as
34664 the full path and filename.
34665 .next
34666 If the string does not start with a slash, it is used as the
34667 filename, and the default path is then used.
34668 .endlist
34669 The &%decode%& condition normally succeeds. It is only false for syntax
34670 errors or unusual circumstances such as memory shortages. You can easily decode
34671 a file with its original, proposed filename using
34672 .code
34673 decode = $mime_filename
34674 .endd
34675 However, you should keep in mind that &$mime_filename$& might contain
34676 anything. If you place files outside of the default path, they are not
34677 automatically unlinked.
34678
34679 For RFC822 attachments (these are messages attached to messages, with a
34680 content-type of &"message/rfc822"&), the ACL is called again in the same manner
34681 as for the primary message, only that the &$mime_is_rfc822$& expansion
34682 variable is set (see below). Attached messages are always decoded to disk
34683 before being checked, and the files are unlinked once the check is done.
34684
34685 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
34686 used to match regular expressions against raw and decoded MIME parts,
34687 respectively. They are described in section &<<SECTscanregex>>&.
34688
34689 .cindex "MIME content scanning" "returned variables"
34690 The following list describes all expansion variables that are
34691 available in the MIME ACL:
34692
34693 .vlist
34694 .vitem &$mime_anomaly_level$& &&&
34695        &$mime_anomaly_text$&
34696 .vindex &$mime_anomaly_level$&
34697 .vindex &$mime_anomaly_text$&
34698 If there are problems decoding, these variables contain information on
34699 the detected issue.
34700
34701 .vitem &$mime_boundary$&
34702 .vindex &$mime_boundary$&
34703 If the current part is a multipart (see &$mime_is_multipart$& below), it should
34704 have a boundary string, which is stored in this variable. If the current part
34705 has no boundary parameter in the &'Content-Type:'& header, this variable
34706 contains the empty string.
34707
34708 .vitem &$mime_charset$&
34709 .vindex &$mime_charset$&
34710 This variable contains the character set identifier, if one was found in the
34711 &'Content-Type:'& header. Examples for charset identifiers are:
34712 .code
34713 us-ascii
34714 gb2312 (Chinese)
34715 iso-8859-1
34716 .endd
34717 Please note that this value is not normalized, so you should do matches
34718 case-insensitively.
34719
34720 .vitem &$mime_content_description$&
34721 .vindex &$mime_content_description$&
34722 This variable contains the normalized content of the &'Content-Description:'&
34723 header. It can contain a human-readable description of the parts content. Some
34724 implementations repeat the filename for attachments here, but they are usually
34725 only used for display purposes.
34726
34727 .vitem &$mime_content_disposition$&
34728 .vindex &$mime_content_disposition$&
34729 This variable contains the normalized content of the &'Content-Disposition:'&
34730 header. You can expect strings like &"attachment"& or &"inline"& here.
34731
34732 .vitem &$mime_content_id$&
34733 .vindex &$mime_content_id$&
34734 This variable contains the normalized content of the &'Content-ID:'& header.
34735 This is a unique ID that can be used to reference a part from another part.
34736
34737 .vitem &$mime_content_size$&
34738 .vindex &$mime_content_size$&
34739 This variable is set only after the &%decode%& modifier (see above) has been
34740 successfully run. It contains the size of the decoded part in kilobytes. The
34741 size is always rounded up to full kilobytes, so only a completely empty part
34742 has a &$mime_content_size$& of zero.
34743
34744 .vitem &$mime_content_transfer_encoding$&
34745 .vindex &$mime_content_transfer_encoding$&
34746 This variable contains the normalized content of the
34747 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
34748 type. Typical values are &"base64"& and &"quoted-printable"&.
34749
34750 .vitem &$mime_content_type$&
34751 .vindex &$mime_content_type$&
34752 If the MIME part has a &'Content-Type:'& header, this variable contains its
34753 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
34754 are some examples of popular MIME types, as they may appear in this variable:
34755 .code
34756 text/plain
34757 text/html
34758 application/octet-stream
34759 image/jpeg
34760 audio/midi
34761 .endd
34762 If the MIME part has no &'Content-Type:'& header, this variable contains the
34763 empty string.
34764
34765 .vitem &$mime_decoded_filename$&
34766 .vindex &$mime_decoded_filename$&
34767 This variable is set only after the &%decode%& modifier (see above) has been
34768 successfully run. It contains the full path and filename of the file
34769 containing the decoded data.
34770 .endlist
34771
34772 .cindex "RFC 2047"
34773 .vlist
34774 .vitem &$mime_filename$&
34775 .vindex &$mime_filename$&
34776 This is perhaps the most important of the MIME variables. It contains a
34777 proposed filename for an attachment, if one was found in either the
34778 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
34779 RFC2047
34780 or RFC2231
34781 decoded, but no additional sanity checks are done.
34782  If no filename was
34783 found, this variable contains the empty string.
34784
34785 .vitem &$mime_is_coverletter$&
34786 .vindex &$mime_is_coverletter$&
34787 This variable attempts to differentiate the &"cover letter"& of an e-mail from
34788 attached data. It can be used to clamp down on flashy or unnecessarily encoded
34789 content in the cover letter, while not restricting attachments at all.
34790
34791 The variable contains 1 (true) for a MIME part believed to be part of the
34792 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
34793 follows:
34794
34795 .olist
34796 The outermost MIME part of a message is always a cover letter.
34797
34798 .next
34799 If a multipart/alternative or multipart/related MIME part is a cover letter,
34800 so are all MIME subparts within that multipart.
34801
34802 .next
34803 If any other multipart is a cover letter, the first subpart is a cover letter,
34804 and the rest are attachments.
34805
34806 .next
34807 All parts contained within an attachment multipart are attachments.
34808 .endlist olist
34809
34810 As an example, the following will ban &"HTML mail"& (including that sent with
34811 alternative plain text), while allowing HTML files to be attached. HTML
34812 coverletter mail attached to non-HTML coverletter mail will also be allowed:
34813 .code
34814 deny !condition = $mime_is_rfc822
34815      condition = $mime_is_coverletter
34816      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
34817      message = HTML mail is not accepted here
34818 .endd
34819
34820 .vitem &$mime_is_multipart$&
34821 .vindex &$mime_is_multipart$&
34822 This variable has the value 1 (true) when the current part has the main type
34823 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
34824 Since multipart entities only serve as containers for other parts, you may not
34825 want to carry out specific actions on them.
34826
34827 .vitem &$mime_is_rfc822$&
34828 .vindex &$mime_is_rfc822$&
34829 This variable has the value 1 (true) if the current part is not a part of the
34830 checked message itself, but part of an attached message. Attached message
34831 decoding is fully recursive.
34832
34833 .vitem &$mime_part_count$&
34834 .vindex &$mime_part_count$&
34835 This variable is a counter that is raised for each processed MIME part. It
34836 starts at zero for the very first part (which is usually a multipart). The
34837 counter is per-message, so it is reset when processing RFC822 attachments (see
34838 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
34839 complete, so you can use it in the DATA ACL to determine the number of MIME
34840 parts of a message. For non-MIME messages, this variable contains the value -1.
34841 .endlist
34842
34843
34844
34845 .section "Scanning with regular expressions" "SECTscanregex"
34846 .cindex "content scanning" "with regular expressions"
34847 .cindex "regular expressions" "content scanning with"
34848 You can specify your own custom regular expression matches on the full body of
34849 the message, or on individual MIME parts.
34850
34851 The &%regex%& condition takes one or more regular expressions as arguments and
34852 matches them against the full message (when called in the DATA ACL) or a raw
34853 MIME part (when called in the MIME ACL). The &%regex%& condition matches
34854 linewise, with a maximum line length of 32K characters. That means you cannot
34855 have multiline matches with the &%regex%& condition.
34856
34857 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
34858 to 32K of decoded content (the whole content at once, not linewise). If the
34859 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
34860 is decoded automatically when &%mime_regex%& is executed (using default path
34861 and filename values). If the decoded data is larger than  32K, only the first
34862 32K characters are checked.
34863
34864 The regular expressions are passed as a colon-separated list. To include a
34865 literal colon, you must double it. Since the whole right-hand side string is
34866 expanded before being used, you must also escape dollar signs and backslashes
34867 with more backslashes, or use the &`\N`& facility to disable expansion.
34868 Here is a simple example that contains two regular expressions:
34869 .code
34870 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
34871      message = contains blacklisted regex ($regex_match_string)
34872 .endd
34873 The conditions returns true if any one of the regular expressions matches. The
34874 &$regex_match_string$& expansion variable is then set up and contains the
34875 matching regular expression.
34876 The expansion variables &$regex1$& &$regex2$& etc
34877 are set to any substrings captured by the regular expression.
34878
34879 &*Warning*&: With large messages, these conditions can be fairly
34880 CPU-intensive.
34881
34882 .ecindex IIDcosca
34883
34884
34885
34886
34887 . ////////////////////////////////////////////////////////////////////////////
34888 . ////////////////////////////////////////////////////////////////////////////
34889
34890 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
34891          "Local scan function"
34892 .scindex IIDlosca "&[local_scan()]& function" "description of"
34893 .cindex "customizing" "input scan using C function"
34894 .cindex "policy control" "by local scan function"
34895 In these days of email worms, viruses, and ever-increasing spam, some sites
34896 want to apply a lot of checking to messages before accepting them.
34897
34898 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
34899 passing messages to external virus and spam scanning software. You can also do
34900 a certain amount in Exim itself through string expansions and the &%condition%&
34901 condition in the ACL that runs after the SMTP DATA command or the ACL for
34902 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
34903
34904 To allow for further customization to a site's own requirements, there is the
34905 possibility of linking Exim with a private message scanning function, written
34906 in C. If you want to run code that is written in something other than C, you
34907 can of course use a little C stub to call it.
34908
34909 The local scan function is run once for every incoming message, at the point
34910 when Exim is just about to accept the message.
34911 It can therefore be used to control non-SMTP messages from local processes as
34912 well as messages arriving via SMTP.
34913
34914 Exim applies a timeout to calls of the local scan function, and there is an
34915 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
34916 Zero means &"no timeout"&.
34917 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
34918 before calling the local scan function, so that the most common types of crash
34919 are caught. If the timeout is exceeded or one of those signals is caught, the
34920 incoming message is rejected with a temporary error if it is an SMTP message.
34921 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
34922 code. The incident is logged on the main and reject logs.
34923
34924
34925
34926 .section "Building Exim to use a local scan function" "SECID207"
34927 .cindex "&[local_scan()]& function" "building Exim to use"
34928 To make use of the local scan function feature, you must tell Exim where your
34929 function is before building Exim, by setting
34930 both HAVE_LOCAL_SCAN and
34931 LOCAL_SCAN_SOURCE in your
34932 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
34933 directory, so you might set
34934 .code
34935 HAVE_LOCAL_SCAN=yes
34936 LOCAL_SCAN_SOURCE=Local/local_scan.c
34937 .endd
34938 for example. The function must be called &[local_scan()]&;
34939 the source file(s) for it should first #define LOCAL_SCAN
34940 and then #include "local_scan.h".
34941 It is called by
34942 Exim after it has received a message, when the success return code is about to
34943 be sent. This is after all the ACLs have been run. The return code from your
34944 function controls whether the message is actually accepted or not. There is a
34945 commented template function (that just accepts the message) in the file
34946 _src/local_scan.c_.
34947
34948 If you want to make use of Exim's runtime configuration file to set options
34949 for your &[local_scan()]& function, you must also set
34950 .code
34951 LOCAL_SCAN_HAS_OPTIONS=yes
34952 .endd
34953 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
34954
34955
34956
34957
34958 .section "API for local_scan()" "SECTapiforloc"
34959 .cindex "&[local_scan()]& function" "API description"
34960 .cindex &%dlfunc%& "API description"
34961 You must include this line near the start of your code:
34962 .code
34963 #define LOCAL_SCAN
34964 #include "local_scan.h"
34965 .endd
34966 This header file defines a number of variables and other values, and the
34967 prototype for the function itself. Exim is coded to use unsigned char values
34968 almost exclusively, and one of the things this header defines is a shorthand
34969 for &`unsigned char`& called &`uschar`&.
34970 It also makes available the following macro definitions, to simplify casting character
34971 strings and pointers to character strings:
34972 .code
34973 #define CS   (char *)
34974 #define CCS  (const char *)
34975 #define CSS  (char **)
34976 #define US   (unsigned char *)
34977 #define CUS  (const unsigned char *)
34978 #define USS  (unsigned char **)
34979 .endd
34980 The function prototype for &[local_scan()]& is:
34981 .code
34982 extern int local_scan(int fd, uschar **return_text);
34983 .endd
34984 The arguments are as follows:
34985
34986 .ilist
34987 &%fd%& is a file descriptor for the file that contains the body of the message
34988 (the -D file). The file is open for reading and writing, but updating it is not
34989 recommended. &*Warning*&: You must &'not'& close this file descriptor.
34990
34991 The descriptor is positioned at character 19 of the file, which is the first
34992 character of the body itself, because the first 19 characters are the message
34993 id followed by &`-D`& and a newline. If you rewind the file, you should use the
34994 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
34995 case this changes in some future version.
34996 .next
34997 &%return_text%& is an address which you can use to return a pointer to a text
34998 string at the end of the function. The value it points to on entry is NULL.
34999 .endlist
35000
35001 The function must return an &%int%& value which is one of the following macros:
35002
35003 .vlist
35004 .vitem &`LOCAL_SCAN_ACCEPT`&
35005 .vindex "&$local_scan_data$&"
35006 The message is accepted. If you pass back a string of text, it is saved with
35007 the message, and made available in the variable &$local_scan_data$&. No
35008 newlines are permitted (if there are any, they are turned into spaces) and the
35009 maximum length of text is 1000 characters.
35010
35011 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
35012 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35013 queued without immediate delivery, and is frozen.
35014
35015 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
35016 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
35017 queued without immediate delivery.
35018
35019 .vitem &`LOCAL_SCAN_REJECT`&
35020 The message is rejected; the returned text is used as an error message which is
35021 passed back to the sender and which is also logged. Newlines are permitted &--
35022 they cause a multiline response for SMTP rejections, but are converted to
35023 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
35024 used.
35025
35026 .vitem &`LOCAL_SCAN_TEMPREJECT`&
35027 The message is temporarily rejected; the returned text is used as an error
35028 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
35029 problem"& is used.
35030
35031 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
35032 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
35033 message is not written to the reject log. It has the effect of unsetting the
35034 &%rejected_header%& log selector for just this rejection. If
35035 &%rejected_header%& is already unset (see the discussion of the
35036 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
35037 same as LOCAL_SCAN_REJECT.
35038
35039 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
35040 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
35041 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
35042 .endlist
35043
35044 If the message is not being received by interactive SMTP, rejections are
35045 reported by writing to &%stderr%& or by sending an email, as configured by the
35046 &%-oe%& command line options.
35047
35048
35049
35050 .section "Configuration options for local_scan()" "SECTconoptloc"
35051 .cindex "&[local_scan()]& function" "configuration options"
35052 It is possible to have option settings in the main configuration file
35053 that set values in static variables in the &[local_scan()]& module. If you
35054 want to do this, you must have the line
35055 .code
35056 LOCAL_SCAN_HAS_OPTIONS=yes
35057 .endd
35058 in your &_Local/Makefile_& when you build Exim. (This line is in
35059 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
35060 file, you must define static variables to hold the option values, and a table
35061 to define them.
35062
35063 The table must be a vector called &%local_scan_options%&, of type
35064 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
35065 and a pointer to the variable that holds the value. The entries must appear in
35066 alphabetical order. Following &%local_scan_options%& you must also define a
35067 variable called &%local_scan_options_count%& that contains the number of
35068 entries in the table. Here is a short example, showing two kinds of option:
35069 .code
35070 static int my_integer_option = 42;
35071 static uschar *my_string_option = US"a default string";
35072
35073 optionlist local_scan_options[] = {
35074   { "my_integer", opt_int,       &my_integer_option },
35075   { "my_string",  opt_stringptr, &my_string_option }
35076 };
35077
35078 int local_scan_options_count =
35079   sizeof(local_scan_options)/sizeof(optionlist);
35080 .endd
35081 The values of the variables can now be changed from Exim's runtime
35082 configuration file by including a local scan section as in this example:
35083 .code
35084 begin local_scan
35085 my_integer = 99
35086 my_string = some string of text...
35087 .endd
35088 The available types of option data are as follows:
35089
35090 .vlist
35091 .vitem &*opt_bool*&
35092 This specifies a boolean (true/false) option. The address should point to a
35093 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
35094 that are defined as &"1"& and &"0"&, respectively. If you want to detect
35095 whether such a variable has been set at all, you can initialize it to
35096 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
35097 values.)
35098
35099 .vitem &*opt_fixed*&
35100 This specifies a fixed point number, such as is used for load averages.
35101 The address should point to a variable of type &`int`&. The value is stored
35102 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
35103
35104 .vitem &*opt_int*&
35105 This specifies an integer; the address should point to a variable of type
35106 &`int`&. The value may be specified in any of the integer formats accepted by
35107 Exim.
35108
35109 .vitem &*opt_mkint*&
35110 This is the same as &%opt_int%&, except that when such a value is output in a
35111 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
35112 printed with the suffix K or M.
35113
35114 .vitem &*opt_octint*&
35115 This also specifies an integer, but the value is always interpreted as an
35116 octal integer, whether or not it starts with the digit zero, and it is
35117 always output in octal.
35118
35119 .vitem &*opt_stringptr*&
35120 This specifies a string value; the address must be a pointer to a
35121 variable that points to a string (for example, of type &`uschar *`&).
35122
35123 .vitem &*opt_time*&
35124 This specifies a time interval value. The address must point to a variable of
35125 type &`int`&. The value that is placed there is a number of seconds.
35126 .endlist
35127
35128 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
35129 out the values of all the &[local_scan()]& options.
35130
35131
35132
35133 .section "Available Exim variables" "SECID208"
35134 .cindex "&[local_scan()]& function" "available Exim variables"
35135 The header &_local_scan.h_& gives you access to a number of C variables. These
35136 are the only ones that are guaranteed to be maintained from release to release.
35137 Note, however, that you can obtain the value of any Exim expansion variable,
35138 including &$recipients$&, by calling &'expand_string()'&. The exported
35139 C variables are as follows:
35140
35141 .vlist
35142 .vitem &*int&~body_linecount*&
35143 This variable contains the number of lines in the message's body.
35144 It is not valid if the &%spool_wireformat%& option is used.
35145
35146 .vitem &*int&~body_zerocount*&
35147 This variable contains the number of binary zero bytes in the message's body.
35148 It is not valid if the &%spool_wireformat%& option is used.
35149
35150 .vitem &*unsigned&~int&~debug_selector*&
35151 This variable is set to zero when no debugging is taking place. Otherwise, it
35152 is a bitmap of debugging selectors. Two bits are identified for use in
35153 &[local_scan()]&; they are defined as macros:
35154
35155 .ilist
35156 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
35157 testing option that is not privileged &-- any caller may set it. All the
35158 other selector bits can be set only by admin users.
35159
35160 .next
35161 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
35162 by the &`+local_scan`& debug selector. It is not included in the default set
35163 of debugging bits.
35164 .endlist ilist
35165
35166 Thus, to write to the debugging output only when &`+local_scan`& has been
35167 selected, you should use code like this:
35168 .code
35169 if ((debug_selector & D_local_scan) != 0)
35170   debug_printf("xxx", ...);
35171 .endd
35172 .vitem &*uschar&~*expand_string_message*&
35173 After a failing call to &'expand_string()'& (returned value NULL), the
35174 variable &%expand_string_message%& contains the error message, zero-terminated.
35175
35176 .vitem &*header_line&~*header_list*&
35177 A pointer to a chain of header lines. The &%header_line%& structure is
35178 discussed below.
35179
35180 .vitem &*header_line&~*header_last*&
35181 A pointer to the last of the header lines.
35182
35183 .vitem &*uschar&~*headers_charset*&
35184 The value of the &%headers_charset%& configuration option.
35185
35186 .vitem &*BOOL&~host_checking*&
35187 This variable is TRUE during a host checking session that is initiated by the
35188 &%-bh%& command line option.
35189
35190 .vitem &*uschar&~*interface_address*&
35191 The IP address of the interface that received the message, as a string. This
35192 is NULL for locally submitted messages.
35193
35194 .vitem &*int&~interface_port*&
35195 The port on which this message was received. When testing with the &%-bh%&
35196 command line option, the value of this variable is -1 unless a port has been
35197 specified via the &%-oMi%& option.
35198
35199 .vitem &*uschar&~*message_id*&
35200 This variable contains Exim's message id for the incoming message (the value of
35201 &$message_exim_id$&) as a zero-terminated string.
35202
35203 .vitem &*uschar&~*received_protocol*&
35204 The name of the protocol by which the message was received.
35205
35206 .vitem &*int&~recipients_count*&
35207 The number of accepted recipients.
35208
35209 .vitem &*recipient_item&~*recipients_list*&
35210 .cindex "recipient" "adding in local scan"
35211 .cindex "recipient" "removing in local scan"
35212 The list of accepted recipients, held in a vector of length
35213 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
35214 can add additional recipients by calling &'receive_add_recipient()'& (see
35215 below). You can delete recipients by removing them from the vector and
35216 adjusting the value in &%recipients_count%&. In particular, by setting
35217 &%recipients_count%& to zero you remove all recipients. If you then return the
35218 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
35219 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
35220 and then call &'receive_add_recipient()'& as often as needed.
35221
35222 .vitem &*uschar&~*sender_address*&
35223 The envelope sender address. For bounce messages this is the empty string.
35224
35225 .vitem &*uschar&~*sender_host_address*&
35226 The IP address of the sending host, as a string. This is NULL for
35227 locally-submitted messages.
35228
35229 .vitem &*uschar&~*sender_host_authenticated*&
35230 The name of the authentication mechanism that was used, or NULL if the message
35231 was not received over an authenticated SMTP connection.
35232
35233 .vitem &*uschar&~*sender_host_name*&
35234 The name of the sending host, if known.
35235
35236 .vitem &*int&~sender_host_port*&
35237 The port on the sending host.
35238
35239 .vitem &*BOOL&~smtp_input*&
35240 This variable is TRUE for all SMTP input, including BSMTP.
35241
35242 .vitem &*BOOL&~smtp_batched_input*&
35243 This variable is TRUE for BSMTP input.
35244
35245 .vitem &*int&~store_pool*&
35246 The contents of this variable control which pool of memory is used for new
35247 requests. See section &<<SECTmemhanloc>>& for details.
35248 .endlist
35249
35250
35251 .section "Structure of header lines" "SECID209"
35252 The &%header_line%& structure contains the members listed below.
35253 You can add additional header lines by calling the &'header_add()'& function
35254 (see below). You can cause header lines to be ignored (deleted) by setting
35255 their type to *.
35256
35257
35258 .vlist
35259 .vitem &*struct&~header_line&~*next*&
35260 A pointer to the next header line, or NULL for the last line.
35261
35262 .vitem &*int&~type*&
35263 A code identifying certain headers that Exim recognizes. The codes are printing
35264 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
35265 Notice in particular that any header line whose type is * is not transmitted
35266 with the message. This flagging is used for header lines that have been
35267 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
35268 lines.) Effectively, * means &"deleted"&.
35269
35270 .vitem &*int&~slen*&
35271 The number of characters in the header line, including the terminating and any
35272 internal newlines.
35273
35274 .vitem &*uschar&~*text*&
35275 A pointer to the text of the header. It always ends with a newline, followed by
35276 a zero byte. Internal newlines are preserved.
35277 .endlist
35278
35279
35280
35281 .section "Structure of recipient items" "SECID210"
35282 The &%recipient_item%& structure contains these members:
35283
35284 .vlist
35285 .vitem &*uschar&~*address*&
35286 This is a pointer to the recipient address as it was received.
35287
35288 .vitem &*int&~pno*&
35289 This is used in later Exim processing when top level addresses are created by
35290 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
35291 and must always contain -1 at this stage.
35292
35293 .vitem &*uschar&~*errors_to*&
35294 If this value is not NULL, bounce messages caused by failing to deliver to the
35295 recipient are sent to the address it contains. In other words, it overrides the
35296 envelope sender for this one recipient. (Compare the &%errors_to%& generic
35297 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
35298 an unqualified address, Exim qualifies it using the domain from
35299 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
35300 is NULL for all recipients.
35301 .endlist
35302
35303
35304
35305 .section "Available Exim functions" "SECID211"
35306 .cindex "&[local_scan()]& function" "available Exim functions"
35307 The header &_local_scan.h_& gives you access to a number of Exim functions.
35308 These are the only ones that are guaranteed to be maintained from release to
35309 release:
35310
35311 .vlist
35312 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
35313        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
35314
35315 This function creates a child process that runs the command specified by
35316 &%argv%&. The environment for the process is specified by &%envp%&, which can
35317 be NULL if no environment variables are to be passed. A new umask is supplied
35318 for the process in &%newumask%&.
35319
35320 Pipes to the standard input and output of the new process are set up
35321 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
35322 standard error is cloned to the standard output. If there are any file
35323 descriptors &"in the way"& in the new process, they are closed. If the final
35324 argument is TRUE, the new process is made into a process group leader.
35325
35326 The function returns the pid of the new process, or -1 if things go wrong.
35327
35328 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
35329 This function waits for a child process to terminate, or for a timeout (in
35330 seconds) to expire. A timeout value of zero means wait as long as it takes. The
35331 return value is as follows:
35332
35333 .ilist
35334 >= 0
35335
35336 The process terminated by a normal exit and the value is the process
35337 ending status.
35338
35339 .next
35340 < 0 and > &--256
35341
35342 The process was terminated by a signal and the value is the negation of the
35343 signal number.
35344
35345 .next
35346 &--256
35347
35348 The process timed out.
35349 .next
35350 &--257
35351
35352 The was some other error in wait(); &%errno%& is still set.
35353 .endlist
35354
35355 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
35356 This function provide you with a means of submitting a new message to
35357 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
35358 want, but this packages it all up for you.) The function creates a pipe,
35359 forks a subprocess that is running
35360 .code
35361 exim -t -oem -oi -f <>
35362 .endd
35363 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
35364 that is connected to the standard input. The yield of the function is the PID
35365 of the subprocess. You can then write a message to the file descriptor, with
35366 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
35367
35368 When you have finished, call &'child_close()'& to wait for the process to
35369 finish and to collect its ending status. A timeout value of zero is usually
35370 fine in this circumstance. Unless you have made a mistake with the recipient
35371 addresses, you should get a return code of zero.
35372
35373
35374 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
35375        *sender_authentication)*&
35376 This function is a more sophisticated version of &'child_open()'&. The command
35377 that it runs is:
35378 .display
35379 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
35380 .endd
35381 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
35382
35383
35384 .vitem &*void&~debug_printf(char&~*,&~...)*&
35385 This is Exim's debugging function, with arguments as for &'(printf()'&. The
35386 output is written to the standard error stream. If no debugging is selected,
35387 calls to &'debug_printf()'& have no effect. Normally, you should make calls
35388 conditional on the &`local_scan`& debug selector by coding like this:
35389 .code
35390 if ((debug_selector & D_local_scan) != 0)
35391   debug_printf("xxx", ...);
35392 .endd
35393
35394 .vitem &*uschar&~*expand_string(uschar&~*string)*&
35395 This is an interface to Exim's string expansion code. The return value is the
35396 expanded string, or NULL if there was an expansion failure.
35397 The C variable &%expand_string_message%& contains an error message after an
35398 expansion failure. If expansion does not change the string, the return value is
35399 the pointer to the input string. Otherwise, the return value points to a new
35400 block of memory that was obtained by a call to &'store_get()'&. See section
35401 &<<SECTmemhanloc>>& below for a discussion of memory handling.
35402
35403 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
35404 This function allows you to an add additional header line at the end of the
35405 existing ones. The first argument is the type, and should normally be a space
35406 character. The second argument is a format string and any number of
35407 substitution arguments as for &[sprintf()]&. You may include internal newlines
35408 if you want, and you must ensure that the string ends with a newline.
35409
35410 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
35411         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
35412 This function adds a new header line at a specified point in the header
35413 chain. The header itself is specified as for &'header_add()'&.
35414
35415 If &%name%& is NULL, the new header is added at the end of the chain if
35416 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
35417 NULL, the header lines are searched for the first non-deleted header that
35418 matches the name. If one is found, the new header is added before it if
35419 &%after%& is false. If &%after%& is true, the new header is added after the
35420 found header and any adjacent subsequent ones with the same name (even if
35421 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
35422 option controls where the header is added. If it is true, addition is at the
35423 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
35424 headers, or at the top if there are no &'Received:'& headers, you could use
35425 .code
35426 header_add_at_position(TRUE, US"Received", TRUE,
35427   ' ', "X-xxx: ...");
35428 .endd
35429 Normally, there is always at least one non-deleted &'Received:'& header, but
35430 there may not be if &%received_header_text%& expands to an empty string.
35431
35432
35433 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
35434 This function removes header lines. If &%occurrence%& is zero or negative, all
35435 occurrences of the header are removed. If occurrence is greater than zero, that
35436 particular instance of the header is removed. If no header(s) can be found that
35437 match the specification, the function does nothing.
35438
35439
35440 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
35441         int&~length,&~BOOL&~notdel)*&"
35442 This function tests whether the given header has the given name. It is not just
35443 a string comparison, because white space is permitted between the name and the
35444 colon. If the &%notdel%& argument is true, a false return is forced for all
35445 &"deleted"& headers; otherwise they are not treated specially. For example:
35446 .code
35447 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
35448 .endd
35449 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
35450 .cindex "base64 encoding" "functions for &[local_scan()]& use"
35451 This function base64-encodes a string, which is passed by address and length.
35452 The text may contain bytes of any value, including zero. The result is passed
35453 back in dynamic memory that is obtained by calling &'store_get()'&. It is
35454 zero-terminated.
35455
35456 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
35457 This function decodes a base64-encoded string. Its arguments are a
35458 zero-terminated base64-encoded string and the address of a variable that is set
35459 to point to the result, which is in dynamic memory. The length of the decoded
35460 string is the yield of the function. If the input is invalid base64 data, the
35461 yield is -1. A zero byte is added to the end of the output string to make it
35462 easy to interpret as a C string (assuming it contains no zeros of its own). The
35463 added zero byte is not included in the returned count.
35464
35465 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
35466 This function checks for a match in a domain list. Domains are always
35467 matched caselessly. The return value is one of the following:
35468 .display
35469 &`OK     `& match succeeded
35470 &`FAIL   `& match failed
35471 &`DEFER  `& match deferred
35472 .endd
35473 DEFER is usually caused by some kind of lookup defer, such as the
35474 inability to contact a database.
35475
35476 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
35477         BOOL&~caseless)*&"
35478 This function checks for a match in a local part list. The third argument
35479 controls case-sensitivity. The return values are as for
35480 &'lss_match_domain()'&.
35481
35482 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
35483         BOOL&~caseless)*&"
35484 This function checks for a match in an address list. The third argument
35485 controls the case-sensitivity of the local part match. The domain is always
35486 matched caselessly. The return values are as for &'lss_match_domain()'&.
35487
35488 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
35489         uschar&~*list)*&"
35490 This function checks for a match in a host list. The most common usage is
35491 expected to be
35492 .code
35493 lss_match_host(sender_host_name, sender_host_address, ...)
35494 .endd
35495 .vindex "&$sender_host_address$&"
35496 An empty address field matches an empty item in the host list. If the host name
35497 is NULL, the name corresponding to &$sender_host_address$& is automatically
35498 looked up if a host name is required to match an item in the list. The return
35499 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
35500 returns ERROR in the case when it had to look up a host name, but the lookup
35501 failed.
35502
35503 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
35504         *format,&~...)*&"
35505 This function writes to Exim's log files. The first argument should be zero (it
35506 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
35507 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
35508 them. It specifies to which log or logs the message is written. The remaining
35509 arguments are a format and relevant insertion arguments. The string should not
35510 contain any newlines, not even at the end.
35511
35512
35513 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
35514 This function adds an additional recipient to the message. The first argument
35515 is the recipient address. If it is unqualified (has no domain), it is qualified
35516 with the &%qualify_recipient%& domain. The second argument must always be -1.
35517
35518 This function does not allow you to specify a private &%errors_to%& address (as
35519 described with the structure of &%recipient_item%& above), because it pre-dates
35520 the addition of that field to the structure. However, it is easy to add such a
35521 value afterwards. For example:
35522 .code
35523  receive_add_recipient(US"monitor@mydom.example", -1);
35524  recipients_list[recipients_count-1].errors_to =
35525    US"postmaster@mydom.example";
35526 .endd
35527
35528 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
35529 This is a convenience function to remove a named recipient from the list of
35530 recipients. It returns true if a recipient was removed, and false if no
35531 matching recipient could be found. The argument must be a complete email
35532 address.
35533 .endlist
35534
35535
35536 .cindex "RFC 2047"
35537 .vlist
35538 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
35539   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
35540 This function decodes strings that are encoded according to RFC 2047. Typically
35541 these are the contents of header lines. First, each &"encoded word"& is decoded
35542 from the Q or B encoding into a byte-string. Then, if provided with the name of
35543 a charset encoding, and if the &[iconv()]& function is available, an attempt is
35544 made  to translate the result to the named character set. If this fails, the
35545 binary string is returned with an error message.
35546
35547 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
35548 maximum MIME word length is enforced. The third argument is the target
35549 encoding, or NULL if no translation is wanted.
35550
35551 .cindex "binary zero" "in RFC 2047 decoding"
35552 .cindex "RFC 2047" "binary zero in"
35553 If a binary zero is encountered in the decoded string, it is replaced by the
35554 contents of the &%zeroval%& argument. For use with Exim headers, the value must
35555 not be 0 because header lines are handled as zero-terminated strings.
35556
35557 The function returns the result of processing the string, zero-terminated; if
35558 &%lenptr%& is not NULL, the length of the result is set in the variable to
35559 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
35560
35561 If an error is encountered, the function returns NULL and uses the &%error%&
35562 argument to return an error message. The variable pointed to by &%error%& is
35563 set to NULL if there is no error; it may be set non-NULL even when the function
35564 returns a non-NULL value if decoding was successful, but there was a problem
35565 with translation.
35566
35567
35568 .vitem &*int&~smtp_fflush(void)*&
35569 This function is used in conjunction with &'smtp_printf()'&, as described
35570 below.
35571
35572 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
35573 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
35574 output stream. You should use this function only when there is an SMTP output
35575 stream, that is, when the incoming message is being received via interactive
35576 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
35577 is FALSE. If you want to test for an incoming message from another host (as
35578 opposed to a local process that used the &%-bs%& command line option), you can
35579 test the value of &%sender_host_address%&, which is non-NULL when a remote host
35580 is involved.
35581
35582 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
35583 output function, so it can be used for all forms of SMTP connection.
35584
35585 The second argument is used to request that the data be buffered
35586 (when TRUE) or flushed (along with any previously buffered, when FALSE).
35587 This is advisory only, but likely to save on system-calls and packets
35588 sent when a sequence of calls to the function are made.
35589
35590 The argument was added in Exim version 4.90 - changing the API/ABI.
35591 Nobody noticed until 4.93 was imminent, at which point the
35592 ABI version number was incremented.
35593
35594 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
35595 must start with an appropriate response code: 550 if you are going to return
35596 LOCAL_SCAN_REJECT, 451 if you are going to return
35597 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
35598 initial lines of a multi-line response, the code must be followed by a hyphen
35599 to indicate that the line is not the final response line. You must also ensure
35600 that the lines you write terminate with CRLF. For example:
35601 .code
35602 smtp_printf("550-this is some extra info\r\n");
35603 return LOCAL_SCAN_REJECT;
35604 .endd
35605 Note that you can also create multi-line responses by including newlines in
35606 the data returned via the &%return_text%& argument. The added value of using
35607 &'smtp_printf()'& is that, for instance, you could introduce delays between
35608 multiple output lines.
35609
35610 The &'smtp_printf()'& function does not return any error indication, because it
35611 does not
35612 guarantee a flush of
35613 pending output, and therefore does not test
35614 the state of the stream. (In the main code of Exim, flushing and error
35615 detection is done when Exim is ready for the next SMTP input command.) If
35616 you want to flush the output and check for an error (for example, the
35617 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
35618 arguments. It flushes the output stream, and returns a non-zero value if there
35619 is an error.
35620
35621 .vitem &*void&~*store_get(int,BOOL)*&
35622 This function accesses Exim's internal store (memory) manager. It gets a new
35623 chunk of memory whose size is given by the first argument.
35624 The second argument should be given as TRUE if the memory will be used for
35625 data possibly coming from an attacker (eg. the message content),
35626 FALSE if it is locally-sourced.
35627 Exim bombs out if it ever
35628 runs out of memory. See the next section for a discussion of memory handling.
35629
35630 .vitem &*void&~*store_get_perm(int,BOOL)*&
35631 This function is like &'store_get()'&, but it always gets memory from the
35632 permanent pool. See the next section for a discussion of memory handling.
35633
35634 .vitem &*uschar&~*string_copy(uschar&~*string)*&
35635 See below.
35636
35637 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
35638 See below.
35639
35640 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
35641 These three functions create strings using Exim's dynamic memory facilities.
35642 The first makes a copy of an entire string. The second copies up to a maximum
35643 number of characters, indicated by the second argument. The third uses a format
35644 and insertion arguments to create a new string. In each case, the result is a
35645 pointer to a new string in the current memory pool. See the next section for
35646 more discussion.
35647 .endlist
35648
35649
35650
35651 .section "More about Exim's memory handling" "SECTmemhanloc"
35652 .cindex "&[local_scan()]& function" "memory handling"
35653 No function is provided for freeing memory, because that is never needed.
35654 The dynamic memory that Exim uses when receiving a message is automatically
35655 recycled if another message is received by the same process (this applies only
35656 to incoming SMTP connections &-- other input methods can supply only one
35657 message at a time). After receiving the last message, a reception process
35658 terminates.
35659
35660 Because it is recycled, the normal dynamic memory cannot be used for holding
35661 data that must be preserved over a number of incoming messages on the same SMTP
35662 connection. However, Exim in fact uses two pools of dynamic memory; the second
35663 one is not recycled, and can be used for this purpose.
35664
35665 If you want to allocate memory that remains available for subsequent messages
35666 in the same SMTP connection, you should set
35667 .code
35668 store_pool = POOL_PERM
35669 .endd
35670 before calling the function that does the allocation. There is no need to
35671 restore the value if you do not need to; however, if you do want to revert to
35672 the normal pool, you can either restore the previous value of &%store_pool%& or
35673 set it explicitly to POOL_MAIN.
35674
35675 The pool setting applies to all functions that get dynamic memory, including
35676 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
35677 There is also a convenience function called &'store_get_perm()'& that gets a
35678 block of memory from the permanent pool while preserving the value of
35679 &%store_pool%&.
35680 .ecindex IIDlosca
35681
35682
35683
35684
35685 . ////////////////////////////////////////////////////////////////////////////
35686 . ////////////////////////////////////////////////////////////////////////////
35687
35688 .chapter "System-wide message filtering" "CHAPsystemfilter"
35689 .scindex IIDsysfil1 "filter" "system filter"
35690 .scindex IIDsysfil2 "filtering all mail"
35691 .scindex IIDsysfil3 "system filter"
35692 The previous chapters (on ACLs and the local scan function) describe checks
35693 that can be applied to messages before they are accepted by a host. There is
35694 also a mechanism for checking messages once they have been received, but before
35695 they are delivered. This is called the &'system filter'&.
35696
35697 The system filter operates in a similar manner to users' filter files, but it
35698 is run just once per message (however many recipients the message has).
35699 It should not normally be used as a substitute for routing, because &%deliver%&
35700 commands in a system router provide new envelope recipient addresses.
35701 The system filter must be an Exim filter. It cannot be a Sieve filter.
35702
35703 The system filter is run at the start of a delivery attempt, before any routing
35704 is done. If a message fails to be completely delivered at the first attempt,
35705 the system filter is run again at the start of every retry.
35706 If you want your filter to do something only once per message, you can make use
35707 of the &%first_delivery%& condition in an &%if%& command in the filter to
35708 prevent it happening on retries.
35709
35710 .vindex "&$domain$&"
35711 .vindex "&$local_part$&"
35712 &*Warning*&: Because the system filter runs just once, variables that are
35713 specific to individual recipient addresses, such as &$local_part$& and
35714 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
35715 you want to run a centrally-specified filter for each recipient address
35716 independently, you can do so by setting up a suitable &(redirect)& router, as
35717 described in section &<<SECTperaddfil>>& below.
35718
35719
35720 .section "Specifying a system filter" "SECID212"
35721 .cindex "uid (user id)" "system filter"
35722 .cindex "gid (group id)" "system filter"
35723 The name of the file that contains the system filter must be specified by
35724 setting &%system_filter%&. If you want the filter to run under a uid and gid
35725 other than root, you must also set &%system_filter_user%& and
35726 &%system_filter_group%& as appropriate. For example:
35727 .code
35728 system_filter = /etc/mail/exim.filter
35729 system_filter_user = exim
35730 .endd
35731 If a system filter generates any deliveries directly to files or pipes (via the
35732 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
35733 specified by setting &%system_filter_file_transport%& and
35734 &%system_filter_pipe_transport%&, respectively. Similarly,
35735 &%system_filter_reply_transport%& must be set to handle any messages generated
35736 by the &%reply%& command.
35737
35738
35739 .section "Testing a system filter" "SECID213"
35740 You can run simple tests of a system filter in the same way as for a user
35741 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
35742 are permitted only in system filters are recognized.
35743
35744 If you want to test the combined effect of a system filter and a user filter,
35745 you can use both &%-bF%& and &%-bf%& on the same command line.
35746
35747
35748
35749 .section "Contents of a system filter" "SECID214"
35750 The language used to specify system filters is the same as for users' filter
35751 files. It is described in the separate end-user document &'Exim's interface to
35752 mail filtering'&. However, there are some additional features that are
35753 available only in system filters; these are described in subsequent sections.
35754 If they are encountered in a user's filter file or when testing with &%-bf%&,
35755 they cause errors.
35756
35757 .cindex "frozen messages" "manual thaw; testing in filter"
35758 There are two special conditions which, though available in users' filter
35759 files, are designed for use in system filters. The condition &%first_delivery%&
35760 is true only for the first attempt at delivering a message, and
35761 &%manually_thawed%& is true only if the message has been frozen, and
35762 subsequently thawed by an admin user. An explicit forced delivery counts as a
35763 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
35764
35765 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
35766 specify an &"unseen"& (non-significant) delivery, and that delivery does not
35767 succeed, it will not be tried again.
35768 If you want Exim to retry an unseen delivery until it succeeds, you should
35769 arrange to set it up every time the filter runs.
35770
35771 When a system filter finishes running, the values of the variables &$n0$& &--
35772 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
35773 users' filter files. Thus a system filter can, for example, set up &"scores"&
35774 to which users' filter files can refer.
35775
35776
35777
35778 .section "Additional variable for system filters" "SECID215"
35779 .vindex "&$recipients$&"
35780 The expansion variable &$recipients$&, containing a list of all the recipients
35781 of the message (separated by commas and white space), is available in system
35782 filters. It is not available in users' filters for privacy reasons.
35783
35784
35785
35786 .section "Defer, freeze, and fail commands for system filters" "SECID216"
35787 .cindex "freezing messages"
35788 .cindex "message" "freezing"
35789 .cindex "message" "forced failure"
35790 .cindex "&%fail%&" "in system filter"
35791 .cindex "&%freeze%& in system filter"
35792 .cindex "&%defer%& in system filter"
35793 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
35794 always available in system filters, but are not normally enabled in users'
35795 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
35796 for the &(redirect)& router.) These commands can optionally be followed by the
35797 word &%text%& and a string containing an error message, for example:
35798 .code
35799 fail text "this message looks like spam to me"
35800 .endd
35801 The keyword &%text%& is optional if the next character is a double quote.
35802
35803 The &%defer%& command defers delivery of the original recipients of the
35804 message. The &%fail%& command causes all the original recipients to be failed,
35805 and a bounce message to be created. The &%freeze%& command suspends all
35806 delivery attempts for the original recipients. In all cases, any new deliveries
35807 that are specified by the filter are attempted as normal after the filter has
35808 run.
35809
35810 The &%freeze%& command is ignored if the message has been manually unfrozen and
35811 not manually frozen since. This means that automatic freezing by a system
35812 filter can be used as a way of checking out suspicious messages. If a message
35813 is found to be all right, manually unfreezing it allows it to be delivered.
35814
35815 .cindex "log" "&%fail%& command log line"
35816 .cindex "&%fail%&" "log line; reducing"
35817 The text given with a fail command is used as part of the bounce message as
35818 well as being written to the log. If the message is quite long, this can fill
35819 up a lot of log space when such failures are common. To reduce the size of the
35820 log message, Exim interprets the text in a special way if it starts with the
35821 two characters &`<<`& and contains &`>>`& later. The text between these two
35822 strings is written to the log, and the rest of the text is used in the bounce
35823 message. For example:
35824 .code
35825 fail "<<filter test 1>>Your message is rejected \
35826      because it contains attachments that we are \
35827      not prepared to receive."
35828 .endd
35829
35830 .cindex "loop" "caused by &%fail%&"
35831 Take great care with the &%fail%& command when basing the decision to fail on
35832 the contents of the message, because the bounce message will of course include
35833 the contents of the original message and will therefore trigger the &%fail%&
35834 command again (causing a mail loop) unless steps are taken to prevent this.
35835 Testing the &%error_message%& condition is one way to prevent this. You could
35836 use, for example
35837 .code
35838 if $message_body contains "this is spam" and not error_message
35839 then fail text "spam is not wanted here" endif
35840 .endd
35841 though of course that might let through unwanted bounce messages. The
35842 alternative is clever checking of the body and/or headers to detect bounces
35843 generated by the filter.
35844
35845 The interpretation of a system filter file ceases after a
35846 &%defer%&,
35847 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
35848 set up earlier in the filter file are honoured, so you can use a sequence such
35849 as
35850 .code
35851 mail ...
35852 freeze
35853 .endd
35854 to send a specified message when the system filter is freezing (or deferring or
35855 failing) a message. The normal deliveries for the message do not, of course,
35856 take place.
35857
35858
35859
35860 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
35861 .cindex "header lines" "adding; in system filter"
35862 .cindex "header lines" "removing; in system filter"
35863 .cindex "filter" "header lines; adding/removing"
35864 Two filter commands that are available only in system filters are:
35865 .code
35866 headers add <string>
35867 headers remove <string>
35868 .endd
35869 The argument for the &%headers add%& is a string that is expanded and then
35870 added to the end of the message's headers. It is the responsibility of the
35871 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
35872 space is ignored, and if the string is otherwise empty, or if the expansion is
35873 forced to fail, the command has no effect.
35874
35875 You can use &"\n"& within the string, followed by white space, to specify
35876 continued header lines. More than one header may be added in one command by
35877 including &"\n"& within the string without any following white space. For
35878 example:
35879 .code
35880 headers add "X-header-1: ....\n  \
35881              continuation of X-header-1 ...\n\
35882              X-header-2: ...."
35883 .endd
35884 Note that the header line continuation white space after the first newline must
35885 be placed before the backslash that continues the input string, because white
35886 space after input continuations is ignored.
35887
35888 The argument for &%headers remove%& is a colon-separated list of header names.
35889 This command applies only to those headers that are stored with the message;
35890 those that are added at delivery time (such as &'Envelope-To:'& and
35891 &'Return-Path:'&) cannot be removed by this means. If there is more than one
35892 header with the same name, they are all removed.
35893
35894 The &%headers%& command in a system filter makes an immediate change to the set
35895 of header lines that was received with the message (with possible additions
35896 from ACL processing). Subsequent commands in the system filter operate on the
35897 modified set, which also forms the basis for subsequent message delivery.
35898 Unless further modified during routing or transporting, this set of headers is
35899 used for all recipients of the message.
35900
35901 During routing and transporting, the variables that refer to the contents of
35902 header lines refer only to those lines that are in this set. Thus, header lines
35903 that are added by a system filter are visible to users' filter files and to all
35904 routers and transports. This contrasts with the manipulation of header lines by
35905 routers and transports, which is not immediate, but which instead is saved up
35906 until the message is actually being written (see section
35907 &<<SECTheadersaddrem>>&).
35908
35909 If the message is not delivered at the first attempt, header lines that were
35910 added by the system filter are stored with the message, and so are still
35911 present at the next delivery attempt. Header lines that were removed are still
35912 present, but marked &"deleted"& so that they are not transported with the
35913 message. For this reason, it is usual to make the &%headers%& command
35914 conditional on &%first_delivery%& so that the set of header lines is not
35915 modified more than once.
35916
35917 Because header modification in a system filter acts immediately, you have to
35918 use an indirect approach if you want to modify the contents of a header line.
35919 For example:
35920 .code
35921 headers add "Old-Subject: $h_subject:"
35922 headers remove "Subject"
35923 headers add "Subject: new subject (was: $h_old-subject:)"
35924 headers remove "Old-Subject"
35925 .endd
35926
35927
35928
35929 .section "Setting an errors address in a system filter" "SECID217"
35930 .cindex "envelope from"
35931 .cindex "envelope sender"
35932 In a system filter, if a &%deliver%& command is followed by
35933 .code
35934 errors_to <some address>
35935 .endd
35936 in order to change the envelope sender (and hence the error reporting) for that
35937 delivery, any address may be specified. (In a user filter, only the current
35938 user's address can be set.) For example, if some mail is being monitored, you
35939 might use
35940 .code
35941 unseen deliver monitor@spying.example errors_to root@local.example
35942 .endd
35943 to take a copy which would not be sent back to the normal error reporting
35944 address if its delivery failed.
35945
35946
35947
35948 .section "Per-address filtering" "SECTperaddfil"
35949 .vindex "&$domain_data$&"
35950 .vindex "&$local_part_data$&"
35951 In contrast to the system filter, which is run just once per message for each
35952 delivery attempt, it is also possible to set up a system-wide filtering
35953 operation that runs once for each recipient address. In this case, variables
35954 such as &$local_part_data$& and &$domain_data$& can be used,
35955 and indeed, the choice of filter file could be made dependent on them.
35956 This is an example of a router which implements such a filter:
35957 .code
35958 central_filter:
35959   check_local_user
35960   driver = redirect
35961   domains = +local_domains
35962   file = /central/filters/$local_part_data
35963   no_verify
35964   allow_filter
35965   allow_freeze
35966 .endd
35967 The filter is run in a separate process under its own uid. Therefore, either
35968 &%check_local_user%& must be set (as above), in which case the filter is run as
35969 the local user, or the &%user%& option must be used to specify which user to
35970 use. If both are set, &%user%& overrides.
35971
35972 Care should be taken to ensure that none of the commands in the filter file
35973 specify a significant delivery if the message is to go on to be delivered to
35974 its intended recipient. The router will not then claim to have dealt with the
35975 address, so it will be passed on to subsequent routers to be delivered in the
35976 normal way.
35977 .ecindex IIDsysfil1
35978 .ecindex IIDsysfil2
35979 .ecindex IIDsysfil3
35980
35981
35982
35983
35984
35985
35986 . ////////////////////////////////////////////////////////////////////////////
35987 . ////////////////////////////////////////////////////////////////////////////
35988
35989 .chapter "Message processing" "CHAPmsgproc"
35990 .scindex IIDmesproc "message" "general processing"
35991 Exim performs various transformations on the sender and recipient addresses of
35992 all messages that it handles, and also on the messages' header lines. Some of
35993 these are optional and configurable, while others always take place. All of
35994 this processing, except rewriting as a result of routing, and the addition or
35995 removal of header lines while delivering, happens when a message is received,
35996 before it is placed on Exim's queue.
35997
35998 Some of the automatic processing takes place by default only for
35999 &"locally-originated"& messages. This adjective is used to describe messages
36000 that are not received over TCP/IP, but instead are passed to an Exim process on
36001 its standard input. This includes the interactive &"local SMTP"& case that is
36002 set up by the &%-bs%& command line option.
36003
36004 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
36005 or ::1) are not considered to be locally-originated. Exim does not treat the
36006 loopback interface specially in any way.
36007
36008 If you want the loopback interface to be treated specially, you must ensure
36009 that there are appropriate entries in your ACLs.
36010
36011
36012
36013
36014 .section "Submission mode for non-local messages" "SECTsubmodnon"
36015 .cindex "message" "submission"
36016 .cindex "submission mode"
36017 Processing that happens automatically for locally-originated messages (unless
36018 &%suppress_local_fixups%& is set) can also be requested for messages that are
36019 received over TCP/IP. The term &"submission mode"& is used to describe this
36020 state. Submission mode is set by the modifier
36021 .code
36022 control = submission
36023 .endd
36024 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
36025 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
36026 a local submission, and is normally used when the source of the message is
36027 known to be an MUA running on a client host (as opposed to an MTA). For
36028 example, to set submission mode for messages originating on the IPv4 loopback
36029 interface, you could include the following in the MAIL ACL:
36030 .code
36031 warn  hosts = 127.0.0.1
36032       control = submission
36033 .endd
36034 .cindex "&%sender_retain%& submission option"
36035 There are some options that can be used when setting submission mode. A slash
36036 is used to separate options. For example:
36037 .code
36038 control = submission/sender_retain
36039 .endd
36040 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
36041 true and &%local_from_check%& false for the current incoming message. The first
36042 of these allows an existing &'Sender:'& header in the message to remain, and
36043 the second suppresses the check to ensure that &'From:'& matches the
36044 authenticated sender. With this setting, Exim still fixes up messages by adding
36045 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
36046 attempt to check sender authenticity in header lines.
36047
36048 When &%sender_retain%& is not set, a submission mode setting may specify a
36049 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
36050 example:
36051 .code
36052 control = submission/domain=some.domain
36053 .endd
36054 The domain may be empty. How this value is used is described in sections
36055 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
36056 that allows you to specify the user's full name for inclusion in a created
36057 &'Sender:'& or &'From:'& header line. For example:
36058 .code
36059 accept authenticated = *
36060        control = submission/domain=wonderland.example/\
36061                             name=${lookup {$authenticated_id} \
36062                                    lsearch {/etc/exim/namelist}}
36063 .endd
36064 Because the name may contain any characters, including slashes, the &%name%&
36065 option must be given last. The remainder of the string is used as the name. For
36066 the example above, if &_/etc/exim/namelist_& contains:
36067 .code
36068 bigegg:  Humpty Dumpty
36069 .endd
36070 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
36071 line would be:
36072 .code
36073 Sender: Humpty Dumpty <bigegg@wonderland.example>
36074 .endd
36075 .cindex "return path" "in submission mode"
36076 By default, submission mode forces the return path to the same address as is
36077 used to create the &'Sender:'& header. However, if &%sender_retain%& is
36078 specified, the return path is also left unchanged.
36079
36080 &*Note*&: The changes caused by submission mode take effect after the predata
36081 ACL. This means that any sender checks performed before the fix-ups use the
36082 untrusted sender address specified by the user, not the trusted sender address
36083 specified by submission mode. Although this might be slightly unexpected, it
36084 does mean that you can configure ACL checks to spot that a user is trying to
36085 spoof another's address.
36086
36087 .section "Line endings" "SECTlineendings"
36088 .cindex "line endings"
36089 .cindex "carriage return"
36090 .cindex "linefeed"
36091 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
36092 linefeed) is the line ending for messages transmitted over the Internet using
36093 SMTP over TCP/IP. However, within individual operating systems, different
36094 conventions are used. For example, Unix-like systems use just LF, but others
36095 use CRLF or just CR.
36096
36097 Exim was designed for Unix-like systems, and internally, it stores messages
36098 using the system's convention of a single LF as a line terminator. When
36099 receiving a message, all line endings are translated to this standard format.
36100 Originally, it was thought that programs that passed messages directly to an
36101 MTA within an operating system would use that system's convention. Experience
36102 has shown that this is not the case; for example, there are Unix applications
36103 that use CRLF in this circumstance. For this reason, and for compatibility with
36104 other MTAs, the way Exim handles line endings for all messages is now as
36105 follows:
36106
36107 .ilist
36108 LF not preceded by CR is treated as a line ending.
36109 .next
36110 CR is treated as a line ending; if it is immediately followed by LF, the LF
36111 is ignored.
36112 .next
36113 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
36114 nor a local message in the state where a line containing only a dot is a
36115 terminator.
36116 .next
36117 If a bare CR is encountered within a header line, an extra space is added after
36118 the line terminator so as not to end the header line. The reasoning behind this
36119 is that bare CRs in header lines are most likely either to be mistakes, or
36120 people trying to play silly games.
36121 .next
36122 If the first header line received in a message ends with CRLF, a subsequent
36123 bare LF in a header line is treated in the same way as a bare CR in a header
36124 line.
36125 .endlist
36126
36127
36128
36129
36130
36131 .section "Unqualified addresses" "SECID218"
36132 .cindex "unqualified addresses"
36133 .cindex "address" "qualification"
36134 By default, Exim expects every envelope address it receives from an external
36135 host to be fully qualified. Unqualified addresses cause negative responses to
36136 SMTP commands. However, because SMTP is used as a means of transporting
36137 messages from MUAs running on personal workstations, there is sometimes a
36138 requirement to accept unqualified addresses from specific hosts or IP networks.
36139
36140 Exim has two options that separately control which hosts may send unqualified
36141 sender or recipient addresses in SMTP commands, namely
36142 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
36143 cases, if an unqualified address is accepted, it is qualified by adding the
36144 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
36145
36146 .oindex "&%qualify_domain%&"
36147 .oindex "&%qualify_recipient%&"
36148 Unqualified addresses in header lines are automatically qualified for messages
36149 that are locally originated, unless the &%-bnq%& option is given on the command
36150 line. For messages received over SMTP, unqualified addresses in header lines
36151 are qualified only if unqualified addresses are permitted in SMTP commands. In
36152 other words, such qualification is also controlled by
36153 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
36154
36155
36156
36157
36158 .section "The UUCP From line" "SECID219"
36159 .cindex "&""From""& line"
36160 .cindex "UUCP" "&""From""& line"
36161 .cindex "sender" "address"
36162 .oindex "&%uucp_from_pattern%&"
36163 .oindex "&%uucp_from_sender%&"
36164 .cindex "envelope from"
36165 .cindex "envelope sender"
36166 .cindex "Sendmail compatibility" "&""From""& line"
36167 Messages that have come from UUCP (and some other applications) often begin
36168 with a line containing the envelope sender and a timestamp, following the word
36169 &"From"&. Examples of two common formats are:
36170 .code
36171 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
36172 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
36173 .endd
36174 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
36175 Exim recognizes such lines at the start of messages that are submitted to it
36176 via the command line (that is, on the standard input). It does not recognize
36177 such lines in incoming SMTP messages, unless the sending host matches
36178 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
36179 and &%ignore_fromline_local%& is set. The recognition is controlled by a
36180 regular expression that is defined by the &%uucp_from_pattern%& option, whose
36181 default value matches the two common cases shown above and puts the address
36182 that follows &"From"& into &$1$&.
36183
36184 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
36185 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
36186 a trusted user, the message's sender address is constructed by expanding the
36187 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
36188 then parsed as an RFC 2822 address. If there is no domain, the local part is
36189 qualified with &%qualify_domain%& unless it is the empty string. However, if
36190 the command line &%-f%& option is used, it overrides the &"From"& line.
36191
36192 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
36193 sender address is not changed. This is also the case for incoming SMTP messages
36194 that are permitted to contain &"From"& lines.
36195
36196 Only one &"From"& line is recognized. If there is more than one, the second is
36197 treated as a data line that starts the body of the message, as it is not valid
36198 as a header line. This also happens if a &"From"& line is present in an
36199 incoming SMTP message from a source that is not permitted to send them.
36200
36201
36202
36203 .section "Resent- header lines" "SECID220"
36204 .chindex Resent-
36205 RFC 2822 makes provision for sets of header lines starting with the string
36206 &`Resent-`& to be added to a message when it is resent by the original
36207 recipient to somebody else. These headers are &'Resent-Date:'&,
36208 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
36209 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
36210
36211 .blockquote
36212 &'Resent fields are strictly informational. They MUST NOT be used in the normal
36213 processing of replies or other such automatic actions on messages.'&
36214 .endblockquote
36215
36216 This leaves things a bit vague as far as other processing actions such as
36217 address rewriting are concerned. Exim treats &%Resent-%& header lines as
36218 follows:
36219
36220 .ilist
36221 A &'Resent-From:'& line that just contains the login id of the submitting user
36222 is automatically rewritten in the same way as &'From:'& (see below).
36223 .next
36224 If there's a rewriting rule for a particular header line, it is also applied to
36225 &%Resent-%& header lines of the same type. For example, a rule that rewrites
36226 &'From:'& also rewrites &'Resent-From:'&.
36227 .next
36228 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
36229 also removed.
36230 .next
36231 For a locally-submitted message,
36232 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
36233 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
36234 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
36235 included in log lines in this case.
36236 .next
36237 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
36238 &%Resent-%& header lines are present.
36239 .endlist
36240
36241
36242
36243
36244 .section "The Auto-Submitted: header line" "SECID221"
36245 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
36246 includes the header line:
36247 .code
36248 Auto-Submitted: auto-replied
36249 .endd
36250
36251 .section "The Bcc: header line" "SECID222"
36252 .cindex "&'Bcc:'& header line"
36253 If Exim is called with the &%-t%& option, to take recipient addresses from a
36254 message's header, it removes any &'Bcc:'& header line that may exist (after
36255 extracting its addresses). If &%-t%& is not present on the command line, any
36256 existing &'Bcc:'& is not removed.
36257
36258
36259 .section "The Date: header line" "SECID223"
36260 .cindex Date:
36261 If a locally-generated or submission-mode message has no &'Date:'& header line,
36262 Exim adds one, using the current date and time, unless the
36263 &%suppress_local_fixups%& control has been specified.
36264
36265 .section "The Delivery-date: header line" "SECID224"
36266 .cindex "&'Delivery-date:'& header line"
36267 .oindex "&%delivery_date_remove%&"
36268 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
36269 set. Exim can be configured to add them to the final delivery of messages. (See
36270 the generic &%delivery_date_add%& transport option.) They should not be present
36271 in messages in transit. If the &%delivery_date_remove%& configuration option is
36272 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
36273 messages.
36274
36275
36276 .section "The Envelope-to: header line" "SECID225"
36277 .chindex Envelope-to:
36278 .oindex "&%envelope_to_remove%&"
36279 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
36280 Exim can be configured to add them to the final delivery of messages. (See the
36281 generic &%envelope_to_add%& transport option.) They should not be present in
36282 messages in transit. If the &%envelope_to_remove%& configuration option is set
36283 (the default), Exim removes &'Envelope-to:'& header lines from incoming
36284 messages.
36285
36286
36287 .section "The From: header line" "SECTthefrohea"
36288 .chindex From:
36289 .cindex "Sendmail compatibility" "&""From""& line"
36290 .cindex "message" "submission"
36291 .cindex "submission mode"
36292 If a submission-mode message does not contain a &'From:'& header line, Exim
36293 adds one if either of the following conditions is true:
36294
36295 .ilist
36296 The envelope sender address is not empty (that is, this is not a bounce
36297 message). The added header line copies the envelope sender address.
36298 .next
36299 .vindex "&$authenticated_id$&"
36300 The SMTP session is authenticated and &$authenticated_id$& is not empty.
36301 .olist
36302 .vindex "&$qualify_domain$&"
36303 If no domain is specified by the submission control, the local part is
36304 &$authenticated_id$& and the domain is &$qualify_domain$&.
36305 .next
36306 If a non-empty domain is specified by the submission control, the local
36307 part is &$authenticated_id$&, and the domain is the specified domain.
36308 .next
36309 If an empty domain is specified by the submission control,
36310 &$authenticated_id$& is assumed to be the complete address.
36311 .endlist
36312 .endlist
36313
36314 A non-empty envelope sender takes precedence.
36315
36316 If a locally-generated incoming message does not contain a &'From:'& header
36317 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
36318 containing the sender's address. The calling user's login name and full name
36319 are used to construct the address, as described in section &<<SECTconstr>>&.
36320 They are obtained from the password data by calling &[getpwuid()]& (but see the
36321 &%unknown_login%& configuration option). The address is qualified with
36322 &%qualify_domain%&.
36323
36324 For compatibility with Sendmail, if an incoming, non-SMTP message has a
36325 &'From:'& header line containing just the unqualified login name of the calling
36326 user, this is replaced by an address containing the user's login name and full
36327 name as described in section &<<SECTconstr>>&.
36328
36329
36330 .section "The Message-ID: header line" "SECID226"
36331 .chindex Message-ID:
36332 .cindex "message" "submission"
36333 .oindex "&%message_id_header_text%&"
36334 If a locally-generated or submission-mode incoming message does not contain a
36335 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
36336 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
36337 to the message. If there are any &'Resent-:'& headers in the message, it
36338 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
36339 message id, preceded by the letter E to ensure it starts with a letter, and
36340 followed by @ and the primary host name. Additional information can be included
36341 in this header line by setting the &%message_id_header_text%& and/or
36342 &%message_id_header_domain%& options.
36343
36344
36345 .section "The Received: header line" "SECID227"
36346 .chindex Received:
36347 A &'Received:'& header line is added at the start of every message. The
36348 contents are defined by the &%received_header_text%& configuration option, and
36349 Exim automatically adds a semicolon and a timestamp to the configured string.
36350
36351 The &'Received:'& header is generated as soon as the message's header lines
36352 have been received. At this stage, the timestamp in the &'Received:'& header
36353 line is the time that the message started to be received. This is the value
36354 that is seen by the DATA ACL and by the &[local_scan()]& function.
36355
36356 Once a message is accepted, the timestamp in the &'Received:'& header line is
36357 changed to the time of acceptance, which is (apart from a small delay while the
36358 -H spool file is written) the earliest time at which delivery could start.
36359
36360
36361 .section "The References: header line" "SECID228"
36362 .chindex References:
36363 Messages created by the &(autoreply)& transport include a &'References:'&
36364 header line. This is constructed according to the rules that are described in
36365 section 3.64 of RFC 2822 (which states that replies should contain such a
36366 header line), and section 3.14 of RFC 3834 (which states that automatic
36367 responses are not different in this respect). However, because some mail
36368 processing software does not cope well with very long header lines, no more
36369 than 12 message IDs are copied from the &'References:'& header line in the
36370 incoming message. If there are more than 12, the first one and then the final
36371 11 are copied, before adding the message ID of the incoming message.
36372
36373
36374
36375 .section "The Return-path: header line" "SECID229"
36376 .chindex Return-path:
36377 .oindex "&%return_path_remove%&"
36378 &'Return-path:'& header lines are defined as something an MTA may insert when
36379 it does the final delivery of messages. (See the generic &%return_path_add%&
36380 transport option.) Therefore, they should not be present in messages in
36381 transit. If the &%return_path_remove%& configuration option is set (the
36382 default), Exim removes &'Return-path:'& header lines from incoming messages.
36383
36384
36385
36386 .section "The Sender: header line" "SECTthesenhea"
36387 .cindex "&'Sender:'& header line"
36388 .cindex "message" "submission"
36389 .chindex Sender:
36390 For a locally-originated message from an untrusted user, Exim may remove an
36391 existing &'Sender:'& header line, and it may add a new one. You can modify
36392 these actions by setting the &%local_sender_retain%& option true, the
36393 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
36394 control setting.
36395
36396 When a local message is received from an untrusted user and
36397 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
36398 control has not been set, a check is made to see if the address given in the
36399 &'From:'& header line is the correct (local) sender of the message. The address
36400 that is expected has the login name as the local part and the value of
36401 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
36402 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
36403 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
36404 line is added to the message.
36405
36406 If you set &%local_from_check%& false, this checking does not occur. However,
36407 the removal of an existing &'Sender:'& line still happens, unless you also set
36408 &%local_sender_retain%& to be true. It is not possible to set both of these
36409 options true at the same time.
36410
36411 .cindex "submission mode"
36412 By default, no processing of &'Sender:'& header lines is done for messages
36413 received over TCP/IP or for messages submitted by trusted users. However, when
36414 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
36415 not specified on the submission control, the following processing takes place:
36416
36417 .vindex "&$authenticated_id$&"
36418 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
36419 authenticated, and &$authenticated_id$& is not empty, a sender address is
36420 created as follows:
36421
36422 .ilist
36423 .vindex "&$qualify_domain$&"
36424 If no domain is specified by the submission control, the local part is
36425 &$authenticated_id$& and the domain is &$qualify_domain$&.
36426 .next
36427 If a non-empty domain is specified by the submission control, the local part
36428 is &$authenticated_id$&, and the domain is the specified domain.
36429 .next
36430 If an empty domain is specified by the submission control,
36431 &$authenticated_id$& is assumed to be the complete address.
36432 .endlist
36433
36434 This address is compared with the address in the &'From:'& header line. If they
36435 are different, a &'Sender:'& header line containing the created address is
36436 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
36437 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
36438
36439 .cindex "return path" "created from &'Sender:'&"
36440 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
36441 the message (the envelope sender address) is changed to be the same address,
36442 except in the case of submission mode when &%sender_retain%& is specified.
36443
36444
36445
36446 .section "Adding and removing header lines in routers and transports" &&&
36447          "SECTheadersaddrem"
36448 .cindex "header lines" "adding; in router or transport"
36449 .cindex "header lines" "removing; in router or transport"
36450 When a message is delivered, the addition and removal of header lines can be
36451 specified in a system filter, or on any of the routers and transports that
36452 process the message. Section &<<SECTaddremheasys>>& contains details about
36453 modifying headers in a system filter. Header lines can also be added in an ACL
36454 as a message is received (see section &<<SECTaddheadacl>>&).
36455
36456 In contrast to what happens in a system filter, header modifications that are
36457 specified on routers and transports apply only to the particular recipient
36458 addresses that are being processed by those routers and transports. These
36459 changes do not actually take place until a copy of the message is being
36460 transported. Therefore, they do not affect the basic set of header lines, and
36461 they do not affect the values of the variables that refer to header lines.
36462
36463 &*Note*&: In particular, this means that any expansions in the configuration of
36464 the transport cannot refer to the modified header lines, because such
36465 expansions all occur before the message is actually transported.
36466
36467 For both routers and transports, the argument of a &%headers_add%&
36468 option must be in the form of one or more RFC 2822 header lines, separated by
36469 newlines (coded as &"\n"&). For example:
36470 .code
36471 headers_add = X-added-header: added by $primary_hostname\n\
36472               X-added-second: another added header line
36473 .endd
36474 Exim does not check the syntax of these added header lines.
36475
36476 Multiple &%headers_add%& options for a single router or transport can be
36477 specified; the values will append to a single list of header lines.
36478 Each header-line is separately expanded.
36479
36480 The argument of a &%headers_remove%& option must consist of a colon-separated
36481 list of header names. This is confusing, because header names themselves are
36482 often terminated by colons. In this case, the colons are the list separators,
36483 not part of the names. For example:
36484 .code
36485 headers_remove = return-receipt-to:acknowledge-to
36486 .endd
36487
36488 Multiple &%headers_remove%& options for a single router or transport can be
36489 specified; the arguments will append to a single header-names list.
36490 Each item is separately expanded.
36491 Note that colons in complex expansions which are used to
36492 form all or part of a &%headers_remove%& list
36493 will act as list separators.
36494
36495 When &%headers_add%& or &%headers_remove%& is specified on a router,
36496 items are expanded at routing time,
36497 and then associated with all addresses that are
36498 accepted by that router, and also with any new addresses that it generates. If
36499 an address passes through several routers as a result of aliasing or
36500 forwarding, the changes are cumulative.
36501
36502 .oindex "&%unseen%&"
36503 However, this does not apply to multiple routers that result from the use of
36504 the &%unseen%& option. Any header modifications that were specified by the
36505 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
36506
36507 Addresses that end up with different &%headers_add%& or &%headers_remove%&
36508 settings cannot be delivered together in a batch, so a transport is always
36509 dealing with a set of addresses that have the same header-processing
36510 requirements.
36511
36512 The transport starts by writing the original set of header lines that arrived
36513 with the message, possibly modified by the system filter. As it writes out
36514 these lines, it consults the list of header names that were attached to the
36515 recipient address(es) by &%headers_remove%& options in routers, and it also
36516 consults the transport's own &%headers_remove%& option. Header lines whose
36517 names are on either of these lists are not written out. If there are multiple
36518 instances of any listed header, they are all skipped.
36519
36520 After the remaining original header lines have been written, new header
36521 lines that were specified by routers' &%headers_add%& options are written, in
36522 the order in which they were attached to the address. These are followed by any
36523 header lines specified by the transport's &%headers_add%& option.
36524
36525 This way of handling header line modifications in routers and transports has
36526 the following consequences:
36527
36528 .ilist
36529 The original set of header lines, possibly modified by the system filter,
36530 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
36531 to it, at all times.
36532 .next
36533 Header lines that are added by a router's
36534 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
36535 expansion syntax in subsequent routers or the transport.
36536 .next
36537 Conversely, header lines that are specified for removal by &%headers_remove%&
36538 in a router remain visible to subsequent routers and the transport.
36539 .next
36540 Headers added to an address by &%headers_add%& in a router cannot be removed by
36541 a later router or by a transport.
36542 .next
36543 An added header can refer to the contents of an original header that is to be
36544 removed, even it has the same name as the added header. For example:
36545 .code
36546 headers_remove = subject
36547 headers_add = Subject: new subject (was: $h_subject:)
36548 .endd
36549 .endlist
36550
36551 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
36552 for a &(redirect)& router that has the &%one_time%& option set.
36553
36554
36555
36556
36557
36558 .section "Constructed addresses" "SECTconstr"
36559 .cindex "address" "constructed"
36560 .cindex "constructed address"
36561 When Exim constructs a sender address for a locally-generated message, it uses
36562 the form
36563 .display
36564 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
36565 .endd
36566 For example:
36567 .code
36568 Zaphod Beeblebrox <zaphod@end.univ.example>
36569 .endd
36570 The user name is obtained from the &%-F%& command line option if set, or
36571 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
36572 &"gecos"& field from the password entry. If the &"gecos"& field contains an
36573 ampersand character, this is replaced by the login name with the first letter
36574 upper cased, as is conventional in a number of operating systems. See the
36575 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
36576 The &%unknown_username%& option can be used to specify user names in cases when
36577 there is no password file entry.
36578
36579 .cindex "RFC 2047"
36580 In all cases, the user name is made to conform to RFC 2822 by quoting all or
36581 parts of it if necessary. In addition, if it contains any non-printing
36582 characters, it is encoded as described in RFC 2047, which defines a way of
36583 including non-ASCII characters in header lines. The value of the
36584 &%headers_charset%& option specifies the name of the encoding that is used (the
36585 characters are assumed to be in this encoding). The setting of
36586 &%print_topbitchars%& controls whether characters with the top bit set (that
36587 is, with codes greater than 127) count as printing characters or not.
36588
36589
36590
36591 .section "Case of local parts" "SECID230"
36592 .cindex "case of local parts"
36593 .cindex "local part" "case of"
36594 RFC 2822 states that the case of letters in the local parts of addresses cannot
36595 be assumed to be non-significant. Exim preserves the case of local parts of
36596 addresses, but by default it uses a lower-cased form when it is routing,
36597 because on most Unix systems, usernames are in lower case and case-insensitive
36598 routing is required. However, any particular router can be made to use the
36599 original case for local parts by setting the &%caseful_local_part%& generic
36600 router option.
36601
36602 .cindex "mixed-case login names"
36603 If you must have mixed-case user names on your system, the best way to proceed,
36604 assuming you want case-independent handling of incoming email, is to set up
36605 your first router to convert incoming local parts in your domains to the
36606 correct case by means of a file lookup. For example:
36607 .code
36608 correct_case:
36609   driver = redirect
36610   domains = +local_domains
36611   data = ${lookup{$local_part}cdb\
36612               {/etc/usercased.cdb}{$value}fail}\
36613               @$domain
36614 .endd
36615 For this router, the local part is forced to lower case by the default action
36616 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
36617 up a new local part in the correct case. If you then set &%caseful_local_part%&
36618 on any subsequent routers which process your domains, they will operate on
36619 local parts with the correct case in a case-sensitive manner.
36620
36621
36622
36623 .section "Dots in local parts" "SECID231"
36624 .cindex "dot" "in local part"
36625 .cindex "local part" "dots in"
36626 RFC 2822 forbids empty components in local parts. That is, an unquoted local
36627 part may not begin or end with a dot, nor have two consecutive dots in the
36628 middle. However, it seems that many MTAs do not enforce this, so Exim permits
36629 empty components for compatibility.
36630
36631
36632
36633 .section "Rewriting addresses" "SECID232"
36634 .cindex "rewriting" "addresses"
36635 Rewriting of sender and recipient addresses, and addresses in headers, can
36636 happen automatically, or as the result of configuration options, as described
36637 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
36638 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
36639
36640 Automatic rewriting includes qualification, as mentioned above. The other case
36641 in which it can happen is when an incomplete non-local domain is given. The
36642 routing process may cause this to be expanded into the full domain name. For
36643 example, a header such as
36644 .code
36645 To: hare@teaparty
36646 .endd
36647 might get rewritten as
36648 .code
36649 To: hare@teaparty.wonderland.fict.example
36650 .endd
36651 Rewriting as a result of routing is the one kind of message processing that
36652 does not happen at input time, as it cannot be done until the address has
36653 been routed.
36654
36655 Strictly, one should not do &'any'& deliveries of a message until all its
36656 addresses have been routed, in case any of the headers get changed as a
36657 result of routing. However, doing this in practice would hold up many
36658 deliveries for unreasonable amounts of time, just because one address could not
36659 immediately be routed. Exim therefore does not delay other deliveries when
36660 routing of one or more addresses is deferred.
36661 .ecindex IIDmesproc
36662
36663
36664
36665 . ////////////////////////////////////////////////////////////////////////////
36666 . ////////////////////////////////////////////////////////////////////////////
36667
36668 .chapter "SMTP processing" "CHAPSMTP"
36669 .scindex IIDsmtpproc1 "SMTP" "processing details"
36670 .scindex IIDsmtpproc2 "LMTP" "processing details"
36671 Exim supports a number of different ways of using the SMTP protocol, and its
36672 LMTP variant, which is an interactive protocol for transferring messages into a
36673 closed mail store application. This chapter contains details of how SMTP is
36674 processed. For incoming mail, the following are available:
36675
36676 .ilist
36677 SMTP over TCP/IP (Exim daemon or &'inetd'&);
36678 .next
36679 SMTP over the standard input and output (the &%-bs%& option);
36680 .next
36681 Batched SMTP on the standard input (the &%-bS%& option).
36682 .endlist
36683
36684 For mail delivery, the following are available:
36685
36686 .ilist
36687 SMTP over TCP/IP (the &(smtp)& transport);
36688 .next
36689 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
36690 &"lmtp"&);
36691 .next
36692 LMTP over a pipe to a process running in the local host (the &(lmtp)&
36693 transport);
36694 .next
36695 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
36696 the &%use_bsmtp%& option set).
36697 .endlist
36698
36699 &'Batched SMTP'& is the name for a process in which batches of messages are
36700 stored in or read from files (or pipes), in a format in which SMTP commands are
36701 used to contain the envelope information.
36702
36703
36704
36705 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
36706 .cindex "SMTP" "outgoing over TCP/IP"
36707 .cindex "outgoing SMTP over TCP/IP"
36708 .cindex "LMTP" "over TCP/IP"
36709 .cindex "outgoing LMTP over TCP/IP"
36710 .cindex "EHLO"
36711 .cindex "HELO"
36712 .cindex "SIZE" "option on MAIL command"
36713 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
36714 The &%protocol%& option selects which protocol is to be used, but the actual
36715 processing is the same in both cases.
36716
36717 .cindex "ESMTP extensions" SIZE
36718 If, in response to its EHLO command, Exim is told that the SIZE
36719 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
36720 command. The value of <&'n'&> is the message size plus the value of the
36721 &%size_addition%& option (default 1024) to allow for additions to the message
36722 such as per-transport header lines, or changes made in a
36723 .cindex "transport" "filter"
36724 .cindex "filter" "transport filter"
36725 transport filter. If &%size_addition%& is set negative, the use of SIZE is
36726 suppressed.
36727
36728 If the remote server advertises support for PIPELINING, Exim uses the
36729 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
36730 required for the transaction.
36731
36732 If the remote server advertises support for the STARTTLS command, and Exim
36733 was built to support TLS encryption, it tries to start a TLS session unless the
36734 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
36735 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
36736 is called for verification.
36737
36738 If the remote server advertises support for the AUTH command, Exim scans
36739 the authenticators configuration for any suitable client settings, as described
36740 in chapter &<<CHAPSMTPAUTH>>&.
36741
36742 .cindex "carriage return"
36743 .cindex "linefeed"
36744 Responses from the remote host are supposed to be terminated by CR followed by
36745 LF. However, there are known to be hosts that do not send CR characters, so in
36746 order to be able to interwork with such hosts, Exim treats LF on its own as a
36747 line terminator.
36748
36749 If a message contains a number of different addresses, all those with the same
36750 characteristics (for example, the same envelope sender) that resolve to the
36751 same set of hosts, in the same order, are sent in a single SMTP transaction,
36752 even if they are for different domains, unless there are more than the setting
36753 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
36754 they are split into groups containing no more than &%max_rcpt%&s addresses
36755 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
36756 in parallel sessions. The order of hosts with identical MX values is not
36757 significant when checking whether addresses can be batched in this way.
36758
36759 When the &(smtp)& transport suffers a temporary failure that is not
36760 message-related, Exim updates its transport-specific database, which contains
36761 records indexed by host name that remember which messages are waiting for each
36762 particular host. It also updates the retry database with new retry times.
36763
36764 .cindex "hints database" "retry keys"
36765 Exim's retry hints are based on host name plus IP address, so if one address of
36766 a multi-homed host is broken, it will soon be skipped most of the time.
36767 See the next section for more detail about error handling.
36768
36769 .cindex "SMTP" "passed connection"
36770 .cindex "SMTP" "batching over TCP/IP"
36771 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
36772 looks in the hints database for the transport to see if there are any queued
36773 messages waiting for the host to which it is connected. If it finds one, it
36774 creates a new Exim process using the &%-MC%& option (which can only be used by
36775 a process running as root or the Exim user) and passes the TCP/IP socket to it
36776 so that it can deliver another message using the same socket. The new process
36777 does only those deliveries that are routed to the connected host, and may in
36778 turn pass the socket on to a third process, and so on.
36779
36780 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
36781 limit the number of messages sent down a single TCP/IP connection.
36782
36783 .cindex "asterisk" "after IP address"
36784 The second and subsequent messages delivered down an existing connection are
36785 identified in the main log by the addition of an asterisk after the closing
36786 square bracket of the IP address.
36787
36788
36789
36790
36791 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
36792 .cindex "error" "in outgoing SMTP"
36793 .cindex "SMTP" "errors in outgoing"
36794 .cindex "host" "error"
36795 Three different kinds of error are recognized for outgoing SMTP: host errors,
36796 message errors, and recipient errors.
36797
36798 .vlist
36799 .vitem "&*Host errors*&"
36800 A host error is not associated with a particular message or with a
36801 particular recipient of a message. The host errors are:
36802
36803 .ilist
36804 Connection refused or timed out,
36805 .next
36806 Any error response code on connection,
36807 .next
36808 Any error response code to EHLO or HELO,
36809 .next
36810 Loss of connection at any time, except after &"."&,
36811 .next
36812 I/O errors at any time,
36813 .next
36814 Timeouts during the session, other than in response to MAIL, RCPT or
36815 the &"."& at the end of the data.
36816 .endlist ilist
36817
36818 For a host error, a permanent error response on connection, or in response to
36819 EHLO, causes all addresses routed to the host to be failed. Any other host
36820 error causes all addresses to be deferred, and retry data to be created for the
36821 host. It is not tried again, for any message, until its retry time arrives. If
36822 the current set of addresses are not all delivered in this run (to some
36823 alternative host), the message is added to the list of those waiting for this
36824 host, so if it is still undelivered when a subsequent successful delivery is
36825 made to the host, it will be sent down the same SMTP connection.
36826
36827 .vitem "&*Message errors*&"
36828 .cindex "message" "error"
36829 A message error is associated with a particular message when sent to a
36830 particular host, but not with a particular recipient of the message. The
36831 message errors are:
36832
36833 .ilist
36834 Any error response code to MAIL, DATA, or the &"."& that terminates
36835 the data,
36836 .next
36837 Timeout after MAIL,
36838 .next
36839 Timeout or loss of connection after the &"."& that terminates the data. A
36840 timeout after the DATA command itself is treated as a host error, as is loss of
36841 connection at any other time.
36842 .endlist ilist
36843
36844 For a message error, a permanent error response (5&'xx'&) causes all addresses
36845 to be failed, and a delivery error report to be returned to the sender. A
36846 temporary error response (4&'xx'&), or one of the timeouts, causes all
36847 addresses to be deferred. Retry data is not created for the host, but instead,
36848 a retry record for the combination of host plus message id is created. The
36849 message is not added to the list of those waiting for this host. This ensures
36850 that the failing message will not be sent to this host again until the retry
36851 time arrives. However, other messages that are routed to the host are not
36852 affected, so if it is some property of the message that is causing the error,
36853 it will not stop the delivery of other mail.
36854
36855 If the remote host specified support for the SIZE parameter in its response
36856 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
36857 over-large message will cause a message error because the error arrives as a
36858 response to MAIL.
36859
36860 .vitem "&*Recipient errors*&"
36861 .cindex "recipient" "error"
36862 A recipient error is associated with a particular recipient of a message. The
36863 recipient errors are:
36864
36865 .ilist
36866 Any error response to RCPT,
36867 .next
36868 Timeout after RCPT.
36869 .endlist
36870
36871 For a recipient error, a permanent error response (5&'xx'&) causes the
36872 recipient address to be failed, and a bounce message to be returned to the
36873 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
36874 address to be deferred, and routing retry data to be created for it. This is
36875 used to delay processing of the address in subsequent queue runs, until its
36876 routing retry time arrives. This applies to all messages, but because it
36877 operates only in queue runs, one attempt will be made to deliver a new message
36878 to the failing address before the delay starts to operate. This ensures that,
36879 if the failure is really related to the message rather than the recipient
36880 (&"message too big for this recipient"& is a possible example), other messages
36881 have a chance of getting delivered. If a delivery to the address does succeed,
36882 the retry information gets cleared, so all stuck messages get tried again, and
36883 the retry clock is reset.
36884
36885 The message is not added to the list of those waiting for this host. Use of the
36886 host for other messages is unaffected, and except in the case of a timeout,
36887 other recipients are processed independently, and may be successfully delivered
36888 in the current SMTP session. After a timeout it is of course impossible to
36889 proceed with the session, so all addresses get deferred. However, those other
36890 than the one that failed do not suffer any subsequent retry delays. Therefore,
36891 if one recipient is causing trouble, the others have a chance of getting
36892 through when a subsequent delivery attempt occurs before the failing
36893 recipient's retry time.
36894 .endlist
36895
36896 In all cases, if there are other hosts (or IP addresses) available for the
36897 current set of addresses (for example, from multiple MX records), they are
36898 tried in this run for any undelivered addresses, subject of course to their
36899 own retry data. In other words, recipient error retry data does not take effect
36900 until the next delivery attempt.
36901
36902 Some hosts have been observed to give temporary error responses to every
36903 MAIL command at certain times (&"insufficient space"& has been seen). It
36904 would be nice if such circumstances could be recognized, and defer data for the
36905 host itself created, but this is not possible within the current Exim design.
36906 What actually happens is that retry data for every (host, message) combination
36907 is created.
36908
36909 The reason that timeouts after MAIL and RCPT are treated specially is that
36910 these can sometimes arise as a result of the remote host's verification
36911 procedures. Exim makes this assumption, and treats them as if a temporary error
36912 response had been received. A timeout after &"."& is treated specially because
36913 it is known that some broken implementations fail to recognize the end of the
36914 message if the last character of the last line is a binary zero. Thus, it is
36915 helpful to treat this case as a message error.
36916
36917 Timeouts at other times are treated as host errors, assuming a problem with the
36918 host, or the connection to it. If a timeout after MAIL, RCPT,
36919 or &"."& is really a connection problem, the assumption is that at the next try
36920 the timeout is likely to occur at some other point in the dialogue, causing it
36921 then to be treated as a host error.
36922
36923 There is experimental evidence that some MTAs drop the connection after the
36924 terminating &"."& if they do not like the contents of the message for some
36925 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
36926 should be given. That is why Exim treats this case as a message rather than a
36927 host error, in order not to delay other messages to the same host.
36928
36929
36930
36931
36932 .section "Incoming SMTP messages over TCP/IP" "SECID233"
36933 .cindex "SMTP" "incoming over TCP/IP"
36934 .cindex "incoming SMTP over TCP/IP"
36935 .cindex "inetd"
36936 .cindex "daemon"
36937 Incoming SMTP messages can be accepted in one of two ways: by running a
36938 listening daemon, or by using &'inetd'&. In the latter case, the entry in
36939 &_/etc/inetd.conf_& should be like this:
36940 .code
36941 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
36942 .endd
36943 Exim distinguishes between this case and the case of a locally running user
36944 agent using the &%-bs%& option by checking whether or not the standard input is
36945 a socket. When it is, either the port must be privileged (less than 1024), or
36946 the caller must be root or the Exim user. If any other user passes a socket
36947 with an unprivileged port number, Exim prints a message on the standard error
36948 stream and exits with an error code.
36949
36950 By default, Exim does not make a log entry when a remote host connects or
36951 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
36952 unexpected. It can be made to write such log entries by setting the
36953 &%smtp_connection%& log selector.
36954
36955 .cindex "carriage return"
36956 .cindex "linefeed"
36957 Commands from the remote host are supposed to be terminated by CR followed by
36958 LF. However, there are known to be hosts that do not send CR characters. In
36959 order to be able to interwork with such hosts, Exim treats LF on its own as a
36960 line terminator.
36961 Furthermore, because common code is used for receiving messages from all
36962 sources, a CR on its own is also interpreted as a line terminator. However, the
36963 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
36964
36965 .cindex "EHLO" "invalid data"
36966 .cindex "HELO" "invalid data"
36967 One area that sometimes gives rise to problems concerns the EHLO or
36968 HELO commands. Some clients send syntactically invalid versions of these
36969 commands, which Exim rejects by default. (This is nothing to do with verifying
36970 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
36971 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
36972 match the broken hosts that send invalid commands.
36973
36974 .cindex "SIZE option on MAIL command"
36975 .cindex "MAIL" "SIZE option"
36976 The amount of disk space available is checked whenever SIZE is received on
36977 a MAIL command, independently of whether &%message_size_limit%& or
36978 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
36979 false. A temporary error is given if there is not enough space. If
36980 &%check_spool_space%& is set, the check is for that amount of space plus the
36981 value given with SIZE, that is, it checks that the addition of the incoming
36982 message will not reduce the space below the threshold.
36983
36984 When a message is successfully received, Exim includes the local message id in
36985 its response to the final &"."& that terminates the data. If the remote host
36986 logs this text it can help with tracing what has happened to a message.
36987
36988 The Exim daemon can limit the number of simultaneous incoming connections it is
36989 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
36990 number of simultaneous incoming connections from a single remote host (see the
36991 &%smtp_accept_max_per_host%& option). Additional connection attempts are
36992 rejected using the SMTP temporary error code 421.
36993
36994 The Exim daemon does not rely on the SIGCHLD signal to detect when a
36995 subprocess has finished, as this can get lost at busy times. Instead, it looks
36996 for completed subprocesses every time it wakes up. Provided there are other
36997 things happening (new incoming calls, starts of queue runs), completed
36998 processes will be noticed and tidied away. On very quiet systems you may
36999 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
37000 it will be noticed when the daemon next wakes up.
37001
37002 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
37003 and can also be set up to reject SMTP calls from non-reserved hosts at times of
37004 high system load &-- for details see the &%smtp_accept_reserve%&,
37005 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
37006 applies in both the daemon and &'inetd'& cases.
37007
37008 Exim normally starts a delivery process for each message received, though this
37009 can be varied by means of the &%-odq%& command line option and the
37010 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
37011 number of simultaneously running delivery processes started in this way from
37012 SMTP input can be limited by the &%smtp_accept_queue%& and
37013 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
37014 subsequently received messages are just put on the input queue without starting
37015 a delivery process.
37016
37017 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
37018 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
37019 started up from the &'inetd'& daemon, because in that case each connection is
37020 handled by an entirely independent Exim process. Control by load average is,
37021 however, available with &'inetd'&.
37022
37023 Exim can be configured to verify addresses in incoming SMTP commands as they
37024 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
37025 to rewrite addresses at this time &-- before any syntax checking is done. See
37026 section &<<SECTrewriteS>>&.
37027
37028 Exim can also be configured to limit the rate at which a client host submits
37029 MAIL and RCPT commands in a single SMTP session. See the
37030 &%smtp_ratelimit_hosts%& option.
37031
37032
37033
37034 .section "Unrecognized SMTP commands" "SECID234"
37035 .cindex "SMTP" "unrecognized commands"
37036 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
37037 commands during a single SMTP connection, it drops the connection after sending
37038 the error response to the last command. The default value for
37039 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
37040 abuse that subvert web servers into making connections to SMTP ports; in these
37041 circumstances, a number of non-SMTP lines are sent first.
37042
37043
37044 .section "Syntax and protocol errors in SMTP commands" "SECID235"
37045 .cindex "SMTP" "syntax errors"
37046 .cindex "SMTP" "protocol errors"
37047 A syntax error is detected if an SMTP command is recognized, but there is
37048 something syntactically wrong with its data, for example, a malformed email
37049 address in a RCPT command. Protocol errors include invalid command
37050 sequencing such as RCPT before MAIL. If Exim receives more than
37051 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
37052 drops the connection after sending the error response to the last command. The
37053 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
37054 broken clients that loop sending bad commands (yes, it has been seen).
37055
37056
37057
37058 .section "Use of non-mail SMTP commands" "SECID236"
37059 .cindex "SMTP" "non-mail commands"
37060 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
37061 DATA. Exim counts such commands, and drops the connection if there are too
37062 many of them in a single SMTP session. This action catches some
37063 denial-of-service attempts and things like repeated failing AUTHs, or a mad
37064 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
37065 defines what &"too many"& means. Its default value is 10.
37066
37067 When a new message is expected, one occurrence of RSET is not counted. This
37068 allows a client to send one RSET between messages (this is not necessary,
37069 but some clients do it). Exim also allows one uncounted occurrence of HELO
37070 or EHLO, and one occurrence of STARTTLS between messages. After
37071 starting up a TLS session, another EHLO is expected, and so it too is not
37072 counted.
37073
37074 The first occurrence of AUTH in a connection, or immediately following
37075 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
37076 RCPT, DATA, and QUIT are counted.
37077
37078 You can control which hosts are subject to the limit set by
37079 &%smtp_accept_max_nonmail%& by setting
37080 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
37081 the limit apply to all hosts. This option means that you can exclude any
37082 specific badly-behaved hosts that you have to live with.
37083
37084
37085
37086
37087 .section "The VRFY and EXPN commands" "SECID237"
37088 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
37089 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
37090 appropriate) in order to decide whether the command should be accepted or not.
37091
37092 .cindex "VRFY" "processing"
37093 When no ACL is defined for VRFY, or if it rejects without
37094 setting an explicit response code, the command is accepted
37095 (with a 252 SMTP response code)
37096 in order to support awkward clients that do a VRFY before every RCPT.
37097 When VRFY is accepted, it runs exactly the same code as when Exim is
37098 called with the &%-bv%& option, and returns 250/451/550
37099 SMTP response codes.
37100
37101 .cindex "EXPN" "processing"
37102 If no ACL for EXPN is defined, the command is rejected.
37103 When EXPN is accepted, a single-level expansion of the address is done.
37104 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
37105 than a verification (the &%-bv%& option). If an unqualified local part is given
37106 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
37107 of VRFY and EXPN commands are logged on the main and reject logs, and
37108 VRFY verification failures are logged on the main log for consistency with
37109 RCPT failures.
37110
37111
37112
37113 .section "The ETRN command" "SECTETRN"
37114 .cindex "ETRN" "processing"
37115 .cindex "ESMTP extensions" ETRN
37116 RFC 1985 describes an ESMTP command called ETRN that is designed to
37117 overcome the security problems of the TURN command (which has fallen into
37118 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
37119 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
37120 should be accepted or not. If no ACL is defined, the command is rejected.
37121
37122 The ETRN command is concerned with &"releasing"& messages that are awaiting
37123 delivery to certain hosts. As Exim does not organize its message queue by host,
37124 the only form of ETRN that is supported by default is the one where the
37125 text starts with the &"#"& prefix, in which case the remainder of the text is
37126 specific to the SMTP server. A valid ETRN command causes a run of Exim with
37127 the &%-R%& option to happen, with the remainder of the ETRN text as its
37128 argument. For example,
37129 .code
37130 ETRN #brigadoon
37131 .endd
37132 runs the command
37133 .code
37134 exim -R brigadoon
37135 .endd
37136 which causes a delivery attempt on all messages with undelivered addresses
37137 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
37138 default), Exim prevents the simultaneous execution of more than one queue run
37139 for the same argument string as a result of an ETRN command. This stops
37140 a misbehaving client from starting more than one queue runner at once.
37141
37142 .cindex "hints database" "ETRN serialization"
37143 Exim implements the serialization by means of a hints database in which a
37144 record is written whenever a process is started by ETRN, and deleted when
37145 the process completes. However, Exim does not keep the SMTP session waiting for
37146 the ETRN process to complete. Once ETRN is accepted, the client is sent
37147 a &"success"& return code. Obviously there is scope for hints records to get
37148 left lying around if there is a system or program crash. To guard against this,
37149 Exim ignores any records that are more than six hours old.
37150
37151 .oindex "&%smtp_etrn_command%&"
37152 For more control over what ETRN does, the &%smtp_etrn_command%& option can
37153 used. This specifies a command that is run whenever ETRN is received,
37154 whatever the form of its argument. For
37155 example:
37156 .code
37157 smtp_etrn_command = /etc/etrn_command $domain \
37158                     $sender_host_address
37159 .endd
37160 .vindex "&$domain$&"
37161 The string is split up into arguments which are independently expanded. The
37162 expansion variable &$domain$& is set to the argument of the ETRN command,
37163 and no syntax checking is done on the contents of this argument. Exim does not
37164 wait for the command to complete, so its status code is not checked. Exim runs
37165 under its own uid and gid when receiving incoming SMTP, so it is not possible
37166 for it to change them before running the command.
37167
37168
37169
37170 .section "Incoming local SMTP" "SECID238"
37171 .cindex "SMTP" "local incoming"
37172 Some user agents use SMTP to pass messages to their local MTA using the
37173 standard input and output, as opposed to passing the envelope on the command
37174 line and writing the message to the standard input. This is supported by the
37175 &%-bs%& option. This form of SMTP is handled in the same way as incoming
37176 messages over TCP/IP (including the use of ACLs), except that the envelope
37177 sender given in a MAIL command is ignored unless the caller is trusted. In
37178 an ACL you can detect this form of SMTP input by testing for an empty host
37179 identification. It is common to have this as the first line in the ACL that
37180 runs for RCPT commands:
37181 .code
37182 accept hosts = :
37183 .endd
37184 This accepts SMTP messages from local processes without doing any other tests.
37185
37186
37187
37188 .section "Outgoing batched SMTP" "SECTbatchSMTP"
37189 .cindex "SMTP" "batched outgoing"
37190 .cindex "batched SMTP output"
37191 Both the &(appendfile)& and &(pipe)& transports can be used for handling
37192 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
37193 be output in BSMTP format. No SMTP responses are possible for this form of
37194 delivery. All it is doing is using SMTP commands as a way of transmitting the
37195 envelope along with the message.
37196
37197 The message is written to the file or pipe preceded by the SMTP commands
37198 MAIL and RCPT, and followed by a line containing a single dot. Lines in
37199 the message that start with a dot have an extra dot added. The SMTP command
37200 HELO is not normally used. If it is required, the &%message_prefix%& option
37201 can be used to specify it.
37202
37203 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
37204 one recipient address at a time by default. However, you can arrange for them
37205 to handle several addresses at once by setting the &%batch_max%& option. When
37206 this is done for BSMTP, messages may contain multiple RCPT commands. See
37207 chapter &<<CHAPbatching>>& for more details.
37208
37209 .vindex "&$host$&"
37210 When one or more addresses are routed to a BSMTP transport by a router that
37211 sets up a host list, the name of the first host on the list is available to the
37212 transport in the variable &$host$&. Here is an example of such a transport and
37213 router:
37214 .code
37215 begin routers
37216 route_append:
37217   driver = manualroute
37218   transport = smtp_appendfile
37219   route_list = domain.example  batch.host.example
37220
37221 begin transports
37222 smtp_appendfile:
37223   driver = appendfile
37224   directory = /var/bsmtp/$host
37225   batch_max = 1000
37226   use_bsmtp
37227   user = exim
37228 .endd
37229 This causes messages addressed to &'domain.example'& to be written in BSMTP
37230 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
37231 message (unless there are more than 1000 recipients).
37232
37233
37234
37235 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
37236 .cindex "SMTP" "batched incoming"
37237 .cindex "batched SMTP input"
37238 The &%-bS%& command line option causes Exim to accept one or more messages by
37239 reading SMTP on the standard input, but to generate no responses. If the caller
37240 is trusted, the senders in the MAIL commands are believed; otherwise the
37241 sender is always the caller of Exim. Unqualified senders and receivers are not
37242 rejected (there seems little point) but instead just get qualified. HELO
37243 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
37244 as NOOP; QUIT quits.
37245
37246 Minimal policy checking is done for BSMTP input. Only the non-SMTP
37247 ACL is run in the same way as for non-SMTP local input.
37248
37249 If an error is detected while reading a message, including a missing &"."& at
37250 the end, Exim gives up immediately. It writes details of the error to the
37251 standard output in a stylized way that the calling program should be able to
37252 make some use of automatically, for example:
37253 .code
37254 554 Unexpected end of file
37255 Transaction started in line 10
37256 Error detected in line 14
37257 .endd
37258 It writes a more verbose version, for human consumption, to the standard error
37259 file, for example:
37260 .code
37261 An error was detected while processing a file of BSMTP input.
37262 The error message was:
37263
37264 501 '>' missing at end of address
37265
37266 The SMTP transaction started in line 10.
37267 The error was detected in line 12.
37268 The SMTP command at fault was:
37269
37270 rcpt to:<malformed@in.com.plete
37271
37272 1 previous message was successfully processed.
37273 The rest of the batch was abandoned.
37274 .endd
37275 The return code from Exim is zero only if there were no errors. It is 1 if some
37276 messages were accepted before an error was detected, and 2 if no messages were
37277 accepted.
37278 .ecindex IIDsmtpproc1
37279 .ecindex IIDsmtpproc2
37280
37281
37282
37283 . ////////////////////////////////////////////////////////////////////////////
37284 . ////////////////////////////////////////////////////////////////////////////
37285
37286 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
37287          "Customizing messages"
37288 When a message fails to be delivered, or remains in the queue for more than a
37289 configured amount of time, Exim sends a message to the original sender, or
37290 to an alternative configured address. The text of these messages is built into
37291 the code of Exim, but it is possible to change it, either by adding a single
37292 string, or by replacing each of the paragraphs by text supplied in a file.
37293
37294 The &'From:'& and &'To:'& header lines are automatically generated; you can
37295 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
37296 option. Exim also adds the line
37297 .code
37298 Auto-Submitted: auto-generated
37299 .endd
37300 to all warning and bounce messages,
37301
37302
37303 .section "Customizing bounce messages" "SECID239"
37304 .cindex "customizing" "bounce message"
37305 .cindex "bounce message" "customizing"
37306 If &%bounce_message_text%& is set, its contents are included in the default
37307 message immediately after &"This message was created automatically by mail
37308 delivery software."& The string is not expanded. It is not used if
37309 &%bounce_message_file%& is set.
37310
37311 When &%bounce_message_file%& is set, it must point to a template file for
37312 constructing error messages. The file consists of a series of text items,
37313 separated by lines consisting of exactly four asterisks. If the file cannot be
37314 opened, default text is used and a message is written to the main and panic
37315 logs. If any text item in the file is empty, default text is used for that
37316 item.
37317
37318 .vindex "&$bounce_recipient$&"
37319 .vindex "&$bounce_return_size_limit$&"
37320 Each item of text that is read from the file is expanded, and there are two
37321 expansion variables which can be of use here: &$bounce_recipient$& is set to
37322 the recipient of an error message while it is being created, and
37323 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
37324 option, rounded to a whole number.
37325
37326 The items must appear in the file in the following order:
37327
37328 .ilist
37329 The first item is included in the headers, and should include at least a
37330 &'Subject:'& header. Exim does not check the syntax of these headers.
37331 .next
37332 The second item forms the start of the error message. After it, Exim lists the
37333 failing addresses with their error messages.
37334 .next
37335 The third item is used to introduce any text from pipe transports that is to be
37336 returned to the sender. It is omitted if there is no such text.
37337 .next
37338 The fourth, fifth and sixth items will be ignored and may be empty.
37339 The fields exist for back-compatibility
37340 .endlist
37341
37342 The default state (&%bounce_message_file%& unset) is equivalent to the
37343 following file, in which the sixth item is empty. The &'Subject:'& and some
37344 other lines have been split in order to fit them on the page:
37345 .code
37346 Subject: Mail delivery failed
37347   ${if eq{$sender_address}{$bounce_recipient}
37348   {: returning message to sender}}
37349 ****
37350 This message was created automatically by mail delivery software.
37351
37352 A message ${if eq{$sender_address}{$bounce_recipient}
37353   {that you sent }{sent by
37354
37355 <$sender_address>
37356
37357 }}could not be delivered to all of its recipients.
37358 This is a permanent error. The following address(es) failed:
37359 ****
37360 The following text was generated during the delivery attempt(s):
37361 ****
37362 ------ This is a copy of the message, including all the headers.
37363   ------
37364 ****
37365 ------ The body of the message is $message_size characters long;
37366   only the first
37367 ------ $bounce_return_size_limit or so are included here.
37368 ****
37369 .endd
37370 .section "Customizing warning messages" "SECTcustwarn"
37371 .cindex "customizing" "warning message"
37372 .cindex "warning of delay" "customizing the message"
37373 The option &%warn_message_file%& can be pointed at a template file for use when
37374 warnings about message delays are created. In this case there are only three
37375 text sections:
37376
37377 .ilist
37378 The first item is included in the headers, and should include at least a
37379 &'Subject:'& header. Exim does not check the syntax of these headers.
37380 .next
37381 The second item forms the start of the warning message. After it, Exim lists
37382 the delayed addresses.
37383 .next
37384 The third item then ends the message.
37385 .endlist
37386
37387 The default state is equivalent to the following file, except that some lines
37388 have been split here, in order to fit them on the page:
37389 .code
37390 Subject: Warning: message $message_exim_id delayed
37391   $warn_message_delay
37392 ****
37393 This message was created automatically by mail delivery software.
37394
37395 A message ${if eq{$sender_address}{$warn_message_recipients}
37396 {that you sent }{sent by
37397
37398 <$sender_address>
37399
37400 }}has not been delivered to all of its recipients after
37401 more than $warn_message_delay in the queue on $primary_hostname.
37402
37403 The message identifier is:     $message_exim_id
37404 The subject of the message is: $h_subject
37405 The date of the message is:    $h_date
37406
37407 The following address(es) have not yet been delivered:
37408 ****
37409 No action is required on your part. Delivery attempts will
37410 continue for some time, and this warning may be repeated at
37411 intervals if the message remains undelivered. Eventually the
37412 mail delivery software will give up, and when that happens,
37413 the message will be returned to you.
37414 .endd
37415 .vindex "&$warn_message_delay$&"
37416 .vindex "&$warn_message_recipients$&"
37417 However, in the default state the subject and date lines are omitted if no
37418 appropriate headers exist. During the expansion of this file,
37419 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
37420 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
37421 of recipients for the warning message. There may be more than one if there are
37422 multiple addresses with different &%errors_to%& settings on the routers that
37423 handled them.
37424
37425
37426
37427
37428 . ////////////////////////////////////////////////////////////////////////////
37429 . ////////////////////////////////////////////////////////////////////////////
37430
37431 .chapter "Some common configuration settings" "CHAPcomconreq"
37432 This chapter discusses some configuration settings that seem to be fairly
37433 common. More examples and discussion can be found in the Exim book.
37434
37435
37436
37437 .section "Sending mail to a smart host" "SECID240"
37438 .cindex "smart host" "example router"
37439 If you want to send all mail for non-local domains to a &"smart host"&, you
37440 should replace the default &(dnslookup)& router with a router which does the
37441 routing explicitly:
37442 .code
37443 send_to_smart_host:
37444   driver = manualroute
37445   route_list = !+local_domains smart.host.name
37446   transport = remote_smtp
37447 .endd
37448 You can use the smart host's IP address instead of the name if you wish.
37449 If you are using Exim only to submit messages to a smart host, and not for
37450 receiving incoming messages, you can arrange for it to do the submission
37451 synchronously by setting the &%mua_wrapper%& option (see chapter
37452 &<<CHAPnonqueueing>>&).
37453
37454
37455
37456
37457 .section "Using Exim to handle mailing lists" "SECTmailinglists"
37458 .cindex "mailing lists"
37459 Exim can be used to run simple mailing lists, but for large and/or complicated
37460 requirements, the use of additional specialized mailing list software such as
37461 Majordomo or Mailman is recommended.
37462
37463 The &(redirect)& router can be used to handle mailing lists where each list
37464 is maintained in a separate file, which can therefore be managed by an
37465 independent manager. The &%domains%& router option can be used to run these
37466 lists in a separate domain from normal mail. For example:
37467 .code
37468 lists:
37469   driver = redirect
37470   domains = lists.example
37471   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37472   forbid_pipe
37473   forbid_file
37474   errors_to = ${quote_local_part:$local_part-request}@lists.example
37475   no_more
37476 .endd
37477 This router is skipped for domains other than &'lists.example'&. For addresses
37478 in that domain, it looks for a file that matches the local part. If there is no
37479 such file, the router declines, but because &%no_more%& is set, no subsequent
37480 routers are tried, and so the whole delivery fails.
37481
37482 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
37483 expanded into a filename or a pipe delivery, which is usually inappropriate in
37484 a mailing list.
37485
37486 .oindex "&%errors_to%&"
37487 The &%errors_to%& option specifies that any delivery errors caused by addresses
37488 taken from a mailing list are to be sent to the given address rather than the
37489 original sender of the message. However, before acting on this, Exim verifies
37490 the error address, and ignores it if verification fails.
37491
37492 For example, using the configuration above, mail sent to
37493 &'dicts@lists.example'& is passed on to those addresses contained in
37494 &_/usr/lists/dicts_&, with error reports directed to
37495 &'dicts-request@lists.example'&, provided that this address can be verified.
37496 There could be a file called &_/usr/lists/dicts-request_& containing
37497 the address(es) of this particular list's manager(s), but other approaches,
37498 such as setting up an earlier router (possibly using the &%local_part_prefix%&
37499 or &%local_part_suffix%& options) to handle addresses of the form
37500 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
37501
37502
37503
37504 .section "Syntax errors in mailing lists" "SECID241"
37505 .cindex "mailing lists" "syntax errors in"
37506 If an entry in redirection data contains a syntax error, Exim normally defers
37507 delivery of the original address. That means that a syntax error in a mailing
37508 list holds up all deliveries to the list. This may not be appropriate when a
37509 list is being maintained automatically from data supplied by users, and the
37510 addresses are not rigorously checked.
37511
37512 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
37513 entries that fail to parse, noting the incident in the log. If in addition
37514 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
37515 whenever a broken address is skipped. It is usually appropriate to set
37516 &%syntax_errors_to%& to the same address as &%errors_to%&.
37517
37518
37519
37520 .section "Re-expansion of mailing lists" "SECID242"
37521 .cindex "mailing lists" "re-expansion of"
37522 Exim remembers every individual address to which a message has been delivered,
37523 in order to avoid duplication, but it normally stores only the original
37524 recipient addresses with a message. If all the deliveries to a mailing list
37525 cannot be done at the first attempt, the mailing list is re-expanded when the
37526 delivery is next tried. This means that alterations to the list are taken into
37527 account at each delivery attempt, so addresses that have been added to
37528 the list since the message arrived will therefore receive a copy of the
37529 message, even though it pre-dates their subscription.
37530
37531 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
37532 on the &(redirect)& router. If this is done, any addresses generated by the
37533 router that fail to deliver at the first attempt are added to the message as
37534 &"top level"& addresses, and the parent address that generated them is marked
37535 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
37536 subsequent delivery attempts. The disadvantage of this is that if any of the
37537 failing addresses are incorrect, correcting them in the file has no effect on
37538 pre-existing messages.
37539
37540 The original top-level address is remembered with each of the generated
37541 addresses, and is output in any log messages. However, any intermediate parent
37542 addresses are not recorded. This makes a difference to the log only if the
37543 &%all_parents%& selector is set, but for mailing lists there is normally only
37544 one level of expansion anyway.
37545
37546
37547
37548 .section "Closed mailing lists" "SECID243"
37549 .cindex "mailing lists" "closed"
37550 The examples so far have assumed open mailing lists, to which anybody may
37551 send mail. It is also possible to set up closed lists, where mail is accepted
37552 from specified senders only. This is done by making use of the generic
37553 &%senders%& option to restrict the router that handles the list.
37554
37555 The following example uses the same file as a list of recipients and as a list
37556 of permitted senders. It requires three routers:
37557 .code
37558 lists_request:
37559   driver = redirect
37560   domains = lists.example
37561   local_part_suffix = -request
37562   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
37563   file = /usr/lists/${local_part_data}-request
37564   no_more
37565
37566 lists_post:
37567   driver = redirect
37568   domains = lists.example
37569   local_parts = ${lookup {$local_part} dsearch,filter=file,ret=full {/usr/lists}}
37570   senders = ${if exists {$local_part_data} {lsearch;$local_part_data}{*}}
37571   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37572   forbid_pipe
37573   forbid_file
37574   errors_to = ${quote_local_part:$local_part-request}@lists.example
37575   no_more
37576
37577 lists_closed:
37578   driver = redirect
37579   domains = lists.example
37580   allow_fail
37581   data = :fail: $local_part@lists.example is a closed mailing list
37582 .endd
37583 All three routers have the same &%domains%& setting, so for any other domains,
37584 they are all skipped. The first router runs only if the local part ends in
37585 &%-request%&. It handles messages to the list manager(s) by means of an open
37586 mailing list.
37587
37588 The second router runs only if the &%senders%& precondition is satisfied. It
37589 checks for the existence of a list that corresponds to the local part, and then
37590 checks that the sender is on the list by means of a linear search. It is
37591 necessary to check for the existence of the file before trying to search it,
37592 because otherwise Exim thinks there is a configuration error. If the file does
37593 not exist, the expansion of &%senders%& is *, which matches all senders. This
37594 means that the router runs, but because there is no list, declines, and
37595 &%no_more%& ensures that no further routers are run. The address fails with an
37596 &"unrouteable address"& error.
37597
37598 The third router runs only if the second router is skipped, which happens when
37599 a mailing list exists, but the sender is not on it. This router forcibly fails
37600 the address, giving a suitable error message.
37601
37602
37603
37604
37605 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
37606 .cindex "VERP"
37607 .cindex "Variable Envelope Return Paths"
37608 .cindex "envelope from"
37609 .cindex "envelope sender"
37610 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
37611 are a way of helping mailing list administrators discover which subscription
37612 address is the cause of a particular delivery failure. The idea is to encode
37613 the original recipient address in the outgoing envelope sender address, so that
37614 if the message is forwarded by another host and then subsequently bounces, the
37615 original recipient can be extracted from the recipient address of the bounce.
37616
37617 .oindex &%errors_to%&
37618 .oindex &%return_path%&
37619 Envelope sender addresses can be modified by Exim using two different
37620 facilities: the &%errors_to%& option on a router (as shown in previous mailing
37621 list examples), or the &%return_path%& option on a transport. The second of
37622 these is effective only if the message is successfully delivered to another
37623 host; it is not used for errors detected on the local host (see the description
37624 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
37625 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
37626 .code
37627 verp_smtp:
37628   driver = smtp
37629   max_rcpt = 1
37630   return_path = \
37631     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37632       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37633 .endd
37634 This has the effect of rewriting the return path (envelope sender) on outgoing
37635 SMTP messages, if the local part of the original return path ends in
37636 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
37637 local part and domain of the recipient into the return path. Suppose, for
37638 example, that a message whose return path has been set to
37639 &'somelist-request@your.dom.example'& is sent to
37640 &'subscriber@other.dom.example'&. In the transport, the return path is
37641 rewritten as
37642 .code
37643 somelist-request+subscriber=other.dom.example@your.dom.example
37644 .endd
37645 .vindex "&$local_part$&"
37646 For this to work, you must tell Exim to send multiple copies of messages that
37647 have more than one recipient, so that each copy has just one recipient. This is
37648 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
37649 might be sent to several different recipients in the same domain, in which case
37650 &$local_part$& is not available in the transport, because it is not unique.
37651
37652 Unless your host is doing nothing but mailing list deliveries, you should
37653 probably use a separate transport for the VERP deliveries, so as not to use
37654 extra resources in making one-per-recipient copies for other deliveries. This
37655 can easily be done by expanding the &%transport%& option in the router:
37656 .code
37657 dnslookup:
37658   driver = dnslookup
37659   domains = ! +local_domains
37660   transport = \
37661     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37662       {verp_smtp}{remote_smtp}}
37663   no_more
37664 .endd
37665 If you want to change the return path using &%errors_to%& in a router instead
37666 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
37667 routers that handle mailing list addresses. This will ensure that all delivery
37668 errors, including those detected on the local host, are sent to the VERP
37669 address.
37670
37671 On a host that does no local deliveries and has no manual routing, only the
37672 &(dnslookup)& router needs to be changed. A special transport is not needed for
37673 SMTP deliveries. Every mailing list recipient has its own return path value,
37674 and so Exim must hand them to the transport one at a time. Here is an example
37675 of a &(dnslookup)& router that implements VERP:
37676 .code
37677 verp_dnslookup:
37678   driver = dnslookup
37679   domains = ! +local_domains
37680   transport = remote_smtp
37681   errors_to = \
37682     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
37683      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37684   no_more
37685 .endd
37686 Before you start sending out messages with VERPed return paths, you must also
37687 configure Exim to accept the bounce messages that come back to those paths.
37688 Typically this is done by setting a &%local_part_suffix%& option for a
37689 router, and using this to route the messages to wherever you want to handle
37690 them.
37691
37692 The overhead incurred in using VERP depends very much on the size of the
37693 message, the number of recipient addresses that resolve to the same remote
37694 host, and the speed of the connection over which the message is being sent. If
37695 a lot of addresses resolve to the same host and the connection is slow, sending
37696 a separate copy of the message for each address may take substantially longer
37697 than sending a single copy with many recipients (for which VERP cannot be
37698 used).
37699
37700
37701
37702
37703
37704
37705 .section "Virtual domains" "SECTvirtualdomains"
37706 .cindex "virtual domains"
37707 .cindex "domain" "virtual"
37708 The phrase &'virtual domain'& is unfortunately used with two rather different
37709 meanings:
37710
37711 .ilist
37712 A domain for which there are no real mailboxes; all valid local parts are
37713 aliases for other email addresses. Common examples are organizational
37714 top-level domains and &"vanity"& domains.
37715 .next
37716 One of a number of independent domains that are all handled by the same host,
37717 with mailboxes on that host, but where the mailbox owners do not necessarily
37718 have login accounts on that host.
37719 .endlist
37720
37721 The first usage is probably more common, and does seem more &"virtual"& than
37722 the second. This kind of domain can be handled in Exim with a straightforward
37723 aliasing router. One approach is to create a separate alias file for each
37724 virtual domain. Exim can test for the existence of the alias file to determine
37725 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
37726 to a router of this form:
37727 .code
37728 virtual:
37729   driver = redirect
37730   domains = dsearch;/etc/mail/virtual
37731   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
37732   no_more
37733 .endd
37734 The &%domains%& option specifies that the router is to be skipped, unless there
37735 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
37736 domain that is being processed.
37737 The &(dsearch)& lookup used results in an untainted version of &$domain$&
37738 being placed into the &$domain_data$& variable.
37739
37740 When the router runs, it looks up the local
37741 part in the file to find a new address (or list of addresses). The &%no_more%&
37742 setting ensures that if the lookup fails (leading to &%data%& being an empty
37743 string), Exim gives up on the address without trying any subsequent routers.
37744
37745 This one router can handle all the virtual domains because the alias filenames
37746 follow a fixed pattern. Permissions can be arranged so that appropriate people
37747 can edit the different alias files. A successful aliasing operation results in
37748 a new envelope recipient address, which is then routed from scratch.
37749
37750 The other kind of &"virtual"& domain can also be handled in a straightforward
37751 way. One approach is to create a file for each domain containing a list of
37752 valid local parts, and use it in a router like this:
37753 .code
37754 my_domains:
37755   driver = accept
37756   domains = dsearch;/etc/mail/domains
37757   local_parts = lsearch;/etc/mail/domains/$domain
37758   transport = my_mailboxes
37759 .endd
37760 The address is accepted if there is a file for the domain, and the local part
37761 can be found in the file. The &%domains%& option is used to check for the
37762 file's existence because &%domains%& is tested before the &%local_parts%&
37763 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
37764 because that option is tested after &%local_parts%&. The transport is as
37765 follows:
37766 .code
37767 my_mailboxes:
37768   driver = appendfile
37769   file = /var/mail/$domain_data/$local_part_data
37770   user = mail
37771 .endd
37772 This uses a directory of mailboxes for each domain. The &%user%& setting is
37773 required, to specify which uid is to be used for writing to the mailboxes.
37774
37775 The configuration shown here is just one example of how you might support this
37776 requirement. There are many other ways this kind of configuration can be set
37777 up, for example, by using a database instead of separate files to hold all the
37778 information about the domains.
37779
37780
37781
37782 .section "Multiple user mailboxes" "SECTmulbox"
37783 .cindex "multiple mailboxes"
37784 .cindex "mailbox" "multiple"
37785 .cindex "local part" "prefix"
37786 .cindex "local part" "suffix"
37787 Heavy email users often want to operate with multiple mailboxes, into which
37788 incoming mail is automatically sorted. A popular way of handling this is to
37789 allow users to use multiple sender addresses, so that replies can easily be
37790 identified. Users are permitted to add prefixes or suffixes to their local
37791 parts for this purpose. The wildcard facility of the generic router options
37792 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
37793 example, consider this router:
37794 .code
37795 userforward:
37796   driver = redirect
37797   check_local_user
37798   file = $home/.forward
37799   local_part_suffix = -*
37800   local_part_suffix_optional
37801   allow_filter
37802 .endd
37803 .vindex "&$local_part_suffix$&"
37804 It runs a user's &_.forward_& file for all local parts of the form
37805 &'username-*'&. Within the filter file the user can distinguish different
37806 cases by testing the variable &$local_part_suffix$&. For example:
37807 .code
37808 if $local_part_suffix contains -special then
37809 save /home/$local_part_data/Mail/special
37810 endif
37811 .endd
37812 If the filter file does not exist, or does not deal with such addresses, they
37813 fall through to subsequent routers, and, assuming no subsequent use of the
37814 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
37815 control over which suffixes are valid.
37816
37817 Alternatively, a suffix can be used to trigger the use of a different
37818 &_.forward_& file &-- which is the way a similar facility is implemented in
37819 another MTA:
37820 .code
37821 userforward:
37822   driver = redirect
37823   check_local_user
37824   local_part_suffix = -*
37825   local_part_suffix_optional
37826   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
37827   allow_filter
37828 .endd
37829 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
37830 example, &_.forward-special_& is used. Once again, if the appropriate file
37831 does not exist, or does not deal with the address, it is passed on to
37832 subsequent routers, which could, if required, look for an unqualified
37833 &_.forward_& file to use as a default.
37834
37835
37836
37837 .section "Simplified vacation processing" "SECID244"
37838 .cindex "vacation processing"
37839 The traditional way of running the &'vacation'& program is for a user to set up
37840 a pipe command in a &_.forward_& file
37841 (see section &<<SECTspecitredli>>& for syntax details).
37842 This is prone to error by inexperienced users. There are two features of Exim
37843 that can be used to make this process simpler for users:
37844
37845 .ilist
37846 A local part prefix such as &"vacation-"& can be specified on a router which
37847 can cause the message to be delivered directly to the &'vacation'& program, or
37848 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
37849 &_.forward_& file are then much simpler. For example:
37850 .code
37851 spqr, vacation-spqr
37852 .endd
37853 .next
37854 The &%require_files%& generic router option can be used to trigger a
37855 vacation delivery by checking for the existence of a certain file in the
37856 user's home directory. The &%unseen%& generic option should also be used, to
37857 ensure that the original delivery also proceeds. In this case, all the user has
37858 to do is to create a file called, say, &_.vacation_&, containing a vacation
37859 message.
37860 .endlist
37861
37862 Another advantage of both these methods is that they both work even when the
37863 use of arbitrary pipes by users is locked out.
37864
37865
37866
37867 .section "Taking copies of mail" "SECID245"
37868 .cindex "message" "copying every"
37869 Some installations have policies that require archive copies of all messages to
37870 be made. A single copy of each message can easily be taken by an appropriate
37871 command in a system filter, which could, for example, use a different file for
37872 each day's messages.
37873
37874 There is also a shadow transport mechanism that can be used to take copies of
37875 messages that are successfully delivered by local transports, one copy per
37876 delivery. This could be used, &'inter alia'&, to implement automatic
37877 notification of delivery by sites that insist on doing such things.
37878
37879
37880
37881 .section "Intermittently connected hosts" "SECID246"
37882 .cindex "intermittently connected hosts"
37883 It has become quite common (because it is cheaper) for hosts to connect to the
37884 Internet periodically rather than remain connected all the time. The normal
37885 arrangement is that mail for such hosts accumulates on a system that is
37886 permanently connected.
37887
37888 Exim was designed for use on permanently connected hosts, and so it is not
37889 particularly well-suited to use in an intermittently connected environment.
37890 Nevertheless there are some features that can be used.
37891
37892
37893 .section "Exim on the upstream server host" "SECID247"
37894 It is tempting to arrange for incoming mail for the intermittently connected
37895 host to remain in Exim's queue until the client connects. However, this
37896 approach does not scale very well. Two different kinds of waiting message are
37897 being mixed up in the same queue &-- those that cannot be delivered because of
37898 some temporary problem, and those that are waiting for their destination host
37899 to connect. This makes it hard to manage the queue, as well as wasting
37900 resources, because each queue runner scans the entire queue.
37901
37902 A better approach is to separate off those messages that are waiting for an
37903 intermittently connected host. This can be done by delivering these messages
37904 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
37905 format, from where they are transmitted by other software when their
37906 destination connects. This makes it easy to collect all the mail for one host
37907 in a single directory, and to apply local timeout rules on a per-message basis
37908 if required.
37909
37910 On a very small scale, leaving the mail on Exim's queue can be made to work. If
37911 you are doing this, you should configure Exim with a long retry period for the
37912 intermittent host. For example:
37913 .code
37914 cheshire.wonderland.fict.example    *   F,5d,24h
37915 .endd
37916 This stops a lot of failed delivery attempts from occurring, but Exim remembers
37917 which messages it has queued up for that host. Once the intermittent host comes
37918 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
37919 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
37920 causes all the queued up messages to be delivered, often down a single SMTP
37921 connection. While the host remains connected, any new messages get delivered
37922 immediately.
37923
37924 If the connecting hosts do not have fixed IP addresses, that is, if a host is
37925 issued with a different IP address each time it connects, Exim's retry
37926 mechanisms on the holding host get confused, because the IP address is normally
37927 used as part of the key string for holding retry information. This can be
37928 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
37929 Since this has disadvantages for permanently connected hosts, it is best to
37930 arrange a separate transport for the intermittently connected ones.
37931
37932
37933
37934 .section "Exim on the intermittently connected client host" "SECID248"
37935 The value of &%smtp_accept_queue_per_connection%& should probably be
37936 increased, or even set to zero (that is, disabled) on the intermittently
37937 connected host, so that all incoming messages down a single connection get
37938 delivered immediately.
37939
37940 .cindex "SMTP" "passed connection"
37941 .cindex "SMTP" "multiple deliveries"
37942 .cindex "multiple SMTP deliveries"
37943 .cindex "first pass routing"
37944 Mail waiting to be sent from an intermittently connected host will probably
37945 not have been routed, because without a connection DNS lookups are not
37946 possible. This means that if a normal queue run is done at connection time,
37947 each message is likely to be sent in a separate SMTP session. This can be
37948 avoided by starting the queue run with a command line option beginning with
37949 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
37950 first pass, routing is done but no deliveries take place. The second pass is a
37951 normal queue run; since all the messages have been previously routed, those
37952 destined for the same host are likely to get sent as multiple deliveries in a
37953 single SMTP connection.
37954
37955
37956
37957 . ////////////////////////////////////////////////////////////////////////////
37958 . ////////////////////////////////////////////////////////////////////////////
37959
37960 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
37961          "Exim as a non-queueing client"
37962 .cindex "client, non-queueing"
37963 .cindex "smart host" "suppressing queueing"
37964 On a personal computer, it is a common requirement for all
37965 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
37966 configured to operate that way, for all the popular operating systems.
37967 However, there are some MUAs for Unix-like systems that cannot be so
37968 configured: they submit messages using the command line interface of
37969 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
37970 messages this way.
37971
37972 If the personal computer runs continuously, there is no problem, because it can
37973 run a conventional MTA that handles delivery to the smart host, and deal with
37974 any delays via its queueing mechanism. However, if the computer does not run
37975 continuously or runs different operating systems at different times, queueing
37976 email is not desirable.
37977
37978 There is therefore a requirement for something that can provide the
37979 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
37980 any queueing or retrying facilities. Furthermore, the delivery to the smart
37981 host should be synchronous, so that if it fails, the sending MUA is immediately
37982 informed. In other words, we want something that extends an MUA that submits
37983 to a local MTA via the command line so that it behaves like one that submits
37984 to a remote smart host using TCP/SMTP.
37985
37986 There are a number of applications (for example, there is one called &'ssmtp'&)
37987 that do this job. However, people have found them to be lacking in various
37988 ways. For instance, you might want to allow aliasing and forwarding to be done
37989 before sending a message to the smart host.
37990
37991 Exim already had the necessary infrastructure for doing this job. Just a few
37992 tweaks were needed to make it behave as required, though it is somewhat of an
37993 overkill to use a fully-featured MTA for this purpose.
37994
37995 .oindex "&%mua_wrapper%&"
37996 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
37997 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
37998 assumes that it is being used to &"wrap"& a command-line MUA in the manner
37999 just described. As well as setting &%mua_wrapper%&, you also need to provide a
38000 compatible router and transport configuration. Typically there will be just one
38001 router and one transport, sending everything to a smart host.
38002
38003 When run in MUA wrapping mode, the behaviour of Exim changes in the
38004 following ways:
38005
38006 .ilist
38007 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
38008 In other words, the only way to submit messages is via the command line.
38009 .next
38010 Each message is synchronously delivered as soon as it is received (&%-odi%& is
38011 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
38012 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
38013 does not finish until the delivery attempt is complete. If the delivery is
38014 successful, a zero return code is given.
38015 .next
38016 Address redirection is permitted, but the final routing for all addresses must
38017 be to the same remote transport, and to the same list of hosts. Furthermore,
38018 the return address (envelope sender) must be the same for all recipients, as
38019 must any added or deleted header lines. In other words, it must be possible to
38020 deliver the message in a single SMTP transaction, however many recipients there
38021 are.
38022 .next
38023 If these conditions are not met, or if routing any address results in a
38024 failure or defer status, or if Exim is unable to deliver all the recipients
38025 successfully to one of the smart hosts, delivery of the entire message fails.
38026 .next
38027 Because no queueing is allowed, all failures are treated as permanent; there
38028 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
38029 smart host. Furthermore, because only a single yes/no response can be given to
38030 the caller, it is not possible to deliver to some recipients and not others. If
38031 there is an error (temporary or permanent) for any recipient, all are failed.
38032 .next
38033 If more than one smart host is listed, Exim will try another host after a
38034 connection failure or a timeout, in the normal way. However, if this kind of
38035 failure happens for all the hosts, the delivery fails.
38036 .next
38037 When delivery fails, an error message is written to the standard error stream
38038 (as well as to Exim's log), and Exim exits to the caller with a return code
38039 value 1. The message is expunged from Exim's spool files. No bounce messages
38040 are ever generated.
38041 .next
38042 No retry data is maintained, and any retry rules are ignored.
38043 .next
38044 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
38045 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
38046 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
38047 .endlist
38048
38049 The overall effect is that Exim makes a single synchronous attempt to deliver
38050 the message, failing if there is any kind of problem. Because no local
38051 deliveries are done and no daemon can be run, Exim does not need root
38052 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
38053 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
38054 the advantages and disadvantages of running without root privilege.
38055
38056
38057
38058
38059 . ////////////////////////////////////////////////////////////////////////////
38060 . ////////////////////////////////////////////////////////////////////////////
38061
38062 .chapter "Log files" "CHAPlog"
38063 .scindex IIDloggen "log" "general description"
38064 .cindex "log" "types of"
38065 Exim writes three different logs, referred to as the main log, the reject log,
38066 and the panic log:
38067
38068 .ilist
38069 .cindex "main log"
38070 The main log records the arrival of each message and each delivery in a single
38071 line in each case. The format is as compact as possible, in an attempt to keep
38072 down the size of log files. Two-character flag sequences make it easy to pick
38073 out these lines. A number of other events are recorded in the main log. Some of
38074 them are optional, in which case the &%log_selector%& option controls whether
38075 they are included or not. A Perl script called &'eximstats'&, which does simple
38076 analysis of main log files, is provided in the Exim distribution (see section
38077 &<<SECTmailstat>>&).
38078 .next
38079 .cindex "reject log"
38080 The reject log records information from messages that are rejected as a result
38081 of a configuration option (that is, for policy reasons).
38082 The first line of each rejection is a copy of the line that is also written to
38083 the main log. Then, if the message's header has been read at the time the log
38084 is written, its contents are written to this log. Only the original header
38085 lines are available; header lines added by ACLs are not logged. You can use the
38086 reject log to check that your policy controls are working correctly; on a busy
38087 host this may be easier than scanning the main log for rejection messages. You
38088 can suppress the writing of the reject log by setting &%write_rejectlog%&
38089 false.
38090 .next
38091 .cindex "panic log"
38092 .cindex "system log"
38093 When certain serious errors occur, Exim writes entries to its panic log. If the
38094 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
38095 are usually written to the main log as well, but can get lost amid the mass of
38096 other entries. The panic log should be empty under normal circumstances. It is
38097 therefore a good idea to check it (or to have a &'cron'& script check it)
38098 regularly, in order to become aware of any problems. When Exim cannot open its
38099 panic log, it tries as a last resort to write to the system log (syslog). This
38100 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
38101 message itself is written at priority LOG_CRIT.
38102 .endlist
38103
38104 Every log line starts with a timestamp, in the format shown in the following
38105 example. Note that many of the examples shown in this chapter are line-wrapped.
38106 In the log file, this would be all on one line:
38107 .code
38108 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
38109   by QUIT
38110 .endd
38111 By default, the timestamps are in the local timezone. There are two
38112 ways of changing this:
38113
38114 .ilist
38115 You can set the &%timezone%& option to a different time zone; in particular, if
38116 you set
38117 .code
38118 timezone = UTC
38119 .endd
38120 the timestamps will be in UTC (aka GMT).
38121 .next
38122 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
38123 example:
38124 .code
38125 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
38126 .endd
38127 .endlist
38128
38129 .cindex "log" "process ids in"
38130 .cindex "pid (process id)" "in log lines"
38131 Exim does not include its process id in log lines by default, but you can
38132 request that it does so by specifying the &`pid`& log selector (see section
38133 &<<SECTlogselector>>&). When this is set, the process id is output, in square
38134 brackets, immediately after the time and date.
38135
38136
38137
38138
38139 .section "Where the logs are written" "SECTwhelogwri"
38140 .cindex "log" "destination"
38141 .cindex "log" "to file"
38142 .cindex "log" "to syslog"
38143 .cindex "syslog"
38144 The logs may be written to local files, or to syslog, or both. However, it
38145 should be noted that many syslog implementations use UDP as a transport, and
38146 are therefore unreliable in the sense that messages are not guaranteed to
38147 arrive at the loghost, nor is the ordering of messages necessarily maintained.
38148 It has also been reported that on large log files (tens of megabytes) you may
38149 need to tweak syslog to prevent it syncing the file with each write &-- on
38150 Linux this has been seen to make syslog take 90% plus of CPU time.
38151
38152 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
38153 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
38154 configuration. This latter string is expanded, so it can contain, for example,
38155 references to the host name:
38156 .code
38157 log_file_path = /var/log/$primary_hostname/exim_%slog
38158 .endd
38159 It is generally advisable, however, to set the string in &_Local/Makefile_&
38160 rather than at runtime, because then the setting is available right from the
38161 start of Exim's execution. Otherwise, if there's something it wants to log
38162 before it has read the configuration file (for example, an error in the
38163 configuration file) it will not use the path you want, and may not be able to
38164 log at all.
38165
38166 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
38167 list, currently limited to at most two items. This is one option where the
38168 facility for changing a list separator may not be used. The list must always be
38169 colon-separated. If an item in the list is &"syslog"& then syslog is used;
38170 otherwise the item must either be an absolute path, containing &`%s`& at the
38171 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
38172 implying the use of a default path.
38173
38174 When Exim encounters an empty item in the list, it searches the list defined by
38175 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
38176 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
38177 mean &"use the path specified at build time"&. If no such item exists, log
38178 files are written in the &_log_& subdirectory of the spool directory. This is
38179 equivalent to the setting:
38180 .code
38181 log_file_path = $spool_directory/log/%slog
38182 .endd
38183 If you do not specify anything at build time or runtime,
38184 or if you unset the option at runtime (i.e. &`log_file_path = `&),
38185 that is where the logs are written.
38186
38187 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
38188 are in use &-- see section &<<SECTdatlogfil>>& below.
38189
38190 Here are some examples of possible settings:
38191 .display
38192 &`LOG_FILE_PATH=syslog                    `& syslog only
38193 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
38194 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
38195 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
38196 .endd
38197 If there are more than two paths in the list, the first is used and a panic
38198 error is logged.
38199
38200
38201
38202 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
38203 .cindex "log" "cycling local files"
38204 .cindex "cycling logs"
38205 .cindex "&'exicyclog'&"
38206 .cindex "log" "local files; writing to"
38207 Some operating systems provide centralized and standardized methods for cycling
38208 log files. For those that do not, a utility script called &'exicyclog'& is
38209 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
38210 main and reject logs each time it is called. The maximum number of old logs to
38211 keep can be set. It is suggested this script is run as a daily &'cron'& job.
38212
38213 An Exim delivery process opens the main log when it first needs to write to it,
38214 and it keeps the file open in case subsequent entries are required &-- for
38215 example, if a number of different deliveries are being done for the same
38216 message. However, remote SMTP deliveries can take a long time, and this means
38217 that the file may be kept open long after it is renamed if &'exicyclog'& or
38218 something similar is being used to rename log files on a regular basis. To
38219 ensure that a switch of log files is noticed as soon as possible, Exim calls
38220 &[stat()]& on the main log's name before reusing an open file, and if the file
38221 does not exist, or its inode has changed, the old file is closed and Exim
38222 tries to open the main log from scratch. Thus, an old log file may remain open
38223 for quite some time, but no Exim processes should write to it once it has been
38224 renamed.
38225
38226
38227
38228 .section "Datestamped log files" "SECTdatlogfil"
38229 .cindex "log" "datestamped files"
38230 Instead of cycling the main and reject log files by renaming them
38231 periodically, some sites like to use files whose names contain a datestamp,
38232 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
38233 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
38234 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
38235 point where the datestamp is required. For example:
38236 .code
38237 log_file_path = /var/spool/exim/log/%slog-%D
38238 log_file_path = /var/log/exim-%s-%D.log
38239 log_file_path = /var/spool/exim/log/%D-%slog
38240 log_file_path = /var/log/exim/%s.%M
38241 .endd
38242 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
38243 examples of names generated by the above examples:
38244 .code
38245 /var/spool/exim/log/mainlog-20021225
38246 /var/log/exim-reject-20021225.log
38247 /var/spool/exim/log/20021225-mainlog
38248 /var/log/exim/main.200212
38249 .endd
38250 When this form of log file is specified, Exim automatically switches to new
38251 files at midnight. It does not make any attempt to compress old logs; you
38252 will need to write your own script if you require this. You should not
38253 run &'exicyclog'& with this form of logging.
38254
38255 The location of the panic log is also determined by &%log_file_path%&, but it
38256 is not datestamped, because rotation of the panic log does not make sense.
38257 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
38258 the string. In addition, if it immediately follows a slash, a following
38259 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
38260 character is removed. Thus, the four examples above would give these panic
38261 log names:
38262 .code
38263 /var/spool/exim/log/paniclog
38264 /var/log/exim-panic.log
38265 /var/spool/exim/log/paniclog
38266 /var/log/exim/panic
38267 .endd
38268
38269
38270 .section "Logging to syslog" "SECID249"
38271 .cindex "log" "syslog; writing to"
38272 The use of syslog does not change what Exim logs or the format of its messages,
38273 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
38274 Exim's log lines are omitted when these lines are sent to syslog. Apart from
38275 that, the same strings are written to syslog as to log files. The syslog
38276 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
38277 by default, but you can change these by setting the &%syslog_facility%& and
38278 &%syslog_processname%& options, respectively. If Exim was compiled with
38279 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
38280 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
38281 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
38282 the time and host name to each line.
38283 The three log streams are mapped onto syslog priorities as follows:
38284
38285 .ilist
38286 &'mainlog'& is mapped to LOG_INFO
38287 .next
38288 &'rejectlog'& is mapped to LOG_NOTICE
38289 .next
38290 &'paniclog'& is mapped to LOG_ALERT
38291 .endlist
38292
38293 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
38294 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
38295 these are routed by syslog to the same place. You can suppress this duplication
38296 by setting &%syslog_duplication%& false.
38297
38298 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
38299 entries contain multiple lines when headers are included. To cope with both
38300 these cases, entries written to syslog are split into separate &[syslog()]&
38301 calls at each internal newline, and also after a maximum of
38302 870 data characters. (This allows for a total syslog line length of 1024, when
38303 additions such as timestamps are added.) If you are running a syslog
38304 replacement that can handle lines longer than the 1024 characters allowed by
38305 RFC 3164, you should set
38306 .code
38307 SYSLOG_LONG_LINES=yes
38308 .endd
38309 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
38310 lines, but it still splits at internal newlines in &'reject'& log entries.
38311
38312 To make it easy to re-assemble split lines later, each component of a split
38313 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
38314 where <&'n'&> is the component number and <&'m'&> is the total number of
38315 components in the entry. The / delimiter is used when the line was split
38316 because it was too long; if it was split because of an internal newline, the \
38317 delimiter is used. For example, supposing the length limit to be 50 instead of
38318 870, the following would be the result of a typical rejection message to
38319 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
38320 name, and pid as added by syslog:
38321 .code
38322 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
38323 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
38324 [3/5]  when scanning for sender: missing or malformed lo
38325 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
38326 [5/5] mple>)
38327 .endd
38328 The same error might cause the following lines to be written to &"rejectlog"&
38329 (LOG_NOTICE):
38330 .code
38331 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
38332 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
38333 [3/18] er when scanning for sender: missing or malformed
38334 [4/18]  local part in "<>" (envelope sender is <ph10@cam
38335 [5\18] .example>)
38336 [6\18] Recipients: ph10@some.domain.cam.example
38337 [7\18] P Received: from [127.0.0.1] (ident=ph10)
38338 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
38339 [9\18]        id 16RdAL-0006pc-00
38340 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
38341 [11\18] 09:43 +0100
38342 [12\18] F From: <>
38343 [13\18]   Subject: this is a test header
38344 [18\18]   X-something: this is another header
38345 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
38346 [16\18] le>
38347 [17\18] B Bcc:
38348 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
38349 .endd
38350 Log lines that are neither too long nor contain newlines are written to syslog
38351 without modification.
38352
38353 If only syslog is being used, the Exim monitor is unable to provide a log tail
38354 display, unless syslog is routing &'mainlog'& to a file on the local host and
38355 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
38356 where it is.
38357
38358
38359
38360 .section "Log line flags" "SECID250"
38361 One line is written to the main log for each message received, and for each
38362 successful, unsuccessful, and delayed delivery. These lines can readily be
38363 picked out by the distinctive two-character flags that immediately follow the
38364 timestamp. The flags are:
38365 .display
38366 &`<=`&     message arrival
38367 &`(=`&     message fakereject
38368 &`=>`&     normal message delivery
38369 &`->`&     additional address in same delivery
38370 &`>>`&     cutthrough message delivery
38371 &`*>`&     delivery suppressed by &%-N%&
38372 &`**`&     delivery failed; address bounced
38373 &`==`&     delivery deferred; temporary problem
38374 .endd
38375
38376
38377 .section "Logging message reception" "SECID251"
38378 .cindex "log" "reception line"
38379 The format of the single-line entry in the main log that is written for every
38380 message received is shown in the basic example below, which is split over
38381 several lines in order to fit it on the page:
38382 .code
38383 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
38384   H=mailer.fict.example [192.168.123.123] U=exim
38385   P=smtp S=5678 id=<incoming message id>
38386 .endd
38387 The address immediately following &"<="& is the envelope sender address. A
38388 bounce message is shown with the sender address &"<>"&, and if it is locally
38389 generated, this is followed by an item of the form
38390 .code
38391 R=<message id>
38392 .endd
38393 which is a reference to the message that caused the bounce to be sent.
38394
38395 .cindex "HELO"
38396 .cindex "EHLO"
38397 For messages from other hosts, the H and U fields identify the remote host and
38398 record the RFC 1413 identity of the user that sent the message, if one was
38399 received. The number given in square brackets is the IP address of the sending
38400 host. If there is a single, unparenthesized  host name in the H field, as
38401 above, it has been verified to correspond to the IP address (see the
38402 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
38403 by the remote host in the SMTP HELO or EHLO command, and has not been
38404 verified. If verification yields a different name to that given for HELO or
38405 EHLO, the verified name appears first, followed by the HELO or EHLO
38406 name in parentheses.
38407
38408 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
38409 without brackets, in the HELO or EHLO command, leading to entries in
38410 the log containing text like these examples:
38411 .code
38412 H=(10.21.32.43) [192.168.8.34]
38413 H=([10.21.32.43]) [192.168.8.34]
38414 .endd
38415 This can be confusing. Only the final address in square brackets can be relied
38416 on.
38417
38418 For locally generated messages (that is, messages not received over TCP/IP),
38419 the H field is omitted, and the U field contains the login name of the caller
38420 of Exim.
38421
38422 .cindex "authentication" "logging"
38423 .cindex "AUTH" "logging"
38424 For all messages, the P field specifies the protocol used to receive the
38425 message. This is the value that is stored in &$received_protocol$&. In the case
38426 of incoming SMTP messages, the value indicates whether or not any SMTP
38427 extensions (ESMTP), encryption, or authentication were used. If the SMTP
38428 session was encrypted, there is an additional X field that records the cipher
38429 suite that was used.
38430
38431 .cindex log protocol
38432 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
38433 hosts that have authenticated themselves using the SMTP AUTH command. The first
38434 value is used when the SMTP connection was encrypted (&"secure"&). In this case
38435 there is an additional item A= followed by the name of the authenticator that
38436 was used. If an authenticated identification was set up by the authenticator's
38437 &%server_set_id%& option, this is logged too, separated by a colon from the
38438 authenticator name.
38439
38440 .cindex "size" "of message"
38441 The id field records the existing message id, if present. The size of the
38442 received message is given by the S field. When the message is delivered,
38443 headers may be removed or added, so that the size of delivered copies of the
38444 message may not correspond with this value (and indeed may be different to each
38445 other).
38446
38447 The &%log_selector%& option can be used to request the logging of additional
38448 data when a message is received. See section &<<SECTlogselector>>& below.
38449
38450
38451
38452 .section "Logging deliveries" "SECID252"
38453 .cindex "log" "delivery line"
38454 The format of the single-line entry in the main log that is written for every
38455 delivery is shown in one of the examples below, for local and remote
38456 deliveries, respectively. Each example has been split into multiple lines in order
38457 to fit it on the page:
38458 .code
38459 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
38460   <marv@hitch.fict.example> R=localuser T=local_delivery
38461 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
38462   monk@holistic.fict.example R=dnslookup T=remote_smtp
38463   H=holistic.fict.example [192.168.234.234]
38464 .endd
38465 For ordinary local deliveries, the original address is given in angle brackets
38466 after the final delivery address, which might be a pipe or a file. If
38467 intermediate address(es) exist between the original and the final address, the
38468 last of these is given in parentheses after the final address. The R and T
38469 fields record the router and transport that were used to process the address.
38470
38471 If SMTP AUTH was used for the delivery there is an additional item A=
38472 followed by the name of the authenticator that was used.
38473 If an authenticated identification was set up by the authenticator's &%client_set_id%&
38474 option, this is logged too, as a second colon-separated list item.
38475 Optionally (see the &%smtp_mailauth%& &%log_selector%&) there may be a third list item.
38476
38477 If a shadow transport was run after a successful local delivery, the log line
38478 for the successful delivery has an item added on the end, of the form
38479 .display
38480 &`ST=<`&&'shadow transport name'&&`>`&
38481 .endd
38482 If the shadow transport did not succeed, the error message is put in
38483 parentheses afterwards.
38484
38485 .cindex "asterisk" "after IP address"
38486 When more than one address is included in a single delivery (for example, two
38487 SMTP RCPT commands in one transaction) the second and subsequent addresses are
38488 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
38489 down a single SMTP connection, an asterisk follows the
38490 remote IP address (and port if enabled)
38491 in the log lines for the second and subsequent messages.
38492 When two or more messages are delivered down a single TLS connection, the
38493 DNS and some TLS-related information logged for the first message delivered
38494 will not be present in the log lines for the second and subsequent messages.
38495 TLS cipher information is still available.
38496
38497 .cindex "delivery" "cutthrough; logging"
38498 .cindex "cutthrough" "logging"
38499 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
38500 line precedes the reception line, since cutthrough waits for a possible
38501 rejection from the destination in case it can reject the sourced item.
38502
38503 The generation of a reply message by a filter file gets logged as a
38504 &"delivery"& to the addressee, preceded by &">"&.
38505
38506 The &%log_selector%& option can be used to request the logging of additional
38507 data when a message is delivered. See section &<<SECTlogselector>>& below.
38508
38509
38510 .section "Discarded deliveries" "SECID253"
38511 .cindex "discarded messages"
38512 .cindex "message" "discarded"
38513 .cindex "delivery" "discarded; logging"
38514 When a message is discarded as a result of the command &"seen finish"& being
38515 obeyed in a filter file which generates no deliveries, a log entry of the form
38516 .code
38517 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
38518   <low.club@bridge.example> R=userforward
38519 .endd
38520 is written, to record why no deliveries are logged. When a message is discarded
38521 because it is aliased to &":blackhole:"& the log line is like this:
38522 .code
38523 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
38524   <hole@nowhere.example> R=blackhole_router
38525 .endd
38526
38527
38528 .section "Deferred deliveries" "SECID254"
38529 When a delivery is deferred, a line of the following form is logged:
38530 .code
38531 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
38532   R=dnslookup T=smtp defer (146): Connection refused
38533 .endd
38534 In the case of remote deliveries, the error is the one that was given for the
38535 last IP address that was tried. Details of individual SMTP failures are also
38536 written to the log, so the above line would be preceded by something like
38537 .code
38538 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
38539   mail1.endrest.example [192.168.239.239]: Connection refused
38540 .endd
38541 When a deferred address is skipped because its retry time has not been reached,
38542 a message is written to the log, but this can be suppressed by setting an
38543 appropriate value in &%log_selector%&.
38544
38545
38546
38547 .section "Delivery failures" "SECID255"
38548 .cindex "delivery" "failure; logging"
38549 If a delivery fails because an address cannot be routed, a line of the
38550 following form is logged:
38551 .code
38552 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
38553   <jim@trek99.example>: unknown mail domain
38554 .endd
38555 If a delivery fails at transport time, the router and transport are shown, and
38556 the response from the remote host is included, as in this example:
38557 .code
38558 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
38559   R=dnslookup T=remote_smtp: SMTP error from remote mailer
38560   after pipelined RCPT TO:<ace400@pb.example>: host
38561   pbmail3.py.example [192.168.63.111]: 553 5.3.0
38562   <ace400@pb.example>...Addressee unknown
38563 .endd
38564 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
38565 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
38566 disabling PIPELINING. The log lines for all forms of delivery failure are
38567 flagged with &`**`&.
38568
38569
38570
38571 .section "Fake deliveries" "SECID256"
38572 .cindex "delivery" "fake; logging"
38573 If a delivery does not actually take place because the &%-N%& option has been
38574 used to suppress it, a normal delivery line is written to the log, except that
38575 &"=>"& is replaced by &"*>"&.
38576
38577
38578
38579 .section "Completion" "SECID257"
38580 A line of the form
38581 .code
38582 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
38583 .endd
38584 is written to the main log when a message is about to be removed from the spool
38585 at the end of its processing.
38586
38587
38588
38589
38590 .section "Summary of Fields in Log Lines" "SECID258"
38591 .cindex "log" "summary of fields"
38592 A summary of the field identifiers that are used in log lines is shown in
38593 the following table:
38594 .display
38595 &`A   `&        authenticator name (and optional id and sender)
38596 &`C   `&        SMTP confirmation on delivery
38597 &`    `&        command list for &"no mail in SMTP session"&
38598 &`CV  `&        certificate verification status
38599 &`D   `&        duration of &"no mail in SMTP session"&
38600 &`DKIM`&        domain verified in incoming message
38601 &`DN  `&        distinguished name from peer certificate
38602 &`DS  `&        DNSSEC secured lookups
38603 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
38604 &`F   `&        sender address (on delivery lines)
38605 &`H   `&        host name and IP address
38606 &`I   `&        local interface used
38607 &`id  `&        message id (from header) for incoming message
38608 &`K   `&        CHUNKING extension used
38609 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
38610 &`M8S `&        8BITMIME status for incoming message
38611 &`P   `&        on &`<=`& lines: protocol used
38612 &`    `&        on &`=>`& and &`**`& lines: return path
38613 &`PRDR`&        PRDR extension used
38614 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
38615 &`Q   `&        alternate queue name
38616 &`QT  `&        on &`=>`& lines: time spent on queue so far
38617 &`    `&        on &"Completed"& lines: time spent on queue
38618 &`R   `&        on &`<=`& lines: reference for local bounce
38619 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
38620 &`RT  `&        on &`<=`& lines: time taken for reception
38621 &`S   `&        size of message in bytes
38622 &`SNI `&        server name indication from TLS client hello
38623 &`ST  `&        shadow transport name
38624 &`T   `&        on &`<=`& lines: message subject (topic)
38625 &`TFO `&        connection took advantage of TCP Fast Open
38626 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
38627 &`U   `&        local user or RFC 1413 identity
38628 &`X   `&        TLS cipher suite
38629 .endd
38630
38631
38632 .section "Other log entries" "SECID259"
38633 Various other types of log entry are written from time to time. Most should be
38634 self-explanatory. Among the more common are:
38635
38636 .ilist
38637 .cindex "retry" "time not reached"
38638 &'retry time not reached'&&~&~An address previously suffered a temporary error
38639 during routing or local delivery, and the time to retry has not yet arrived.
38640 This message is not written to an individual message log file unless it happens
38641 during the first delivery attempt.
38642 .next
38643 &'retry time not reached for any host'&&~&~An address previously suffered
38644 temporary errors during remote delivery, and the retry time has not yet arrived
38645 for any of the hosts to which it is routed.
38646 .next
38647 .cindex "spool directory" "file locked"
38648 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
38649 some other Exim process is already working on the message. This can be quite
38650 common if queue running processes are started at frequent intervals. The
38651 &'exiwhat'& utility script can be used to find out what Exim processes are
38652 doing.
38653 .next
38654 .cindex "error" "ignored"
38655 &'error ignored'&&~&~There are several circumstances that give rise to this
38656 message:
38657 .olist
38658 Exim failed to deliver a bounce message whose age was greater than
38659 &%ignore_bounce_errors_after%&. The bounce was discarded.
38660 .next
38661 A filter file set up a delivery using the &"noerror"& option, and the delivery
38662 failed. The delivery was discarded.
38663 .next
38664 A delivery set up by a router configured with
38665 . ==== As this is a nested list, any displays it contains must be indented
38666 . ==== as otherwise they are too far to the left.
38667 .code
38668     errors_to = <>
38669 .endd
38670 failed. The delivery was discarded.
38671 .endlist olist
38672 .next
38673 .cindex DKIM "log line"
38674 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
38675 logging and the message has a DKIM signature header.
38676 .endlist ilist
38677
38678
38679
38680
38681
38682 .section "Reducing or increasing what is logged" "SECTlogselector"
38683 .cindex "log" "selectors"
38684 By setting the &%log_selector%& global option, you can disable some of Exim's
38685 default logging, or you can request additional logging. The value of
38686 &%log_selector%& is made up of names preceded by plus or minus characters. For
38687 example:
38688 .code
38689 log_selector = +arguments -retry_defer
38690 .endd
38691 The list of optional log items is in the following table, with the default
38692 selection marked by asterisks:
38693 .display
38694 &` 8bitmime                   `&  received 8BITMIME status
38695 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
38696 &` address_rewrite            `&  address rewriting
38697 &` all_parents                `&  all parents in => lines
38698 &` arguments                  `&  command line arguments
38699 &`*connection_reject          `&  connection rejections
38700 &`*delay_delivery             `&  immediate delivery delayed
38701 &` deliver_time               `&  time taken to attempt delivery
38702 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
38703 &`*dkim                       `&  DKIM verified domain on <= lines
38704 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
38705 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
38706 &` dnssec                     `&  DNSSEC secured lookups
38707 &`*etrn                       `&  ETRN commands
38708 &`*host_lookup_failed         `&  as it says
38709 &` ident_timeout              `&  timeout for ident connection
38710 &` incoming_interface         `&  local interface on <= and => lines
38711 &` incoming_port              `&  remote port on <= lines
38712 &`*lost_incoming_connection   `&  as it says (includes timeouts)
38713 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
38714 &`*msg_id                     `&  on <= lines, Message-ID: header value
38715 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
38716 &` outgoing_interface         `&  local interface on => lines
38717 &` outgoing_port              `&  add remote port to => lines
38718 &`*queue_run                  `&  start and end queue runs
38719 &` queue_time                 `&  time on queue for one recipient
38720 &`*queue_time_exclusive       `&  exclude recieve time from QT times
38721 &` queue_time_overall         `&  time on queue for whole message
38722 &` pid                        `&  Exim process id
38723 &` pipelining                 `&  PIPELINING use, on <= and => lines
38724 &` proxy                      `&  proxy address on <= and => lines
38725 &` receive_time               `&  time taken to receive message
38726 &` received_recipients        `&  recipients on <= lines
38727 &` received_sender            `&  sender on <= lines
38728 &`*rejected_header            `&  header contents on reject log
38729 &`*retry_defer                `&  &"retry time not reached"&
38730 &` return_path_on_delivery    `&  put return path on => and ** lines
38731 &` sender_on_delivery         `&  add sender to => lines
38732 &`*sender_verify_fail         `&  sender verification failures
38733 &`*size_reject                `&  rejection because too big
38734 &`*skip_delivery              `&  delivery skipped in a queue run
38735 &`*smtp_confirmation          `&  SMTP confirmation on => lines
38736 &` smtp_connection            `&  incoming SMTP connections
38737 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
38738 &` smtp_mailauth              `&  AUTH argument to MAIL commands
38739 &` smtp_no_mail               `&  session with no MAIL commands
38740 &` smtp_protocol_error        `&  SMTP protocol errors
38741 &` smtp_syntax_error          `&  SMTP syntax errors
38742 &` subject                    `&  contents of &'Subject:'& on <= lines
38743 &`*taint                      `&  taint errors or warnings
38744 &`*tls_certificate_verified   `&  certificate verification status
38745 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
38746 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
38747 &` tls_resumption             `&  append * to cipher field
38748 &` tls_sni                    `&  TLS SNI on <= lines
38749 &` unknown_in_list            `&  DNS lookup failed in list match
38750
38751 &` all                        `&  all of the above
38752 .endd
38753 See also the &%slow_lookup_log%& main configuration option,
38754 section &<<SECID99>>&
38755
38756 More details on each of these items follows:
38757
38758 .ilist
38759 .cindex "8BITMIME"
38760 .cindex "log" "8BITMIME"
38761 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
38762 which may help in tracking down interoperability issues with ancient MTAs
38763 that are not 8bit clean.  This is added to the &"<="& line, tagged with
38764 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
38765 &`7BIT`& and &`8BITMIME`& respectively.
38766 .next
38767 .cindex "&%warn%& ACL verb" "log when skipping"
38768 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
38769 its conditions cannot be evaluated, a log line to this effect is written if
38770 this log selector is set.
38771 .next
38772 .cindex "log" "rewriting"
38773 .cindex "rewriting" "logging"
38774 &%address_rewrite%&: This applies both to global rewrites and per-transport
38775 rewrites, but not to rewrites in filters run as an unprivileged user (because
38776 such users cannot access the log).
38777 .next
38778 .cindex "log" "full parentage"
38779 &%all_parents%&: Normally only the original and final addresses are logged on
38780 delivery lines; with this selector, intermediate parents are given in
38781 parentheses between them.
38782 .next
38783 .cindex "log" "Exim arguments"
38784 .cindex "Exim arguments, logging"
38785 &%arguments%&: This causes Exim to write the arguments with which it was called
38786 to the main log, preceded by the current working directory. This is a debugging
38787 feature, added to make it easier to find out how certain MUAs call
38788 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
38789 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
38790 that are empty or that contain white space are quoted. Non-printing characters
38791 are shown as escape sequences. This facility cannot log unrecognized arguments,
38792 because the arguments are checked before the configuration file is read. The
38793 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
38794 between the caller and Exim.
38795 .next
38796 .cindex "log" "connection rejections"
38797 &%connection_reject%&: A log entry is written whenever an incoming SMTP
38798 connection is rejected, for whatever reason.
38799 .next
38800 .cindex "log" "delayed delivery"
38801 .cindex "delayed delivery, logging"
38802 &%delay_delivery%&: A log entry is written whenever a delivery process is not
38803 started for an incoming message because the load is too high or too many
38804 messages were received on one connection. Logging does not occur if no delivery
38805 process is started because &%queue_only%& is set or &%-odq%& was used.
38806 .next
38807 .cindex "log" "delivery duration"
38808 &%deliver_time%&: For each delivery, the amount of real time it has taken to
38809 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
38810 If millisecond logging is enabled, short times will be shown with greater
38811 precision, eg. &`DT=0.304s`&.
38812 .next
38813 .cindex "log" "message size on delivery"
38814 .cindex "size" "of message"
38815 &%delivery_size%&: For each delivery, the size of message delivered is added to
38816 the &"=>"& line, tagged with S=.
38817 .next
38818 .cindex log "DKIM verification"
38819 .cindex DKIM "verification logging"
38820 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
38821 verifies successfully a tag of DKIM is added, with one of the verified domains.
38822 .next
38823 .cindex log "DKIM verification"
38824 .cindex DKIM "verification logging"
38825 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
38826 .next
38827 .cindex "log" "dnslist defer"
38828 .cindex "DNS list" "logging defer"
38829 .cindex "black list (DNS)"
38830 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
38831 DNS black list suffers a temporary error.
38832 .next
38833 .cindex log dnssec
38834 .cindex dnssec logging
38835 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
38836 dns lookups gave secure results a tag of DS is added.
38837 For acceptance this covers the reverse and forward lookups for host name verification.
38838 It does not cover helo-name verification.
38839 For delivery this covers the SRV, MX, A and/or AAAA lookups.
38840 .next
38841 .cindex "log" "ETRN commands"
38842 .cindex "ETRN" "logging"
38843 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
38844 is run to determine whether or not it is actually accepted. An invalid ETRN
38845 command, or one received within a message transaction is not logged by this
38846 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
38847 .next
38848 .cindex "log" "host lookup failure"
38849 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
38850 any addresses, or when a lookup of an IP address fails to find a host name, a
38851 log line is written. This logging does not apply to direct DNS lookups when
38852 routing email addresses, but it does apply to &"byname"& lookups.
38853 .next
38854 .cindex "log" "ident timeout"
38855 .cindex "RFC 1413" "logging timeout"
38856 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
38857 client's ident port times out.
38858 .next
38859 .cindex "log" "incoming interface"
38860 .cindex "log" "outgoing interface"
38861 .cindex "log" "local interface"
38862 .cindex "log" "local address and port"
38863 .cindex "TCP/IP" "logging local address and port"
38864 .cindex "interface" "logging"
38865 &%incoming_interface%&: The interface on which a message was received is added
38866 to the &"<="& line as an IP address in square brackets, tagged by I= and
38867 followed by a colon and the port number. The local interface and port are also
38868 added to other SMTP log lines, for example, &"SMTP connection from"&, to
38869 rejection lines, and (despite the name) to outgoing
38870 &"=>"&, &"->"&, &"=="& and &"**"& lines.
38871 The latter can be disabled by turning off the &%outgoing_interface%& option.
38872 .next
38873 .cindex log "incoming proxy address"
38874 .cindex proxy "logging proxy address"
38875 .cindex "TCP/IP" "logging proxy address"
38876 &%proxy%&: The internal (closest to the system running Exim) IP address
38877 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
38878 on a proxied connection
38879 or the &"=>"& line for a message delivered on a proxied connection.
38880 See &<<SECTproxyInbound>>& for more information.
38881 .next
38882 .cindex "log" "incoming remote port"
38883 .cindex "port" "logging remote"
38884 .cindex "TCP/IP" "logging incoming remote port"
38885 .vindex "&$sender_fullhost$&"
38886 .vindex "&$sender_rcvhost$&"
38887 &%incoming_port%&: The remote port number from which a message was received is
38888 added to log entries and &'Received:'& header lines, following the IP address
38889 in square brackets, and separated from it by a colon. This is implemented by
38890 changing the value that is put in the &$sender_fullhost$& and
38891 &$sender_rcvhost$& variables. Recording the remote port number has become more
38892 important with the widening use of NAT (see RFC 2505).
38893 .next
38894 .cindex "log" "dropped connection"
38895 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
38896 connection is unexpectedly dropped.
38897 .next
38898 .cindex "log" "millisecond timestamps"
38899 .cindex millisecond logging
38900 .cindex timestamps "millisecond, in logs"
38901 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
38902 appended to the seconds value.
38903 .next
38904 .cindex "log" "message id"
38905 &%msg_id%&: The value of the Message-ID: header.
38906 .next
38907 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
38908 This will be either because the message is a bounce, or was submitted locally
38909 (submission mode) without one.
38910 The field identifier will have an asterix appended: &"id*="&.
38911 .next
38912 .cindex "log" "outgoing interface"
38913 .cindex "log" "local interface"
38914 .cindex "log" "local address and port"
38915 .cindex "TCP/IP" "logging local address and port"
38916 .cindex "interface" "logging"
38917 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
38918 interface on which a message was sent is added to delivery lines as an I= tag
38919 followed by IP address in square brackets. You can disable this by turning
38920 off the &%outgoing_interface%& option.
38921 .next
38922 .cindex "log" "outgoing remote port"
38923 .cindex "port" "logging outgoing remote"
38924 .cindex "TCP/IP" "logging outgoing remote port"
38925 &%outgoing_port%&: The remote port number is added to delivery log lines (those
38926 containing => tags) following the IP address.
38927 The local port is also added if &%incoming_interface%& and
38928 &%outgoing_interface%& are both enabled.
38929 This option is not included in the default setting, because for most ordinary
38930 configurations, the remote port number is always 25 (the SMTP port), and the
38931 local port is a random ephemeral port.
38932 .next
38933 .cindex "log" "process ids in"
38934 .cindex "pid (process id)" "in log lines"
38935 &%pid%&: The current process id is added to every log line, in square brackets,
38936 immediately after the time and date.
38937 .next
38938 .cindex log pipelining
38939 .cindex pipelining "logging outgoing"
38940 &%pipelining%&: A field is added to delivery and accept
38941 log lines when the ESMTP PIPELINING extension was used.
38942 The field is a single "L".
38943
38944 On accept lines, where PIPELINING was offered but not used by the client,
38945 the field has a minus appended.
38946
38947 .cindex "pipelining" "early connection"
38948 If Exim is built with the SUPPORT_PIPE_CONNECT build option
38949 accept "L" fields have a period appended if the feature was
38950 offered but not used, or an asterisk appended if used.
38951 Delivery "L" fields have an asterisk appended if used.
38952
38953 .next
38954 .cindex "log" "queue run"
38955 .cindex "queue runner" "logging"
38956 &%queue_run%&: The start and end of every queue run are logged.
38957 .next
38958 .cindex "log" "queue time"
38959 &%queue_time%&: The amount of time the message has been in the queue on the
38960 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
38961 &`QT=3m45s`&.
38962 If millisecond logging is enabled, short times will be shown with greater
38963 precision, eg. &`QT=1.578s`&.
38964 .next
38965 &%queue_time_overall%&: The amount of time the message has been in the queue on
38966 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
38967 example, &`QT=3m45s`&.
38968 .next
38969 .cindex "log" "receive duration"
38970 &%receive_time%&: For each message, the amount of real time it has taken to
38971 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
38972 If millisecond logging is enabled, short times will be shown with greater
38973 precision, eg. &`RT=0.204s`&.
38974 .next
38975 .cindex "log" "recipients"
38976 &%received_recipients%&: The recipients of a message are listed in the main log
38977 as soon as the message is received. The list appears at the end of the log line
38978 that is written when a message is received, preceded by the word &"for"&. The
38979 addresses are listed after they have been qualified, but before any rewriting
38980 has taken place.
38981 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
38982 in the list.
38983 .next
38984 .cindex "log" "sender reception"
38985 &%received_sender%&: The unrewritten original sender of a message is added to
38986 the end of the log line that records the message's arrival, after the word
38987 &"from"& (before the recipients if &%received_recipients%& is also set).
38988 .next
38989 .cindex "log" "header lines for rejection"
38990 &%rejected_header%&: If a message's header has been received at the time a
38991 rejection is written to the reject log, the complete header is added to the
38992 log. Header logging can be turned off individually for messages that are
38993 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
38994 .next
38995 .cindex "log" "retry defer"
38996 &%retry_defer%&: A log line is written if a delivery is deferred because a
38997 retry time has not yet been reached. However, this &"retry time not reached"&
38998 message is always omitted from individual message logs after the first delivery
38999 attempt.
39000 .next
39001 .cindex "log" "return path"
39002 &%return_path_on_delivery%&: The return path that is being transmitted with
39003 the message is included in delivery and bounce lines, using the tag P=.
39004 This is omitted if no delivery actually happens, for example, if routing fails,
39005 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
39006 .next
39007 .cindex "log" "sender on delivery"
39008 &%sender_on_delivery%&: The message's sender address is added to every delivery
39009 and bounce line, tagged by F= (for &"from"&).
39010 This is the original sender that was received with the message; it is not
39011 necessarily the same as the outgoing return path.
39012 .next
39013 .cindex "log" "sender verify failure"
39014 &%sender_verify_fail%&: If this selector is unset, the separate log line that
39015 gives details of a sender verification failure is not written. Log lines for
39016 the rejection of SMTP commands contain just &"sender verify failed"&, so some
39017 detail is lost.
39018 .next
39019 .cindex "log" "size rejection"
39020 &%size_reject%&: A log line is written whenever a message is rejected because
39021 it is too big.
39022 .next
39023 .cindex "log" "frozen messages; skipped"
39024 .cindex "frozen messages" "logging skipping"
39025 &%skip_delivery%&: A log line is written whenever a message is skipped during a
39026 queue run because it another process is already delivering it or because
39027 it is frozen.
39028 .cindex "&""spool file is locked""&"
39029 .cindex "&""message is frozen""&"
39030 The message that is written is either &"spool file is locked"& or
39031 &"message is frozen"&.
39032 .next
39033 .cindex "log" "smtp confirmation"
39034 .cindex "SMTP" "logging confirmation"
39035 .cindex "LMTP" "logging confirmation"
39036 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
39037 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
39038 A number of MTAs (including Exim) return an identifying string in this
39039 response.
39040 .next
39041 .cindex "log" "SMTP connections"
39042 .cindex "SMTP" "logging connections"
39043 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
39044 established or closed, unless the connection is from a host that matches
39045 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
39046 only when the closure is unexpected.) This applies to connections from local
39047 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
39048 dropped in the middle of a message, a log line is always written, whether or
39049 not this selector is set, but otherwise nothing is written at the start and end
39050 of connections unless this selector is enabled.
39051
39052 For TCP/IP connections to an Exim daemon, the current number of connections is
39053 included in the log message for each new connection, but note that the count is
39054 reset if the daemon is restarted.
39055 Also, because connections are closed (and the closure is logged) in
39056 subprocesses, the count may not include connections that have been closed but
39057 whose termination the daemon has not yet noticed. Thus, while it is possible to
39058 match up the opening and closing of connections in the log, the value of the
39059 logged counts may not be entirely accurate.
39060 .next
39061 .cindex "log" "SMTP transaction; incomplete"
39062 .cindex "SMTP" "logging incomplete transactions"
39063 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
39064 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
39065 and the message sender plus any accepted recipients are included in the log
39066 line. This can provide evidence of dictionary attacks.
39067 .next
39068 .cindex "log" "non-MAIL SMTP sessions"
39069 .cindex "MAIL" "logging session without"
39070 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
39071 connection terminates without having issued a MAIL command. This includes both
39072 the case when the connection is dropped, and the case when QUIT is used. It
39073 does not include cases where the connection is rejected right at the start (by
39074 an ACL, or because there are too many connections, or whatever). These cases
39075 already have their own log lines.
39076
39077 The log line that is written contains the identity of the client in the usual
39078 way, followed by D= and a time, which records the duration of the connection.
39079 If the connection was authenticated, this fact is logged exactly as it is for
39080 an incoming message, with an A= item. If the connection was encrypted, CV=,
39081 DN=, and X= items may appear as they do for an incoming message, controlled by
39082 the same logging options.
39083
39084 Finally, if any SMTP commands were issued during the connection, a C= item
39085 is added to the line, listing the commands that were used. For example,
39086 .code
39087 C=EHLO,QUIT
39088 .endd
39089 shows that the client issued QUIT straight after EHLO. If there were fewer
39090 than 20 commands, they are all listed. If there were more than 20 commands,
39091 the last 20 are listed, preceded by &"..."&. However, with the default
39092 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
39093 have been aborted before 20 non-mail commands are processed.
39094 .next
39095 &%smtp_mailauth%&: A third subfield with the authenticated sender,
39096 colon-separated, is appended to the A= item for a message arrival or delivery
39097 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
39098 was accepted or used.
39099 .next
39100 .cindex "log" "SMTP protocol error"
39101 .cindex "SMTP" "logging protocol error"
39102 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
39103 encountered. Exim does not have perfect detection of all protocol errors
39104 because of transmission delays and the use of pipelining. If PIPELINING has
39105 been advertised to a client, an Exim server assumes that the client will use
39106 it, and therefore it does not count &"expected"& errors (for example, RCPT
39107 received after rejecting MAIL) as protocol errors.
39108 .next
39109 .cindex "SMTP" "logging syntax errors"
39110 .cindex "SMTP" "syntax errors; logging"
39111 .cindex "SMTP" "unknown command; logging"
39112 .cindex "log" "unknown SMTP command"
39113 .cindex "log" "SMTP syntax error"
39114 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
39115 encountered. An unrecognized command is treated as a syntax error. For an
39116 external connection, the host identity is given; for an internal connection
39117 using &%-bs%& the sender identification (normally the calling user) is given.
39118 .next
39119 .cindex "log" "subject"
39120 .cindex "subject, logging"
39121 &%subject%&: The subject of the message is added to the arrival log line,
39122 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
39123 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
39124 specifies whether characters with values greater than 127 should be logged
39125 unchanged, or whether they should be rendered as escape sequences.
39126 .next
39127 .cindex "log" "certificate verification"
39128 .cindex log DANE
39129 .cindex DANE logging
39130 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
39131 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
39132 verified
39133 using a CA trust anchor,
39134 &`CV=dane`& if using a DNS trust anchor,
39135 and &`CV=no`& if not.
39136 .next
39137 .cindex "log" "Taint warnings"
39138 &%taint%&: Log warnings about tainted data. This selector can't be
39139 turned of if &%allow_insecure_tainted_data%& is false (which is the
39140 default).
39141 .next
39142 .cindex "log" "TLS cipher"
39143 .cindex "TLS" "logging cipher"
39144 &%tls_cipher%&: When a message is sent or received over an encrypted
39145 connection, the cipher suite used is added to the log line, preceded by X=.
39146 .next
39147 .cindex "log" "TLS peer DN"
39148 .cindex "TLS" "logging peer DN"
39149 &%tls_peerdn%&: When a message is sent or received over an encrypted
39150 connection, and a certificate is supplied by the remote host, the peer DN is
39151 added to the log line, preceded by DN=.
39152 .next
39153 .cindex "log" "TLS resumption"
39154 .cindex "TLS" "logging session resumption"
39155 &%tls_resumption%&: When a message is sent or received over an encrypted
39156 connection and the TLS session resumed one used on a previous TCP connection,
39157 an asterisk is appended to the X= cipher field in the log line.
39158 .next
39159 .cindex "log" "TLS SNI"
39160 .cindex "TLS" "logging SNI"
39161 .cindex SNI logging
39162 &%tls_sni%&: When a message is received over an encrypted connection, and
39163 the remote host provided the Server Name Indication extension, the SNI is
39164 added to the log line, preceded by SNI=.
39165 .next
39166 .cindex "log" "DNS failure in list"
39167 &%unknown_in_list%&: This setting causes a log entry to be written when the
39168 result of a list match is failure because a DNS lookup failed.
39169 .endlist
39170
39171
39172 .section "Message log" "SECID260"
39173 .cindex "message" "log file for"
39174 .cindex "log" "message log; description of"
39175 .cindex "&_msglog_& directory"
39176 .oindex "&%preserve_message_logs%&"
39177 In addition to the general log files, Exim writes a log file for each message
39178 that it handles. The names of these per-message logs are the message ids, and
39179 they are kept in the &_msglog_& sub-directory of the spool directory. Each
39180 message log contains copies of the log lines that apply to the message. This
39181 makes it easier to inspect the status of an individual message without having
39182 to search the main log. A message log is deleted when processing of the message
39183 is complete, unless &%preserve_message_logs%& is set, but this should be used
39184 only with great care because they can fill up your disk very quickly.
39185
39186 On a heavily loaded system, it may be desirable to disable the use of
39187 per-message logs, in order to reduce disk I/O. This can be done by setting the
39188 &%message_logs%& option false.
39189 .ecindex IIDloggen
39190
39191
39192
39193
39194 . ////////////////////////////////////////////////////////////////////////////
39195 . ////////////////////////////////////////////////////////////////////////////
39196
39197 .chapter "Exim utilities" "CHAPutils"
39198 .scindex IIDutils "utilities"
39199 A number of utility scripts and programs are supplied with Exim and are
39200 described in this chapter. There is also the Exim Monitor, which is covered in
39201 the next chapter. The utilities described here are:
39202
39203 .itable none 0 0 3  7* left  15* left  40* left
39204 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
39205   "list what Exim processes are doing"
39206 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
39207 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
39208 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
39209 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
39210                                                 various criteria"
39211 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
39212 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
39213   "extract statistics from the log"
39214 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
39215   "check address acceptance from given IP"
39216 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
39217 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
39218 .irow &<<SECTdumpdb>>&        &'exim_dumpdb'&   "dump a hints database"
39219 .irow &<<SECTtidydb>>&        &'exim_tidydb'&   "clean up a hints database"
39220 .irow &<<SECTfixdb>>&         &'exim_fixdb'&    "patch a hints database"
39221 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
39222 .endtable
39223
39224 Another utility that might be of use to sites with many MTAs is Tom Kistner's
39225 &'exilog'&. It provides log visualizations across multiple Exim servers. See
39226 &url(https://duncanthrax.net/exilog/) for details.
39227
39228
39229
39230
39231 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
39232 .cindex "&'exiwhat'&"
39233 .cindex "process, querying"
39234 .cindex "SIGUSR1"
39235 On operating systems that can restart a system call after receiving a signal
39236 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
39237 a line describing what it is doing to the file &_exim-process.info_& in the
39238 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
39239 processes it can find, having first emptied the file. It then waits for one
39240 second to allow the Exim processes to react before displaying the results. In
39241 order to run &'exiwhat'& successfully you have to have sufficient privilege to
39242 send the signal to the Exim processes, so it is normally run as root.
39243
39244 &*Warning*&: This is not an efficient process. It is intended for occasional
39245 use by system administrators. It is not sensible, for example, to set up a
39246 script that sends SIGUSR1 signals to Exim processes at short intervals.
39247
39248
39249 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
39250 varies in different operating systems. Not only are different options used,
39251 but the format of the output is different. For this reason, there are some
39252 system configuration options that configure exactly how &'exiwhat'& works. If
39253 it doesn't seem to be working for you, check the following compile-time
39254 options:
39255 .display
39256 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
39257 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
39258 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
39259 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
39260 .endd
39261 An example of typical output from &'exiwhat'& is
39262 .code
39263 164 daemon: -q1h, listening on port 25
39264 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
39265 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
39266   [10.19.42.42] (editor@ref.example)
39267 10592 handling incoming call from [192.168.243.242]
39268 10628 accepting a local non-SMTP message
39269 .endd
39270 The first number in the output line is the process number. The third line has
39271 been split here, in order to fit it on the page.
39272
39273
39274
39275 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
39276 .cindex "&'exiqgrep'&"
39277 .cindex "queue" "grepping"
39278 This utility is a Perl script contributed by Matt Hubbard. It runs
39279 .code
39280 exim -bpu
39281 .endd
39282 or (in case &*-a*& switch is specified)
39283 .code
39284 exim -bp
39285 .endd
39286 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
39287 contain alternate exim configuration the queue management might be using.
39288
39289 to obtain a queue listing, and then greps the output to select messages
39290 that match given criteria. The following selection options are available:
39291
39292 .vlist
39293 .vitem &*-f*&&~<&'regex'&>
39294 Match the sender address using a case-insensitive search. The field that is
39295 tested is enclosed in angle brackets, so you can test for bounce messages with
39296 .code
39297 exiqgrep -f '^<>$'
39298 .endd
39299 .vitem &*-r*&&~<&'regex'&>
39300 Match a recipient address using a case-insensitive search. The field that is
39301 tested is not enclosed in angle brackets.
39302
39303 .vitem &*-s*&&~<&'regex'&>
39304 Match against the size field.
39305
39306 .vitem &*-y*&&~<&'seconds'&>
39307 Match messages that are younger than the given time.
39308
39309 .vitem &*-o*&&~<&'seconds'&>
39310 Match messages that are older than the given time.
39311
39312 .vitem &*-z*&
39313 Match only frozen messages.
39314
39315 .vitem &*-x*&
39316 Match only non-frozen messages.
39317
39318 .vitem &*-G*&&~<&'queuename'&>
39319 Match only messages in the given queue.  Without this, the default queue is searched.
39320 .endlist
39321
39322 The following options control the format of the output:
39323
39324 .vlist
39325 .vitem &*-c*&
39326 Display only the count of matching messages.
39327
39328 .vitem &*-l*&
39329 Long format &-- display the full message information as output by Exim. This is
39330 the default.
39331
39332 .vitem &*-i*&
39333 Display message ids only.
39334
39335 .vitem &*-b*&
39336 Brief format &-- one line per message.
39337
39338 .vitem &*-R*&
39339 Display messages in reverse order.
39340
39341 .vitem &*-a*&
39342 Include delivered recipients in queue listing.
39343 .endlist
39344
39345 There is one more option, &%-h%&, which outputs a list of options.
39346
39347
39348
39349 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
39350 .cindex "&'exiqsumm'&"
39351 .cindex "queue" "summary"
39352 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
39353 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
39354 running a command such as
39355 .code
39356 exim -bp | exiqsumm
39357 .endd
39358 The output consists of one line for each domain that has messages waiting for
39359 it, as in the following example:
39360 .code
39361 3   2322   74m   66m  msn.com.example
39362 .endd
39363 Each line lists the number of pending deliveries for a domain, their total
39364 volume, and the length of time that the oldest and the newest messages have
39365 been waiting. Note that the number of pending deliveries is greater than the
39366 number of messages when messages have more than one recipient.
39367
39368 A summary line is output at the end. By default the output is sorted on the
39369 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
39370 the output to be sorted by oldest message and by count of messages,
39371 respectively. There are also three options that split the messages for each
39372 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
39373 separates frozen messages, and &%-s%& separates messages according to their
39374 sender.
39375
39376 The output of &'exim -bp'& contains the original addresses in the message, so
39377 this also applies to the output from &'exiqsumm'&. No domains from addresses
39378 generated by aliasing or forwarding are included (unless the &%one_time%&
39379 option of the &(redirect)& router has been used to convert them into &"top
39380 level"& addresses).
39381
39382
39383
39384
39385 .section "Extracting specific information from the log (exigrep)" &&&
39386          "SECTextspeinf"
39387 .cindex "&'exigrep'&"
39388 .cindex "log" "extracts; grepping for"
39389 The &'exigrep'& utility is a Perl script that searches one or more main log
39390 files for entries that match a given pattern. When it finds a match, it
39391 extracts all the log entries for the relevant message, not just those that
39392 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
39393 given message, or all mail for a given user, or for a given host, for example.
39394 The input files can be in Exim log format or syslog format.
39395 If a matching log line is not associated with a specific message, it is
39396 included in &'exigrep'&'s output without any additional lines. The usage is:
39397 .display
39398 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
39399 .endd
39400 If no log filenames are given on the command line, the standard input is read.
39401
39402 The &%-t%& argument specifies a number of seconds. It adds an additional
39403 condition for message selection. Messages that are complete are shown only if
39404 they spent more than <&'n'&> seconds in the queue.
39405
39406 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
39407 makes it case-sensitive. This may give a performance improvement when searching
39408 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
39409 option; with &%-I%& they do not. In both cases it is possible to change the
39410 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
39411
39412 The &%-l%& option means &"literal"&, that is, treat all characters in the
39413 pattern as standing for themselves. Otherwise the pattern must be a Perl
39414 regular expression.
39415
39416 The &%-v%& option inverts the matching condition. That is, a line is selected
39417 if it does &'not'& match the pattern.
39418
39419 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
39420 that are generated as a result/response to a message that &'exigrep'& matched
39421 normally.
39422
39423 Example of &%-M%&:
39424 user_a sends a message to user_b, which generates a bounce back to user_b. If
39425 &'exigrep'& is used to search for &"user_a"&, only the first message will be
39426 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
39427 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
39428 when searching for &"user_a"& will show both messages since the bounce is
39429 &"related"& to or a &"result"& of the first message that was found by the
39430 search term.
39431
39432 If the location of a &'zcat'& command is known from the definition of
39433 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
39434 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
39435 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
39436 autodetection of some well known compression extensions.
39437
39438
39439 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
39440 .cindex "&'exipick'&"
39441 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
39442 lists messages from the queue according to a variety of criteria. For details
39443 of &'exipick'&'s facilities, run &'exipick'& with
39444 the &%--help%& option.
39445
39446
39447 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
39448 .cindex "log" "cycling local files"
39449 .cindex "cycling logs"
39450 .cindex "&'exicyclog'&"
39451 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
39452 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
39453 you are using log files with datestamps in their names (see section
39454 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
39455 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
39456 There are two command line options for &'exicyclog'&:
39457 .ilist
39458 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
39459 default that is set when Exim is built. The default default is 10.
39460 .next
39461 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
39462 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
39463 overriding the script's default, which is to find the setting from Exim's
39464 configuration.
39465 .endlist
39466
39467 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
39468 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
39469 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
39470 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
39471 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
39472 logs are handled similarly.
39473
39474 If the limit is greater than 99, the script uses 3-digit numbers such as
39475 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
39476 to one that is greater, or &'vice versa'&, you will have to fix the names of
39477 any existing log files.
39478
39479 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
39480 the end are deleted. All files with numbers greater than 01 are compressed,
39481 using a compression command which is configured by the COMPRESS_COMMAND
39482 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
39483 root &%crontab%& entry of the form
39484 .code
39485 1 0 * * * su exim -c /usr/exim/bin/exicyclog
39486 .endd
39487 assuming you have used the name &"exim"& for the Exim user. You can run
39488 &'exicyclog'& as root if you wish, but there is no need.
39489
39490
39491
39492 .section "Mail statistics (eximstats)" "SECTmailstat"
39493 .cindex "statistics"
39494 .cindex "&'eximstats'&"
39495 A Perl script called &'eximstats'& is provided for extracting statistical
39496 information from log files. The output is either plain text, or HTML.
39497 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
39498 . --- 404 error and everything else points to that.
39499
39500 The &'eximstats'& script has been hacked about quite a bit over time. The
39501 latest version is the result of some extensive revision by Steve Campbell. A
39502 lot of information is given by default, but there are options for suppressing
39503 various parts of it. Following any options, the arguments to the script are a
39504 list of files, which should be main log files. For example:
39505 .code
39506 eximstats -nr /var/spool/exim/log/mainlog.01
39507 .endd
39508 By default, &'eximstats'& extracts information about the number and volume of
39509 messages received from or delivered to various hosts. The information is sorted
39510 both by message count and by volume, and the top fifty hosts in each category
39511 are listed on the standard output. Similar information, based on email
39512 addresses or domains instead of hosts can be requested by means of various
39513 options. For messages delivered and received locally, similar statistics are
39514 also produced per user.
39515
39516 The output also includes total counts and statistics about delivery errors, and
39517 histograms showing the number of messages received and deliveries made in each
39518 hour of the day. A delivery with more than one address in its envelope (for
39519 example, an SMTP transaction with more than one RCPT command) is counted
39520 as a single delivery by &'eximstats'&.
39521
39522 Though normally more deliveries than receipts are reported (as messages may
39523 have multiple recipients), it is possible for &'eximstats'& to report more
39524 messages received than delivered, even though the queue is empty at the start
39525 and end of the period in question. If an incoming message contains no valid
39526 recipients, no deliveries are recorded for it. A bounce message is handled as
39527 an entirely separate message.
39528
39529 &'eximstats'& always outputs a grand total summary giving the volume and number
39530 of messages received and deliveries made, and the number of hosts involved in
39531 each case. It also outputs the number of messages that were delayed (that is,
39532 not completely delivered at the first attempt), and the number that had at
39533 least one address that failed.
39534
39535 The remainder of the output is in sections that can be independently disabled
39536 or modified by various options. It consists of a summary of deliveries by
39537 transport, histograms of messages received and delivered per time interval
39538 (default per hour), information about the time messages spent in the queue,
39539 a list of relayed messages, lists of the top fifty sending hosts, local
39540 senders, destination hosts, and destination local users by count and by volume,
39541 and a list of delivery errors that occurred.
39542
39543 The relay information lists messages that were actually relayed, that is, they
39544 came from a remote host and were directly delivered to some other remote host,
39545 without being processed (for example, for aliasing or forwarding) locally.
39546
39547 There are quite a few options for &'eximstats'& to control exactly what it
39548 outputs. These are documented in the Perl script itself, and can be extracted
39549 by running the command &(perldoc)& on the script. For example:
39550 .code
39551 perldoc /usr/exim/bin/eximstats
39552 .endd
39553
39554 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
39555 .cindex "&'exim_checkaccess'&"
39556 .cindex "policy control" "checking access"
39557 .cindex "checking access"
39558 The &%-bh%& command line argument allows you to run a fake SMTP session with
39559 debugging output, in order to check what Exim is doing when it is applying
39560 policy controls to incoming SMTP mail. However, not everybody is sufficiently
39561 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
39562 sometimes you just want to answer the question &"Does this address have
39563 access?"& without bothering with any further details.
39564
39565 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
39566 two arguments, an IP address and an email address:
39567 .code
39568 exim_checkaccess 10.9.8.7 A.User@a.domain.example
39569 .endd
39570 The utility runs a call to Exim with the &%-bh%& option, to test whether the
39571 given email address would be accepted in a RCPT command in a TCP/IP
39572 connection from the host with the given IP address. The output of the utility
39573 is either the word &"accepted"&, or the SMTP error response, for example:
39574 .code
39575 Rejected:
39576 550 Relay not permitted
39577 .endd
39578 When running this test, the utility uses &`<>`& as the envelope sender address
39579 for the MAIL command, but you can change this by providing additional
39580 options. These are passed directly to the Exim command. For example, to specify
39581 that the test is to be run with the sender address &'himself@there.example'&
39582 you can use:
39583 .code
39584 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
39585                  -f himself@there.example
39586 .endd
39587 Note that these additional Exim command line items must be given after the two
39588 mandatory arguments.
39589
39590 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
39591 while running its checks. You can run checks that include callouts by using
39592 &%-bhc%&, but this is not yet available in a &"packaged"& form.
39593
39594
39595
39596 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
39597 .cindex "DBM" "building dbm files"
39598 .cindex "building DBM files"
39599 .cindex "&'exim_dbmbuild'&"
39600 .cindex "lower casing"
39601 .cindex "binary zero" "in lookup key"
39602 The &'exim_dbmbuild'& program reads an input file containing keys and data in
39603 the format used by the &(lsearch)& lookup (see section
39604 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
39605 names as keys and the remainder of the information as data. The lower-casing
39606 can be prevented by calling the program with the &%-nolc%& option.
39607
39608 A terminating zero is included as part of the key string. This is expected by
39609 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
39610 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
39611 strings or the data strings. The &(dbmnz)& lookup type can be used with such
39612 files.
39613
39614 The program requires two arguments: the name of the input file (which can be a
39615 single hyphen to indicate the standard input), and the name of the output file.
39616 It creates the output under a temporary name, and then renames it if all went
39617 well.
39618
39619 .cindex "USE_DB"
39620 If the native DB interface is in use (USE_DB is set in a compile-time
39621 configuration file &-- this is common in free versions of Unix) the two
39622 filenames must be different, because in this mode the Berkeley DB functions
39623 create a single output file using exactly the name given. For example,
39624 .code
39625 exim_dbmbuild /etc/aliases /etc/aliases.db
39626 .endd
39627 reads the system alias file and creates a DBM version of it in
39628 &_/etc/aliases.db_&.
39629
39630 In systems that use the &'ndbm'& routines (mostly proprietary versions of
39631 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
39632 environment, the suffixes are added to the second argument of
39633 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
39634 when the Berkeley functions are used in compatibility mode (though this is not
39635 recommended), because in that case it adds a &_.db_& suffix to the filename.
39636
39637 If a duplicate key is encountered, the program outputs a warning, and when it
39638 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
39639 option is used. By default, only the first of a set of duplicates is used &--
39640 this makes it compatible with &(lsearch)& lookups. There is an option
39641 &%-lastdup%& which causes it to use the data for the last duplicate instead.
39642 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
39643 &%stderr%&. For other errors, where it doesn't actually make a new file, the
39644 return code is 2.
39645
39646
39647
39648
39649 .section "Finding individual retry times (exinext)" "SECTfinindret"
39650 .cindex "retry" "times"
39651 .cindex "&'exinext'&"
39652 A utility called &'exinext'& (mostly a Perl script) provides the ability to
39653 fish specific information out of the retry database. Given a mail domain (or a
39654 complete address), it looks up the hosts for that domain, and outputs any retry
39655 information for the hosts or for the domain. At present, the retry information
39656 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
39657 output. For example:
39658 .code
39659 $ exinext piglet@milne.fict.example
39660 kanga.milne.example:192.168.8.1 error 146: Connection refused
39661   first failed: 21-Feb-1996 14:57:34
39662   last tried:   21-Feb-1996 14:57:34
39663   next try at:  21-Feb-1996 15:02:34
39664 roo.milne.example:192.168.8.3 error 146: Connection refused
39665   first failed: 20-Jan-1996 13:12:08
39666   last tried:   21-Feb-1996 11:42:03
39667   next try at:  21-Feb-1996 19:42:03
39668   past final cutoff time
39669 .endd
39670 You can also give &'exinext'& a local part, without a domain, and it
39671 will give any retry information for that local part in your default domain.
39672 A message id can be used to obtain retry information pertaining to a specific
39673 message. This exists only when an attempt to deliver a message to a remote host
39674 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
39675 &'exinext'& is not particularly efficient, but then it is not expected to be
39676 run very often.
39677
39678 The &'exinext'& utility calls Exim to find out information such as the location
39679 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
39680 passed on to the &'exim'& commands. The first specifies an alternate Exim
39681 configuration file, and the second sets macros for use within the configuration
39682 file. These features are mainly to help in testing, but might also be useful in
39683 environments where more than one configuration file is in use.
39684
39685
39686
39687 .section "Hints database maintenance" "SECThindatmai"
39688 .cindex "hints database" "maintenance"
39689 .cindex "maintaining Exim's hints database"
39690 Three utility programs are provided for maintaining the DBM files that Exim
39691 uses to contain its delivery hint information. Each program requires two
39692 arguments. The first specifies the name of Exim's spool directory, and the
39693 second is the name of the database it is to operate on. These are as follows:
39694
39695 .ilist
39696 &'retry'&: the database of retry information
39697 .next
39698 &'wait-'&<&'transport name'&>: databases of information about messages waiting
39699 for remote hosts
39700 .next
39701 &'callout'&: the callout cache
39702 .next
39703 &'ratelimit'&: the data for implementing the ratelimit ACL condition
39704 .next
39705 &'tls'&: TLS session resumption data
39706 .next
39707 &'misc'&: other hints data
39708 .endlist
39709
39710 The &'misc'& database is used for
39711
39712 .ilist
39713 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
39714 .next
39715 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
39716 &(smtp)& transport)
39717 .next
39718 Limiting the concurrency of specific transports (when &%max_parallel%& is set
39719 in a transport)
39720 .endlist
39721
39722
39723
39724 .section "exim_dumpdb" "SECTdumpdb"
39725 .cindex "&'exim_dumpdb'&"
39726 The entire contents of a database are written to the standard output by the
39727 &'exim_dumpdb'& program, which has no options or arguments other than the
39728 spool and database names. For example, to dump the retry database:
39729 .code
39730 exim_dumpdb /var/spool/exim retry
39731 .endd
39732 Two lines of output are produced for each entry:
39733 .code
39734 T:mail.ref.example:192.168.242.242 146 77 Connection refused
39735 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
39736 .endd
39737 The first item on the first line is the key of the record. It starts with one
39738 of the letters R, or T, depending on whether it refers to a routing or
39739 transport retry. For a local delivery, the next part is the local address; for
39740 a remote delivery it is the name of the remote host, followed by its failing IP
39741 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
39742 transport). If the remote port is not the standard one (port 25), it is added
39743 to the IP address. Then there follows an error code, an additional error code,
39744 and a textual description of the error.
39745
39746 The three times on the second line are the time of first failure, the time of
39747 the last delivery attempt, and the computed time for the next attempt. The line
39748 ends with an asterisk if the cutoff time for the last retry rule has been
39749 exceeded.
39750
39751 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
39752 consists of a host name followed by a list of ids for messages that are or were
39753 waiting to be delivered to that host. If there are a very large number for any
39754 one host, continuation records, with a sequence number added to the host name,
39755 may be seen. The data in these records is often out of date, because a message
39756 may be routed to several alternative hosts, and Exim makes no effort to keep
39757 cross-references.
39758
39759
39760
39761 .section "exim_tidydb" "SECTtidydb"
39762 .cindex "&'exim_tidydb'&"
39763 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
39764 database. If run with no options, it removes all records that are more than 30
39765 days old. The age is calculated from the date and time that the record was last
39766 updated. Note that, in the case of the retry database, it is &'not'& the time
39767 since the first delivery failure. Information about a host that has been down
39768 for more than 30 days will remain in the database, provided that the record is
39769 updated sufficiently often.
39770
39771 The cutoff date can be altered by means of the &%-t%& option, which must be
39772 followed by a time. For example, to remove all records older than a week from
39773 the retry database:
39774 .code
39775 exim_tidydb -t 7d /var/spool/exim retry
39776 .endd
39777 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
39778 message ids. In the former these appear as data in records keyed by host &--
39779 they were messages that were waiting for that host &-- and in the latter they
39780 are the keys for retry information for messages that have suffered certain
39781 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
39782 message ids in database records are those of messages that are still on the
39783 queue. Message ids for messages that no longer exist are removed from
39784 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
39785 For the &'retry'& database, records whose keys are non-existent message ids are
39786 removed. The &'exim_tidydb'& utility outputs comments on the standard output
39787 whenever it removes information from the database.
39788
39789 Certain records are automatically removed by Exim when they are no longer
39790 needed, but others are not. For example, if all the MX hosts for a domain are
39791 down, a retry record is created for each one. If the primary MX host comes back
39792 first, its record is removed when Exim successfully delivers to it, but the
39793 records for the others remain because Exim has not tried to use those hosts.
39794
39795 It is important, therefore, to run &'exim_tidydb'& periodically on all the
39796 hints databases. You should do this at a quiet time of day, because it requires
39797 a database to be locked (and therefore inaccessible to Exim) while it does its
39798 work. Removing records from a DBM file does not normally make the file smaller,
39799 but all the common DBM libraries are able to re-use the space that is released.
39800 After an initial phase of increasing in size, the databases normally reach a
39801 point at which they no longer get any bigger, as long as they are regularly
39802 tidied.
39803
39804 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
39805 databases is likely to keep on increasing.
39806
39807
39808
39809
39810 .section "exim_fixdb" "SECTfixdb"
39811 .cindex "&'exim_fixdb'&"
39812 The &'exim_fixdb'& program is a utility for interactively modifying databases.
39813 Its main use is for testing Exim, but it might also be occasionally useful for
39814 getting round problems in a live system. It has no options, and its interface
39815 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
39816 key of a database record can then be entered, and the data for that record is
39817 displayed.
39818
39819 If &"d"& is typed at the next prompt, the entire record is deleted. For all
39820 except the &'retry'& database, that is the only operation that can be carried
39821 out. For the &'retry'& database, each field is output preceded by a number, and
39822 data for individual fields can be changed by typing the field number followed
39823 by new data, for example:
39824 .code
39825 > 4 951102:1000
39826 .endd
39827 resets the time of the next delivery attempt. Time values are given as a
39828 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
39829 used as optional separators.
39830
39831
39832
39833
39834 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
39835 .cindex "mailbox" "maintenance"
39836 .cindex "&'exim_lock'&"
39837 .cindex "locking mailboxes"
39838 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
39839 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
39840 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
39841 a user agent while investigating a problem. The utility requires the name of
39842 the file as its first argument. If the locking is successful, the second
39843 argument is run as a command (using C's &[system()]& function); if there is no
39844 second argument, the value of the SHELL environment variable is used; if this
39845 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
39846 is unlocked and the utility ends. The following options are available:
39847
39848 .vlist
39849 .vitem &%-fcntl%&
39850 Use &[fcntl()]& locking on the open mailbox.
39851
39852 .vitem &%-flock%&
39853 Use &[flock()]& locking on the open mailbox, provided the operating system
39854 supports it.
39855
39856 .vitem &%-interval%&
39857 This must be followed by a number, which is a number of seconds; it sets the
39858 interval to sleep between retries (default 3).
39859
39860 .vitem &%-lockfile%&
39861 Create a lock file before opening the mailbox.
39862
39863 .vitem &%-mbx%&
39864 Lock the mailbox using MBX rules.
39865
39866 .vitem &%-q%&
39867 Suppress verification output.
39868
39869 .vitem &%-retries%&
39870 This must be followed by a number; it sets the number of times to try to get
39871 the lock (default 10).
39872
39873 .vitem &%-restore_time%&
39874 This option causes &%exim_lock%& to restore the modified and read times to the
39875 locked file before exiting. This allows you to access a locked mailbox (for
39876 example, to take a backup copy) without disturbing the times that the user
39877 subsequently sees.
39878
39879 .vitem &%-timeout%&
39880 This must be followed by a number, which is a number of seconds; it sets a
39881 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
39882 default), a non-blocking call is used.
39883
39884 .vitem &%-v%&
39885 Generate verbose output.
39886 .endlist
39887
39888 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
39889 default is to create a lock file and also to use &[fcntl()]& locking on the
39890 mailbox, which is the same as Exim's default. The use of &%-flock%& or
39891 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
39892 requires that the directory containing the file be writeable. Locking by lock
39893 file does not last forever; Exim assumes that a lock file is expired if it is
39894 more than 30 minutes old.
39895
39896 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
39897 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
39898 to be taken out on the open mailbox, and an exclusive lock on the file
39899 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
39900 number of the mailbox file. When the locking is released, if an exclusive lock
39901 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
39902
39903 The default output contains verification of the locking that takes place. The
39904 &%-v%& option causes some additional information to be given. The &%-q%& option
39905 suppresses all output except error messages.
39906
39907 A command such as
39908 .code
39909 exim_lock /var/spool/mail/spqr
39910 .endd
39911 runs an interactive shell while the file is locked, whereas
39912 .display
39913 &`exim_lock -q /var/spool/mail/spqr <<End`&
39914 <&'some commands'&>
39915 &`End`&
39916 .endd
39917 runs a specific non-interactive sequence of commands while the file is locked,
39918 suppressing all verification output. A single command can be run by a command
39919 such as
39920 .code
39921 exim_lock -q /var/spool/mail/spqr \
39922   "cp /var/spool/mail/spqr /some/where"
39923 .endd
39924 Note that if a command is supplied, it must be entirely contained within the
39925 second argument &-- hence the quotes.
39926 .ecindex IIDutils
39927
39928
39929 . ////////////////////////////////////////////////////////////////////////////
39930 . ////////////////////////////////////////////////////////////////////////////
39931
39932 .chapter "The Exim monitor" "CHAPeximon"
39933 .scindex IIDeximon "Exim monitor" "description"
39934 .cindex "X-windows"
39935 .cindex "&'eximon'&"
39936 .cindex "Local/eximon.conf"
39937 .cindex "&_exim_monitor/EDITME_&"
39938 The Exim monitor is an application which displays in an X window information
39939 about the state of Exim's queue and what Exim is doing. An admin user can
39940 perform certain operations on messages from this GUI interface; however all
39941 such facilities are also available from the command line, and indeed, the
39942 monitor itself makes use of the command line to perform any actions requested.
39943
39944
39945
39946 .section "Running the monitor" "SECID264"
39947 The monitor is started by running the script called &'eximon'&. This is a shell
39948 script that sets up a number of environment variables, and then runs the
39949 binary called &_eximon.bin_&. The default appearance of the monitor window can
39950 be changed by editing the &_Local/eximon.conf_& file created by editing
39951 &_exim_monitor/EDITME_&. Comments in that file describe what the various
39952 parameters are for.
39953
39954 The parameters that get built into the &'eximon'& script can be overridden for
39955 a particular invocation by setting up environment variables of the same names,
39956 preceded by &`EXIMON_`&. For example, a shell command such as
39957 .code
39958 EXIMON_LOG_DEPTH=400 eximon
39959 .endd
39960 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
39961 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
39962 overrides the Exim log file configuration. This makes it possible to have
39963 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
39964 syslog messages are routed to a file on the local host.
39965
39966 X resources can be used to change the appearance of the window in the normal
39967 way. For example, a resource setting of the form
39968 .code
39969 Eximon*background: gray94
39970 .endd
39971 changes the colour of the background to light grey rather than white. The
39972 stripcharts are drawn with both the data lines and the reference lines in
39973 black. This means that the reference lines are not visible when on top of the
39974 data. However, their colour can be changed by setting a resource called
39975 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
39976 For example, if your X server is running Unix, you could set up lighter
39977 reference lines in the stripcharts by obeying
39978 .code
39979 xrdb -merge <<End
39980 Eximon*highlight: gray
39981 End
39982 .endd
39983 .cindex "admin user"
39984 In order to see the contents of messages in the queue, and to operate on them,
39985 &'eximon'& must either be run as root or by an admin user.
39986
39987 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
39988 contain X11 resource parameters interpreted by the X11 library.  In addition,
39989 if the first parameter starts with the string "gdb" then it is removed and the
39990 binary is invoked under gdb (the parameter is used as the gdb command-name, so
39991 versioned variants of gdb can be invoked).
39992
39993 The monitor's window is divided into three parts. The first contains one or
39994 more stripcharts and two action buttons, the second contains a &"tail"& of the
39995 main log file, and the third is a display of the queue of messages awaiting
39996 delivery, with two more action buttons. The following sections describe these
39997 different parts of the display.
39998
39999
40000
40001
40002 .section "The stripcharts" "SECID265"
40003 .cindex "stripchart"
40004 The first stripchart is always a count of messages in the queue. Its name can
40005 be configured by setting QUEUE_STRIPCHART_NAME in the
40006 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
40007 configuration script by regular expression matches on log file entries, making
40008 it possible to display, for example, counts of messages delivered to certain
40009 hosts or using certain transports. The supplied defaults display counts of
40010 received and delivered messages, and of local and SMTP deliveries. The default
40011 period between stripchart updates is one minute; this can be adjusted by a
40012 parameter in the &_Local/eximon.conf_& file.
40013
40014 The stripchart displays rescale themselves automatically as the value they are
40015 displaying changes. There are always 10 horizontal lines in each chart; the
40016 title string indicates the value of each division when it is greater than one.
40017 For example, &"x2"& means that each division represents a value of 2.
40018
40019 It is also possible to have a stripchart which shows the percentage fullness of
40020 a particular disk partition, which is useful when local deliveries are confined
40021 to a single partition.
40022
40023 .cindex "&%statvfs%& function"
40024 This relies on the availability of the &[statvfs()]& function or equivalent in
40025 the operating system. Most, but not all versions of Unix that support Exim have
40026 this. For this particular stripchart, the top of the chart always represents
40027 100%, and the scale is given as &"x10%"&. This chart is configured by setting
40028 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
40029 &_Local/eximon.conf_& file.
40030
40031
40032
40033
40034 .section "Main action buttons" "SECID266"
40035 .cindex "size" "of monitor window"
40036 .cindex "Exim monitor" "window size"
40037 .cindex "window size"
40038 Below the stripcharts there is an action button for quitting the monitor. Next
40039 to this is another button marked &"Size"&. They are placed here so that
40040 shrinking the window to its default minimum size leaves just the queue count
40041 stripchart and these two buttons visible. Pressing the &"Size"& button causes
40042 the window to expand to its maximum size, unless it is already at the maximum,
40043 in which case it is reduced to its minimum.
40044
40045 When expanding to the maximum, if the window cannot be fully seen where it
40046 currently is, it is moved back to where it was the last time it was at full
40047 size. When it is expanding from its minimum size, the old position is
40048 remembered, and next time it is reduced to the minimum it is moved back there.
40049
40050 The idea is that you can keep a reduced window just showing one or two
40051 stripcharts at a convenient place on your screen, easily expand it to show
40052 the full window when required, and just as easily put it back to what it was.
40053 The idea is copied from what the &'twm'& window manager does for its
40054 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
40055 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
40056
40057 Normally, the monitor starts up with the window at its full size, but it can be
40058 built so that it starts up with the window at its smallest size, by setting
40059 START_SMALL=yes in &_Local/eximon.conf_&.
40060
40061
40062
40063 .section "The log display" "SECID267"
40064 .cindex "log" "tail of; in monitor"
40065 The second section of the window is an area in which a display of the tail of
40066 the main log is maintained.
40067 To save space on the screen, the timestamp on each log line is shortened by
40068 removing the date and, if &%log_timezone%& is set, the timezone.
40069 The log tail is not available when the only destination for logging data is
40070 syslog, unless the syslog lines are routed to a local file whose name is passed
40071 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
40072
40073 The log sub-window has a scroll bar at its lefthand side which can be used to
40074 move back to look at earlier text, and the up and down arrow keys also have a
40075 scrolling effect. The amount of log that is kept depends on the setting of
40076 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
40077 to use. When this is full, the earlier 50% of data is discarded &-- this is
40078 much more efficient than throwing it away line by line. The sub-window also has
40079 a horizontal scroll bar for accessing the ends of long log lines. This is the
40080 only means of horizontal scrolling; the right and left arrow keys are not
40081 available. Text can be cut from this part of the window using the mouse in the
40082 normal way. The size of this subwindow is controlled by parameters in the
40083 configuration file &_Local/eximon.conf_&.
40084
40085 Searches of the text in the log window can be carried out by means of the ^R
40086 and ^S keystrokes, which default to a reverse and a forward search,
40087 respectively. The search covers only the text that is displayed in the window.
40088 It cannot go further back up the log.
40089
40090 The point from which the search starts is indicated by a caret marker. This is
40091 normally at the end of the text in the window, but can be positioned explicitly
40092 by pointing and clicking with the left mouse button, and is moved automatically
40093 by a successful search. If new text arrives in the window when it is scrolled
40094 back, the caret remains where it is, but if the window is not scrolled back,
40095 the caret is moved to the end of the new text.
40096
40097 Pressing ^R or ^S pops up a window into which the search text can be typed.
40098 There are buttons for selecting forward or reverse searching, for carrying out
40099 the search, and for cancelling. If the &"Search"& button is pressed, the search
40100 happens and the window remains so that further searches can be done. If the
40101 &"Return"& key is pressed, a single search is done and the window is closed. If
40102 ^C is typed the search is cancelled.
40103
40104 The searching facility is implemented using the facilities of the Athena text
40105 widget. By default this pops up a window containing both &"search"& and
40106 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
40107 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
40108 However, the linkers in BSDI and HP-UX seem unable to handle an externally
40109 provided version of &%TextPop%& when the remaining parts of the text widget
40110 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
40111 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
40112 on these systems, at the expense of having unwanted items in the search popup
40113 window.
40114
40115
40116
40117 .section "The queue display" "SECID268"
40118 .cindex "queue" "display in monitor"
40119 The bottom section of the monitor window contains a list of all messages that
40120 are in the queue, which includes those currently being received or delivered,
40121 as well as those awaiting delivery. The size of this subwindow is controlled by
40122 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
40123 at which it is updated is controlled by another parameter in the same file &--
40124 the default is 5 minutes, since queue scans can be quite expensive. However,
40125 there is an &"Update"& action button just above the display which can be used
40126 to force an update of the queue display at any time.
40127
40128 When a host is down for some time, a lot of pending mail can build up for it,
40129 and this can make it hard to deal with other messages in the queue. To help
40130 with this situation there is a button next to &"Update"& called &"Hide"&. If
40131 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
40132 type anything in here and press &"Return"&, the text is added to a chain of
40133 such texts, and if every undelivered address in a message matches at least one
40134 of the texts, the message is not displayed.
40135
40136 If there is an address that does not match any of the texts, all the addresses
40137 are displayed as normal. The matching happens on the ends of addresses so, for
40138 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
40139 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
40140 has been set up, a button called &"Unhide"& is displayed. If pressed, it
40141 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
40142 a hide request is automatically cancelled after one hour.
40143
40144 While the dialogue box is displayed, you can't press any buttons or do anything
40145 else to the monitor window. For this reason, if you want to cut text from the
40146 queue display to use in the dialogue box, you have to do the cutting before
40147 pressing the &"Hide"& button.
40148
40149 The queue display contains, for each unhidden queued message, the length of
40150 time it has been in the queue, the size of the message, the message id, the
40151 message sender, and the first undelivered recipient, all on one line. If it is
40152 a bounce message, the sender is shown as &"<>"&. If there is more than one
40153 recipient to which the message has not yet been delivered, subsequent ones are
40154 listed on additional lines, up to a maximum configured number, following which
40155 an ellipsis is displayed. Recipients that have already received the message are
40156 not shown.
40157
40158 .cindex "frozen messages" "display"
40159 If a message is frozen, an asterisk is displayed at the left-hand side.
40160
40161 The queue display has a vertical scroll bar, and can also be scrolled by means
40162 of the arrow keys. Text can be cut from it using the mouse in the normal way.
40163 The text searching facilities, as described above for the log window, are also
40164 available, but the caret is always moved to the end of the text when the queue
40165 display is updated.
40166
40167
40168
40169 .section "The queue menu" "SECID269"
40170 .cindex "queue" "menu in monitor"
40171 If the &%shift%& key is held down and the left button is clicked when the mouse
40172 pointer is over the text for any message, an action menu pops up, and the first
40173 line of the queue display for the message is highlighted. This does not affect
40174 any selected text.
40175
40176 If you want to use some other event for popping up the menu, you can set the
40177 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
40178 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
40179 value set in this parameter is a standard X event description. For example, to
40180 run eximon using &%ctrl%& rather than &%shift%& you could use
40181 .code
40182 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
40183 .endd
40184 The title of the menu is the message id, and it contains entries which act as
40185 follows:
40186
40187 .ilist
40188 &'message log'&: The contents of the message log for the message are displayed
40189 in a new text window.
40190 .next
40191 &'headers'&: Information from the spool file that contains the envelope
40192 information and headers is displayed in a new text window. See chapter
40193 &<<CHAPspool>>& for a description of the format of spool files.
40194 .next
40195 &'body'&: The contents of the spool file containing the body of the message are
40196 displayed in a new text window. There is a default limit of 20,000 bytes to the
40197 amount of data displayed. This can be changed by setting the BODY_MAX
40198 option at compile time, or the EXIMON_BODY_MAX option at runtime.
40199 .next
40200 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
40201 delivery of the message. This causes an automatic thaw if the message is
40202 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
40203 a new text window. The delivery is run in a separate process, to avoid holding
40204 up the monitor while the delivery proceeds.
40205 .next
40206 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
40207 that the message be frozen.
40208 .next
40209 .cindex "thawing messages"
40210 .cindex "unfreezing messages"
40211 .cindex "frozen messages" "thawing"
40212 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
40213 that the message be thawed.
40214 .next
40215 .cindex "delivery" "forcing failure"
40216 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
40217 that Exim gives up trying to deliver the message. A bounce message is generated
40218 for any remaining undelivered addresses.
40219 .next
40220 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
40221 that the message be deleted from the system without generating a bounce
40222 message.
40223 .next
40224 &'add recipient'&: A dialog box is displayed into which a recipient address can
40225 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40226 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40227 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40228 causes a call to Exim to be made using the &%-Mar%& option to request that an
40229 additional recipient be added to the message, unless the entry box is empty, in
40230 which case no action is taken.
40231 .next
40232 &'mark delivered'&: A dialog box is displayed into which a recipient address
40233 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40234 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40235 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40236 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
40237 recipient address as already delivered, unless the entry box is empty, in which
40238 case no action is taken.
40239 .next
40240 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
40241 mark all recipient addresses as already delivered.
40242 .next
40243 &'edit sender'&: A dialog box is displayed initialized with the current
40244 sender's address. Pressing RETURN causes a call to Exim to be made using the
40245 &%-Mes%& option to replace the sender address, unless the entry box is empty,
40246 in which case no action is taken. If you want to set an empty sender (as in
40247 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
40248 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
40249 the address is qualified with that domain.
40250 .endlist
40251
40252 When a delivery is forced, a window showing the &%-v%& output is displayed. In
40253 other cases when a call to Exim is made, if there is any output from Exim (in
40254 particular, if the command fails) a window containing the command and the
40255 output is displayed. Otherwise, the results of the action are normally apparent
40256 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
40257 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
40258 if no output is generated.
40259
40260 The queue display is automatically updated for actions such as freezing and
40261 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
40262 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
40263 force an update of the display after one of these actions.
40264
40265 In any text window that is displayed as result of a menu action, the normal
40266 cut-and-paste facility is available, and searching can be carried out using ^R
40267 and ^S, as described above for the log tail window.
40268 .ecindex IIDeximon
40269
40270
40271
40272
40273
40274 . ////////////////////////////////////////////////////////////////////////////
40275 . ////////////////////////////////////////////////////////////////////////////
40276
40277 .chapter "Security considerations" "CHAPsecurity"
40278 .scindex IIDsecurcon "security" "discussion of"
40279 This chapter discusses a number of issues concerned with security, some of
40280 which are also covered in other parts of this manual.
40281
40282 For reasons that this author does not understand, some people have promoted
40283 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
40284 existence of this chapter in the documentation. However, the intent of the
40285 chapter is simply to describe the way Exim works in relation to certain
40286 security concerns, not to make any specific claims about the effectiveness of
40287 its security as compared with other MTAs.
40288
40289 What follows is a description of the way Exim is supposed to be. Best efforts
40290 have been made to try to ensure that the code agrees with the theory, but an
40291 absence of bugs can never be guaranteed. Any that are reported will get fixed
40292 as soon as possible.
40293
40294
40295 .section "Building a more &""hardened""& Exim" "SECID286"
40296 .cindex "security" "build-time features"
40297 There are a number of build-time options that can be set in &_Local/Makefile_&
40298 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
40299 Exim administrator who does not have the root password, or by someone who has
40300 penetrated the Exim (but not the root) account. These options are as follows:
40301
40302 .ilist
40303 ALT_CONFIG_PREFIX can be set to a string that is required to match the
40304 start of any filenames used with the &%-C%& option. When it is set, these
40305 filenames are also not allowed to contain the sequence &"/../"&. (However, if
40306 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
40307 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
40308 default setting for &%ALT_CONFIG_PREFIX%&.
40309
40310 If the permitted configuration files are confined to a directory to
40311 which only root has access, this guards against someone who has broken
40312 into the Exim account from running a privileged Exim with an arbitrary
40313 configuration file, and using it to break into other accounts.
40314 .next
40315
40316 If a non-trusted configuration file (i.e. not the default configuration file
40317 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
40318 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
40319 the next item), then root privilege is retained only if the caller of Exim is
40320 root. This locks out the possibility of testing a configuration using &%-C%&
40321 right through message reception and delivery, even if the caller is root. The
40322 reception works, but by that time, Exim is running as the Exim user, so when
40323 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
40324 privilege to be lost. However, root can test reception and delivery using two
40325 separate commands.
40326
40327 .next
40328 The WHITELIST_D_MACROS build option declares some macros to be safe to override
40329 with &%-D%& if the real uid is one of root, the Exim run-time user or the
40330 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
40331 requiring the run-time value supplied to &%-D%& to match a regex that errs on
40332 the restrictive side.  Requiring build-time selection of safe macros is onerous
40333 but this option is intended solely as a transition mechanism to permit
40334 previously-working configurations to continue to work after release 4.73.
40335 .next
40336 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
40337 is disabled.
40338 .next
40339 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
40340 never to be used for any deliveries. This is like the &%never_users%& runtime
40341 option, but it cannot be overridden; the runtime option adds additional users
40342 to the list. The default setting is &"root"&; this prevents a non-root user who
40343 is permitted to modify the runtime file from using Exim as a way to get root.
40344 .endlist
40345
40346
40347
40348 .section "Root privilege" "SECID270"
40349 .cindex "setuid"
40350 .cindex "root privilege"
40351 The Exim binary is normally setuid to root, which means that it gains root
40352 privilege (runs as root) when it starts execution. In some special cases (for
40353 example, when the daemon is not in use and there are no local deliveries), it
40354 may be possible to run Exim setuid to some user other than root. This is
40355 discussed in the next section. However, in most installations, root privilege
40356 is required for two things:
40357
40358 .ilist
40359 To set up a socket connected to the standard SMTP port (25) when initialising
40360 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
40361 not required.
40362 .next
40363 To be able to change uid and gid in order to read users' &_.forward_& files and
40364 perform local deliveries as the receiving user or as specified in the
40365 configuration.
40366 .endlist
40367
40368 It is not necessary to be root to do any of the other things Exim does, such as
40369 receiving messages and delivering them externally over SMTP, and it is
40370 obviously more secure if Exim does not run as root except when necessary.
40371 For this reason, a user and group for Exim to use must be defined in
40372 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
40373 group"&. Their values can be changed by the runtime configuration, though this
40374 is not recommended. Often a user called &'exim'& is used, but some sites use
40375 &'mail'& or another user name altogether.
40376
40377 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
40378 abdication; the process cannot regain root afterwards. Prior to release 4.00,
40379 &[seteuid()]& was used in some circumstances, but this is no longer the case.
40380
40381 After a new Exim process has interpreted its command line options, it changes
40382 uid and gid in the following cases:
40383
40384 .ilist
40385 .oindex "&%-C%&"
40386 .oindex "&%-D%&"
40387 If the &%-C%& option is used to specify an alternate configuration file, or if
40388 the &%-D%& option is used to define macro values for the configuration, and the
40389 calling process is not running as root, the uid and gid are changed to those of
40390 the calling process.
40391 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
40392 option may not be used at all.
40393 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
40394 can be supplied if the calling process is running as root, the Exim run-time
40395 user or CONFIGURE_OWNER, if defined.
40396 .next
40397 .oindex "&%-be%&"
40398 .oindex "&%-bf%&"
40399 .oindex "&%-bF%&"
40400 If the expansion test option (&%-be%&) or one of the filter testing options
40401 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
40402 calling process.
40403 .next
40404 If the process is not a daemon process or a queue runner process or a delivery
40405 process or a process for testing address routing (started with &%-bt%&), the
40406 uid and gid are changed to the Exim user and group. This means that Exim always
40407 runs under its own uid and gid when receiving messages. This also applies when
40408 testing address verification
40409 .oindex "&%-bv%&"
40410 .oindex "&%-bh%&"
40411 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
40412 option).
40413 .next
40414 For a daemon, queue runner, delivery, or address testing process, the uid
40415 remains as root at this stage, but the gid is changed to the Exim group.
40416 .endlist
40417
40418 The processes that initially retain root privilege behave as follows:
40419
40420 .ilist
40421 A daemon process changes the gid to the Exim group and the uid to the Exim
40422 user after setting up one or more listening sockets. The &[initgroups()]&
40423 function is called, so that if the Exim user is in any additional groups, they
40424 will be used during message reception.
40425 .next
40426 A queue runner process retains root privilege throughout its execution. Its
40427 job is to fork a controlled sequence of delivery processes.
40428 .next
40429 A delivery process retains root privilege throughout most of its execution,
40430 but any actual deliveries (that is, the transports themselves) are run in
40431 subprocesses which always change to a non-root uid and gid. For local
40432 deliveries this is typically the uid and gid of the owner of the mailbox; for
40433 remote deliveries, the Exim uid and gid are used. Once all the delivery
40434 subprocesses have been run, a delivery process changes to the Exim uid and gid
40435 while doing post-delivery tidying up such as updating the retry database and
40436 generating bounce and warning messages.
40437
40438 While the recipient addresses in a message are being routed, the delivery
40439 process runs as root. However, if a user's filter file has to be processed,
40440 this is done in a subprocess that runs under the individual user's uid and
40441 gid. A system filter is run as root unless &%system_filter_user%& is set.
40442 .next
40443 A process that is testing addresses (the &%-bt%& option) runs as root so that
40444 the routing is done in the same environment as a message delivery.
40445 .endlist
40446
40447
40448
40449
40450 .section "Running Exim without privilege" "SECTrunexiwitpri"
40451 .cindex "privilege, running without"
40452 .cindex "unprivileged running"
40453 .cindex "root privilege" "running without"
40454 Some installations like to run Exim in an unprivileged state for more of its
40455 operation, for added security. Support for this mode of operation is provided
40456 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
40457 gid are changed to the Exim user and group at the start of a delivery process
40458 (and also queue runner and address testing processes). This means that address
40459 routing is no longer run as root, and the deliveries themselves cannot change
40460 to any other uid.
40461
40462 .cindex SIGHUP
40463 .cindex "daemon" "restarting"
40464 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
40465 that the daemon can still be started in the usual way, and it can respond
40466 correctly to SIGHUP because the re-invocation regains root privilege.
40467
40468 An alternative approach is to make Exim setuid to the Exim user and also setgid
40469 to the Exim group. If you do this, the daemon must be started from a root
40470 process. (Calling Exim from a root process makes it behave in the way it does
40471 when it is setuid root.) However, the daemon cannot restart itself after a
40472 SIGHUP signal because it cannot regain privilege.
40473
40474 It is still useful to set &%deliver_drop_privilege%& in this case, because it
40475 stops Exim from trying to re-invoke itself to do a delivery after a message has
40476 been received. Such a re-invocation is a waste of resources because it has no
40477 effect.
40478
40479 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
40480 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
40481 to the Exim user seems a clean approach, but there is one complication:
40482
40483 In this style of operation, Exim is running with the real uid and gid set to
40484 those of the calling process, and the effective uid/gid set to Exim's values.
40485 Ideally, any association with the calling process' uid/gid should be dropped,
40486 that is, the real uid/gid should be reset to the effective values so as to
40487 discard any privileges that the caller may have. While some operating systems
40488 have a function that permits this action for a non-root effective uid, quite a
40489 number of them do not. Because of this lack of standardization, Exim does not
40490 address this problem at this time.
40491
40492 For this reason, the recommended approach for &"mostly unprivileged"& running
40493 is to keep the Exim binary setuid to root, and to set
40494 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
40495 be used in the most straightforward way.
40496
40497 If you configure Exim not to run delivery processes as root, there are a
40498 number of restrictions on what you can do:
40499
40500 .ilist
40501 You can deliver only as the Exim user/group. You should  explicitly use the
40502 &%user%& and &%group%& options to override routers or local transports that
40503 normally deliver as the recipient. This makes sure that configurations that
40504 work in this mode function the same way in normal mode. Any implicit or
40505 explicit specification of another user causes an error.
40506 .next
40507 Use of &_.forward_& files is severely restricted, such that it is usually
40508 not worthwhile to include them in the configuration.
40509 .next
40510 Users who wish to use &_.forward_& would have to make their home directory and
40511 the file itself accessible to the Exim user. Pipe and append-to-file entries,
40512 and their equivalents in Exim filters, cannot be used. While they could be
40513 enabled in the Exim user's name, that would be insecure and not very useful.
40514 .next
40515 Unless the local user mailboxes are all owned by the Exim user (possible in
40516 some POP3 or IMAP-only environments):
40517
40518 .olist
40519 They must be owned by the Exim group and be writeable by that group. This
40520 implies you must set &%mode%& in the appendfile configuration, as well as the
40521 mode of the mailbox files themselves.
40522 .next
40523 You must set &%no_check_owner%&, since most or all of the files will not be
40524 owned by the Exim user.
40525 .next
40526 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
40527 on a newly created mailbox when unprivileged. This also implies that new
40528 mailboxes need to be created manually.
40529 .endlist olist
40530 .endlist ilist
40531
40532
40533 These restrictions severely restrict what can be done in local deliveries.
40534 However, there are no restrictions on remote deliveries. If you are running a
40535 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
40536 gives more security at essentially no cost.
40537
40538 If you are using the &%mua_wrapper%& facility (see chapter
40539 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
40540
40541
40542
40543
40544 .section "Delivering to local files" "SECID271"
40545 Full details of the checks applied by &(appendfile)& before it writes to a file
40546 are given in chapter &<<CHAPappendfile>>&.
40547
40548
40549
40550 .section "Running local commands" "SECTsecconslocalcmds"
40551 .cindex "security" "local commands"
40552 .cindex "security" "command injection attacks"
40553 There are a number of ways in which an administrator can configure Exim to run
40554 commands based upon received, untrustworthy, data. Further, in some
40555 configurations a user who can control a &_.forward_& file can also arrange to
40556 run commands. Configuration to check includes, but is not limited to:
40557
40558 .ilist
40559 Use of &%use_shell%& in the pipe transport: various forms of shell command
40560 injection may be possible with this option present. It is dangerous and should
40561 be used only with considerable caution. Consider constraints which whitelist
40562 allowed characters in a variable which is to be used in a pipe transport that
40563 has &%use_shell%& enabled.
40564 .next
40565 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
40566 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
40567 &_.forward_& files in a redirect router. If Exim is running on a central mail
40568 hub to which ordinary users do not have shell access, but home directories are
40569 NFS mounted (for instance) then administrators should review the list of these
40570 forbid options available, and should bear in mind that the options that may
40571 need forbidding can change as new features are added between releases.
40572 .next
40573 The &%${run...}%& expansion item does not use a shell by default, but
40574 administrators can configure use of &_/bin/sh_& as part of the command.
40575 Such invocations should be viewed with prejudicial suspicion.
40576 .next
40577 Administrators who use embedded Perl are advised to explore how Perl's
40578 taint checking might apply to their usage.
40579 .next
40580 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
40581 administrators are well advised to view its use with suspicion, in case (for
40582 instance) it allows a local-part to contain embedded Exim directives.
40583 .next
40584 Use of &%${match_local_part...}%& and friends becomes more dangerous if
40585 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
40586 each can reference arbitrary lists and files, rather than just being a list
40587 of opaque strings.
40588 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
40589 real-world security vulnerabilities caused by its use with untrustworthy data
40590 injected in, for SQL injection attacks.
40591 Consider the use of the &%inlisti%& expansion condition instead.
40592 .endlist
40593
40594
40595
40596
40597 .section "Trust in configuration data" "SECTsecconfdata"
40598 .cindex "security" "data sources"
40599 .cindex "security" "regular expressions"
40600 .cindex "regular expressions" "security"
40601 .cindex "PCRE" "security"
40602 If configuration data for Exim can come from untrustworthy sources, there
40603 are some issues to be aware of:
40604
40605 .ilist
40606 Use of &%${expand...}%& may provide a path for shell injection attacks.
40607 .next
40608 Letting untrusted data provide a regular expression is unwise.
40609 .next
40610 Using &%${match...}%& to apply a fixed regular expression against untrusted
40611 data may result in pathological behaviour within PCRE.  Be aware of what
40612 "backtracking" means and consider options for being more strict with a regular
40613 expression. Avenues to explore include limiting what can match (avoiding &`.`&
40614 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
40615 possessive quantifiers or just not using regular expressions against untrusted
40616 data.
40617 .next
40618 It can be important to correctly use &%${quote:...}%&,
40619 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
40620 items to ensure that data is correctly constructed.
40621 .next
40622 Some lookups might return multiple results, even though normal usage is only
40623 expected to yield one result.
40624 .endlist
40625
40626
40627
40628
40629 .section "IPv4 source routing" "SECID272"
40630 .cindex "source routing" "in IP packets"
40631 .cindex "IP source routing"
40632 Many operating systems suppress IP source-routed packets in the kernel, but
40633 some cannot be made to do this, so Exim does its own check. It logs incoming
40634 IPv4 source-routed TCP calls, and then drops them. Things are all different in
40635 IPv6. No special checking is currently done.
40636
40637
40638
40639 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
40640 Support for these SMTP commands is disabled by default. If required, they can
40641 be enabled by defining suitable ACLs.
40642
40643
40644
40645
40646 .section "Privileged users" "SECID274"
40647 .cindex "trusted users"
40648 .cindex "admin user"
40649 .cindex "privileged user"
40650 .cindex "user" "trusted"
40651 .cindex "user" "admin"
40652 Exim recognizes two sets of users with special privileges. Trusted users are
40653 able to submit new messages to Exim locally, but supply their own sender
40654 addresses and information about a sending host. For other users submitting
40655 local messages, Exim sets up the sender address from the uid, and doesn't
40656 permit a remote host to be specified.
40657
40658 .oindex "&%-f%&"
40659 However, an untrusted user is permitted to use the &%-f%& command line option
40660 in the special form &%-f <>%& to indicate that a delivery failure for the
40661 message should not cause an error report. This affects the message's envelope,
40662 but it does not affect the &'Sender:'& header. Untrusted users may also be
40663 permitted to use specific forms of address with the &%-f%& option by setting
40664 the &%untrusted_set_sender%& option.
40665
40666 Trusted users are used to run processes that receive mail messages from some
40667 other mail domain and pass them on to Exim for delivery either locally, or over
40668 the Internet. Exim trusts a caller that is running as root, as the Exim user,
40669 as any user listed in the &%trusted_users%& configuration option, or under any
40670 group listed in the &%trusted_groups%& option.
40671
40672 Admin users are permitted to do things to the messages on Exim's queue. They
40673 can freeze or thaw messages, cause them to be returned to their senders, remove
40674 them entirely, or modify them in various ways. In addition, admin users can run
40675 the Exim monitor and see all the information it is capable of providing, which
40676 includes the contents of files on the spool.
40677
40678 .oindex "&%-M%&"
40679 .oindex "&%-q%&"
40680 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
40681 delivery of messages on its queue is restricted to admin users. This
40682 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
40683 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
40684 queue is also restricted to admin users. This restriction can be relaxed by
40685 setting &%no_queue_list_requires_admin%&.
40686
40687 Exim recognizes an admin user if the calling process is running as root or as
40688 the Exim user or if any of the groups associated with the calling process is
40689 the Exim group. It is not necessary actually to be running under the Exim
40690 group. However, if admin users who are not root or the Exim user are to access
40691 the contents of files on the spool via the Exim monitor (which runs
40692 unprivileged), Exim must be built to allow group read access to its spool
40693 files.
40694
40695 By default, regular users are trusted to perform basic testing and
40696 introspection commands, as themselves.  This setting can be tightened by
40697 setting the &%commandline_checks_require_admin%& option.
40698 This affects most of the checking options,
40699 such as &%-be%& and anything else &%-b*%&.
40700
40701
40702 .section "Spool files" "SECID275"
40703 .cindex "spool directory" "files"
40704 Exim's spool directory and everything it contains is owned by the Exim user and
40705 set to the Exim group. The mode for spool files is defined in the
40706 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
40707 any user who is a member of the Exim group can access these files.
40708
40709
40710
40711 .section "Use of argv[0]" "SECID276"
40712 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
40713 of specific strings, Exim assumes certain options. For example, calling Exim
40714 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
40715 to calling it with the option &%-bS%&. There are no security implications in
40716 this.
40717
40718
40719
40720 .section "Use of %f formatting" "SECID277"
40721 The only use made of &"%f"& by Exim is in formatting load average values. These
40722 are actually stored in integer variables as 1000 times the load average.
40723 Consequently, their range is limited and so therefore is the length of the
40724 converted output.
40725
40726
40727
40728 .section "Embedded Exim path" "SECID278"
40729 Exim uses its own path name, which is embedded in the code, only when it needs
40730 to re-exec in order to regain root privilege. Therefore, it is not root when it
40731 does so. If some bug allowed the path to get overwritten, it would lead to an
40732 arbitrary program's being run as exim, not as root.
40733
40734
40735
40736 .section "Dynamic module directory" "SECTdynmoddir"
40737 Any dynamically loadable modules must be installed into the directory
40738 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
40739 loading it.
40740
40741
40742 .section "Use of sprintf()" "SECID279"
40743 .cindex "&[sprintf()]&"
40744 A large number of occurrences of &"sprintf"& in the code are actually calls to
40745 &'string_sprintf()'&, a function that returns the result in malloc'd store.
40746 The intermediate formatting is done into a large fixed buffer by a function
40747 that runs through the format string itself, and checks the length of each
40748 conversion before performing it, thus preventing buffer overruns.
40749
40750 The remaining uses of &[sprintf()]& happen in controlled circumstances where
40751 the output buffer is known to be sufficiently long to contain the converted
40752 string.
40753
40754
40755
40756 .section "Use of debug_printf() and log_write()" "SECID280"
40757 Arbitrary strings are passed to both these functions, but they do their
40758 formatting by calling the function &'string_vformat()'&, which runs through
40759 the format string itself, and checks the length of each conversion.
40760
40761
40762
40763 .section "Use of strcat() and strcpy()" "SECID281"
40764 These are used only in cases where the output buffer is known to be large
40765 enough to hold the result.
40766 .ecindex IIDsecurcon
40767
40768
40769
40770
40771 . ////////////////////////////////////////////////////////////////////////////
40772 . ////////////////////////////////////////////////////////////////////////////
40773
40774 .chapter "Format of spool files" "CHAPspool"
40775 .scindex IIDforspo1 "format" "spool files"
40776 .scindex IIDforspo2 "spool directory" "format of files"
40777 .scindex IIDforspo3 "spool files" "format of"
40778 .cindex "spool files" "editing"
40779 A message on Exim's queue consists of two files, whose names are the message id
40780 followed by -D and -H, respectively. The data portion of the message is kept in
40781 the -D file on its own. The message's envelope, status, and headers are all
40782 kept in the -H file, whose format is described in this chapter. Each of these
40783 two files contains the final component of its own name as its first line. This
40784 is insurance against disk crashes where the directory is lost but the files
40785 themselves are recoverable.
40786
40787 The file formats may be changed, or new formats added, at any release.
40788 Spool files are not intended as an interface to other programs
40789 and should not be used as such.
40790
40791 Some people are tempted into editing -D files in order to modify messages. You
40792 need to be extremely careful if you do this; it is not recommended and you are
40793 on your own if you do it. Here are some of the pitfalls:
40794
40795 .ilist
40796 You must ensure that Exim does not try to deliver the message while you are
40797 fiddling with it. The safest way is to take out a write lock on the -D file,
40798 which is what Exim itself does, using &[fcntl()]&. If you update the file in
40799 place, the lock will be retained. If you write a new file and rename it, the
40800 lock will be lost at the instant of rename.
40801 .next
40802 .vindex "&$body_linecount$&"
40803 If you change the number of lines in the file, the value of
40804 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
40805 cause incomplete transmission of messages or undeliverable messages.
40806 .next
40807 If the message is in MIME format, you must take care not to break it.
40808 .next
40809 If the message is cryptographically signed, any change will invalidate the
40810 signature.
40811 .endlist
40812 All in all, modifying -D files is fraught with danger.
40813
40814 Files whose names end with -J may also be seen in the &_input_& directory (or
40815 its subdirectories when &%split_spool_directory%& is set). These are journal
40816 files, used to record addresses to which the message has been delivered during
40817 the course of a delivery attempt. If there are still undelivered recipients at
40818 the end, the -H file is updated, and the -J file is deleted. If, however, there
40819 is some kind of crash (for example, a power outage) before this happens, the -J
40820 file remains in existence. When Exim next processes the message, it notices the
40821 -J file and uses it to update the -H file before starting the next delivery
40822 attempt.
40823
40824 Files whose names end with -K or .eml may also be seen in the spool.
40825 These are temporaries used for DKIM or malware processing, when that is used.
40826 They should be tidied up by normal operations; any old ones are probably
40827 relics of crashes and can be removed.
40828
40829 .section "Format of the -H file" "SECID282"
40830 .cindex "uid (user id)" "in spool file"
40831 .cindex "gid (group id)" "in spool file"
40832 The second line of the -H file contains the login name for the uid of the
40833 process that called Exim to read the message, followed by the numerical uid and
40834 gid. For a locally generated message, this is normally the user who sent the
40835 message. For a message received over TCP/IP via the daemon, it is
40836 normally the Exim user.
40837
40838 The third line of the file contains the address of the message's sender as
40839 transmitted in the envelope, contained in angle brackets. The sender address is
40840 empty for bounce messages. For incoming SMTP mail, the sender address is given
40841 in the MAIL command. For locally generated mail, the sender address is
40842 created by Exim from the login name of the current user and the configured
40843 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
40844 leading &"From&~"& line if the caller is trusted, or if the supplied address is
40845 &"<>"& or an address that matches &%untrusted_set_senders%&.
40846
40847 The fourth line contains two numbers. The first is the time that the message
40848 was received, in the conventional Unix form &-- the number of seconds since the
40849 start of the epoch. The second number is a count of the number of messages
40850 warning of delayed delivery that have been sent to the sender.
40851
40852 There follow a number of lines starting with a hyphen. These can appear in any
40853 order, and are omitted when not relevant:
40854
40855 .vlist
40856 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
40857 This item is obsolete, and is not generated from Exim release 4.61 onwards;
40858 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
40859 recognized, to provide backward compatibility. In the old format, a line of
40860 this form is present for every ACL variable that is not empty. The number
40861 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
40862 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
40863 the data string for the variable. The string itself starts at the beginning of
40864 the next line, and is followed by a newline character. It may contain internal
40865 newlines.
40866
40867 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
40868 A line of this form is present for every ACL connection variable that is
40869 defined. Note that there is a space between &%-aclc%& and the rest of the name.
40870 The length is the length of the data string for the variable. The string itself
40871 starts at the beginning of the next line, and is followed by a newline
40872 character. It may contain internal newlines.
40873
40874 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
40875 A line of this form is present for every ACL message variable that is defined.
40876 Note that there is a space between &%-aclm%& and the rest of the name. The
40877 length is the length of the data string for the variable. The string itself
40878 starts at the beginning of the next line, and is followed by a newline
40879 character. It may contain internal newlines.
40880
40881 .vitem "&%-active_hostname%&&~<&'hostname'&>"
40882 This is present if, when the message was received over SMTP, the value of
40883 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
40884
40885 .vitem &%-allow_unqualified_recipient%&
40886 This is present if unqualified recipient addresses are permitted in header
40887 lines (to stop such addresses from being qualified if rewriting occurs at
40888 transport time). Local messages that were input using &%-bnq%& and remote
40889 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
40890
40891 .vitem &%-allow_unqualified_sender%&
40892 This is present if unqualified sender addresses are permitted in header lines
40893 (to stop such addresses from being qualified if rewriting occurs at transport
40894 time). Local messages that were input using &%-bnq%& and remote messages from
40895 hosts that match &%sender_unqualified_hosts%& set this flag.
40896
40897 .vitem "&%-auth_id%&&~<&'text'&>"
40898 The id information for a message received on an authenticated SMTP connection
40899 &-- the value of the &$authenticated_id$& variable.
40900
40901 .vitem "&%-auth_sender%&&~<&'address'&>"
40902 The address of an authenticated sender &-- the value of the
40903 &$authenticated_sender$& variable.
40904
40905 .vitem "&%-body_linecount%&&~<&'number'&>"
40906 This records the number of lines in the body of the message, and is
40907 present unless &%-spool_file_wireformat%& is.
40908
40909 .vitem "&%-body_zerocount%&&~<&'number'&>"
40910 This records the number of binary zero bytes in the body of the message, and is
40911 present if the number is greater than zero.
40912
40913 .vitem &%-deliver_firsttime%&
40914 This is written when a new message is first added to the spool. When the spool
40915 file is updated after a deferral, it is omitted.
40916
40917 .vitem "&%-frozen%&&~<&'time'&>"
40918 .cindex "frozen messages" "spool data"
40919 The message is frozen, and the freezing happened at <&'time'&>.
40920
40921 .vitem "&%-helo_name%&&~<&'text'&>"
40922 This records the host name as specified by a remote host in a HELO or EHLO
40923 command.
40924
40925 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
40926 This records the IP address of the host from which the message was received and
40927 the remote port number that was used. It is omitted for locally generated
40928 messages.
40929
40930 .vitem "&%-host_auth%&&~<&'text'&>"
40931 If the message was received on an authenticated SMTP connection, this records
40932 the name of the authenticator &-- the value of the
40933 &$sender_host_authenticated$& variable.
40934
40935 .vitem &%-host_lookup_failed%&
40936 This is present if an attempt to look up the sending host's name from its IP
40937 address failed. It corresponds to the &$host_lookup_failed$& variable.
40938
40939 .vitem "&%-host_name%&&~<&'text'&>"
40940 .cindex "reverse DNS lookup"
40941 .cindex "DNS" "reverse lookup"
40942 This records the name of the remote host from which the message was received,
40943 if the host name was looked up from the IP address when the message was being
40944 received. It is not present if no reverse lookup was done.
40945
40946 .vitem "&%-ident%&&~<&'text'&>"
40947 For locally submitted messages, this records the login of the originating user,
40948 unless it was a trusted user and the &%-oMt%& option was used to specify an
40949 ident value. For messages received over TCP/IP, this records the ident string
40950 supplied by the remote host, if any.
40951
40952 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
40953 This records the IP address of the local interface and the port number through
40954 which a message was received from a remote host. It is omitted for locally
40955 generated messages.
40956
40957 .vitem &%-local%&
40958 The message is from a local sender.
40959
40960 .vitem &%-localerror%&
40961 The message is a locally-generated bounce message.
40962
40963 .vitem "&%-local_scan%&&~<&'string'&>"
40964 This records the data string that was returned by the &[local_scan()]& function
40965 when the message was received &-- the value of the &$local_scan_data$&
40966 variable. It is omitted if no data was returned.
40967
40968 .vitem &%-manual_thaw%&
40969 The message was frozen but has been thawed manually, that is, by an explicit
40970 Exim command rather than via the auto-thaw process.
40971
40972 .vitem &%-N%&
40973 A testing delivery process was started using the &%-N%& option to suppress any
40974 actual deliveries, but delivery was deferred. At any further delivery attempts,
40975 &%-N%& is assumed.
40976
40977 .vitem &%-received_protocol%&
40978 This records the value of the &$received_protocol$& variable, which contains
40979 the name of the protocol by which the message was received.
40980
40981 .vitem &%-sender_set_untrusted%&
40982 The envelope sender of this message was set by an untrusted local caller (used
40983 to ensure that the caller is displayed in queue listings).
40984
40985 .vitem "&%-spam_score_int%&&~<&'number'&>"
40986 If a message was scanned by SpamAssassin, this is present. It records the value
40987 of &$spam_score_int$&.
40988
40989 .vitem &%-spool_file_wireformat%&
40990 The -D file for this message is in wire-format (for ESMTP CHUNKING)
40991 rather than Unix-format.
40992 The line-ending is CRLF rather than newline.
40993 There is still, however, no leading-dot-stuffing.
40994
40995 .vitem &%-tls_certificate_verified%&
40996 A TLS certificate was received from the client that sent this message, and the
40997 certificate was verified by the server.
40998
40999 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
41000 When the message was received over an encrypted connection, this records the
41001 name of the cipher suite that was used.
41002
41003 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
41004 When the message was received over an encrypted connection, and a certificate
41005 was received from the client, this records the Distinguished Name from that
41006 certificate.
41007 .endlist
41008
41009 Any of the above may have an extra hyphen prepended, to indicate the the
41010 corresponding data is untrusted.
41011
41012 Following the options there is a list of those addresses to which the message
41013 is not to be delivered. This set of addresses is initialized from the command
41014 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
41015 is set; otherwise it starts out empty. Whenever a successful delivery is made,
41016 the address is added to this set. The addresses are kept internally as a
41017 balanced binary tree, and it is a representation of that tree which is written
41018 to the spool file. If an address is expanded via an alias or forward file, the
41019 original address is added to the tree when deliveries to all its child
41020 addresses are complete.
41021
41022 If the tree is empty, there is a single line in the spool file containing just
41023 the text &"XX"&. Otherwise, each line consists of two letters, which are either
41024 Y or N, followed by an address. The address is the value for the node of the
41025 tree, and the letters indicate whether the node has a left branch and/or a
41026 right branch attached to it, respectively. If branches exist, they immediately
41027 follow. Here is an example of a three-node tree:
41028 .code
41029 YY darcy@austen.fict.example
41030 NN alice@wonderland.fict.example
41031 NN editor@thesaurus.ref.example
41032 .endd
41033 After the non-recipients tree, there is a list of the message's recipients.
41034 This is a simple list, preceded by a count. It includes all the original
41035 recipients of the message, including those to whom the message has already been
41036 delivered. In the simplest case, the list contains one address per line. For
41037 example:
41038 .code
41039 4
41040 editor@thesaurus.ref.example
41041 darcy@austen.fict.example
41042 rdo@foundation
41043 alice@wonderland.fict.example
41044 .endd
41045 However, when a child address has been added to the top-level addresses as a
41046 result of the use of the &%one_time%& option on a &(redirect)& router, each
41047 line is of the following form:
41048 .display
41049 <&'top-level address'&> <&'errors_to address'&> &&&
41050   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
41051 .endd
41052 The 01 flag bit indicates the presence of the three other fields that follow
41053 the top-level address. Other bits may be used in future to support additional
41054 fields. The <&'parent number'&> is the offset in the recipients list of the
41055 original parent of the &"one time"& address. The first two fields are the
41056 envelope sender that is associated with this address and its length. If the
41057 length is zero, there is no special envelope sender (there are then two space
41058 characters in the line). A non-empty field can arise from a &(redirect)& router
41059 that has an &%errors_to%& setting.
41060
41061
41062 A blank line separates the envelope and status information from the headers
41063 which follow. A header may occupy several lines of the file, and to save effort
41064 when reading it in, each header is preceded by a number and an identifying
41065 character. The number is the number of characters in the header, including any
41066 embedded newlines and the terminating newline. The character is one of the
41067 following:
41068
41069 .table2 50pt
41070 .row <&'blank'&>         "header in which Exim has no special interest"
41071 .row &`B`&               "&'Bcc:'& header"
41072 .row &`C`&               "&'Cc:'& header"
41073 .row &`F`&               "&'From:'& header"
41074 .row &`I`&               "&'Message-id:'& header"
41075 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
41076 .row &`R`&               "&'Reply-To:'& header"
41077 .row &`S`&               "&'Sender:'& header"
41078 .row &`T`&               "&'To:'& header"
41079 .row &`*`&               "replaced or deleted header"
41080 .endtable
41081
41082 Deleted or replaced (rewritten) headers remain in the spool file for debugging
41083 purposes. They are not transmitted when the message is delivered. Here is a
41084 typical set of headers:
41085 .code
41086 111P Received: by hobbit.fict.example with local (Exim 4.00)
41087 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
41088 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
41089 038* X-rewrote-sender: bb@hobbit.fict.example
41090 042* From: Bilbo Baggins <bb@hobbit.fict.example>
41091 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
41092 099* To: alice@wonderland.fict.example, rdo@foundation,
41093 darcy@austen.fict.example, editor@thesaurus.ref.example
41094 104T To: alice@wonderland.fict.example, rdo@foundation.example,
41095 darcy@austen.fict.example, editor@thesaurus.ref.example
41096 038  Date: Fri, 11 May 2001 10:28:59 +0100
41097 .endd
41098 The asterisked headers indicate that the envelope sender, &'From:'& header, and
41099 &'To:'& header have been rewritten, the last one because routing expanded the
41100 unqualified domain &'foundation'&.
41101 .ecindex IIDforspo1
41102 .ecindex IIDforspo2
41103 .ecindex IIDforspo3
41104
41105 .section "Format of the -D file" "SECID282a"
41106 The data file is traditionally in Unix-standard format: lines are ended with
41107 an ASCII newline character.
41108 However, when the &%spool_wireformat%& main option is used some -D files
41109 can have an alternate format.
41110 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
41111 The -D file lines (not including the first name-component line) are
41112 suitable for direct copying to the wire when transmitting using the
41113 ESMTP CHUNKING option, meaning lower processing overhead.
41114 Lines are terminated with an ASCII CRLF pair.
41115 There is no dot-stuffing (and no dot-termination).
41116
41117 . ////////////////////////////////////////////////////////////////////////////
41118 . ////////////////////////////////////////////////////////////////////////////
41119
41120 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
41121          "DKIM, SPF, SRS and DMARC Support"
41122
41123 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
41124 .cindex "DKIM"
41125
41126 DKIM is a mechanism by which messages sent by some entity can be provably
41127 linked to a domain which that entity controls.  It permits reputation to
41128 be tracked on a per-domain basis, rather than merely upon source IP address.
41129 DKIM is documented in RFC 6376.
41130
41131 As DKIM relies on the message being unchanged in transit, messages handled
41132 by a mailing-list (which traditionally adds to the message) will not match
41133 any original DKIM signature.
41134
41135 DKIM support is compiled into Exim by default if TLS support is present.
41136 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
41137
41138 Exim's DKIM implementation allows for
41139 .olist
41140 Signing outgoing messages: This function is implemented in the SMTP transport.
41141 It can co-exist with all other Exim features
41142 (including transport filters)
41143 except cutthrough delivery.
41144 .next
41145 Verifying signatures in incoming messages: This is implemented by an additional
41146 ACL (acl_smtp_dkim), which can be called several times per message, with
41147 different signature contexts.
41148 .endlist
41149
41150 In typical Exim style, the verification implementation does not include any
41151 default "policy". Instead it enables you to build your own policy using
41152 Exim's standard controls.
41153
41154 Please note that verification of DKIM signatures in incoming mail is turned
41155 on by default for logging (in the <= line) purposes.
41156
41157 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
41158 When set, for each signature in incoming email,
41159 exim will log a line displaying the most important signature details, and the
41160 signature status. Here is an example (with line-breaks added for clarity):
41161 .code
41162 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
41163     d=facebookmail.com s=q1-2009b
41164     c=relaxed/relaxed a=rsa-sha1
41165     i=@facebookmail.com t=1252484542 [verification succeeded]
41166 .endd
41167
41168 You might want to turn off DKIM verification processing entirely for internal
41169 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
41170 control modifier. This should typically be done in the RCPT ACL, at points
41171 where you accept mail from relay sources (internal hosts or authenticated
41172 senders).
41173
41174
41175 .section "Signing outgoing messages" "SECDKIMSIGN"
41176 .cindex "DKIM" "signing"
41177
41178 For signing to be usable you must have published a DKIM record in DNS.
41179 Note that RFC 8301 (which does not cover EC keys) says:
41180 .code
41181 rsa-sha1 MUST NOT be used for signing or verifying.
41182
41183 Signers MUST use RSA keys of at least 1024 bits for all keys.
41184 Signers SHOULD use RSA keys of at least 2048 bits.
41185 .endd
41186
41187 Note also that the key content (the 'p=' field)
41188 in the DNS record is different between RSA and EC keys;
41189 for the former it is the base64 of the ASN.1 for the RSA public key
41190 (equivalent to the private-key .pem with the header/trailer stripped)
41191 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
41192
41193 Signing is enabled by setting private options on the SMTP transport.
41194 These options take (expandable) strings as arguments.
41195
41196 .option dkim_domain smtp "string list&!!" unset
41197 The domain(s) you want to sign with.
41198 After expansion, this can be a list.
41199 Each element in turn,
41200 lowercased,
41201 is put into the &%$dkim_domain%& expansion variable
41202 while expanding the remaining signing options.
41203 If it is empty after expansion, DKIM signing is not done,
41204 and no error will result even if &%dkim_strict%& is set.
41205
41206 .option dkim_selector smtp "string list&!!" unset
41207 This sets the key selector string.
41208 After expansion, which can use &$dkim_domain$&, this can be a list.
41209 Each element in turn is put in the expansion
41210 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
41211 option along with &%$dkim_domain%&.
41212 If the option is empty after expansion, DKIM signing is not done for this domain,
41213 and no error will result even if &%dkim_strict%& is set.
41214
41215 To do, for example, dual-signing with RSA and EC keys
41216 this could be be used:
41217 .code
41218 dkim_selector = ec_sel : rsa_sel
41219 dkim_private_key = KEYS_DIR/$dkim_selector
41220 .endd
41221
41222 .option dkim_private_key smtp string&!! unset
41223 This sets the private key to use.
41224 You can use the &%$dkim_domain%& and
41225 &%$dkim_selector%& expansion variables to determine the private key to use.
41226 The result can either
41227 .ilist
41228 be a valid RSA private key in ASCII armor (.pem file), including line breaks
41229 .next
41230 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41231 be a valid Ed25519 private key (same format as above)
41232 .next
41233 start with a slash, in which case it is treated as a file that contains
41234 the private key
41235 .next
41236 be "0", "false" or the empty string, in which case the message will not
41237 be signed. This case will not result in an error, even if &%dkim_strict%&
41238 is set.
41239 .endlist
41240
41241 To generate keys under OpenSSL:
41242 .code
41243 openssl genrsa -out dkim_rsa.private 2048
41244 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
41245 .endd
41246 The result file from the first command should be retained, and
41247 this option set to use it.
41248 Take the base-64 lines from the output of the second command, concatenated,
41249 for the DNS TXT record.
41250 See section 3.6 of RFC6376 for the record specification.
41251
41252 Under GnuTLS:
41253 .code
41254 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
41255 certtool --load-privkey=dkim_rsa.private --pubkey-info
41256 .endd
41257
41258 Note that RFC 8301 says:
41259 .code
41260 Signers MUST use RSA keys of at least 1024 bits for all keys.
41261 Signers SHOULD use RSA keys of at least 2048 bits.
41262 .endd
41263
41264 EC keys for DKIM are defined by RFC 8463.
41265 They are considerably smaller than RSA keys for equivalent protection.
41266 As they are a recent development, users should consider dual-signing
41267 (by setting a list of selectors, and an expansion for this option)
41268 for some transition period.
41269 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41270 for EC keys.
41271
41272 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
41273 .code
41274 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
41275 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
41276 .endd
41277
41278 To produce the required public key value for a DNS record:
41279 .code
41280 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
41281 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
41282 .endd
41283
41284 Exim also supports an alternate format
41285 of Ed25519 keys in DNS which was a candidate during development
41286 of the standard, but not adopted.
41287 A future release will probably drop that support.
41288
41289 .option dkim_hash smtp string&!! sha256
41290 Can be set to any one of the supported hash methods, which are:
41291 .ilist
41292 &`sha1`& &-- should not be used, is old and insecure
41293 .next
41294 &`sha256`& &-- the default
41295 .next
41296 &`sha512`& &-- possibly more secure but less well supported
41297 .endlist
41298
41299 Note that RFC 8301 says:
41300 .code
41301 rsa-sha1 MUST NOT be used for signing or verifying.
41302 .endd
41303
41304 .option dkim_identity smtp string&!! unset
41305 If set after expansion, the value is used to set an "i=" tag in
41306 the signing header.  The DKIM standards restrict the permissible
41307 syntax of this optional tag to a mail address, with possibly-empty
41308 local part, an @, and a domain identical to or subdomain of the "d="
41309 tag value.  Note that Exim does not check the value.
41310
41311 .option dkim_canon smtp string&!! unset
41312 This option sets the canonicalization method used when signing a message.
41313 The DKIM RFC currently supports two methods: "simple" and "relaxed".
41314 The option defaults to "relaxed" when unset. Note: the current implementation
41315 only supports signing with the same canonicalization method for both headers and body.
41316
41317 .option dkim_strict smtp string&!! unset
41318 This  option  defines  how  Exim  behaves  when  signing a message that
41319 should be signed fails for some reason.  When the expansion evaluates to
41320 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
41321 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
41322 variables here.
41323
41324 .option dkim_sign_headers smtp string&!! "see below"
41325 If set, this option must expand to a colon-separated
41326 list of header names.
41327 Headers with these names, or the absence or such a header, will be included
41328 in the message signature.
41329 When unspecified, the header names listed in RFC4871 will be used,
41330 whether or not each header is present in the message.
41331 The default list is available for the expansion in the macro
41332 &"_DKIM_SIGN_HEADERS"&
41333 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
41334
41335 If a name is repeated, multiple headers by that name (or the absence thereof)
41336 will be signed.  The textually later headers in the headers part of the
41337 message are signed first, if there are multiples.
41338
41339 A name can be prefixed with either an &"="& or a &"+"& character.
41340 If an &"="& prefix is used, all headers that are present with this name
41341 will be signed.
41342 If a &"+"& prefix if used, all headers that are present with this name
41343 will be signed, and one signature added for a missing header with the
41344 name will be appended.
41345
41346 .option dkim_timestamps smtp integer&!! unset
41347 This option controls the inclusion of timestamp information in the signature.
41348 If not set, no such information will be included.
41349 Otherwise, must be an unsigned number giving an offset in seconds from the current time
41350 for the expiry tag
41351 (eg. 1209600 for two weeks);
41352 both creation (t=) and expiry (x=) tags will be included.
41353
41354 RFC 6376 lists these tags as RECOMMENDED.
41355
41356
41357 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
41358 .cindex "DKIM" "verification"
41359
41360 Verification of DKIM signatures in SMTP incoming email is done for all
41361 messages for which an ACL control &%dkim_disable_verify%& has not been set.
41362 .cindex DKIM "selecting signature algorithms"
41363 Individual classes of signature algorithm can be ignored by changing
41364 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
41365 The &%dkim_verify_minimal%& option can be set to cease verification
41366 processing for a message once the first passing signature is found.
41367
41368 .cindex authentication "expansion item"
41369 Performing verification sets up information used by the
41370 &%authresults%& expansion item.
41371
41372 For most purposes the default option settings suffice and the remainder
41373 of this section can be ignored.
41374
41375 The results of verification are made available to the
41376 &%acl_smtp_dkim%& ACL, which can examine and modify them.
41377 A missing ACL definition defaults to accept.
41378 By default, the ACL is called once for each
41379 syntactically(!) correct signature in the incoming message.
41380 If any ACL call does not accept, the message is not accepted.
41381 If a cutthrough delivery was in progress for the message, that is
41382 summarily dropped (having wasted the transmission effort).
41383
41384 To evaluate the verification result in the ACL
41385 a large number of expansion variables
41386 containing the signature status and its details are set up during the
41387 runtime of the ACL.
41388
41389 Calling the ACL only for existing signatures is not sufficient to build
41390 more advanced policies. For that reason, the main option
41391 &%dkim_verify_signers%&, and an expansion variable
41392 &%$dkim_signers%& exist.
41393
41394 The main option &%dkim_verify_signers%& can be set to a colon-separated
41395 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
41396 called. It is expanded when the message has been received. At this point,
41397 the expansion variable &%$dkim_signers%& already contains a colon-separated
41398 list of signer domains and identities for the message. When
41399 &%dkim_verify_signers%& is not specified in the main configuration,
41400 it defaults as:
41401 .code
41402 dkim_verify_signers = $dkim_signers
41403 .endd
41404 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
41405 DKIM signature in the message. Current DKIM verifiers may want to explicitly
41406 call the ACL for known domains or identities. This would be achieved as follows:
41407 .code
41408 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
41409 .endd
41410 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
41411 and "ebay.com", plus all domains and identities that have signatures in the message.
41412 You can also be more creative in constructing your policy. For example:
41413 .code
41414 dkim_verify_signers = $sender_address_domain:$dkim_signers
41415 .endd
41416
41417 If a domain or identity is listed several times in the (expanded) value of
41418 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
41419
41420 Note that if the option is set using untrustworthy data
41421 (such as the From: header)
41422 care should be taken to force lowercase for domains
41423 and for the domain part if identities.
41424 The default setting can be regarded as trustworthy in this respect.
41425
41426 If multiple signatures match a domain (or identity), the ACL is called once
41427 for each matching signature.
41428
41429
41430 Inside the DKIM ACL, the following expansion variables are
41431 available (from most to least important):
41432
41433
41434 .vlist
41435 .vitem &%$dkim_cur_signer%&
41436 The signer that is being evaluated in this ACL run. This can be a domain or
41437 an identity. This is one of the list items from the expanded main option
41438 &%dkim_verify_signers%& (see above).
41439
41440 .vitem &%$dkim_verify_status%&
41441 Within the DKIM ACL,
41442 a string describing the general status of the signature. One of
41443 .ilist
41444 &%none%&: There is no signature in the message for the current domain or
41445 identity (as reflected by &%$dkim_cur_signer%&).
41446 .next
41447 &%invalid%&: The signature could not be verified due to a processing error.
41448 More detail is available in &%$dkim_verify_reason%&.
41449 .next
41450 &%fail%&: Verification of the signature failed.  More detail is
41451 available in &%$dkim_verify_reason%&.
41452 .next
41453 &%pass%&: The signature passed verification. It is valid.
41454 .endlist
41455
41456 This variable can be overwritten using an ACL 'set' modifier.
41457 This might, for instance, be done to enforce a policy restriction on
41458 hash-method or key-size:
41459 .code
41460   warn condition       = ${if eq {$dkim_verify_status}{pass}}
41461        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
41462        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
41463                                   {< {$dkim_key_length}{1024}}}}
41464        logwrite        = NOTE: forcing DKIM verify fail (was pass)
41465        set dkim_verify_status = fail
41466        set dkim_verify_reason = hash too weak or key too short
41467 .endd
41468
41469 So long as a DKIM ACL is defined (it need do no more than accept),
41470 after all the DKIM ACL runs have completed, the value becomes a
41471 colon-separated list of the values after each run.
41472 This is maintained for the mime, prdr and data ACLs.
41473
41474 .vitem &%$dkim_verify_reason%&
41475 A string giving a little bit more detail when &%$dkim_verify_status%& is either
41476 "fail" or "invalid". One of
41477 .ilist
41478 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
41479 key for the domain could not be retrieved. This may be a temporary problem.
41480 .next
41481 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
41482 record for the domain is syntactically invalid.
41483 .next
41484 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
41485 body hash does not match the one specified in the signature header. This
41486 means that the message body was modified in transit.
41487 .next
41488 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
41489 could not be verified. This may mean that headers were modified,
41490 re-written or otherwise changed in a way which is incompatible with
41491 DKIM verification. It may of course also mean that the signature is forged.
41492 .endlist
41493
41494 This variable can be overwritten, with any value, using an ACL 'set' modifier.
41495
41496 .vitem &%$dkim_domain%&
41497 The signing domain. IMPORTANT: This variable is only populated if there is
41498 an actual signature in the message for the current domain or identity (as
41499 reflected by &%$dkim_cur_signer%&).
41500
41501 .vitem &%$dkim_identity%&
41502 The signing identity, if present. IMPORTANT: This variable is only populated
41503 if there is an actual signature in the message for the current domain or
41504 identity (as reflected by &%$dkim_cur_signer%&).
41505
41506 .vitem &%$dkim_selector%&
41507 The key record selector string.
41508
41509 .vitem &%$dkim_algo%&
41510 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
41511 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41512 may also be 'ed25519-sha256'.
41513 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41514 for EC keys.
41515
41516 Note that RFC 8301 says:
41517 .code
41518 rsa-sha1 MUST NOT be used for signing or verifying.
41519
41520 DKIM signatures identified as having been signed with historic
41521 algorithms (currently, rsa-sha1) have permanently failed evaluation
41522 .endd
41523
41524 To enforce this you must either have a DKIM ACL which checks this variable
41525 and overwrites the &$dkim_verify_status$& variable as discussed above,
41526 or have set the main option &%dkim_verify_hashes%& to exclude
41527 processing of such signatures.
41528
41529 .vitem &%$dkim_canon_body%&
41530 The body canonicalization method. One of 'relaxed' or 'simple'.
41531
41532 .vitem &%$dkim_canon_headers%&
41533 The header canonicalization method. One of 'relaxed' or 'simple'.
41534
41535 .vitem &%$dkim_copiedheaders%&
41536 A transcript of headers and their values which are included in the signature
41537 (copied from the 'z=' tag of the signature).
41538 Note that RFC6376 requires that verification fail if the From: header is
41539 not included in the signature.  Exim does not enforce this; sites wishing
41540 strict enforcement should code the check explicitly.
41541
41542 .vitem &%$dkim_bodylength%&
41543 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
41544 limit was set by the signer, "9999999999999" is returned. This makes sure
41545 that this variable always expands to an integer value.
41546 &*Note:*& The presence of the signature tag specifying a signing body length
41547 is one possible route to spoofing of valid DKIM signatures.
41548 A paranoid implementation might wish to regard signature where this variable
41549 shows less than the "no limit" return as being invalid.
41550
41551 .vitem &%$dkim_created%&
41552 UNIX timestamp reflecting the date and time when the signature was created.
41553 When this was not specified by the signer, "0" is returned.
41554
41555 .vitem &%$dkim_expires%&
41556 UNIX timestamp reflecting the date and time when the signer wants the
41557 signature to be treated as "expired". When this was not specified by the
41558 signer, "9999999999999" is returned. This makes it possible to do useful
41559 integer size comparisons against this value.
41560 Note that Exim does not check this value.
41561
41562 .vitem &%$dkim_headernames%&
41563 A colon-separated list of names of headers included in the signature.
41564
41565 .vitem &%$dkim_key_testing%&
41566 "1" if the key record has the "testing" flag set, "0" if not.
41567
41568 .vitem &%$dkim_key_nosubdomains%&
41569 "1" if the key record forbids subdomaining, "0" otherwise.
41570
41571 .vitem &%$dkim_key_srvtype%&
41572 Service type (tag s=) from the key record. Defaults to "*" if not specified
41573 in the key record.
41574
41575 .vitem &%$dkim_key_granularity%&
41576 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
41577 in the key record.
41578
41579 .vitem &%$dkim_key_notes%&
41580 Notes from the key record (tag n=).
41581
41582 .vitem &%$dkim_key_length%&
41583 Number of bits in the key.
41584 Valid only once the key is loaded, which is at the time the header signature
41585 is verified, which is after the body hash is.
41586
41587 Note that RFC 8301 says:
41588 .code
41589 Verifiers MUST NOT consider signatures using RSA keys of
41590 less than 1024 bits as valid signatures.
41591 .endd
41592
41593 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
41594 option.
41595
41596 .endlist
41597
41598 In addition, two ACL conditions are provided:
41599
41600 .vlist
41601 .vitem &%dkim_signers%&
41602 ACL condition that checks a colon-separated list of domains or identities
41603 for a match against the domain or identity that the ACL is currently verifying
41604 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
41605 verb to a group of domains or identities. For example:
41606
41607 .code
41608 # Warn when Mail purportedly from GMail has no gmail signature
41609 warn sender_domains = gmail.com
41610      dkim_signers = gmail.com
41611      dkim_status = none
41612      log_message = GMail sender without gmail.com DKIM signature
41613 .endd
41614
41615 Note that the above does not check for a total lack of DKIM signing;
41616 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
41617
41618 .vitem &%dkim_status%&
41619 ACL condition that checks a colon-separated list of possible DKIM verification
41620 results against the actual result of verification. This is typically used
41621 to restrict an ACL verb to a list of verification outcomes, for example:
41622
41623 .code
41624 deny sender_domains = paypal.com:paypal.de
41625      dkim_signers = paypal.com:paypal.de
41626      dkim_status = none:invalid:fail
41627      message = Mail from Paypal with invalid/missing signature
41628 .endd
41629
41630 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
41631 see the documentation of the &%$dkim_verify_status%& expansion variable above
41632 for more information of what they mean.
41633 .endlist
41634
41635
41636
41637
41638 .section "SPF (Sender Policy Framework)" SECSPF
41639 .cindex SPF verification
41640
41641 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
41642 messages with its domain in the envelope from, documented by RFC 7208.
41643 For more information on SPF see &url(http://www.open-spf.org), a static copy of
41644 the &url(http://openspf.org).
41645 . --- 2019-10-28: still not https, open-spf.org is told to be a
41646 . --- web-archive copy of the now dead openspf.org site
41647 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
41648 . --- discussion.
41649
41650 Messages sent by a system not authorised will fail checking of such assertions.
41651 This includes retransmissions done by traditional forwarders.
41652
41653 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
41654 &_Local/Makefile_&.  The support uses the &_libspf2_& library
41655 &url(https://www.libspf2.org/).
41656 There is no Exim involvement in the transmission of messages;
41657 publishing certain DNS records is all that is required.
41658
41659 For verification, an ACL condition and an expansion lookup are provided.
41660 .cindex authentication "expansion item"
41661 Performing verification sets up information used by the
41662 &%authresults%& expansion item.
41663
41664
41665 .cindex SPF "ACL condition"
41666 .cindex ACL "spf condition"
41667 The ACL condition "spf" can be used at or after the MAIL ACL.
41668 It takes as an argument a list of strings giving the outcome of the SPF check,
41669 and will succeed for any matching outcome.
41670 Valid strings are:
41671 .vlist
41672 .vitem &%pass%&
41673 The SPF check passed, the sending host is positively verified by SPF.
41674
41675 .vitem &%fail%&
41676 The SPF check failed, the sending host is NOT allowed to send mail for the
41677 domain in the envelope-from address.
41678
41679 .vitem &%softfail%&
41680 The SPF check failed, but the queried domain can't absolutely confirm that this
41681 is a forgery.
41682
41683 .vitem &%none%&
41684 The queried domain does not publish SPF records.
41685
41686 .vitem &%neutral%&
41687 The SPF check returned a "neutral" state.  This means the queried domain has
41688 published a SPF record, but wants to allow outside servers to send mail under
41689 its domain as well.  This should be treated like "none".
41690
41691 .vitem &%permerror%&
41692 This indicates a syntax error in the SPF record of the queried domain.
41693 You may deny messages when this occurs.
41694
41695 .vitem &%temperror%&
41696 This indicates a temporary error during all processing, including Exim's
41697 SPF processing.  You may defer messages when this occurs.
41698
41699 .vitem &%invalid%&
41700 There was an error during processing of the SPF lookup
41701 .endlist
41702
41703 You can prefix each string with an exclamation mark to  invert
41704 its meaning,  for example  "!fail" will  match all  results but
41705 "fail".  The  string  list is  evaluated  left-to-right,  in a
41706 short-circuit fashion.
41707
41708 Example:
41709 .code
41710 deny spf = fail
41711      message = $sender_host_address is not allowed to send mail from \
41712                ${if def:sender_address_domain \
41713                     {$sender_address_domain}{$sender_helo_name}}.  \
41714                Please see http://www.open-spf.org/Why;\
41715                identity=${if def:sender_address_domain \
41716                              {$sender_address}{$sender_helo_name}};\
41717                ip=$sender_host_address
41718 .endd
41719
41720 Note: The above mentioned URL may not be as helpful as expected. You are
41721 encouraged to replace the link with a link to a site with more
41722 explanations.
41723
41724 When the spf condition has run, it sets up several expansion
41725 variables:
41726
41727 .cindex SPF "verification variables"
41728 .vlist
41729 .vitem &$spf_header_comment$&
41730 .vindex &$spf_header_comment$&
41731   This contains a human-readable string describing the outcome
41732   of the SPF check. You can add it to a custom header or use
41733   it for logging purposes.
41734
41735 .vitem &$spf_received$&
41736 .vindex &$spf_received$&
41737   This contains a complete Received-SPF: header (name and
41738   content) that can be added to the message. Please note that
41739   according to the SPF draft, this header must be added at the
41740   top of the header list, i.e. with
41741 .code
41742 add_header = :at_start:$spf_received
41743 .endd
41744   See section &<<SECTaddheadacl>>& for further details.
41745
41746   Note: in case of "Best-guess" (see below), the convention is
41747   to put this string in a header called X-SPF-Guess: instead.
41748
41749 .vitem &$spf_result$&
41750 .vindex &$spf_result$&
41751   This contains the outcome of the SPF check in string form,
41752   currently one of pass, fail, softfail, none, neutral, permerror,
41753   temperror, or &"(invalid)"&.
41754
41755 .vitem &$spf_result_guessed$&
41756 .vindex &$spf_result_guessed$&
41757   This boolean is true only if a best-guess operation was used
41758   and required in order to obtain a result.
41759
41760 .vitem &$spf_smtp_comment$&
41761 .vindex &$spf_smtp_comment$&
41762 .vindex &%spf_smtp_comment_template%&
41763   This contains a string that can be used in a SMTP response
41764   to the calling party. Useful for "fail".
41765   The string is generated by the SPF library from the template configured in the main config
41766   option &%spf_smtp_comment_template%&.
41767 .endlist
41768
41769
41770 .cindex SPF "ACL condition"
41771 .cindex ACL "spf_guess condition"
41772 .cindex SPF "best guess"
41773 In addition to SPF, you can also perform checks for so-called
41774 "Best-guess".  Strictly speaking, "Best-guess" is not standard
41775 SPF, but it is supported by the same framework that enables SPF
41776 capability.
41777 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
41778 for a description of what it means.
41779 . --- 2019-10-28: still not https:
41780
41781 To access this feature, simply use the spf_guess condition in place
41782 of the spf one.  For example:
41783
41784 .code
41785 deny spf_guess = fail
41786      message = $sender_host_address doesn't look trustworthy to me
41787 .endd
41788
41789 In case you decide to reject messages based on this check, you
41790 should note that although it uses the same framework, "Best-guess"
41791 is not SPF, and therefore you should not mention SPF at all in your
41792 reject message.
41793
41794 When the spf_guess condition has run, it sets up the same expansion
41795 variables as when spf condition is run, described above.
41796
41797 Additionally, since Best-guess is not standardized, you may redefine
41798 what "Best-guess" means to you by redefining the main configuration
41799 &%spf_guess%& option.
41800 For example, the following:
41801
41802 .code
41803 spf_guess = v=spf1 a/16 mx/16 ptr ?all
41804 .endd
41805
41806 would relax host matching rules to a broader network range.
41807
41808
41809 .cindex SPF "lookup expansion"
41810 .cindex lookup spf
41811 A lookup expansion is also available. It takes an email
41812 address as the key and an IP address
41813 (v4 or v6)
41814 as the database:
41815
41816 .code
41817   ${lookup {username@domain} spf {ip.ip.ip.ip}}
41818 .endd
41819
41820 The lookup will return the same result strings as can appear in
41821 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
41822
41823
41824
41825
41826
41827 .section "SRS (Sender Rewriting Scheme)" SECTSRS
41828 .cindex SRS "sender rewriting scheme"
41829
41830 SRS can be used to modify sender addresses when forwarding so that
41831 SPF verification does not object to them.
41832 It operates by encoding the original envelope sender in a new
41833 sender local part and using a domain run by the forwarding site
41834 as the new domain for the sender.  Any DSN message should be returned
41835 to this new sender at the forwarding site, which can extract the
41836 original sender from the coded local part and forward the DSN to
41837 the originator.
41838
41839 This is a way of avoiding the breakage that SPF does to forwarding.
41840 The constructed local-part will be longer than the original,
41841 leading to possible problems with very long addresses.
41842 The changing of the sender address also hinders the tracing of mail
41843 problems.
41844
41845 Exim can be built to include native SRS support.  To do this
41846 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
41847 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
41848 will be defined.
41849 The support is limited to SRS0-encoding; SRS1 is not supported.
41850
41851 .cindex SRS excoding
41852 To encode an address use this expansion item:
41853 .vlist
41854 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
41855 .cindex "&%srs_encode%& expansion item"
41856 .cindex SRS "expansion item"
41857 The first argument should be a secret known and used by all systems
41858 handling the recipient domain for the original message.
41859 There is no need to periodically change this key; a timestamp is also
41860 encoded.
41861 The second argument should be given as the envelope sender address before this
41862 encoding operation.
41863 The third argument should be the recipient domain of the message when
41864 it arrived at this system.
41865 .endlist
41866
41867 .cindex SRS decoding
41868 To decode an address use this expansion condition:
41869 .vlist
41870 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
41871 The first argument should be the recipient local prt as is was received.
41872 The second argument is the site secret.
41873
41874 If the messages is not for an SRS-encoded recipient the condition will
41875 return false.  If it is, the condition will return true and the variable
41876 &$srs_recipient$& will be set to the decoded (original) value.
41877 .endlist
41878
41879 Example usage:
41880 .code
41881   #macro
41882   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
41883
41884   #routers
41885
41886   outbound:
41887     driver =    dnslookup
41888     # if outbound, and forwarding has been done, use an alternate transport
41889     domains =   ! +my_domains
41890     transport = ${if eq {$local_part@$domain} \
41891                         {$original_local_part@$original_domain} \
41892                      {remote_smtp} {remote_forwarded_smtp}}
41893
41894   inbound_srs:
41895     driver =    redirect
41896     senders =   :
41897     domains =   +my_domains
41898     # detect inbound bounces which are SRS'd, and decode them
41899     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
41900     data =      $srs_recipient
41901
41902   inbound_srs_failure:
41903     driver =    redirect
41904     senders =   :
41905     domains =   +my_domains
41906     # detect inbound bounces which look SRS'd but are invalid
41907     condition = ${if inbound_srs {$local_part} {}}
41908     allow_fail
41909     data =      :fail: Invalid SRS recipient address
41910
41911   #... further routers here
41912
41913
41914   # transport; should look like the non-forward outbound
41915   # one, plus the max_rcpt and return_path options
41916   remote_forwarded_smtp:
41917     driver =              smtp
41918     # modify the envelope from, for mails that we forward
41919     max_rcpt =            1
41920     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
41921 .endd
41922
41923
41924
41925
41926
41927 .section DMARC SECDMARC
41928 .cindex DMARC verification
41929
41930 DMARC combines feedback from SPF, DKIM, and header From: in order
41931 to attempt to provide better indicators of the authenticity of an
41932 email.  This document does not explain the fundamentals; you
41933 should read and understand how it works by visiting the website at
41934 &url(http://www.dmarc.org/).
41935
41936 If Exim is built with DMARC support,
41937 the libopendmarc library is used.
41938
41939 For building Exim yourself, obtain the library from
41940 &url(http://sourceforge.net/projects/opendmarc/)
41941 to obtain a copy, or find it in your favorite package
41942 repository.  You will need to attend to the local/Makefile feature
41943 SUPPORT_DMARC and the associated LDFLAGS addition.
41944 This description assumes
41945 that headers will be in /usr/local/include, and that the libraries
41946 are in /usr/local/lib.
41947
41948 . subsection
41949
41950 There are three main-configuration options:
41951 .cindex DMARC "configuration options"
41952
41953 The &%dmarc_tld_file%& option
41954 .oindex &%dmarc_tld_file%&
41955 defines the location of a text file of valid
41956 top level domains the opendmarc library uses
41957 during domain parsing. Maintained by Mozilla,
41958 the most current version can be downloaded
41959 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
41960 See also the util/renew-opendmarc-tlds.sh script.
41961 The default for the option is unset.
41962 If not set, DMARC processing is disabled.
41963
41964
41965 The &%dmarc_history_file%& option, if set
41966 .oindex &%dmarc_history_file%&
41967 defines the location of a file to log results
41968 of dmarc verification on inbound emails. The
41969 contents are importable by the opendmarc tools
41970 which will manage the data, send out DMARC
41971 reports, and expire the data. Make sure the
41972 directory of this file is writable by the user
41973 exim runs as.
41974 The default is unset.
41975
41976 The &%dmarc_forensic_sender%& option
41977 .oindex &%dmarc_forensic_sender%&
41978 defines an alternate email address to use when sending a
41979 forensic report detailing alignment failures
41980 if a sender domain's dmarc record specifies it
41981 and you have configured Exim to send them.
41982 If set, this is expanded and used for the
41983 From: header line; the address is extracted
41984 from it and used for the envelope from.
41985 If not set (the default), the From: header is expanded from
41986 the dsn_from option, and <> is used for the
41987 envelope from.
41988
41989 . I wish we had subsections...
41990
41991 .cindex DMARC controls
41992 By default, the DMARC processing will run for any remote,
41993 non-authenticated user.  It makes sense to only verify DMARC
41994 status of messages coming from remote, untrusted sources.  You can
41995 use standard conditions such as hosts, senders, etc, to decide that
41996 DMARC verification should *not* be performed for them and disable
41997 DMARC with an ACL control modifier:
41998 .code
41999   control = dmarc_disable_verify
42000 .endd
42001 A DMARC record can also specify a "forensic address", which gives
42002 exim an email address to submit reports about failed alignment.
42003 Exim does not do this by default because in certain conditions it
42004 results in unintended information leakage (what lists a user might
42005 be subscribed to, etc).  You must configure exim to submit forensic
42006 reports to the owner of the domain.  If the DMARC record contains a
42007 forensic address and you specify the control statement below, then
42008 exim will send these forensic emails.  It is also advised that you
42009 configure a &%dmarc_forensic_sender%& because the default sender address
42010 construction might be inadequate.
42011 .code
42012   control = dmarc_enable_forensic
42013 .endd
42014 (AGAIN: You can choose not to send these forensic reports by simply
42015 not putting the dmarc_enable_forensic control line at any point in
42016 your exim config.  If you don't tell exim to send them, it will not
42017 send them.)
42018
42019 There are no options to either control.  Both must appear before
42020 the DATA acl.
42021
42022 . subsection
42023
42024 DMARC checks cam be run on incoming SMTP  messages by using the
42025 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
42026 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
42027 condition.  Putting this condition in the ACLs is required in order
42028 for a DMARC check to actually occur.  All of the variables are set
42029 up before the DATA ACL, but there is no actual DMARC check that
42030 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
42031
42032 The &"dmarc_status"& condition takes a list of strings on its
42033 right-hand side.  These strings describe recommended action based
42034 on the DMARC check.  To understand what the policy recommendations
42035 mean, refer to the DMARC website above.  Valid strings are:
42036 .display
42037 &'accept      '& The DMARC check passed and the library recommends accepting the email.
42038 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
42039 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
42040 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
42041 &'norecord    '& No policy section in the DMARC record for this RFC5322.From field
42042 &'nofrom      '& Unable to determine the domain of the sender.
42043 &'temperror   '& Library error or dns error.
42044 &'off         '& The DMARC check was disabled for this email.
42045 .endd
42046 You can prefix each string with an exclamation mark to invert its
42047 meaning, for example "!accept" will match all results but
42048 "accept".  The string list is evaluated left-to-right in a
42049 short-circuit fashion.  When a string matches the outcome of the
42050 DMARC check, the condition succeeds.  If none of the listed
42051 strings matches the outcome of the DMARC check, the condition
42052 fails.
42053
42054 Of course, you can also use any other lookup method that Exim
42055 supports, including LDAP, Postgres, MySQL, etc, as long as the
42056 result is a list of colon-separated strings.
42057
42058 Performing the check sets up information used by the
42059 &%authresults%& expansion item.
42060
42061 Several expansion variables are set before the DATA ACL is
42062 processed, and you can use them in this ACL.  The following
42063 expansion variables are available:
42064
42065 .vlist
42066 .vitem &$dmarc_status$&
42067 .vindex &$dmarc_status$&
42068 .cindex DMARC result
42069 A one word status indicating what the DMARC library
42070 thinks of the email.  It is a combination of the results of
42071 DMARC record lookup and the SPF/DKIM/DMARC processing results
42072 (if a DMARC record was found).  The actual policy declared
42073 in the DMARC record is in a separate expansion variable.
42074
42075 .vitem &$dmarc_status_text$&
42076 .vindex &$dmarc_status_text$&
42077 Slightly longer, human readable status.
42078
42079 .vitem &$dmarc_used_domain$&
42080 .vindex &$dmarc_used_domain$&
42081 The domain which DMARC used to look up the DMARC policy record.
42082
42083 .vitem &$dmarc_domain_policy$&
42084 .vindex &$dmarc_domain_policy$&
42085 The policy declared in the DMARC record.  Valid values
42086 are "none", "reject" and "quarantine".  It is blank when there
42087 is any error, including no DMARC record.
42088 .endlist
42089
42090 . subsection
42091
42092 By default, Exim's DMARC configuration is intended to be
42093 non-intrusive and conservative.  To facilitate this, Exim will not
42094 create any type of logging files without explicit configuration by
42095 you, the admin.  Nor will Exim send out any emails/reports about
42096 DMARC issues without explicit configuration by you, the admin (other
42097 than typical bounce messages that may come about due to ACL
42098 processing or failure delivery issues).
42099
42100 In order to log statistics suitable to be imported by the opendmarc
42101 tools, you need to:
42102 .ilist
42103 Configure the global option &%dmarc_history_file%&
42104 .next
42105 Configure cron jobs to call the appropriate opendmarc history
42106 import scripts and truncating the dmarc_history_file
42107 .endlist
42108
42109 In order to send forensic reports, you need to:
42110 .ilist
42111 Configure the global option &%dmarc_forensic_sender%&
42112 .next
42113 Configure, somewhere before the DATA ACL, the control option to
42114 enable sending DMARC forensic reports
42115 .endlist
42116
42117 . subsection
42118
42119 Example usage:
42120 .code
42121 (RCPT ACL)
42122   warn    domains        = +local_domains
42123           hosts          = +local_hosts
42124           control        = dmarc_disable_verify
42125
42126   warn    !domains       = +screwed_up_dmarc_records
42127           control        = dmarc_enable_forensic
42128
42129   warn    condition      = (lookup if destined to mailing list)
42130           set acl_m_mailing_list = 1
42131
42132 (DATA ACL)
42133   warn    dmarc_status   = accept : none : off
42134           !authenticated = *
42135           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
42136
42137   warn    dmarc_status   = !accept
42138           !authenticated = *
42139           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
42140
42141   warn    dmarc_status   = quarantine
42142           !authenticated = *
42143           set $acl_m_quarantine = 1
42144           # Do something in a transport with this flag variable
42145
42146   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
42147           condition      = ${if eq{$acl_m_mailing_list}{1}}
42148           message        = Messages from $dmarc_used_domain break mailing lists
42149
42150   deny    dmarc_status   = reject
42151           !authenticated = *
42152           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
42153
42154   warn    add_header     = :at_start:${authresults {$primary_hostname}}
42155 .endd
42156
42157
42158
42159
42160
42161 . ////////////////////////////////////////////////////////////////////////////
42162 . ////////////////////////////////////////////////////////////////////////////
42163
42164 .chapter "Proxies" "CHAPproxies" &&&
42165          "Proxy support"
42166 .cindex "proxy support"
42167 .cindex "proxy" "access via"
42168
42169 A proxy is an intermediate system through which communication is passed.
42170 Proxies may provide a security, availability or load-distribution function.
42171
42172
42173 .section "Inbound proxies" SECTproxyInbound
42174 .cindex proxy inbound
42175 .cindex proxy "server side"
42176 .cindex proxy "Proxy protocol"
42177 .cindex "Proxy protocol" proxy
42178
42179 Exim has support for receiving inbound SMTP connections via a proxy
42180 that uses &"Proxy Protocol"& to speak to it.
42181 To include this support, include &"SUPPORT_PROXY=yes"&
42182 in Local/Makefile.
42183
42184 It was built on the HAProxy specification, found at
42185 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
42186
42187 The purpose of this facility is so that an application load balancer,
42188 such as HAProxy, can sit in front of several Exim servers
42189 to distribute load.
42190 Exim uses the local protocol communication with the proxy to obtain
42191 the remote SMTP system IP address and port information.
42192 There is no logging if a host passes or
42193 fails Proxy Protocol negotiation, but it can easily be determined and
42194 recorded in an ACL (example is below).
42195
42196 Use of a proxy is enabled by setting the &%hosts_proxy%&
42197 main configuration option to a hostlist; connections from these
42198 hosts will use Proxy Protocol.
42199 Exim supports both version 1 and version 2 of the Proxy Protocol and
42200 automatically determines which version is in use.
42201
42202 The Proxy Protocol header is the first data received on a TCP connection
42203 and is inserted before any TLS-on-connect handshake from the client; Exim
42204 negotiates TLS between Exim-as-server and the remote client, not between
42205 Exim and the proxy server. The Proxy Protocol header must be received
42206 within &%proxy_protocol_timeout%&, which defaults to 3s.
42207
42208 The following expansion variables are usable
42209 (&"internal"& and &"external"& here refer to the interfaces
42210 of the proxy):
42211 .display
42212 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
42213 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
42214 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
42215 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
42216 &'proxy_session            '& boolean: SMTP connection via proxy
42217 .endd
42218 If &$proxy_session$& is set but &$proxy_external_address$& is empty
42219 there was a protocol error.
42220 The variables &$sender_host_address$& and &$sender_host_port$&
42221 will have values for the actual client system, not the proxy.
42222
42223 Since the real connections are all coming from the proxy, and the
42224 per host connection tracking is done before Proxy Protocol is
42225 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
42226 handle all of the parallel volume you expect per inbound proxy.
42227 With the option set so high, you lose the ability
42228 to protect your server from many connections from one IP.
42229 In order to prevent your server from overload, you
42230 need to add a per connection ratelimit to your connect ACL.
42231 A possible solution is:
42232 .display
42233   # Set max number of connections per host
42234   LIMIT   = 5
42235   # Or do some kind of IP lookup in a flat file or database
42236   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
42237
42238   defer   ratelimit      = LIMIT / 5s / per_conn / strict
42239           message        = Too many connections from this IP right now
42240 .endd
42241
42242
42243
42244 .section "Outbound proxies" SECTproxySOCKS
42245 .cindex proxy outbound
42246 .cindex proxy "client side"
42247 .cindex proxy SOCKS
42248 .cindex SOCKS proxy
42249 Exim has support for sending outbound SMTP via a proxy
42250 using a protocol called SOCKS5 (defined by RFC1928).
42251 The support can be optionally included by defining SUPPORT_SOCKS=yes in
42252 Local/Makefile.
42253
42254 Use of a proxy is enabled by setting the &%socks_proxy%& option
42255 on an smtp transport.
42256 The option value is expanded and should then be a list
42257 (colon-separated by default) of proxy specifiers.
42258 Each proxy specifier is a list
42259 (space-separated by default) where the initial element
42260 is an IP address and any subsequent elements are options.
42261
42262 Options are a string <name>=<value>.
42263 The list of options is in the following table:
42264 .display
42265 &'auth   '& authentication method
42266 &'name   '& authentication username
42267 &'pass   '& authentication password
42268 &'port   '& tcp port
42269 &'tmo    '& connection timeout
42270 &'pri    '& priority
42271 &'weight '& selection bias
42272 .endd
42273
42274 More details on each of these options follows:
42275
42276 .ilist
42277 .cindex authentication "to proxy"
42278 .cindex proxy authentication
42279 &%auth%&: Either &"none"& (default) or &"name"&.
42280 Using &"name"& selects username/password authentication per RFC 1929
42281 for access to the proxy.
42282 Default is &"none"&.
42283 .next
42284 &%name%&: sets the username for the &"name"& authentication method.
42285 Default is empty.
42286 .next
42287 &%pass%&: sets the password for the &"name"& authentication method.
42288 Default is empty.
42289 .next
42290 &%port%&: the TCP port number to use for the connection to the proxy.
42291 Default is 1080.
42292 .next
42293 &%tmo%&: sets a connection timeout in seconds for this proxy.
42294 Default is 5.
42295 .next
42296 &%pri%&: specifies a priority for the proxy within the list,
42297 higher values being tried first.
42298 The default priority is 1.
42299 .next
42300 &%weight%&: specifies a selection bias.
42301 Within a priority set servers are queried in a random fashion,
42302 weighted by this value.
42303 The default value for selection bias is 1.
42304 .endlist
42305
42306 Proxies from the list are tried according to their priority
42307 and weight settings until one responds.  The timeout for the
42308 overall connection applies to the set of proxied attempts.
42309
42310 .section Logging SECTproxyLog
42311 To log the (local) IP of a proxy in the incoming or delivery logline,
42312 add &"+proxy"& to the &%log_selector%& option.
42313 This will add a component tagged with &"PRX="& to the line.
42314
42315 . ////////////////////////////////////////////////////////////////////////////
42316 . ////////////////////////////////////////////////////////////////////////////
42317
42318 .chapter "Internationalisation" "CHAPi18n" &&&
42319          "Internationalisation""
42320 .cindex internationalisation "email address"
42321 .cindex EAI
42322 .cindex i18n
42323 .cindex utf8 "mail name handling"
42324
42325 Exim has support for Internationalised mail names.
42326 To include this it must be built with SUPPORT_I18N and the libidn library.
42327 Standards supported are RFCs 2060, 5890, 6530 and 6533.
42328
42329 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
42330 instead of it) then IDNA2008 is supported; this adds an extra library
42331 requirement, upon libidn2.
42332
42333 .section "MTA operations" SECTi18nMTA
42334 .cindex SMTPUTF8 "ESMTP option"
42335 .cindex "ESMTP extensions" SMTPUTF8
42336 The main configuration option &%smtputf8_advertise_hosts%& specifies
42337 a host list.  If this matches the sending host and
42338 accept_8bitmime is true (the default) then the ESMTP option
42339 SMTPUTF8 will be advertised.
42340
42341 If the sender specifies the SMTPUTF8 option on a MAIL command
42342 international handling for the message is enabled and
42343 the expansion variable &$message_smtputf8$& will have value TRUE.
42344
42345 The option &%allow_utf8_domains%& is set to true for this
42346 message. All DNS lookups are converted to a-label form
42347 whatever the setting of &%allow_utf8_domains%&
42348 when Exim is built with SUPPORT_I18N.
42349
42350 Both localparts and domain are maintained as the original
42351 UTF-8 form internally; any comparison or regular-expression use will
42352 require appropriate care.  Filenames created, eg. by
42353 the appendfile transport, will have UTF-8 names.
42354
42355 HELO names sent by the smtp transport will have any UTF-8
42356 components expanded to a-label form,
42357 and any certificate name checks will be done using the a-label
42358 form of the name.
42359
42360 .cindex log protocol
42361 .cindex SMTPUTF8 logging
42362 .cindex i18n logging
42363 Log lines and Received-by: header lines will acquire a "utf8"
42364 prefix on the protocol element, eg. utf8esmtp.
42365
42366 The following expansion operators can be used:
42367 .code
42368 ${utf8_domain_to_alabel:str}
42369 ${utf8_domain_from_alabel:str}
42370 ${utf8_localpart_to_alabel:str}
42371 ${utf8_localpart_from_alabel:str}
42372 .endd
42373
42374 .cindex utf8 "address downconversion"
42375 .cindex i18n "utf8 address downconversion"
42376 The RCPT ACL
42377 may use the following modifier:
42378 .display
42379 control = utf8_downconvert
42380 control = utf8_downconvert/<value>
42381 .endd
42382 This sets a flag requiring that envelope addresses are converted to
42383 a-label form before smtp delivery.
42384 This is usually for use in a Message Submission Agent context,
42385 but could be used for any message.
42386
42387 If a value is appended it may be:
42388 .display
42389 &`1  `& mandatory downconversion
42390 &`0  `& no downconversion
42391 &`-1 `& if SMTPUTF8 not supported by destination host
42392 .endd
42393 If no value is given, 1 is used.
42394
42395 If mua_wrapper is set, the utf8_downconvert control
42396 is initially set to -1.
42397
42398 The smtp transport has an option &%utf8_downconvert%&.
42399 If set it must expand to one of the three values described above,
42400 or an empty string.
42401 If non-empty it overrides value previously set
42402 (due to mua_wrapper or by an ACL control).
42403
42404
42405 There is no explicit support for VRFY and EXPN.
42406 Configurations supporting these should inspect
42407 &$smtp_command_argument$& for an SMTPUTF8 argument.
42408
42409 There is no support for LMTP on Unix sockets.
42410 Using the "lmtp" protocol option on an smtp transport,
42411 for LMTP over TCP, should work as expected.
42412
42413 There is no support for DSN unitext handling,
42414 and no provision for converting logging from or to UTF-8.
42415
42416
42417
42418 .section "MDA operations" SECTi18nMDA
42419 To aid in constructing names suitable for IMAP folders
42420 the following expansion operator can be used:
42421 .code
42422 ${imapfolder {<string>} {<sep>} {<specials>}}
42423 .endd
42424
42425 The string is converted from the charset specified by
42426 the "headers charset" command (in a filter file)
42427 or &%headers_charset%& main configuration option (otherwise),
42428 to the
42429 modified UTF-7 encoding specified by RFC 2060,
42430 with the following exception: All occurrences of <sep>
42431 (which has to be a single character)
42432 are replaced with periods ("."), and all periods and slashes that are not
42433 <sep> and are not in the <specials> string are BASE64 encoded.
42434
42435 The third argument can be omitted, defaulting to an empty string.
42436 The second argument can be omitted, defaulting to "/".
42437
42438 This is the encoding used by Courier for Maildir names on disk, and followed
42439 by many other IMAP servers.
42440
42441 Examples:
42442 .display
42443 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
42444 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
42445 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
42446 .endd
42447
42448 Note that the source charset setting is vital, and also that characters
42449 must be representable in UTF-16.
42450
42451
42452 . ////////////////////////////////////////////////////////////////////////////
42453 . ////////////////////////////////////////////////////////////////////////////
42454
42455 .chapter "Events" "CHAPevents" &&&
42456          "Events"
42457 .cindex events
42458
42459 The events mechanism in Exim can be used to intercept processing at a number
42460 of points.  It was originally invented to give a way to do customised logging
42461 actions (for example, to a database) but can also be used to modify some
42462 processing actions.
42463
42464 Most installations will never need to use Events.
42465 The support can be left out of a build by defining DISABLE_EVENT=yes
42466 in &_Local/Makefile_&.
42467
42468 There are two major classes of events: main and transport.
42469 The main configuration option &%event_action%& controls reception events;
42470 a transport option &%event_action%& controls delivery events.
42471
42472 Both options are a string which is expanded when the event fires.
42473 An example might look like:
42474 .cindex logging custom
42475 .code
42476 event_action = ${if eq {msg:delivery}{$event_name} \
42477 {${lookup pgsql {SELECT * FROM record_Delivery( \
42478     '${quote_pgsql:$sender_address_domain}',\
42479     '${quote_pgsql:${lc:$sender_address_local_part}}', \
42480     '${quote_pgsql:$domain}', \
42481     '${quote_pgsql:${lc:$local_part}}', \
42482     '${quote_pgsql:$host_address}', \
42483     '${quote_pgsql:${lc:$host}}', \
42484     '${quote_pgsql:$message_exim_id}')}} \
42485 } {}}
42486 .endd
42487
42488 Events have names which correspond to the point in process at which they fire.
42489 The name is placed in the variable &$event_name$& and the event action
42490 expansion must check this, as it will be called for every possible event type.
42491
42492 The current list of events is:
42493 .display
42494 &`dane:fail              after    transport  `& per connection
42495 &`msg:complete           after    main       `& per message
42496 &`msg:defer              after    transport  `& per message per delivery try
42497 &`msg:delivery           after    transport  `& per recipient
42498 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
42499 &`msg:rcpt:defer         after    transport  `& per recipient
42500 &`msg:host:defer         after    transport  `& per host per delivery try; host errors
42501 &`msg:fail:delivery      after    transport  `& per recipient
42502 &`msg:fail:internal      after    main       `& per recipient
42503 &`tcp:connect            before   transport  `& per connection
42504 &`tcp:close              after    transport  `& per connection
42505 &`tls:cert               before   both       `& per certificate in verification chain
42506 &`smtp:connect           after    transport  `& per connection
42507 &`smtp:ehlo              after    transport  `& per connection
42508 .endd
42509 New event types may be added in future.
42510
42511 The event name is a colon-separated list, defining the type of
42512 event in a tree of possibilities.  It may be used as a list
42513 or just matched on as a whole.  There will be no spaces in the name.
42514
42515 The second column in the table above describes whether the event fires
42516 before or after the action is associates with.  Those which fire before
42517 can be used to affect that action (more on this below).
42518
42519 The third column in the table above says what section of the configuration
42520 should define the event action.
42521
42522 An additional variable, &$event_data$&, is filled with information varying
42523 with the event type:
42524 .display
42525 &`dane:fail            `& failure reason
42526 &`msg:defer            `& error string
42527 &`msg:delivery         `& smtp confirmation message
42528 &`msg:fail:internal    `& failure reason
42529 &`msg:fail:delivery    `& smtp error message
42530 &`msg:host:defer       `& error string
42531 &`msg:rcpt:host:defer  `& error string
42532 &`msg:rcpt:defer       `& error string
42533 &`tls:cert             `& verification chain depth
42534 &`smtp:connect         `& smtp banner
42535 &`smtp:ehlo            `& smtp ehlo response
42536 .endd
42537
42538 The :defer events populate one extra variable: &$event_defer_errno$&.
42539
42540 For complex operations an ACL expansion can be used in &%event_action%&
42541 however due to the multiple contexts that Exim operates in during
42542 the course of its processing:
42543 .ilist
42544 variables set in transport events will not be visible outside that
42545 transport call
42546 .next
42547 acl_m variables in a server context are lost on a new connection,
42548 and after smtp helo/ehlo/mail/starttls/rset commands
42549 .endlist
42550 Using an ACL expansion with the logwrite modifier can be
42551 a useful way of writing to the main log.
42552
42553 The expansion of the event_action option should normally
42554 return an empty string.  Should it return anything else the
42555 following will be forced:
42556 .display
42557 &`tcp:connect      `&  do not connect
42558 &`tls:cert         `&  refuse verification
42559 &`smtp:connect     `&  close connection
42560 .endd
42561 All other message types ignore the result string, and
42562 no other use is made of it.
42563
42564 For a tcp:connect event, if the connection is being made to a proxy
42565 then the address and port variables will be that of the proxy and not
42566 the target system.
42567
42568 For tls:cert events, if GnuTLS is in use this will trigger only per
42569 chain element received on the connection.
42570 For OpenSSL it will trigger for every chain element including those
42571 loaded locally.
42572
42573 . ////////////////////////////////////////////////////////////////////////////
42574 . ////////////////////////////////////////////////////////////////////////////
42575
42576 .chapter "Adding new drivers or lookup types" "CHID13" &&&
42577          "Adding drivers or lookups"
42578 .cindex "adding drivers"
42579 .cindex "new drivers, adding"
42580 .cindex "drivers" "adding new"
42581 The following actions have to be taken in order to add a new router, transport,
42582 authenticator, or lookup type to Exim:
42583
42584 .olist
42585 Choose a name for the driver or lookup type that does not conflict with any
42586 existing name; I will use &"newdriver"& in what follows.
42587 .next
42588 Add to &_src/EDITME_& the line:
42589 .display
42590 <&'type'&>&`_NEWDRIVER=yes`&
42591 .endd
42592 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
42593 code is not to be included in the binary by default, comment this line out. You
42594 should also add any relevant comments about the driver or lookup type.
42595 .next
42596 Add to &_src/config.h.defaults_& the line:
42597 .code
42598 #define <type>_NEWDRIVER
42599 .endd
42600 .next
42601 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
42602 and create a table entry as is done for all the other drivers and lookup types.
42603 .next
42604 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
42605 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
42606 Add your &`NEWDRIVER`& to that list.
42607 As long as the dynamic module would be named &_newdriver.so_&, you can use the
42608 simple form that most lookups have.
42609 .next
42610 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
42611 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
42612 driver or lookup type and add it to the definition of OBJ.
42613 .next
42614 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
42615 definition of OBJ_MACRO.  Add a set of line to do the compile also.
42616 .next
42617 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
42618 &_src_&.
42619 .next
42620 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
42621 as for other drivers and lookups.
42622 .endlist
42623
42624 Then all you need to do is write the code! A good way to start is to make a
42625 proforma by copying an existing module of the same type, globally changing all
42626 occurrences of the name, and cutting out most of the code. Note that any
42627 options you create must be listed in alphabetical order, because the tables are
42628 searched using a binary chop procedure.
42629
42630 There is a &_README_& file in each of the sub-directories of &_src_& describing
42631 the interface that is expected.
42632
42633
42634
42635
42636 . ////////////////////////////////////////////////////////////////////////////
42637 . ////////////////////////////////////////////////////////////////////////////
42638
42639 . /////////////////////////////////////////////////////////////////////////////
42640 . These lines are processing instructions for the Simple DocBook Processor that
42641 . Philip Hazel has developed as a less cumbersome way of making PostScript and
42642 . PDFs than using xmlto and fop. They will be ignored by all other XML
42643 . processors.
42644 . /////////////////////////////////////////////////////////////////////////////
42645
42646 .literal xml
42647 <?sdop
42648   format="newpage"
42649   foot_right_recto="&chaptertitle;"
42650   foot_right_verso="&chaptertitle;"
42651 ?>
42652 .literal off
42653
42654 .makeindex "Options index"   "option"
42655 .makeindex "Variables index" "variable"
42656 .makeindex "Concept index"   "concept"
42657
42658
42659 . /////////////////////////////////////////////////////////////////////////////
42660 . /////////////////////////////////////////////////////////////////////////////